文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 实例管理/ DDM实例节点缩容
更新时间：2024-07-19 GMT+08:00
查看PDF

DDM实例节点缩容

功能介绍

对指定的DDM实例的节点个数进行缩容。

接口约束

请确保实例关联的RDS状态正常并且没有进行其他操作。包周期实例不支持该操作。

URI

POST /v2/{project_id}/instances/{instance_id}/action/reduce

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

node_number

是

Integer

需要缩容的节点数量，最大值为实例节点数减1。

group_id

否

String

组ID，指定当前进行节点扩容的组。当实例的组大于1时，必填。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instanceId

String

DDM实例ID。

instanceName

String

DDM实例名称。

jobId

String

任务ID，仅按需实例时会返回该参数。

order_id

String

订单号，仅包年包月实例时返回该参数。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

  • 缩容实例节点，需要缩容的节点数量为2。
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce

{
  "node_number" : 2
}
  • 缩容实例节点，实例有多个组，需要缩容的节点数量为1。
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/reduce

{
  "group_id" : "f080abf2010d45118068c28c8958f5fcgr09",
  "node_number" : 1
}

响应示例

状态码： 200

ok

{
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
  "instanceName" : "BUG-ddm-fb88-test",
  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码： 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

ok

400

bad request

500

server error

错误码

请参见错误码。

父主题： 实例管理