Querying Instances and Details

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

id

No

String

Explanation:

Instance ID.

Constraints:

If you enter an instance ID starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance ID, an exact result is returned.

Values:

N/A

Default value:

N/A

name

No

String

Explanation:

Instance name.

Constraints:

If you enter an instance name starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance name, an exact result is returned.

Values:

N/A

Default value:

N/A

datastore_type

No

String

Explanation:

Database type

Constraints:

N/A

Values:

cassandra, indicating that GeminiDB Cassandra instances are queried.

mongodb, indicating that GeminiDB Mongo instances are queried.

influxdb, indicating that GeminiDB Influx instances are queried.

redis, indicating that GeminiDB Redis instances are queried.

Default value:

If this parameter is not transferred, all types of instances are queried.

mode

No

String

Explanation:

Instance type

Constraints:

N/A

Values:

• Cluster: GeminiDB Cassandra, GeminiDB Influx, and GeminiDB Redis instances in a proxy cluster

• CloudNativeCluster: GeminiDB Cassandra, Influx, and Redis instances with cloud native storage in a cluster

• RedisCluster: GeminiDB Redis instances with classic storage in a Redis Cluster

• Replication: GeminiDB Redis instances with classic storage in primary/standby mode

• InfluxdbSingle: Single-node GeminiDB Influx instance with classic storage
• ReplicaSet: GeminiDB Mongo instance in a replica set
• The system ignores this parameter if datastore_type is not transferred.

Default value:

N/A

vpc_id

No

String

Explanation:

VPC ID. You can obtain the value with either of the following methods:

• Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
• Method 2: Query the VPC ID using the VPC API. For details, see Querying VPCs.

Constraints:

N/A

Values:

N/A

Default value:

N/A

subnet_id

No

String

Explanation:

Subnet ID. You can obtain the subnet ID with either of the following methods:

• Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
• Method 2: Query the subnet ID using the VPC API. For details, see Querying Subnets.

Constraints:

N/A

Values:

N/A

Default value:

N/A

offset

No

Integer

Explanation:

Index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.

Constraints:

N/A

Values:

The value must be no less than 0.

Default value:

If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

limit

No

Integer

Explanation:

Maximum number of instances that can be queried.

Constraints:

N/A

Values:

1 to 100

Default value:

If this parameter is not transferred, the first 100 instances are queried by default.

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A

instances

Array of ListInstancesResult objects

Explanation:

Instance information.

total_count

Integer

Explanation:

Total number of records.

Values:

N/A

id

String

Explanation:

Instance ID.

Values:

N/A

name

String

Explanation:

Instance name.

Values:

N/A

status

String

Explanation:

Instance status.

Values:

• normal, indicating that the instance is running normally.
• abnormal, indicating that the instance is abnormal.
• creating, indicating that the instance is being created.
• frozen, indicating that the instance is frozen.
• data_disk_full, indicating that the instance disk is full.
• createfail, indicating that the instance failed to be created.
• enlargefail, indicating that nodes failed to be added to the instance.

port

String

Explanation:

Database port.

Values:

N/A

mode

String

Explanation:

Instance type

Values:

This parameter is the same as the corresponding request parameter.

product_type

String

Explanation:

Product type used for GeminiDB Redis instances with cloud native storage

Values:

• Standard
• Capacity

region

String

Explanation:

Region where the instance is deployed.

Values:

N/A

datastore

ListInstancesDatastoreResult object

Explanation:

Database information.

engine

String

Explanation:

Storage engine.

Values:

rocksDB

created

String

Explanation:

Instance creation time.

Values:

N/A

updated

String

Explanation:

Time when an instance is updated.

Values:

N/A

db_user_name

String

Explanation:

Default username

Values:

rwuser

vpc_id

String

Explanation:

VPC ID.

Values:

N/A

subnet_id

String

Explanation:

Subnet ID.

Values:

One GeminiDB Cassandra instance may use multiple subnets. For the subnet ID, see Table 10.

security_group_id

String

Explanation:

Security group ID.

Values:

N/A

backup_strategy

ListInstancesBackupStrategyResult object

Explanation:

Backup policy.

pay_mode

String

Explanation:

Billing mode. Options:

Values:

• 0: indicates the instance is billed on a pay-per-use basis.
• 1: indicates the instance is billed on a yearly/monthly basis.

maintenance_window

String

Explanation:

Maintenance time window.

Values:

N/A

groups

Array of ListInstancesGroupResult objects

Explanation:

Group information.

enterprise_project_id

String

Explanation:

Enterprise project ID.

Values:

0: default enterprise project

time_zone

String

Explanation:

Time zone.

Values:

N/A

actions

Array of strings

Explanation:

Operation that is executed on the instance. Example values:

• CREATE
• REBOOT
• RESTORE

dedicated_resource_id

String

Explanation:

Dedicated resource ID. This parameter is returned only when the instance belongs to a dedicated resource pool.

Values:

N/A

lb_ip_address

String

Explanation:

Load balancer IP address

Constraints:

This parameter is returned only when a load balancer IP address is assigned.

Values:

N/A

lb_port

String

Explanation:

Load balancer port

Constraints:

This parameter is returned only when a load balancer IP address is assigned.

Values:

N/A

availability_zone

String

Explanation:

AZ

Values:

N/A

type

String

Explanation:

DB API.

Values:

N/A

version

String

Explanation:

DB version number.

Values:

N/A

patch_available

Boolean

Explanation:

Whether the current instance can be patched

Values:

• true: A database can be upgraded through a patching API.
• false: A database cannot be upgraded through a patching API.

whole_version

String

Explanation:

Complete database version number

Constraints:

Currently, this parameter is available only for GeminiDB Cassandra API.

Values:

N/A

start_time

String

Explanation:

Backup time window. Automated backup will be triggered during the backup time window. The current time is the UTC time.

Values:

N/A

keep_days

Integer

Explanation:

Backup retention days

Values:

0–35

id

String

Explanation:

Group ID.

Values:

N/A

status

String

Explanation:

Group status.

Values:

• normal, indicating that the group is normal.
• abnormal, indicating that the group is abnormal.
• creating, indicating that the group is being created.
• createfail, indicating that the group failed to be created.
• deleted: indicating that the group has been deleted.
• resizefailed: indicating that the group specifications failed to be changed.
• enlargefail: indicating the group failed to be scaled out.

volume

Volume object

Explanation:

Volume information.

nodes

Array of ListInstancesNodeResult objects

Explanation:

Node information.

size

String

Explanation:

Storage space in GB.

Values:

N/A

used

String

Explanation:

Used storage space, in GB.

Values:

N/A

id

String

Explanation:

Node ID.

Values:

N/A

name

String

Explanation:

Node name.

Values:

N/A

status

String

Explanation:

Node status.

Values:

• normal: A node is normal.
• abnormal: A node is abnormal.
• creating: A node is being created.
• createfail: A node failed to be created.
• deleted: A node is deleted.
• resizefailed: Node specifications failed to be changed.
• enlargefail: Nodes failed to be added.

role

String

Explanation:

Node role.

Constraints:

This parameter is available only for GeminiDB MongoAPI replica set instances.

Values:

N/A

subnet_id

String

Explanation:

ID of the subnet where the instance node is deployed.

Values:

N/A

private_ip

String

Explanation:

Private IP address of a node

Constraints:

This parameter value is available after an ECS is created. Otherwise, the value is "".

Values:

N/A

public_ip

String

Explanation:

Bound EIP

Constraints:

This parameter is valid only for nodes bound with EIPs.

Values:

N/A

spec_code

String

Explanation:

Resource specification code. For the code, see the value of parameter flavors.spec_code in Querying Instance Specifications.

Values:

N/A

availability_zone

String

Explanation:

AZ.

Values:

N/A

support_reduce

Boolean

Explanation:

Whether instance nodes can be deleted. The value can be:

Values:

• true: Instance nodes can be deleted.
• false: Instance nodes cannot be deleted.

role

String

Explanation:

Active-active role

Values:

N/A

status

String

Explanation:

Active-active status

Values:

N/A

destination_instance_id

String

Explanation:

ID of the peer instance in the active-active pair

Values:

N/A

destination_region

String

Explanation:

Peer region of the active-active pair

Values:

N/A