变更实例规格

接口说明

变更实例的规格，包括同系列和跨系列变更规格。

调整实例规格时，文档数据库服务会有5~10分钟的业务中断重启，请谨慎操作。

变更规则

华为云文档数据库DDS因考虑到实例的稳定性和相关性能，当前支持的规格变更规则如表1。请谨慎操作。

“√”表示支持，“×”表示不支持。

约束说明

• 该接口既支持包年包月实例，也支持按需实例。
• 变更为同系列其他规格时，需要改变的规格不能与原规格一样。
• 实例状态仅为“normal”时，可以变更实例规格。
• 不支持集群实例只读节点的规格变更。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/resize

请求消息

• 参数说明

  表3 参数说明

  名称	参数类型	是否必选	描述
  resize	Object	是	目标规格信息。详情请参见表4。
  is_auto_pay	Boolean	否	变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 对于降低规格场景，该字段无效。 对于扩大规格场景： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。

  表4 resize字段数据结构说明

  名称	参数类型	是否必选	描述
  target_type	String	否	对象类型。 对于集群实例，该参数为必选。变更mongos节点规格时，取值为“mongos”；变更单个shard组规格、或者批量变更多个shard组规格时，取值为“shard”，变更config组规格时，取值为"config"。 对于副本集实例，不传该参数。变更readonly节点规格时,取值为“readonly”。 对于单节点实例，不传该参数。 枚举值： mongos shard config readonly
  target_id	String	否	待变更规格的节点ID或实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 对于集群实例，变更mongos节点规格时，取值为mongos节点ID；变更单个shard组规格时，取值为shard组ID；批量变更多个shard组规格时，不传该参数；变更config组规格时，取值为config组的ID。 对于副本集实例，取值为相应的实例ID。变更readonly节点规格时，取值为readonly节点ID。 对于单节点实例，取值为相应的实例ID。
  target_ids	Array of strings	否	待变更规格的节点组ID列表，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 对于集群实例，变更mongos节点规格时，不传该参数；变更单个shard组规格时，不传该参数；变更config组规格时，不传该参数；批量变更多个shard组规格时，取值为相应的多个shard组ID，最多支持16个shard组批量变更。 对于副本集实例，不传该参数。 对于单节点实例，不传该参数。
  target_spec_code	String	是	变更至新规格的资源规格编码。获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。

请求示例

• 变更集群实例下mongos节点的规格

  {
    "resize": {
      "target_type": "mongos",
      "target_id": "a742c13a284949adad177672e8a0f01cno02",
      "target_spec_code": "dds.mongodb.c6.large.4.mongos"
    }
  }

• 变更集群实例下shard组的规格

  {
    "resize": {
      "target_type": "shard",
      "target_id": "aeeb40a704904977ad78993d138ec942gr02",
      "target_spec_code": "dds.momgodb.c6.large.4.shard"
    }
  }

• 变更集群实例下config组的规格

  {
    "resize": {
      "target_type": "config",
      "target_id": "10a1c330537b42c1a9b3f7a5ebcda35egr02",
      "target_spec_code": "dds.momgodb.c6.xlarge.2.config"
    }
  }

• 变更副本集或单节点实例的规格

  {
    "resize": {
      "target_id": "aeeb40a704904977ad78993d138ec942in02",
      "target_spec_code": "dds.mongodb.c6.medium.4.repset"
    }
  }

• 批量变更集群实例下多个shard组的规格：

  POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3eain02/resize 
   { 
     "resize" : { 
       "target_type" : "shard", 
       "target_ids" : [ "aeeb40a704904977ad78993d138ec942gr02", "5cbbb49b8f88424590a8a7b744b2dcf0gr02", "0407115681454784b1446c15590e42f0gr02" ], 
       "target_spec_code" : "dds.mongodb.c6.large.4.shard" 
     } 
   }

响应消息

• 参数说明

  表5 参数说明

  名称	参数类型	是否必选	描述
  job_id	String	是	任务ID。
  order_id	String	否	订单ID，仅变更包年包月实例的规格时返回该参数。

• 响应示例

  {
      "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
  }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。