Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Obtaining the Storage Type of an HTAP Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Storage Type of an HTAP Instance

Function

This API is used to obtain the storage type of an HTAP instance. Before calling this API:

URI

GET /v3/{project_id}/htap/storage-type/{database}

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.

database

Yes

String

HTAP database name. Values:

  • star-rocks
  • click-house
Table 2 Query parameters

Parameter

Mandatory

Type

Description

version_name

Yes

String

DB major version number.

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

storage_type

Array of storage_type objects

Storage type.
Table 5 storage_type

Parameter

Type

Description

name

String

Name of the storage medium.

az_status

Map<String,String>

Whether the AZ is supported.

min_volume_size

Integer

Minimum disk size.

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 the storage types available for a StarRocks instance

GET https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/htap/storage-type/star-rocks?version_name=3.1.6.0

Example Response

Status code: 200

Success.

{
  "storage_type" : [ {
    "name" : "ULTRAHIGH",
    "az_status" : {
      "cn-southwest-244d" : "normal",
      "cn-southwest-244c" : "normal",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    },
    "min_volume_size" : 50
  }, {
    "name" : "ESSD",
    "az_status" : {
      "cn-southwest-244d" : "unsupported",
      "cn-southwest-244c" : "unsupported",
      "cn-southwest-244b" : "normal",
      "cn-southwest-244a" : "normal"
    },
    "min_volume_size" : 40
  } ]
}

Status code: 400

Client error.

{
    "error_msg": "The DB engine or version is not supported."
    "error_code": "DBS.280238",
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)