Instance Specifications

Function

This API is used to query all instance specifications under a specified condition.

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Querying Instance Specifications) before then.

Constraints

This API supports the following types of instances:

GeminiDB Cassandra
GeminiDB Mongo
GeminiDB Influx
GeminiDB Redis

URI

URI format
GET https://{Endpoint}/v3/{project_id}/flavors?region={region}&engine_name={engine_name}
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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
region	No	Region where the instance is deployed. The value can be: Must be specified. For details, see Regions and Endpoints.
engine_name	No	Database type. The value can be: cassandra, indicating that the instances are of the GeminiDB Cassandra type. mongodb, indicating that the instances are of the GeminiDB Mongo type. influxdb, indicating that the instances are of the GeminiDB Influx type. redis, indicating that the instances are of the GeminiDB Redis type. If this parameter is not transferred, the default value is cassandra.

Request Parameters

None

Response Parameters

Normal response

**Table 2** Parameter description
Parameter	Type	Description
total_count	Integer	Total number of records.
flavors	Array of objects	Instance specifications. For more information, see Table 3.

**Table 3** Data structure description of parameter **flavors**
Parameter	Type	Description
engine_name	String	API name.
engine_version	String	API version.
vcpus	String	Number of vCPUs.
ram	String	Memory size in megabytes (MB).
spec_code	String	Resource specification code. Example: geminidb.cassandra.8xlarge.4 NOTE: geminidb.cassandra indicates that the instance of the GeminiDB Cassandra type. 8xlarge.4 indicates node specifications.
availability_zone	Array of strings	ID of the AZ that supports the specifications. NOTE: This parameter has been discarded. Do not use it.
az_status	Object	Status of specifications in an AZ. The value can be: normal, indicating that the specifications are on sale. unsupported, indicating that the specifications are not supported. sellout, indicating that the specifications are sold out.

The parameter values under az_status are example values and only for reference.

Example normal response

{  
    "total_count": 4, 
    "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"
            }
        },  
       {  
            "engine_name": "cassandra",  
            "engine_version": "3.11", 
            "vcpus": "16",  
            "ram": "64",  
            "spec_code": "geminidb.cassandra.4xlarge.4",  
            "availability_zone": [  
                "az1",  
                "az2"  
            ],
            "az_status": {
                 "az1":"normal",
                 "az2":"sellout"
            }
        }, 
       {  
            "engine_name": "cassandra",  
            "engine_version": "3.11", 
            "vcpus": "32",  
            "ram": "128",  
            "spec_code": "geminidb.cassandra.8xlarge.4",  
            "availability_zone": [  
                "az1",  
                "az2"  
            ],
            "az_status": {
                 "az1":"normal",
                 "az2":"normal"
             }
        }  
    ]  
}