变更实例规格

功能介绍

变更实例的规格。

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

接口约束

• 需要改变的规格不能与原规格一样。
• 实例状态仅为“normal”时，可以变更实例规格。
• 该接口仅支持同系列内变更规格。

  规格系列包括：通用型（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不是同一规格系列。

URI

• URI格式

  POST /v3/{project_id}/instances/{instance_id}/resize

• 参数说明

  表1 参数说明

  名称	是否必选	描述
  project_id	是	租户在某一region下的project ID。
  instance_id	是	实例ID。

请求消息

• 参数说明

  表2 参数说明

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

  表3 resize字段数据结构说明

  名称	是否必选	参数类型	描述
  target_type	否	String	对象类型。 对于集群实例，该参数为必选。变更mongos节点规格时，取值为“mongos”；变更shard组规格时，取值为“shard”。 对于副本集实例，不传该参数。
  target_id	是	String	待变更规格的节点ID或实例ID。 对于集群实例，变更mongos节点规格时，取值为mongos节点ID；变更shard组规格时，取值为shard组ID。 对于副本集实例，取值为相应的实例ID。
  target_spec_code	是	String	变更至新规格的资源规格编码。获取方法请参见查询所有实例规格信息中响应参数“flavors.spec_code”的值。

• 请求头

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

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

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

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

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

  变更副本集实例的规格：

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

响应消息

• 要素说明

  表4 要素说明

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

• 响应样例

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

状态码

详情请参见状态码。

错误码

详情请参见错误码。