Wang , Deng Ke a8436b1d56 gaussdb API Initial version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>

2022-11-24 13:34:54 +00:00

16 KiB

Raw Blame History

Querying Database Specifications

Function

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

Learn how to authorize and authenticate this API before using it.
Before calling this API, obtain the required region and endpoint.

URI

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

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	Yes	String	DB engine. Its value can be any of the following and is case-insensitive: 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 type of the specification. The value can be single or multi.
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	Integer	Memory size in gigabyte (GB).
type	String	Specification type. The value can be arm or x86.
id	String	Specification ID. The value must be unique.
spec_code	String	Resource specification code. 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.

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"
            }
        }
    ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: API

16 KiB Raw Blame History