功能介绍

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

规格系列包括：通用型（s6）、增强型（c3）、增强Ⅱ型（c6）。

示例：

• dds.mongodb.s6.large.4.mongos和dds.mongodb.s6.medium.4.mongos是同一规格系列。
• dds.mongodb.s6.large.4.mongos和dds.mongodb.c3.large.4.mongos不是同一规格系列。

调整实例规格时，文档数据库服务会有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

• 参数说明

  表2 参数说明

  名称	是否必选	描述
  project_id	是	租户在某一region下的project ID。
  instance_id	是	实例ID，可以调用“查询实例列表”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求消息

• 参数说明

  表3 参数说明

  名称	是否必选	参数类型	描述
  resize	是	Object	目标规格信息。详情请参见表4。

  表4 resize字段数据结构说明

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

• 请求体样例
  变更集群实例下mongos节点的规格：

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

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

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

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

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

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

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

响应消息

• 要素说明

  表5 要素说明

  名称	参数类型	描述
  job_id	String	任务ID。

• 响应样例

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

状态码

详情请参见状态码。

错误码

详情请参见错误码。