Querying Database Specifications

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

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

Parameter description

**Table 1** Parameter description
Name	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	DB engine. Its value is case-insensitive and can be: gaussdb-mysql
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 can be single or multi and is case-insensitive.
spec_code	No	String	Specification code.

Request

None.

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
flavors	Array of objects	DB instance specification list. For details, see Table 3.

**Table 3** flavors field data structure description
Name	Type	Description
vcpus	String	Number of vCPUs. For example, the value 1 indicates 1 vCPU.
ram	String	Memory size in GB.
type	String	Specification type. The value can be arm.
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.
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

Example normal response

{
    "flavors":[
        {
            "vcpus":"1",
            "ram":"4",
            "type":"x86",           
            "id":"3169caaf-6c2f-41d5-aadd-c8fc3d83597e",
            "spec_code":"gaussdb.xlarge.x86.4",
            "instance_mode":"Cluster",
            "version_name": "8.0",
            "az_status":{
                "az1":"normal",
                "az2":"normal"
            }
        },
        {
            "vcpus":"2",
            "ram":"4",
            "type":"arm"
            "id":"cefb8fab-c9f7-482f-a97c-e8a0c8abe35b",
            "spec_code":"gaussdb.mysql.xlarge.x86.2",
            "instance_mode":"Cluster",
            "version_name": "8.0",
            "az_status":{
                "az1":"normal",
                "az2":"normal"
            }
        }
    ]
}