更新时间:2024-09-11 GMT+08:00

实例规格变更

功能介绍

实例规格变更。

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse/resize-flavor

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

ClickHouse实例ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

flavor_ref

String

规格ID。可通过HTAP查询规格信息获取。

仅允许使用对应实例的规格ID。

delay

Boolean

是否延迟变更。默认false。

instance_id

String

实例ID,严格匹配UUID规则。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

String

请求结果。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

ClickHouse实例规格变更。

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/clickhouse/resize-flavor

{
  "flavor_ref" : "6ebc6add-7462-3c27-b92b-3d79ae37a309",
  "delay" : false,
  "instance_id" : "59c6b263cd884178b7395e1ee8d93fbdin16"
}

响应示例

状态码: 200

Success.

{
  "result" : "3077fd46-2924-4513-ae07-82bac7886a9c"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码