Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Checking StarRocks Resources
Updated on 2024-09-11 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 parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

Content-Type

Yes

String

Content type.

Value: application/json

X-Language

No

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Verification type. Only instance creation can be verified.

Enumerated value: createInstance

resource

Yes

resource object

Resource information.
Table 4 resource

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Enterprise project ID.

instance_num

Yes

Integer

Number of instances.

mode

Yes

String

Instance deployment mode.

Enumerated values:

  • Cluster
  • Single

availability_zone_mode

Yes

String

AZ type. Currently, only single AZ is supported.

fe_node_num

Yes

Integer

Number of frontend nodes.

be_node_num

Yes

Integer

Number of backend nodes.

fe_flavor_ref

Yes

String

Specification code of the frontend node.

be_flavor_ref

Yes

String

Specification code of the backend node.

availability_zone

No

String

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

subnet_id

Yes

String

Subnet ID. The HTAP instance subnet is also the GaussDB(for MySQL) instance subnet.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

Boolean

Check result.

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

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)