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

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

接口说明

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

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dds:CreateNode	create	dbinstance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
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：Shard 节点。 mongos：Mongos 节点。	shard
ClientToken	string	否	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	ETnLKlblzczshOTUbOCz****
AutoPay	boolean	否	是否自动付费，取值说明： true：（默认值）自动付费，请确保账号有足够的余额。 false：控制台手动付费。您可以登录云数据库 MongoDB 控制台，在页面右上角选择费用 > 费用与成本，在左侧导航栏，选择订购订单>我的订单，在商品订单页签找到目标订单进行支付。说明当付费类型为包年包月时，需要配置该参数。	true
ReadonlyReplicas	integer	否	设置 Shard 节点中只读节点的个数。取值范围：0~5（整数），默认值为 0。说明当前仅中国站支持本参数。	5
BusinessInfo	string	否	附加参数，业务信息。	{“ActivityId":"000000000"}
CouponNo	string	否	是否使用优惠券，取值说明： default 或 null（默认）：使用优惠券。 youhuiquan_promotion_option_id_for_blank：不使用优惠券。	default
ShardDirect	boolean	否	是否申请 Shard 节点直连地址，取值说明： true：申请 Shard 节点直连地址。 false：（默认值）不申请 Shard 节点直连地址。	false
AccountName	string	否	账号名，取值说明：以小写字母开头。由小写字母、数字或下划线（_）组成。长度为 4~16 个字符。说明云数据库 MongoDB 不支持使用关键字作为账号。账号的权限固定为只读权限。首次申请 Shard 节点直连地址时，需要设置账号和密码，后续申请无需再次设置。	ceshi
AccountPassword	string	否	账号密码，取值说明：由大写字母、小写字母、数字、特殊字符中的至少三种组成。 !@#$%^&*()_+-=为特殊字符。长度为 8~32 个字符。说明云数据库 MongoDB 不支持重置 Shard 节点的账号密码。	123+abc

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7D48FB19-20CA-4725-A870-3D8F5CE6****
NodeId	string	节点 ID。	d-bp1b234bf7a4****
OrderId	string	订单 ID。	20951063702****

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-07-08	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情