Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying HTAP Engine Resources
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying HTAP Engine Resources

Function

This API is used to query HTAP engine resources. Before calling this API:

URI

GET /v3/{project_id}/htap/datastores/{engine_name}

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.

engine_name

Yes

String

HTAP engine name. Values:

  • star-rocks
  • click-house

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

datastores

Array of datastores objects

Database information list.
Table 4 datastores

Parameter

Type

Description

id

String

DB version ID. The value is unique.

name

String

DB version number. Only the major version number with two digits is returned.

kernel_version

String

DB kernel version. A complete four-number version is returned.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying StarRocks DB version information

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/datastores/star-rock

Example Response

Status code: 200

Success.

{
  "datastores" : [ {
    "id" : "38197973-8895-36ed-b853-52daeefb6d3a",
    "name" : "3.1",
    "kernel_version" : "3.1.6.0"
  } ]
}

Status code: 400

Client error.

{
  "error_msg" : "Invalid database type.",
  "error_code" : "DBS.280235"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)