Instance Specifications
Function
This API is used to query all instance specifications under a specified condition.
This API will be unavailable. You are advised to use the new API (Querying Instance Specifications) before then.
Constraints
This API supports the following instances:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
Authorization Information
Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
-
-
-
-
-
-
URI
- URI format
- URI example
https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/flavors?region=ap-southeast-1&engine_name=cassandra
- Required parameters
Table 1 Parameter description Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
Constraints
N/A
Range
The value contains 32 characters. Only letters and digits are allowed.
Default Value
N/A
region
No
Definition
Region where an instance is deployed. For details, see Regions and Endpoints.
Constraints
N/A
Range
N/A
Default Value
N/A
engine_name
No
Definition
Database type.
Constraints
N/A
Range
- cassandra: GeminiDB Cassandra instance specifications are queried.
- mongodb: GeminiDB Mongo instance specifications are queried.
- influxdb: GeminiDB Influx instance specifications are queried.
- redis: GeminiDB Redis instance specifications are queried.
Default Value
cassandra
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| total_count | Integer | Definition Total number of records. Range N/A |
| flavors | Array of flavors objects | Definition Instance specifications. |
| Parameter | Type | Description |
|---|---|---|
| engine_name | String | Definition Engine name. Range N/A |
| engine_version | String | Definition Engine version. Range N/A |
| vcpus | String | Definition CPU cores. Range N/A |
| ram | String | Definition Memory (MB). Range N/A |
| spec_code | String | Definition Resource specification code. Example: geminidb.cassandra.8xlarge.4 Range
|
| availability_zone | Array of strings | Definition ID of the AZ that supports the specifications. This parameter has been discarded. Do not use it. |
| az_status | Object | Definition Status of the specifications in an AZ. Range
|
Example Requests
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/flavors?region=cn-north-7&engine_name=cassandra Example Responses
Status code: 200
Success.
{
"total_count" : 2,
"flavors" : [ {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "4",
"ram" : "16",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "unsupported"
}
},{
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "8",
"ram" : "32",
"spec_code" : "geminidb.cassandra.2xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "unsupported",
"az2" : "normal"
}
} ]
} Status Codes
For more information, see Status Codes.
Error Codes
For more information, see Error Codes.
What is your overall rating for this page?
Thank 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