创建副本 - CreateUDBReplicationInstance
简介
创建MongoDB的副本节点(包括仲裁)
定义
公共参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Action | string | 对应的 API 指令名称,当前 API 为 CreateUDBReplicationInstance | Yes |
PublicKey | string | 用户公钥,可从 控制台 获取 | Yes |
Signature | string | 根据公钥及 API 指令生成的用户签名,参见 签名算法 | Yes |
请求参数
参数名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
Region | string | 地域。 参见 地域和可用区列表 | Yes |
Zone | string | 可用区。参见 可用区列表 | No |
ProjectId | string | 项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口 | No |
SrcId | string | primary节点的DBId,该值可以通过DescribeUDBInstance获取 | Yes |
Name | string | 实例名称,至少6位 | Yes |
Port | int | 端口号,默认27017,取值范围3306至65535。 | No |
IsArbiter | boolean | 是否是仲裁节点,默认false,仲裁节点按最小机型创建 | No |
UseSSD | boolean | 是否使用SSD,默认为true。目前主要可用区、海外机房、新机房只提供SSD资源,非SSD资源不再提供。 | No |
InstanceType | string | UDB数据库机型: “Normal”: “标准机型” , “SATA_SSD”: “SSD机型” , “PCIE_SSD”: “SSD高性能机型” , “Normal_Volume”: “标准大容量机型”, “SATA_SSD_Volume”: “SSD大容量机型” , “PCIE_SSD_Volume”: “SSD高性能大容量机型”, “NVMe_SSD”: “快杰机型” | No |
ChargeType | string | Year, Month, Dynamic,Trial,默认和主库保持一致 | No |
Quantity | string | 购买时长,默认默认和主库保持一致 | No |
CouponId | string | 使用的代金券id | No |
响应字段
字段名 | 类型 | 描述信息 | 必填 |
---|---|---|---|
RetCode | int | 返回状态码,为 0 则为成功返回,非 0 为失败 | Yes |
Action | string | 操作指令名称 | Yes |
Message | string | 返回错误消息,当 RetCode 非 0 时提供详细的描述信息 | No |
DBId | string | 创建从节点的DBId | No |
示例
请求示例
https://api.an-link.com/?Action=CreateUDBReplicationInstance
&Region=cn-bj2
&SrcId=udb-xxxxx
&Name=mongodb-xxxxxxx-01
&InstanceType=OfalVzHs
&ChargeType=pAfhbuZY
&Quantity=sREIXrXW
&CouponId=tsZYXxdk
响应示例
{
"Action": "CreateUDBReplicationInstanceResponse",
"DBId": "udb-xxxxx",
"RetCode": 0
}