调用CreateNode接口为云数据库MongoDB分片集群实例添加Shard节点或Mongos节点。

请确保在使用该接口前,已充分了解MongoDB产品的收费方式和价格

该接口仅适用于分片集群实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateNode

系统规定参数。取值:CreateNode

DBInstanceId String dds-bp11501cd7b5****

分片集群实例ID。

NodeClass String dds.shard.mid

Shard节点或Mongos节点的规格,规格详情请参见实例规格表

NodeStorage Integer 10

Node的磁盘空间,单位:GB。

取值范围:10~2000,步长为10 GB。

说明 当节点类型为Shard时,需要配置该参数。
NodeType String shard

节点类型,取值说明:

  • shard:Shard节点。
  • mongos:Mongos节点。
ClientToken String ETnLKlblzczshOTUbOCz****

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

AutoPay Boolean true

是否自动付费,取值说明:

  • true:(默认值)自动付费,请确保账号有足够的余额。
  • false:控制台手动付费。您可以单击控制台右上角的费用,进入费用中心页面,选择订单管理 > 我的订单,在订单列表页面找到目标订单进行支付。
说明 当付费类型为包年包月时,需要配置该参数。
ReadonlyReplicas Integer 5

设置Shard节点中只读节点的个数。

取值范围:0~5(整数),默认值为0

说明 当前仅中国站支持本参数。
BusinessInfo String {“ActivityId":"000000000"}

附加参数,业务信息。

CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码,默认为youhuiquan_promotion_option_id_for_blank

ShardDirect Boolean false

是否申请Shard节点直连地址,取值说明:

  • true:申请Shard节点直连地址。
  • false:(默认值)不申请Shard节点直连地址。
AccountName String ceshi

账号名,取值说明:

  • 以小写字母开头。
  • 由小写字母、数字或下划线(_)组成。
  • 长度为4~16个字符。
说明
  • 云数据库MongoDB不支持使用关键字作为账号。
  • 账号的权限固定为只读权限。
  • 首次申请Shard节点直连地址时,需要设置账号和密码,后续申请无需再次设置。
AccountPassword String 123+abc

账号密码,取值说明:

  • 由大写字母、小写字母、数字、特殊字符中的至少三种组成。
  • !@#$%^&*()_+-=为特殊字符。
  • 长度为8~32个字符。
说明 云数据库MongoDB不支持重置Shard节点的账号密码。

返回数据

名称 类型 示例值 描述
RequestId String 7D48FB19-20CA-4725-A870-3D8F5CE6****

请求ID。

NodeId String d-bp1b234bf7a4****

节点ID。

OrderId String 20951063702****

订单ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=CreateNode
&DBInstanceId=dds-bp11501cd7b5****
&NodeClass=dds.shard.mid
&NodeStorage=10
&NodeType=shard
&ClientToken=ETnLKlblzczshOTUbOCz****
&FromApp=mongo_buy
&AutoPay=true
&ReadonlyReplicas=5
&BusinessInfo={“ActivityId":"000000000"}
&CouponNo=youhuiquan_promotion_option_id_for_blank
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateNodeResponse>
    <RequestId>7D48FB19-20CA-4725-A870-3D8F5CE6****</RequestId>
    <NodeId>d-bp1b234bf7a4****</NodeId>
    <OrderId>20951063702****</OrderId>
</CreateNodeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "7D48FB19-20CA-4725-A870-3D8F5CE6****",
  "NodeId" : "d-bp1b234bf7a4****",
  "OrderId" : "20951063702****"
}

错误码

访问错误中心查看更多错误码。