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

DDM实例节点扩容V3

功能介绍

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

接口约束

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

调试

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

URI

  • URL格式

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

  • 参数说明
    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    租户在某一region下的project ID。

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

    instance_id

    是

    String

    DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

参数

是否必选

参数类型

描述

group_id

否

String

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

subnet_id

否

String

子网ID，当实例组下的子网ID数量大于1时，必填。

is_auto_pay

否

Boolean

对包年包月实例节点扩容时可指定，表示是否自动从账户中支付。

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

nodes

是

Array of 表 EnlargeNodeInfo objects

节点信息列表。

最小：1

最大：实例下最大节点个数不超过32
表4 EnlargeNodeInfo

参数

是否必选

参数类型

描述

available_zone

是

String

节点可用区。取值非空，请参见地区和终端节点。

请求示例

扩容按需实例的节点，需要扩容的节点数量为1。

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/nodes
{
     "nodes": [
        {
            "available_zone": "az1"
        }
    ]
}

扩容按需实例的节点，实例有多个组，组下有多个子网，需要扩容的节点数量为1。

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/nodes
{
    "group_id": "efd077a3a50e460c8ba62e1956363299gr09",
    "subnet_id": "ead1e945-ca89-45dd-bcce-4a30b2054c22",
     "nodes": [
        {
            "available_zone": "az1"
        }
    ]
}
扩容包周期实例的节点，需要扩容的节点数量为1，自动从账户余额中支付。 
POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/nodes
{
    "is_auto_pay" : true,
     "nodes": [
        {
            "available_zone": "az1"
        }
    ]
}

响应消息

  • 正常响应参数说明
    表5 响应Body参数

    参数

    参数类型

    描述

    job_id

    String

    创建组的任务ID。

    仅创建按需实例时会返回该参数。

    order_id

    String

    订单号，创建包年包月时返回该参数。
  • 正常响应示例

    按需：

    {
  "job_id": "eff1d289-4d03-4942-8b9f-463ea07c000c"
}

    包周期：

    {
  "order_id" : "CS1810251738L8VVD" 
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档