Create Replica Set - CreateUMongoDBReplSet
Overview
Create a Mongodb replica set cluster
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CreateUMongoDBReplSet. | Yes |
| PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| Zone | string | Availability Zone. See Availability Zone List | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| Name | string | Replica set instance name, at least 6 characters | Yes |
| DBVersion | string | Version of Mongodb's replica set, such as MongoDB_3_6, MongoDB_4_2 | Yes |
| AdminPassword | string | Administrator Password | Yes |
| DiskSpace | int | Disk Space (GB) | Yes |
| MachineTypeId | string | Machine Configuration | Yes |
| NodeCount | int | Number of Replica Set Nodes | Yes |
| ListenPort | int | Mongo service port | No |
| SubnetId | string | Subnet ID | No |
| VPCId | string | ID of VPC | No |
| Tag | string | The name of the business group where the instance is located | No |
| ChargeType | string | Payment methods: Yearly, Monthly, Dynamic, Trial, Default: Monthly | No |
| Quantity | int | Purchase duration, default value 1 | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.surfercloud.com/?Action=CreateUMongoDBReplSet
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=dHsclqIa
&Name=FtgAKIEl
&DBVersion=wqUloOJO
&AdminPassword=wpDUSWbu
&DiskSpace=uDHddgoU
&MachineTypeId=HDnfeFgp
&NodeCount=8
&SubnetId=QmISYYRw
&VPCId=SvxLSwuj
&Tag=wDGWVOqD
&ChargeType=Year
&Quantity=6
&ListenPort=3Response Example
{
"Action": "CreateUMongoDBReplSetResponse",
"RetCode": 0
}