调用ModifyDBInstanceSpec接口变更云数据库MongoDB单节点实例、副本集实例和Serverless实例(仅中国站支持)的规格或存储空间。

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

该接口仅适用于云数据库MongoDB单节点实例、副本集实例和Serverless实例(仅中国站支持)。如需变更分片集群实例的配置,您可以根据需求通过调用ModifyNodeSpecCreateNodeDeleteNodeModifyNodeSpecBatch接口来实现。

调试

您可以在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

实例规格。

  • 单节点实例和副本集实例配置为实例的规格,详情请参见实例规格表
  • Serverless实例(仅支持中国站)配置为实例的计算规格,取值范围为100~8000。
说明 该参数和DBInstanceStorage参数两者中至少配置一项。
DBInstanceStorage String 50

实例的存储空间。

  • 单节点实例和副本集实例存储空间的取值范围为10~3000 GB,步长为10 GB。具体取值受实例规格约束,详情请参见实例规格表
  • Serverless实例(仅中国站支持)存储空间的取值范围1~100 GB,步长为1 GB。
说明
  • 该参数和DBInstanceClass参数两者中至少配置一项。
  • 仅按量付费的副本集实例支持降配存储空间,且存储空间必须大于当前已使用的存储空间。
OrderType String UPGRADE

变配类型,取值:

  • UPGRADE:升级配置。
  • DOWNGRADE:降级配置。

默认为DOWNGRADE(降级配置)。

说明 当实例付费方式为包年包月时,可以配置该参数。
AutoPay Boolean true

是否自动付费。取值:

  • true:自动付费,请确保账号有足够的余额。
  • false:控制台手动付费。具体操作为:登录控制台。在页面右上角选择费用 > 用户中心,在左侧导航栏,选择订单管理,在订单管理页面找到目标订单进行支付。

    默认值为true

BusinessInfo String {“ActivityId":"000000000"}

业务信息。

ReplicationFactor String 3

设置实例的节点个数。

  • 副本集实例取值为357
  • 单节点实例取值固定为1
说明 Serverless实例(仅中国站支持)不需要配置该参数。
ReadonlyReplicas String 1

只读节点的个数,取值范围为1~5

CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码,默认为youhuiquan_promotion_option_id_for_blank

EffectiveTime String Immediately

变更配置的生效时间,取值:

  • Immediately:立即生效。
  • MaintainTime:在实例的可运维时间段内生效。

默认为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****"
}

错误码

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