为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点。
接口说明
请确保在使用该接口前,已充分了解MongoDB产品的收费方式和价格。
该接口仅适用于分片集群实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:CreateNode | WRITE |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
分片集群实例ID。 |
dds-bp11501cd7b5**** |
NodeClass | string | 是 |
Shard节点或Mongos节点的规格,规格详情请参见实例规格表。 |
dds.shard.mid |
NodeStorage | integer | 否 |
Node的磁盘空间,单位:GB。 取值范围:10~2000,步长为10 GB。
说明
当节点类型为Shard时,需要配置该参数。
|
10 |
NodeType | string | 是 |
节点类型,取值说明:
|
shard |
ClientToken | string | 否 |
用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
ETnLKlblzczshOTUbOCz**** |
AutoPay | boolean | 否 |
是否自动付费,取值说明:
说明
当付费类型为包年包月时,需要配置该参数。
|
true |
ReadonlyReplicas | integer | 否 |
设置Shard节点中只读节点的个数。 取值范围:0~5(整数),默认值为0。
说明
当前仅中国站支持本参数。
|
5 |
BusinessInfo | string | 否 |
附加参数,业务信息。 |
{“ActivityId":"000000000"} |
CouponNo | string | 否 |
优惠码,默认为youhuiquan_promotion_option_id_for_blank。 |
youhuiquan_promotion_option_id_for_blank |
ShardDirect | boolean | 否 |
是否申请Shard节点直连地址,取值说明:
|
false |
AccountName | string | 否 |
账号名,取值说明:
说明
|
ceshi |
AccountPassword | string | 否 |
账号密码,取值说明:
说明
云数据库MongoDB不支持重置Shard节点的账号密码。
|
123+abc |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "7D48FB19-20CA-4725-A870-3D8F5CE6****",
"NodeId": "d-bp1b234bf7a4****",
"OrderId": "20951063702****"
}
错误码
访问错误中心查看更多错误码。