使用ModifyNodeSpec API变更分片集群实例的节点规格和存储空间-云数据库 MongoDB 版-阿里云

变更MongoDB分片集群实例中节点的规格和存储空间。

接口说明

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

说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dds:ModifyNodeSpec

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。	dds-bp1c0b990184****
NodeId	string	是	分片集群实例中 Shard 节点 ID 或 Mongos 节点 ID，您可以通过调用 DescribeDBInstanceAttribute 接口查询。说明当传入的值为 Shard 节点 ID 时，还需要传入 NodeStorage 参数。	s-bp143e1b1637****
NodeClass	string	否	Shard 节点或 Mongos 节点的规格，规格详情请参见实例规格表。	dds.mongos.standard
NodeStorage	integer	否	Shard 节点的存储空间，步长为 10，单位：GB。 SSD 本地盘，取值范围：10~2000。 ESSD PL1 云盘，取值范围：20~16000。	20
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	ETnLKlblzczshOTUbOCz****
FromApp	string	否	请求来源，取值说明： OpenApi：请求来源为 OpenApi。 mongo_buy：请求来源为控制台。	OpenApi
AutoPay	boolean	否	是否自动付费，取值说明： true（默认值）：自动付费，请确保账号有足够的余额。 false：手动付费。	true
EffectiveTime	string	否	变更配置的生效时间，取值说明： Immediately（默认值）：立即生效。 MaintainTime：实例可运维时间段内生效。	Immediately
SwitchTime	string	否	变更配置的执行时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明该参数已废弃，请替换使用 EffectiveTime 参数。	2022-01-05T03:18:53Z
OrderType	string	否	订单类型，取值说明： UPGRADE：升配。 DOWNGRADE：降配。	UPGRADE
ReadonlyReplicas	integer	否	调整 Shard 节点中只读节点的个数。取值范围：0~5（整数）。	5
BusinessInfo	string	否	附加参数，业务信息。	{“ActivityId":"000000000"}
CouponNo	string	否	是否使用优惠券，取值说明： default 或 null（默认）：使用优惠券。 youhuiquan_promotion_option_id_for_blank：不使用优惠券。	default
TargetZoneId	string	否	迁移可用区的目标主可用区。重要只支持云盘实例。	cn-hangzhou-h
TargetSecondaryZoneId	string	否	迁移可用区的目标 secondary 可用区。重要只支持云盘实例。	cn-hangzhou-e
TargetHiddenZoneId	string	否	迁移可用区的目标 Hidden 可用区。重要只支持云盘实例。	cn-hangzhou-j
TargetVswitchId	string	否	迁移可用区的目标 VswitchId。重要只支持云盘实例。	vsw-xxxxxxxx

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	61B05CCF-EBAB-4BF3-BA67-D77256A721E2
OrderId	string	订单 ID。	21084641369****

示例

正常返回示例

JSON格式

{
  "RequestId": "61B05CCF-EBAB-4BF3-BA67-D77256A721E2",
  "OrderId": "21084641369****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	GadInstanceNotSupport	GAD Instance doesn't support the operation.

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

变更历史

更多信息，参考变更详情。