变更云数据库MongoDB分片集群实例中一个或多个Mongos节点、Shard节点的配置。
接口说明
请确保在使用该接口前,已充分了解云数据库 MongoDB 产品的收费方式和价格。
该接口仅适用于云数据库 MongoDB 分片集群实例。
对多个分片集群实例进行批量升降配操作时,目标规格会受到一定的约束,例如存储空间扩容,目标容量需大于等于当前容量。当多个分片集群实例规格不一致的时候,会随机选择一个分片集群实例的规格去构造约束条件,可能出现无法升降配的情况。 如果遇到无法正常进行批量升降配的情况,建议选择使用 ModifyNodeSpec 接口对单个分片集群实例进行变配。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:ModifyNodeSpecBatch | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID,您可以调用 DescribeRegions 查询。 | cn-hangzhou |
DBInstanceId | string | 是 | 需要进行变更配置的实例 ID。 | dds-bp1337621e8f**** |
NodesInfo | string | 是 | 需要变配的 Mongos 节点、Shard 节点的规格信息。具体规格请参见实例规格表。 | {"Shards":[{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp14ae4572fd****","Storage":20},{"DBInstanceClass":"dds.shard.mid","DBInstanceName":"d-bp19f4f92dc5****","Storage":30}]} |
ClientToken | string | 否 | 用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCz**** |
AutoPay | boolean | 否 | 是否自动付费。取值:
默认值为 true。 | true |
EffectiveTime | string | 否 | 变更配置的生效时间,取值:
说明
默认为 Immediately。 | Immediately |
OrderType | string | 否 | 变配类型,取值:
说明
当实例付费方式为包年包月时,该参数可用。
| UPGRADE |
CouponNo | string | 否 | 是否使用优惠券,取值说明:
| default |
BusinessInfo | string | 否 | 业务信息。 | {“ActivityId":"000000000"} |
返回参数
示例
正常返回示例
JSON
格式
{
"OrderId": "21012719476****",
"RequestId": "0637BC25-6895-5500-871F-1127CA34****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史