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

StarRocks资源检查

功能介绍

StarRocks资源检查。

URI

POST /v3/{project_id}/starrocks/resource-check

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

Content-Type

String

内容类型。

取值:application/json。

X-Language

String

请求语言类型。默认en-us。 取值范围:

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

参数

是否必选

参数类型

描述

action

String

校验类型,仅支持校验创建实例。

枚举值:createInstance

resource

resource object

资源信息。

表4 resource

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID。

instance_num

Integer

实例数量。

mode

String

实例部署模式。

枚举值:

  • Cluster
  • Single

availability_zone_mode

String

可用区类型,目前仅支持single。

fe_node_num

Integer

FE节点数量。

be_node_num

Integer

BE节点数量。

fe_flavor_ref

String

FE规格码。

be_flavor_ref

String

BE规格码。

availability_zone

String

可用区码。选填,校验可用区码是否正确。

subnet_id

String

HTAP实例子网即GaussDB(for MySQL)实例子网。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

Boolean

检查结果。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

StarRocks实例资源检查

POST https://{endpoint}/v3/8f26bcbd59e84e1d9e0569c32545cee9/starrocks/resource-check

响应示例

状态码: 200

Success.

{
  "result" : true
}

状态码

请参见状态码

错误码

请参见错误码