Updated on 2026-09-22 GMT+08:00

Querying Instance Specifications That Can Be Changed

Function

This API is used to query instance specifications that can be changed.

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

gaussdbfornosql:instance:listFlavors

List

-

-

nosql:instance:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:listFlavors	List	-	-	nosql:instance:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/available-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 The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Index position. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range The value must be greater than or equal to 0. Default Value 0
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1 to 100 Default Value 100

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
instance_id	String	Definition Instance ID. Range N/A
instance_name	String	Definition Instance name Range N/A
current_flavor	ComputeFlavor object	Definition Instance specifications.
optional_flavors	OptionalFlavorsInfo object	Definition Available specification options that the instance specifications can be changed to.

**Table 5** ComputeFlavor
Parameter	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 Specification code Range N/A
az_status	Map<String,String>	Definition AZ status in the key:value format. key indicates the AZ code. value can be: normal: available for general use abandon: offline sellout: sold-out unknown: unavailable
region_status	String	Definition Region status Range normal: available for general use abandon: offline sellout: sold-out NOTE: This parameter has been deprecated and does not take effect. Ignore and do not use it.

**Table 6** OptionalFlavorsInfo
Parameter	Type	Description
list	Array of objects in ComputeFlavor	Definition Available specification options
total_count	Integer	Definition Total number of records. Range N/A

Example Requests

URI example

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors

Example Responses

Status code: 200

Success

{ 
  "instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06", 
  "instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg", 
  "current_flavor" : { 
    "vcpus" : "4", 
    "ram" : "16", 
    "spec_code" : "geminidb.cassandra.xlarge.4", 
    "az_status" : { 
      "az2***" : "unknown", 
      "az1***" : "normal", 
      "az3***" : "unknown" 
    }, 
    "region_status" : null 
  }, 
  "optional_flavors" : {
    "list" : [ { 
      "vcpus" : "2", 
      "ram" : "8", 
      "spec_code" : "geminidb.cassandra.large.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az4***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "8", 
      "ram" : "32", 
      "spec_code" : "geminidb.cassandra.2xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "16", 
      "ram" : "64", 
      "spec_code" : "geminidb.cassandra.4xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    }, { 
      "vcpus" : "32", 
      "ram" : "128", 
      "spec_code" : "geminidb.cassandra.8xlarge.4", 
      "az_status" : { 
        "az2***" : "unknown", 
        "az1***" : "normal", 
        "az3***" : "unknown" 
      }, 
      "region_status" : "normal" 
    } ], 
    "total_count": 4
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances