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

DDM实例节点扩容

功能介绍

对指定的DDM实例的节点个数进行扩容，支持按需实例与包周期实例。

接口约束

请确保实例关联的RDS状态正常并且没有进行其他操作。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

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

instance_id

是

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

flavor_id

是

String

当前进行节点扩容的DDM实例底层虚拟机规格ID。

node_number

是

Integer

需要扩容的节点个数。

group_id

否

String

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

is_auto_pay

否

Boolean

变更包年包月实例规格时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。

  • true，表示自动从账户中支付。
  • false，表示手动从账户中支付，默认为该方式。

available_zones

否

Array of strings

可用区Code，仅包年包月实例传递该参数，个数需与node_number一致。请参见地区和终端节点。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instanceId

String

DDM实例ID。

instanceName

String

DDM实例名称，仅按需实例时会返回该参数。

jobId

String

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

orderId

String

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

状态码： 400

表5 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

  • 扩容按需实例的节点，需要扩容的节点数量为1。 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "node_number" : 1
}
  • 扩容按需实例的节点，实例有多个组，需要扩容的节点数量为1。 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "group_id" : "f080abf2010d45118068c28c8958f5fcgr09",
  "node_number" : 1
}
  • 扩容包周期实例的节点，需要扩容的节点数量为1，自动从账户余额中支付。 
    POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/action/enlarge

{
  "flavor_id" : "8f2e696c-a9c1-30bd-af90-25522bc67606",
  "node_number" : 1,
  "is_auto_pay" : true,
  "available_zones": [
	"az1xahz"
  ]
}

响应示例

状态码： 200

ok

{ 
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09", 
  "instanceName" : "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

错误码

请参见错误码。

父主题： 实例管理

相关文档