Querying Instance Specifications
Function
This API is used to query instance specifications. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
Name |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A |
version |
No |
String |
Definition DB version number. You can query the specifications supported by a specified DB version, for example, V2.0-1.4. Constraints N/A Range N/A Default Value N/A |
spec_code |
No |
String |
Definition Specification code. Constraints N/A Range N/A Default Value N/A |
ha_mode |
No |
String |
Definition Instance type. You can query the specifications supported by a specified instance type. Constraints N/A Range
Default Value N/A |
limit |
No |
Integer |
Definition Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed. Constraints N/A Range [1, 100] Default Value 100 |
offset |
No |
Integer |
Definition Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 1 and limit is set to 10, only the 2nd to 11th records are displayed. Constraints N/A Range [0,2^31-1] Default Value 0: The query starts from the first data record. |
Request Parameters
None
Response Parameters
Name |
Type |
Description |
---|---|---|
flavors |
Array of objects |
Definition Specification details. For details, see Table 3. |
total |
Integer |
Definition Total number of records. Range The actual return value depends on the query result. |
Name |
Type |
Description |
---|---|---|
vcpus |
String |
Definition Number of vCPUs. Range N/A |
ram |
String |
Definition Memory size in GB. Range N/A |
spec_code |
String |
Definition Resource specification code. For details, see DB Instance Specifications. Range N/A |
availability_zone |
Array of strings |
Definition AZ that supports the specifications. |
az_status |
Map<String,String> |
Definition key indicates the AZ ID, and value indicates the specification status in the AZ. |
version |
String |
Definition DB engine version supported by the specifications. Range N/A |
name |
String |
Definition DB engine. Range N/A |
group_type |
String |
Definition Performance specifications. Range
|
Example Request
- Querying specifications of a centralized instance
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.2/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=centralization_standard&version=V2.0-3.100&spec_code=gaussdb.opengauss.ee.km1.2xlarge.arm8.ha
- Querying specifications of a distributed instance
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.2/0483b6b16e954cb88930a360d2c4e663/flavors?offset=0&limit=10&ha_mode=enterprise&version=V2.0-3.100&spec_code=gaussdb.opengauss.ee.dn.m4.2xlarge.8.in
Example Response
{
"flavors": [
{
"vcpus": "2",
"ram": "16",
"availability_zone": [
"az2xahz",
"az1xahz",
"az3xahz"
],
"version": "V2.0-1.4",
"name": "GaussDB",
"spec_code": "gaussdb.opengauss.ee.dn.m6.large.8.in",
"az_status": {
"az2xahz": "normal",
"az1xahz": "normal",
"az3xahz": "normal"
},
"group_type": "normal2"
}
],
"total": 1
}
Status Code
- Normal
- Abnormal
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