Querying Instance Specifications

Function

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

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

GET /v3.1/{project_id}/flavors

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
engine_name	No	String	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
mode	No	String	Definition Instance type Constraints N/A Range CloudNativeCluster: Specifications of instances with cloud native storage are queried. EnhancedCluster: Specifications of GeminiDB Influx cluster (performance-enhanced) instances with classic storage are queried. Default Value If this parameter is not transferred, the specifications of all instances with classic storage are queried.
product_type	No	String	Definition Product type Constraints This parameter is mandatory when you query a GeminiDB Redis cluster instance with cloud native storage. Range Standard Capacity Default Value N/A
offset	No	Integer	Definition Index offset Constraints N/A Range The value must be a non-negative number. Default Value If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.
limit	No	Integer	Definition Maximum of specifications that can be queried Constraints N/A Range 1 to 100 Default Value If this parameter is not transferred, the first 100 pieces of specification information can be queried by default.

Request Parameters

**Table 3** Request header 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

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A
flavors	Array of Flavors objects	Definition Instance specifications

**Table 5** Flavors
Parameter	Type	Description
engine_name	String	Definition API name Range cassandra: specifications supported by a GeminiDB Cassandra instance mongodb: specifications supported by a GeminiDB Mongo instance influxdb: specifications supported by a GeminiDB Influx instance redis: specifications supported by a GeminiDB Redis instance
engine_version	String	Definition API version. Range N/A Default Value N/A
vcpus	String	Definition CPU cores Range N/A Default Value N/A
ram	String	Definition Memory (MB) Range N/A Default Value N/A
spec_code	String	Definition Resource specification code Example: geminidb.cassandra.8xlarge.4 NOTE: geminidb.cassandra: GeminiDB Cassandra instance 8xlarge.4: node specifications Range N/A
availability_zone	Array of strings	Definition ID of the AZ that supports the specifications NOTE: This parameter has been discarded. Do not use it. Range N/A
az_status	Object	Definition Status of specifications in an AZ Range normal: on sale unsupported: The specifications are not supported. sellout: sold-out

Example Requests

URI example

GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&offset=0&limit=10

Example Responses

Status code: 200

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