调用ModifyDBInstanceSpec接口变更MongoDB单节点实例、副本集实例和Serverless实例(仅中国站支持)的规格或存储空间。
请确保在使用该接口前,已充分了解MongoDB产品的收费方式和价格(中国站价格、国际站价格)。
该接口仅适用于单节点实例、副本集实例和Serverless实例(仅中国站支持)。分片集群实例如需变更配置,您可以根据需求通过调用ModifyNodeSpec、CreateNode、DeleteNode或ModifyNodeSpecBatch接口来实现。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 否 | ModifyDBInstanceSpec | 系统规定参数。取值:ModifyDBInstanceSpec。 |
| RegionId | String | 否 | cn-hangzhou | 实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。 |
| DBInstanceId | String | 是 | dds-bp1ea17b41ab**** | 实例ID。 |
| DBInstanceClass | String | 否 | dds.sn4.xlarge.1 | 实例规格。
说明 该参数和
DBInstanceStorage参数两者中至少配置一项。
|
| DBInstanceStorage | String | 否 | 50 | 实例的存储空间。
说明
|
| OrderType | String | 否 | UPGRADE | 变配类型,取值:
默认为DOWNGRADE(降级配置)。
说明 当实例付费方式为包年包月时,可以配置该参数。
|
| AutoPay | Boolean | 否 | true | 是否自动付费。取值:
|
| BusinessInfo | String | 否 | {“ActivityId":"000000000"} | 业务信息。 |
| ReplicationFactor | String | 否 | 3 | 设置实例的节点个数。
说明 Serverless实例(仅中国站支持)不需要配置该参数。
|
| ReadonlyReplicas | String | 否 | 1 | 只读节点的个数,取值范围为1~5。 |
| CouponNo | String | 否 | youhuiquan_promotion_option_id_for_blank | 优惠码,默认为youhuiquan_promotion_option_id_for_blank。 |
| EffectiveTime | String | 否 | Immediately | 变更配置的生效时间,取值:
默认为Immediately。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 1E9F1104-19E7-59F0-AB7F-F4EBFDEA**** | 请求ID。 |
| OrderId | String | 21012408824**** | 订单ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=ModifyDBInstanceSpec &DBInstanceId=dds-bp1ea17b41ab**** &DBInstanceStorage=50 &<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyDBInstanceSpecResponse>
<RequestId>1E9F1104-19E7-59F0-AB7F-F4EBFDEA****</RequestId>
<OrderId>21012408824****</OrderId>
</ModifyDBInstanceSpecResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "1E9F1104-19E7-59F0-AB7F-F4EBFDEA****",
"OrderId" : "21012408824****"
}
错误码
访问错误中心查看更多错误码。