Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Checking StarRocks Resources
Updated on 2025-09-09 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Checking StarRocks Resources

Function

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

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

Resource information.
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
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)