Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Specifications of an HTAP Instance

Updated on 2024-09-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Specifications of an HTAP Instance

Function

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/htap/flavors/{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

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
availability_zone_mode	No	String	AZ mode. Currently, only single AZ is supported.
spec_code	No	String	Specification code. If this parameter is specified, only the specified specification code is queried.
version_name	No	String	DB version number. If this parameter is left blank, the default value 3.1.6.0 is used.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
flavors	Array of flavors objects	Specification information.

**Table 5** flavors
Parameter	Type	Description
type	String	Specification type. The value can be arm, x86, or generalX86. arm: exclusive Arm x86: exclusive x86 generalX86: general-purpose x86
vcpus	String	Number of vCPUs. For example, the value 1 indicates 1 vCPU.
ram	String	Memory size in GB.
id	String	Specification ID. The value is unique.
spec_code	String	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 specifications (4 vCPUs). x86 indicates the x86 architecture. 4 indicates the ratio of vCPUs to memory is 1:4.
version_name	String	DB version number.
instance_mode	String	Instance type. The value can be Cluster or Single.
az_status	Map<String,String>	Status of the specification in the AZ. The value can be any of the following: normal: The specification is available in the AZ. unsupported: The specification is not supported. sellout: The specification is 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.

Parent topic: HTAP (Standard Edition)

Previous topic: Obtaining the Storage Type of an HTAP Instance

Next topic: Querying HTAP Instances

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot