文档

CreateNode - 新增Shard节点或Mongos节点

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

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:CreateNodeWrite
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

分片集群实例 ID。

dds-bp11501cd7b5****
NodeClassstring

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

dds.shard.mid
NodeStorageinteger

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

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

说明 当节点类型为 Shard 时,需要配置该参数。
10
NodeTypestring

节点类型,取值说明:

  • shard:Shard 节点。
  • mongos:Mongos 节点。
shard
ClientTokenstring

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

ETnLKlblzczshOTUbOCz****
AutoPayboolean

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

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

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

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

说明 当前仅中国站支持本参数。
5
BusinessInfostring

附加参数,业务信息。

{“ActivityId":"000000000"}
CouponNostring

是否使用优惠券,取值说明:

  • defaultnull(默认):使用优惠券。
  • youhuiquan_promotion_option_id_for_blank:不使用优惠券。
default
ShardDirectboolean

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

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

账号名,取值说明:

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

    账号密码,取值说明:

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    7D48FB19-20CA-4725-A870-3D8F5CE6****
    NodeIdstring

    节点 ID。

    d-bp1b234bf7a4****
    OrderIdstring

    订单 ID。

    20951063702****

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈