StarRocks资源检查 - CheckStarRocksResource
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。 
     授权项 访问级别 资源类型(*为必须) 条件键 别名 依赖的授权项 gaussdbformysql:instance:list List - - gaussdb:instance:list - 
URI
POST /v3/{project_id}/starrocks/resource-check
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认值: 不涉及。 | 
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| Content-Type | 是 | String | 参数解释: 内容类型。 约束限制: 不涉及。 取值范围: application/json。 默认取值: application/json。 | 
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| action | 是 | String | 参数解释: 校验类型,仅支持校验创建实例。 约束限制: 不涉及。 取值范围: createInstance:校验创建实例。 默认取值: 不涉及。 | 
| resource | 是 | resource object | 参数解释: 资源信息。 约束限制: 不涉及。 | 
| 参数 | 是否必选 | 参数类型 | 描述 | 
|---|---|---|---|
| enterprise_project_id | 是 | String | 参数解释: 企业项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 | 
| instance_num | 是 | Integer | 参数解释: 实例数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| mode | 是 | String | 参数解释: 实例部署模式。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 | 
| availability_zone_mode | 是 | String | 参数解释: 可用区类型,目前仅支持Single。 约束限制: 不涉及。 取值范围: Single:单可用区。 默认取值: 不涉及。 | 
| fe_node_num | 是 | Integer | 参数解释: FE节点数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| be_node_num | 是 | Integer | 参数解释: BE节点数量。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| fe_flavor_ref | 是 | String | 参数解释: FE规格码。可通过调用HTAP查询规格信息 - ListHtapFlavor接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| be_flavor_ref | 是 | String | 参数解释: BE规格码。可通过调用HTAP查询规格信息 - ListHtapFlavor接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| availability_zone | 否 | String | 参数解释: 可用区码。选填,校验可用区码是否正确。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 | 
| subnet_id | 是 | String | 参数解释: HTAP实例子网ID,即TaurusDB实例子网ID。 获取方法如下: 
 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及。 | 
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| result | Boolean | 参数解释: 检查结果。 取值范围: 不涉及。 | 
状态码: 400
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码。 | 
| error_msg | String | 错误消息。 | 
状态码: 500
| 参数 | 参数类型 | 描述 | 
|---|---|---|
| error_code | String | 错误码。 | 
| error_msg | String | 错误消息。 | 
请求示例
StarRocks实例资源检查。
POST https://{endpoint}/v3/8f26bcbd59e84e1d9e0569c32545cee9/starrocks/resource-check
{
  "action" : "createInstance",
  "resource" : {
    "instance_num" : 1,
    "mode" : "Cluster",
    "availability_zone_mode" : "single",
    "fe_node_num" : 3,
    "be_node_num" : 3,
    "fe_flavor_ref" : "gaussdb.sr-fe.8xlarge.x86.4",
    "be_flavor_ref" : "gaussdb.sr-be.8xlarge.x86.4",
    "availability_zone" : "cn-southwest-244a",
    "subnet_id" : "b00dc497-91e1-4082-aeb0-a1dc95e10371",
    "enterprise_project_id" : "0"
  }
}
  响应示例
状态码: 200
Success.
{
  "result" : true
}
  状态码
请参见状态码。
错误码
请参见错误码。
 
    