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

功能介绍

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

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

接口约束

• CN扩容
  • CN横向扩容后最大到256。
  • 若创建实例时指定的可用区为1个，CN横向扩容需选择同一可用区。
• DN扩容
  • 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。
  is_auto_pay	否	String	包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 枚举值： true false

  表3 expand_cluster字段数据结构说明

  名称	是否必选	参数类型	说明
  coordinators	否	Array of Coordinators objects	CN扩容时必选。需要填写表4参数。
  shard	否	Shard object	DN分片扩容时必选。需要填写表5参数。

  表4 coordinators参数填写说明

  名称	是否必选	参数类型	说明
  az_code	是	string	新增CN横向扩容每个节点的可用区。如果需要扩容多个CN，请分别填写待扩容CN所在的可用区。 不同区域的可用区请参考地区和终端节点。

  表5 shard参数填写说明

  名称	是否必选	参数类型	说明
  count	是	integer	新增DN分片的数量。

  表6 enlarge_volume字段数据结构说明

  名称	是否必选	参数类型	说明
  size	是	Integer	GaussDB磁盘大小要求（分片数*40GB）的倍数；取值范围：（分片数*40GB）~（分片数*16TB）。

请求示例

• 添加一个协调节点

  {
      "expand_cluster": {
          "coordinators": [
              {
                  "az_code": "az_code"
              }
          ]
      }
  }

  
  

• 添加多个协调节点

  {
      "expand_cluster": {
          "coordinators": [
              {
                  "az_code": "az_code"
              },
              {
                  "az_code": "az_code"
              },
              {
                  "az_code": "az_code"
              }
          ]
      }
  }

  
  

• 添加一个DN分片

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

  
  

• 扩容磁盘到400GB

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

  
  

响应消息

• 正常响应要素说明

  表7 要素说明

  名称	参数类型	说明
  job_id	String	任务ID。按需实例时仅返回任务id。
  order_id	String	订单id。包周期实例时仅返回订单id。

• 正常响应样例

  {
  	"job_id": "2b414788a6004883a02390e2eb0ea227"
  }

  
  

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  202

• 异常

  请参见状态码。

错误码

请参见错误码。