文档首页> 云数据库 GaussDB (for openGauss)> API参考> API（推荐）> 实例管理> CN横向扩容/DN分片扩容/磁盘扩容
更新时间：2022-05-19 GMT+08:00
查看PDF
分享

CN横向扩容/DN分片扩容/磁盘扩容

功能介绍

通过该接口调用CN横向扩容/DN分片扩容/磁盘扩容。

接口约束

  • CN扩容
    • CN横向扩容步长1~9。
    • CN横向扩容后最大到256。
    • 若创建实例时指定的可用区为1个,CN横向扩容需选择同一可用区。
    • 扩容后，实例中CN节点的数量必须小于或等于两倍的分片数量。
  • DN扩容
    • DN分片扩容单次步长限制1~9。
    • DN分片扩容后最大到256。
  • 扩容实例磁盘
    • 磁盘大小要求(分片数*40GB )的整数倍。
    • 所有节点状态正常。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/action

  • URI样例

    https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/action

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一region下的project ID。

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

    instance_id

    是

    实例ID。

请求消息

  • 参数说明
    表2 参数说明

    名称

    是否必选

    参数类型

    说明

    expand_cluster

    否

    Object

    CN横向扩容/DN分片扩容时必填。

    详情请参见表3。

    enlarge_volume

    否

    Object

    扩容实例磁盘时必填。 所需扩容到的磁盘容量大小。

    详情请参见表6。
    表3 expand_cluster字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    coordinators

    否

    Array of Coordinators objects

    CN扩容时必选。需要填写表4参数。

    shard

    否

    Shard object

    DN分片扩容时必选。需要填写表5参数。
    表4 coordinators参数填写说明

    名称

    是否必选

    参数类型

    说明

    az_code

    是

    string

    新增CN横向扩容每个节点的可用区。如果需要扩容多个CN，请分别填写待扩容CN所在的可用区。

    不同区域的可用区请参考地区和终端节点。

    说明：

    扩容后，实例中CN节点的数量必须小于或等于两倍的分片数量。
    表5 shard参数填写说明

    名称

    是否必选

    参数类型

    说明

    count

    是

    integer

    新增DN分片的数量。
    表6 enlarge_volume字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    size

    是

    Integer

    GaussDB(for openGauss)磁盘大小要求（分片数*40GB）的倍数；取值范围：（分片数*40GB）~（分片数*16TB）。
  • 请求样例

    扩单CN

    {
    "expand_cluster": {
        "coordinators": [
            {
                "az_code": "cn-north-4a"
            }
        ]
    }
}

    扩多CN

    {
    "expand_cluster": {
        "coordinators": [
            {
                "az_code": "cn-north-4a"
            },
            {
                "az_code": "cn-north-4a"
            },
            {
                "az_code": "cn-north-4a"
            }
        ]
    }
}

    扩DN

    {
    "expand_cluster": {
        "shard": {
            "count": "1"
        }
    }
}

扩磁盘

{
    "enlarge_volume": {
        "size": 400
    }
}

响应消息

  • 正常响应要素说明
    表7 要素说明

    名称

    参数类型

    说明

    job_id

    String

    任务ID
  • 正常响应样例
    {
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}
  • 异常响应

    请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理
分享：

    相关文档

    相关产品

close