StarRocks资源检查
功能介绍
StarRocks资源检查。
调用方法
请参见如何调用API。
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查询规格信息接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
be_flavor_ref |
是 |
String |
参数解释: BE规格码。可通过调用HTAP查询规格信息接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
availability_zone |
否 |
String |
参数解释: 可用区码。选填,校验可用区码是否正确。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
subnet_id |
是 |
String |
参数解释: HTAP实例子网ID,即TaurusDB实例子网ID。 子网的网络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 }
SDK代码示例
SDK代码示例如下。
StarRocks实例资源检查
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class CheckStarRocksResourceSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); CheckStarRocksResourceRequest request = new CheckStarRocksResourceRequest(); ResourceCheck body = new ResourceCheck(); ResourceCheckResource resourcebody = new ResourceCheckResource(); resourcebody.withEnterpriseProjectId("0") .withInstanceNum(1) .withMode(ResourceCheckResource.ModeEnum.fromValue("Cluster")) .withAvailabilityZoneMode("single") .withFeNodeNum(3) .withBeNodeNum(3) .withFeFlavorRef("gaussdb.sr-fe.8xlarge.x86.4") .withBeFlavorRef("gaussdb.sr-be.8xlarge.x86.4") .withAvailabilityZone("cn-southwest-244a") .withSubnetId("b00dc497-91e1-4082-aeb0-a1dc95e10371"); body.withResource(resourcebody); body.withAction(ResourceCheck.ActionEnum.fromValue("createInstance")); request.withBody(body); try { CheckStarRocksResourceResponse response = client.checkStarRocksResource(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
StarRocks实例资源检查
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = CheckStarRocksResourceRequest() resourcebody = ResourceCheckResource( enterprise_project_id="0", 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" ) request.body = ResourceCheck( resource=resourcebody, action="createInstance" ) response = client.check_star_rocks_resource(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
StarRocks实例资源检查
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CheckStarRocksResourceRequest{} availabilityZoneResource:= "cn-southwest-244a" resourcebody := &model.ResourceCheckResource{ EnterpriseProjectId: "0", InstanceNum: int32(1), Mode: model.GetResourceCheckResourceModeEnum().CLUSTER, AvailabilityZoneMode: "single", FeNodeNum: int32(3), BeNodeNum: int32(3), FeFlavorRef: "gaussdb.sr-fe.8xlarge.x86.4", BeFlavorRef: "gaussdb.sr-be.8xlarge.x86.4", AvailabilityZone: &availabilityZoneResource, SubnetId: "b00dc497-91e1-4082-aeb0-a1dc95e10371", } request.Body = &model.ResourceCheck{ Resource: resourcebody, Action: model.GetResourceCheckActionEnum().CREATE_INSTANCE, } response, err := client.CheckStarRocksResource(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。