功能介绍

数据库CN横向扩容。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

• CN横向扩容步长1~9。
• CN横向扩容后最大到256。
• 若创建实例时指定的可用区为1个，CN横向扩容需选择同一可用区。
• 扩容后，实例中CN节点的数量必须小于或等于两倍的分片数量。

URI

• URI格式

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

• URI样例

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

• 参数说明

  表2 参数说明

  名称	是否必选	参数类型	说明
  expand_cluster	是	Object	请参见表3

  表3 expand_cluster字段数据结构说明

  名称	是否必选	参数类型	说明
  coordinators	是	Array	请参见表4
  isAutoPay	否	int	包周期用户需要填写该字段。 0：表示不自动支付扩容订单费用 1：表示自动支付扩容订单费用 不填写则保持默认。默认值：0

  表4 azCode字段数据结构说明

  名称	是否必选	参数类型	说明
  az_code	是	String	新增CN横向扩容每个节点的可用区

• 请求样例 （扩单CN）

  {
  	"expand_cluster": {
                  "coordinators": [
                          {
                                 "az_code":"az1xahz"
                          }
                  ]，
                 "isAutoPay":0
  	}
  }

• 请求样例 （扩多CN）扩多CN

  {
  	"expand_cluster": {
                  "coordinators": [
                          {
                                 "az_code":"az1xahz"
                          },
                          {
                                 "az_code":"az2xahz"
                          },
                          {
                                 "az_code":"az3xahz"
                          }
                  ]
  	}
  }

响应消息

• 正常响应要素说明

  表5 要素说明

  名称	参数类型	说明
  job_id	String	任务ID

状态码

请参见状态码。

错误码

请参见错误码。