Querying Database Specifications
Function
This API is used to query the database specifications of a specified DB engine version.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, obtain the required region and endpoint.
URI
- URI format
GET https://{Endpoint}/v3/{project_id}/flavors/{database_name}?version_name={version_name}
- Example
https://rds.my-kualalumpur-1.alphaedge.tmone.com.my/v3/0483b6b16e954cb88930a360d2c4e663/flavors/mysql?version_name=5.7
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
database_name
Yes
Specifies the DB engine name. Its value can be any of the following and is case-insensitive:
- MySQL
- PostgreSQL
- SQLServer
version_name
No
Specifies the database version. For details about how to obtain the database version, see section Querying Version Information About a DB Engine.
spec_code
No
Specifies the specification code.
Request
None
Response
- Normal response
Table 2 Parameter description Name
Type
Description
flavors
Array of objects
Indicates the DB instance specifications information list.
For details, see Table 3.
Table 3 flavors field data structure description Name
Type
Description
vcpus
String
Indicates the CPU size. For example, the value 1 indicates 1 vCPU.
ram
Integer
Indicates the memory size in GB.
id
String
Indicates the flavor ID. The value must be unique.
spec_code
String
Indicates the resource specification code. Use rds.mysql.m1.xlarge.rr as an example.
- rds: indicates the RDS product.
- mysql: indicates the DB engine.
- m1.xlarge: indicates the high memory performance specifications.
- rr: indicates the read replica (.ha indicates primary/standby DB instances).
version_name
Array
Indicates the database version.
instance_mode
String
Indicates the DB instance type. Its value can be any of the following:
- ha: indicates primary/standby DB instances.
- replica: indicates read replicas.
- single: indicates single DB instances.
az_status
Map<String, String>
Indicates the status of the AZ to which the DB instance specifications belong. Its value can be any of the following:
- normal: indicates that the AZ is on sale.
- unsupported: indicates that the DB instance specifications are not supported by the AZ.
- sellout: indicates that the DB instance specifications are sold out.
- Example normal response
{ "flavors": [{ "vcpus": "1", "ram": 2, "id":"2988b9cc-2aac-3a94-898c-14666702f129", "spec_code": "rds.mysql.c2.medium.ha", "version_name": "{5.6,5.7,8.0}", "instance_mode": "ha", "az_status": { "az1": "normal", "az2": "normal" } }, { "vcpus": "1", "ram": 2, "id":"2988b9cc-2aac-3a94-898c-14666702f130", "spec_code": "rds.mysql.c2.medium.rr", "version_name": "{5.6,5.7,8.0}", "instance_mode": "replica", "az_status": { "az1": "normal", "az2": "normal" } } ] }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot