全部产品
Search

搜索本产品

    云数据库 MongoDB：CreateNodeBatch - 批量创建节点

    文档中心

    云数据库 MongoDB：CreateNodeBatch - 批量创建节点

    更新时间：Sep 03, 2024

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

    接口说明

    请确保在使用该接口前，已充分了解云数据库 MongoDB 产品的收费方式和价格。

    该接口仅适用于云数据库 MongoDB 分片集群实例。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    ClientTokenstring否

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

    		ETnLKlblzczshOTUbOCz****
    FromAppstring否

    请求来源，取值说明：

    • OpenApi：请求来源为 OpenAPI。
    • mongo_buy：请求来源为控制台。
    		OpenApi
    AutoPayboolean否

    是否自动付费，取值说明：

    • true：（默认值）自动付费，请确保账号有足够的余额。
    • false：手动付费。具体操作请参见手动续费包年包月实例。
    		true
    DBInstanceIdstring是

    需要添加节点的实例 ID。

    		dds-bp18b0934e70****
    NodesInfostring是

    添加 Mongos 节点或 Shard 节点的规格信息。具体规格，请参见实例规格表。

    说明 分片集群实例默认最多支持 32 个 Mongos 节点和 32 个 Shard 节点。
    		{"Shards":[{"DBInstanceClass":"mdb.shard.4x.large.d","Storage":20}]}
    CouponNostring否

    是否使用优惠券，取值说明：

    • default 或 null（默认）：使用优惠券。
    • youhuiquan_promotion_option_id_for_blank：不使用优惠券。
    		default
    BusinessInfostring否

    业务信息。

    		{“ActivityId":"000000000"}
    ShardDirectboolean否

    是否申请 Shard 节点直连地址，取值说明：

    • true：申请 Shard 节点直连地址。
    • false：（默认值）不申请 Shard 节点直连地址。
    		false
    AccountNamestring否

    账号名，取值说明：

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

    账号密码，取值说明：

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

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		55D41A94-1ACE-55E8-8BC7-67D622E7****
    OrderIdstring

    订单 ID。

    		50179021707****
    NodeIdstring

    新增的 Mongos 节点或 Shard 节点 ID。

    		d-bp18f7d6b6a7****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "55D41A94-1ACE-55E8-8BC7-67D622E7****",
  "OrderId": "50179021707****",
  "NodeId": "d-bp18f7d6b6a7****"
}

    错误码

    HTTP status code错误码错误信息描述
    400SSLNotSupportAddNodeInstance with SSL certificate can't add node, please contact us to solve this problem.SSL加密实例不允许添加节点，如您需要，请联系我们解决该问题。

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

    变更历史

    变更时间变更内容概要操作
    2024-07-08OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
    2023-10-17API 内部配置变更，不影响调用查看变更详情