Updated on 2026-01-05 GMT+08:00

Checking StarRocks Resources

Function

This API is used to check StarRocks resources. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:instance:list

    List

    -

    -

    gaussdb:instance:list

    -

URI

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

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Definition

Verification type. Only instance creation can be verified.

Constraints

N/A

Range

createInstance: pre-checking resources during instance creation

Default Value

N/A

resource

Yes

resource object

Definition

Resource information.

Constraints

N/A

Table 4 resource

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Definition

Enterprise project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_num

Yes

Integer

Definition

Number of instances.

Constraints

N/A

Range

N/A

Default Value

N/A

mode

Yes

String

Definition

Instance deployment mode.

Constraints

N/A

Range

  • Cluster

  • Single

Default Value

N/A

availability_zone_mode

Yes

String

Definition

AZ type. Currently, only Single is supported.

Constraints

N/A

Range

Single: single AZ

Default Value

N/A

fe_node_num

Yes

Integer

Definition

Number of frontend nodes.

Constraints

N/A

Range

N/A

Default Value

N/A

be_node_num

Yes

Integer

Definition

Number of backend nodes.

Constraints

N/A

Range

N/A

Default Value

N/A

fe_flavor_ref

Yes

String

Definition

Specification code of the frontend node. To obtain this value, see Querying Specifications of an HTAP Instance.

Constraints

N/A

Range

N/A

Default Value

N/A

be_flavor_ref

Yes

String

Definition

Specification code of the backend node. To obtain this value, see Querying Specifications of an HTAP Instance.

Constraints

N/A

Range

N/A

Default Value

N/A

availability_zone

No

String

Definition

AZ code. This parameter is optional. The AZ code correctness is verified.

Constraints

N/A

Range

N/A

Default Value

N/A

subnet_id

Yes

String

Definition

Subnet ID of the HTAP instance, that is, the subnet ID of the TaurusDB instance.

To obtain this value, use either of the following methods:

  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the subnet ID on the displayed page.

  • Method 2: Query the subnet ID through the VPC API. For details, see Querying Subnets.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

result

Boolean

Definition

Check results.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Checking StarRocks instance resources

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"
  }
}

Example Response

Status code: 200

Success.

{
  "result" : true
}

SDK Sample Code

The SDK sample code is as follows.

Checking StarRocks instance resources

 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());
        }
    }
}

Checking StarRocks instance resources

 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)

Checking StarRocks instance resources

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.