调用ModifyDBInstanceSpec接口变更MongoDB单节点或副本集实例的规格或存储空间。

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

该接口仅适用于单节点实例和副本集实例。分片集群实例如需变更配置,您可以根据需求通过调用ModifyNodeSpecCreateNodeDeleteNode接口来实现。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
DBInstanceId String dds-bpxxxxxxxx

实例ID。

Action String ModifyDBInstanceSpec

系统规定参数,取值:ModifyDBInstanceSpec

DBInstanceClass String dds.mongo.standard

实例规格,详情请参考实例规格表

说明 本参数和DBInstanceStorage参数两者中必须传入一项。
DBInstanceStorage String 50

实例的存储空间。

  • 取值范围:10~3000,单位为GB,具体取值受实例规格约束,详情请参考实例规格表
  • 每10GB递增。
说明
  • 本参数和DBInstanceClass参数两者中必须传入一项。
  • 仅按量付费的副本集实例支持降配存储空间,且存储空间必须大于当前已使用的存储空间。
OrderType String UPGRADE

变配类型,取值:

  • UPGRADE:升级配置。
  • DOWNGRADE:降级配置,默认为降级配置。
说明 当实例付费方式为包年包月时,本参数才可用。
AutoPay Boolean true

是否自动付费。取值:

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

默认值为:true

BusinessInfo String {“ActivityId":"000000000"}

业务信息。

ReplicationFactor String 3

设置实例的节点个数。

  • 副本集实例取值为3,5,7
  • 单节点实例取值固定为1
CouponNo String youhuiquan_promotion_option_id_for_blank

优惠码,默认为:youhuiquan_promotion_option_id_for_blank

EffectiveTime String Immediately

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

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

默认为Immediately

RegionId String cn-hangzhou

实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。

ReadonlyReplicas String 1

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

AccessKeyId String LTAIgbTGpxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

名称 类型 示例值 描述
OrderId String 2033xxxxxxxx

订单ID。

RequestId String C5662998-62BE-4C7F-961D-7DFE775DD813

请求ID。

示例

请求示例


http(s)://mongodb.aliyuncs.com/?Action=ModifyDBInstanceSpec
&DBInstanceId=dds-bpxxxxxxxx
&DBInstanceStorage=50
&<公共请求参数>

正常返回示例

XML 格式

<ModifyDBInstanceSpecResponse>	
	  <OrderId>2033xxxxxxxx</OrderId>
	  <RequestId>C5662998-62BE-4C7F-961D-7DFE775DD813</RequestId>
</ModifyDBInstanceSpecResponse>

JSON 格式

{
	"RequestId":"C5662998-62BE-4C7F-961D-7DFE775DD813",
	"OrderId":"2033xxxxxxxx"
}

错误码

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