Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Specifications of an HTAP Instance
Updated on 2025-07-29 GMT+08:00

Querying Specifications of an HTAP Instance

Function

This API is used to query specifications of an HTAP instance. Before calling this API:

URI

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

Table 1 URI parameters

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

engine_name

Yes

String

Definition

HTAP engine type.

Constraints

N/A

Range

  • star-rocks

  • click-house

Default Value

star-rocks

Table 2 Query parameter

Parameter

Mandatory

Type

Description

availability_zone_mode

No

String

Definition

AZ type.

Constraints

N/A

Range

Only single is supported.

Default Value

single

spec_code

No

String

Definition

Specification code. If this parameter is specified, only the specified specification code is queried.

Constraints

N/A

Range

N/A

Default Value

N/A

version_name

No

String

Definition

HTAP database version.

Constraints

N/A

Range

N/A

Default Value

3.1.6.0

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

flavors

Array of flavors objects

Definition

Specification information.

Range

N/A

Table 5 flavors

Parameter

Type

Description

type

String

Definition

CPU architecture.

Range

The value can be arm, x86, or generalX86.

  • arm: exclusive Arm
  • x86: exclusive x86
  • generalX86: general-purpose x86

vcpus

String

Definition

Number of vCPUs. For example, the value 1 indicates 1 vCPU.

Range

N/A

ram

String

Definition

Memory size, in GB.

Range

N/A

id

String

Definition

Specification ID. The value is unique.

Range

N/A

spec_code

String

Definition

Resource specification code. Its value is same as the value of flavor_ref. Example: gaussdb.sr-be.xlarge.x86.4

gaussdb.sr indicates the product.

xlarge indicates the compute specifications (4 vCPUs).

x86 indicates the x86 architecture.

4 indicates the ratio of vCPUs to memory is 1:4.

Range

N/A

version_name

String

Definition

DB version number.

Range

N/A

instance_mode

String

Definition

Instance type. The value can be Cluster or Single.

Range

N/A

az_status

Map<String,String>

Definition

Specification status in an AZ.

Range

  • normal: The specifications are available in the AZ.
  • unsupported: The specifications are not supported.
  • sellout: The specifications are sold out.

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

Querying StarRocks specifications

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/flavors/star-rocks?availability_zone_mode=single

Example Response

Status code: 200

Success.

{
  "flavors" : [ {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "de565db8-0a96-37ea-9388-61167624712c",
    "spec_code" : "gaussdb.sr-be.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "4",
    "ram" : "16",
    "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
    "spec_code" : "gaussdb.sr-fe.xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0",
    "spec_code" : "gaussdb.sr-be.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "8",
    "ram" : "32",
    "id" : "24059750-4280-3ee5-a44b-488b924633b4",
    "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4",
    "spec_code" : "gaussdb.sr-be.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "16",
    "ram" : "64",
    "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f",
    "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "2bf6aa50-50da-3f27-91af-a8c873070537",
    "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "32",
    "ram" : "128",
    "id" : "9f52a065-aa93-371a-9975-959fedf6e24f",
    "spec_code" : "gaussdb.sr-be.8xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "normal"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "709822e4-567f-3e85-b4af-cb099206c8e2",
    "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  }, {
    "type" : "x86",
    "vcpus" : "64",
    "ram" : "256",
    "id" : "4e56e208-0226-34bb-b84d-035ab0497824",
    "spec_code" : "gaussdb.sr-be.16xlarge.x86.4",
    "version_name" : "8.0",
    "instance_mode" : "Cluster",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal",
      "az3" : "normal",
      "az4" : "unsupported"
    }
  } ]
}

Status code: 400

Client error.

{
  "error_msg" : "Invalid specification code.",
  "error_code" : "DBS.280434"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.