Querying Database Specifications

Updated on 2023-10-18 GMT+08:00

View PDF

Function

This API is used to query the database specifications of a specified DB engine version. Before calling this API:

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

URI

GET /v3/{project_id}/flavors/{database_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.
database_name	Yes	String	Database name.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
version_name	No	String	DB version number. To obtain this value, see Querying Version Information About a DB Engine. Currently, only MySQL 8.0 is supported.
availability_zone_mode	Yes	String	AZ mode. Its value is case-insensitive and can be: single: single AZ multi: multiple AZs
spec_code	No	String	Specification code.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value.
X-Language	No	String	Request language type. The default value is en-us. Value: en-us zh-cn

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
flavors	Array of MysqlFlavorsInfo objects	Instance specifications.

**Table 5** MysqlFlavorsInfo
Parameter	Type	Description
vcpus	String	Number of vCPUs. For example, the value 1 indicates 1 vCPU.
ram	String	Memory size in GB.
type	String	CPU architecture. Value: arm: exclusive Arm x86: exclusive x86
id	String	Specification ID. The value must be unique.
spec_code	String	Resource specification code. Its value is same as the value of flavor_ref. For example: gaussdb.mysql.xlarge.x86.4.
version_name	String	DB version number.
instance_mode	String	DB instance type. Currently, only the cluster type is supported.
az_status	Map<String,String>	Status of the AZ where the specification belongs. Its value can be any of the following: normal: on sale unsupported: not supported sellout: 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 specific specifications of a GaussDB(for MySQL) instance

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/flavors/gaussdb-mysql?version_name=8.0&spec_code=gaussdb.mysql.xlarge.x86.4&availability_zone_mode=single

Example Response

Status code: 202

Success.

{
  "flavors" : [ {
    "vcpus" : "4",
    "ram" : "16",
    "type" : "x86",
    "id" : "3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
    "spec_code" : "gaussdb.mysql.xlarge.x86.4",
    "instance_mode" : "Cluster",
    "version_name" : "8.0",
    "az_status" : {
      "az1" : "normal",
      "az2" : "normal"
    }
  } ]
}