Updated on 2024-08-20 GMT+08:00

Querying DB Instances

Function

This API is used to query instances according to search criteria. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}
Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

id

String

No

Explanation:

Instance ID, which uniquely identifies an instance. You can query instances by instance ID.

The asterisk (*) is reserved for the system. If the instance ID starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance ID. The value cannot contain only asterisks (*).

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

name

String

No

Explanation:

DB instance name. You can query instances by instance name.

The asterisk (*) is reserved for the system. If the instance name starts with *, it indicates that fuzzy match is performed based on the value following *. Otherwise, the exact match is performed based on the instance name. The value cannot contain only asterisks (*).

Restrictions:

None

Value range:

The value must start with a letter and can contain 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Default value:

None

type

String

No

Explanation:

Instance type. You can query instances by instance type.

Restrictions:

None

Value range:

  • Enterprise (case-sensitive): distributed instances (in the independent deployment).
  • Centralization_standard (case-sensitive): primary/standby instances.

Default value:

None

datastore_type

String

No

Explanation:

Database type. Its value is case-insensitive. You can query the instances by database type.

Restrictions:

None

Value range:

GaussDB

Default value:

None

vpc_id

String

No

Explanation:

VPC ID. You can query instances by VPC where the instances are located. To obtain the value:

  • Method 1: Log in to VPC console and view the VPC ID in the VPC details page.
  • Method 2: Query the VPC ID through the VPC API. For details, see Querying VPCs.
  • Method 2: See the section "Querying VPCs" in the Virtual Private Cloud API Reference.

Restrictions:

None

Value range:

UUID format

Default value:

None

subnet_id

String

No

Explanation:

Network ID of the subnet. You can query instances by subnet.

  • Method 1: Log in to VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: See section "Querying Subnets" in the Virtual Private Cloud API Reference.

Restrictions:

None

Value range:

UUID format

Default value:

None

offset

Integer

No

Explanation:

Index offset. The query starts from the next piece of data indexed by this parameter.

Restrictions:

None

Value range:

[0, 2^31-1]

Default value:

0 (indicating that the query starts from the first data record.)

limit

Integer

No

Explanation:

Number of records to be queried.

Restrictions:

None

Value range:

[1, 100]

Default value:

100

tags

String

No

Explanation:

Queries based on the instance tag keys and values.

  • {key} indicates the tag key.
  • {value} indicates the tag value.

Restrictions:

To query instances with multiple tag keys and values, separate key-value pairs with commas (,). A maximum of 20 key-value pairs are supported.

Value range:

  • Each tag key can contain up to 127 Unicode characters key cannot be an empty string, a space, or left blank. Before using key, delete single-byte character (SBC) spaces before and after the value. The value cannot contain the following special characters: +/?#&=,%
  • The tag value can be left blank. It can contain up to 255 Unicode characters. Before using value, delete SBC spaces before and after the value. The value cannot contain the following special characters: +/?#&=,% If the value is left blank, it indicates any_value (querying any value).

Default value:

None

Request Parameters

None

Response Parameters

Table 2 Response parameters

Parameter

Type

Description

instances

Array of objects

Explanation:

Instance information.

For details, see Table 3.

total_count

Integer

Explanation:

Total number of records.

Value range:

[0, 2^31 – 1]

Table 3 instances field data structure description

Parameter

Type

Description

id

String

Explanation:

Instance ID.

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

name

String

Explanation:

Instance name.

Value range:

The value must start with a letter and can contain 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

status

String

Explanation:

Instance status.

Value range:

Value range:

If the value is BUILD, the instance is being created.

If the value is ACTIVE, the instance is normal.

If the value is FAILED, the instance is abnormal.

If the value is FROZEN, the instance is frozen.

If the value is MODIFYING, the storage is being scaled up or instance specifications are being changed.

If the value is EXPANDING, read replicas are being added to the instance or CNs or DNs are being added to the instance.

If the value is REBOOTING, the instance is being rebooted.

If the value is REDUCING: read replicas are being deleted.

If the value is UPGRADING, the instance is being upgraded.

If the value is RESTORING, the instance is being restored.

If the value is SWITCHOVER, the primary/standby switchover is being performed.

If the value is MIGRATING, the instance is being migrated.

If the value is BACKING UP, the instance is being backed up.

If the value is UPGRADE TO BE OBSERVED, the instance upgrade is in the observation period.

If the value is REDUCING REPLICATION, the number of replicas is being reduced.

If the value is STORAGE FULL, the instance storage is full.

private_ips

List<String>

Explanation:

Private IP address list. The value is an empty string until ECSs where CNs of distributed instances are deployed or ECSs where DNs of primary/standby instances are deployed are created.

public_ips

List<String>

Explanation:

Public IP address list. This parameter cannot be left blank after an EIP is bound.

port

Integer

Explanation:

Database port number.

Value range:

The GaussDB database port is from 1024 to 39998 (excluding the following which are occupied by the system and cannot be used: 2378, 2379, 2380, 4999, 5000, 5999, 6000, 6001, 8097, 8098, 20049, 20050, 21731, and 21732).

type

String

Explanation:

Instance type.

Value range:

The value is case-sensitive. The value Enterprise indicates the distributed instance (Enterprise Edition).

ha

Object

Explanation:

Instance high availability. It includes parameters for transaction consistency type and standby node's replication mode.

For details, see Table 4.

replica_num

Integer

Explanation:

Number of replicas.

Value range:

None

region

String

Explanation:

Region where the instance is deployed.

Value range:

None

datastore

Object

Explanation:

Database information.

For details, see Table 5.

created

String

Explanation:

Creation time in the "yyyy-mm-dd hh:mm:ss timezone" format.

timezone indicates the time zone, for example, 2024-07-16 09:31:43 UTC.

When the instance is being created, the value is the time when the creation request is delivered. After the instance is created, the value is the time when the creation is complete.

Value range:

None

updated

String

Explanation:

Update time. The format is the same as that of the created field, for example, 2024-07-16 09:31:43 UTC.

The return value is empty when no DB instance has been created. After a DB instance is created, the value is not empty.

Value range:

None

db_user_name

String

Explanation:

Default username.

Value range:

root

vpc_id

String

Explanation:

ID of the VPC to which the instance belongs

Value range:

UUID format

subnet_id

String

Explanation:

ID of the subnet associated with the instance.

Value range:

UUID format

security_group_id

String

Explanation:

Security group ID.

Value range:

UUID format

flavor_ref

String

Explanation:

Specification code. For details on how to obtain the GaussDB specification code, see DB Instance Specifications.

Value range:

None

flavor_info

Object

Explanation:

Flavor information.

For details, see Table 6.

volume

Object

Explanation:

Volume information.

For details, see Table 7.

switch_strategy

String

Explanation:

Database failover priority.

Value range:

The value can be Reliability or Availability, indicating that the reliability or availability is given priority during the failover, respectively.

If no failover priority is selected during the creation, the failover priority is not displayed.

backup_strategy

Object

Explanation:

Backup policy.

For details, see Table 8.

maintenance_window

String

Explanation:

Maintenance time window, which is the UTC time. The format is hh:mm-HH:MM, for example, 18:00-22:00.

Value range:

None

nodes

Array of objects

Explanation:

Instance node information.

For details, see Table 9.

disk_encryption_id

String

Explanation:

Disk encryption key ID. This parameter is displayed only when the instance disk is encrypted.

Value range:

None

enterprise_project_id

String

Explanation:

Enterprise project tag ID.

Value range:

If an instance does not belong to any enterprise project, the default value is 0.

instance_mode

String

Explanation:

Instance product type.

Value range:

enterprise indicates enterprise edition, standard indicates the standard edition, and basic indicates the basic edition.

time_zone

String

Explanation:

Time zone.

Value range:

None

charge_info

Object

Explanation:

Billing type, which can be pay-per-use or yearly/monthly.

For details, see Table 10.

tags

Array of objects

Explanation:

Tags. This parameter is not returned if there is no tag.

For details, see Table 11.

Table 4 ha field data structure description

Parameter

Type

Description

consistency

String

Explanation:

Transaction consistency type.

Value range:

The value can be strong or eventual, indicating strong consistency and eventual consistency, respectively.

replication_mode

String

Explanation:

Replication mode for the standby node.

Value range:

The value can only be set to sync, indicating that data is synchronized in synchronous mode.

Table 5 datastore field data structure description

Parameter

Type

Description

type

String

Explanation:

DB engine.

Value range:

GaussDB

version

String

Explanation:

DB engine version.

Value range:

The value depends on the DB engine version, for example, 8.200.

Table 6 flavor_info field data structure description

Parameter

Type

Description

vcpu

Integer

Explanation:

Number of vCPUs.

Value range:

None

mem

Integer

Explanation:

Memory size in GB.

Value range:

None

Table 7 volume field data structure description

Parameter

Type

Description

type

String

Explanation:

Disk type.

Value range:

ULTRAHIGH (SSD storage) or ESSD (extreme SSD storage). The value is case-sensitive.

size

Integer

Explanation:

Disk size.

Value range:

None

Table 8 backup_strategy field data structure description

Parameter

Type

Description

start_time

String

Explanation:

Backup time window. The creation of an automated backup will be triggered during the backup time window.

The value is the UTC time. The format is hh:mm-HH:MM, for example, 19:00-20:00.

Value range:

None

keep_days

Integer

Explanation:

Number of days to retain the generated backup files.

Value range:

[1, 732]

Table 9 nodes field data structure description

Parameter

Type

Description

id

String

Explanation:

Node ID.

Value range:

The value can contain 36 characters. Only letters and digits are allowed.

name

String

Explanation:

Node name.

Value range:

The value must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed.

role

String

Explanation:

Node type, indicating the role of a node in an instance.

Value range:

master (primary node) or slave (standby node)

status

String

Explanation:

Node status.

Value range:

BUILD_FAILED: The node fails to be created.

availability_zone

String

Explanation:

AZ.

Value range:

None

private_ip

String

Explanation:

Private IP address of the node. For distributed instances, this parameter is valid only for CNs. For primary/standby instances, this parameter is valid for all nodes. The parameter value is returned after an ECS is created.

Value range:

None

public_ip

String

Explanation:

EIP bound to the instance. For distributed instances, this parameter is valid only for CNs. For primary/standby instances, this parameter is valid for all nodes. The parameter value is returned after an ECS is created and an EIP is bound to a DB instance.

Value range:

None

Table 10 chargeInfo field data structure description

Parameter

Mandatory

Type

Description

charge_mode

Yes

String

Explanation:

Billing mode.

Value range:

postPaid: pay-per-use

prePaid: yearly/monthly

Table 11 tags field data structure description

Parameter

Type

Description

key

String

Explanation:

Tag key.

Value range:

None

value

String

Explanation:

Tag value.

Value range:

None

Example Request

  • Querying all instances
    https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances
  • Querying instances based on search criteria
    https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002

Example Response

  • Instance information queried.
    {
        "instances": [
            {
                "id": "b331ed66cc3249f78bc20737308c01f4in14",
                "status": "ACTIVE",
                "name": "gauss-9e88",
                "port": 8000,
                "type": "Enterprise",
                "ha": {
                    "consistency": "strong",
                    "replication_mode": "sync"
                },
    	    "region": "eu-de",
    	    "region": "aaa",
                "datastore": {
                    "type": "GaussDB",
                    "version": "1.3"
                },
                "created": "2021-01-15 01:46:40 UTC",
                "updated": "2021-01-15 02:05:03 UTC",
                "volume": {
                    "type": "ULTRAHIGH",
                    "size": 120
                },
                "nodes": [
                    {
                        "id": "02ebf757aaf94074855f49cc6e0e4712no14",
                        "name": "gauss-9e88_gaussdbv5cn_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.16.253"
                    },
                    {
                        "id": "0a87b8ecbfeb46aba1409cfc0f0d5c34no14",
                        "name": "gauss-9e88_gaussdbv5cn_0",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.28.81"
                    },
                    {
                        "id": "2d9fec1ab3834936b074d63acf48b1f2no14",
                        "name": "gauss-9e88_gaussdbv5dn3_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "48bb08a2d635435891ac0caa1c0bf2e3no14",
                        "name": "gauss-9e88_gaussdbv5dn1_0",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "5df830f652204827ada32f8bc28b107eno14",
                        "name": "gauss-9e88_gaussdbv5dn1_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "8a97a246cee841b38c5b47290d4c9c38no14",
                        "name": "gauss-9e88_gaussdbv5cn_1",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.27.52"
                    },
                    {
                        "id": "8c1a3f8eecca4d9e9974a868bb6dd942no14",
                        "name": "gauss-9e88_gaussdbv5dn2_0",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "9bd0c80b8a684cc9bd7d99dd5adffb07no14",
                        "name": "gauss-9e88_gaussdbv5dn3_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "9e2a3cd541e249d4af5aa57c5d3a7f39no14",
                        "name": "gauss-9e88_gaussdbv5dn1_2",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "b046d28989ec4ae5a1a9ab20fe65f248no14",
                        "name": "gauss-9e88_gaussdbv5dn2_2",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "b614cc12fd3742dbb230245f88a7bf00no14",
                        "name": "gauss-9e88_gaussdbv5dn3_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "caba8e88c3c84ae58202f1f589490611no14",
                        "name": "gauss-9e88_gaussdbv5dn2_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    }
                ],
                "private_ips": [
                    "192.168.16.253 / 192.168.28.81 / 192.168.27.52"
                ],
                
                "replica_num": 3,
                "db_user_name": "root",
                "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
                "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
                "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
                "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
                "flavor_info": {
                    "vcpu": 2,
                    "mem": 16
                },
                "switch_strategy": "Reliability",
                "charge_info": {
                    "charge_mode": "prePaid"
                },
                "backup_strategy": {
                    "start_time": "19:00-20:00",
                    "keep_days": 7
                },
                "maintenance_window": "18:00-22:00",
                "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
                "enterprise_project_id": "6e76681b-a2f5-4c5f-97c5-ba4fd3c0dfb2",
                "time_zone": "UTC+08:00",
                "instance_mode":"enterprise"
            },
            {
                "id": "226b4afcfcc84c86bf1b9cb345d3b00fin14",
                "status": "ACTIVE",
                "name": "UTS-gauss-ad53-2C3D",
                "port": 8000,
                "type": "Enterprise",
                "ha": {
                    "consistency": "strong",
                    "replication_mode": "sync"
                },
                "region": "cn-xianhz-1",
                "datastore": {
                    "type": "GaussDB",
                    "version": "1.3"
                },
                "created": "2021-01-08 09:18:27 UTC",
                "updated": "2021-01-14 13:25:03 UTC",
                "volume": {
                    "type": "ULTRAHIGH",
                    "size": 120
                },
                "nodes": [
                    {
                        "id": "07538a1def584cee99e2a5685eeab36ano14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "21f41baba1e2454f82331b7cb5aeabe5no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "2909771a3b3e4e3998f9388e77d22391no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "2bd9a90a5da242a6b0743a7f597f6106no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "77092f1dadb74d3ea13d28269cdd3590no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "a46bfaa6d5a24355a60fce7432b964cano14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn3_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "aa5277736f3844e2a7adeb9de529e2b1no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "b1d798e4ea7344dfa95032984bc6cfd7no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_1",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.29.231"
                    },
                    {
                        "id": "b9a46540186f4c0781eabaa2a79594cbno14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn1_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "d283813030364060ab64371d50294977no14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5dn2_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "eb7bce29b2284cd290405eaddc1b1a1eno14",
                        "name": "UTS-gauss-ad53-2C3D_gaussdbv5cn_0",
                        "role": "master",
                        "status": "FAILED",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.30.44",
                        "public_ip": "10.154.217.248"
                    }
                ],
                "private_ips": [
                    "192.168.29.231 / 192.168.30.44"
                ],
                "public_ips": [
                    "10.154.217.248"
                ],
                "replica_num": 3,
                "db_user_name": "root",
                "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
                "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
                "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
                "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
                "flavor_info": {
                    "vcpu": 2,
                    "mem": 16
                },
                "switch_strategy": "Reliability",
                "charge_info": {
                    "charge_mode": "prePaid"
                },
                "backup_strategy": {
                    "start_time": "18:00-19:00",
                    "keep_days": 7
                },
                "maintenance_window": "18:00-22:00",
                "enterprise_project_id": "0",
                "time_zone": "UTC+08:00",
                "instance_mode":"enterprise"
            },
            {
                "id": "706c65c3dd7d497ab16f5b3a113690abin14",
                "status": "ACTIVE",
                "name": "UTS-gauss-7362",
                "port": 8000,
                "type": "Enterprise",
                "ha": {
                    "consistency": "strong",
                    "replication_mode": "sync"
                },
                "region": "cn-xianhz-1",
                "datastore": {
                    "type": "GaussDB",
                    "version": "1.2"
                },
                "created": "2020-12-23 03:21:41 UTC",
                "updated": "2021-01-15 02:32:13 UTC",
                "volume": {
                    "type": "ULTRAHIGH",
                    "size": 80
                },
                "nodes": [
                    {
                        "id": "25b7f16ee4084b7884d52f1bdfab4e68no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "ad6f02f31744422fa8ce487e81c9e7afno14",
                        "name": "UTS-gauss-7362_gaussdbv5cn_0",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz",
                        "private_ip": "192.168.26.70"
                    },
                    {
                        "id": "b30c56582bf44a548e3bb5b5af6c4773no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    },
                    {
                        "id": "f79ea0600cba42b2888bd9bd67e52a79no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az2xahz"
                    }
                ],
                "private_ips": [
                    "192.168.26.70"
                ],
                
                "db_user_name": "root",
                "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
                "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
                "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
                "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
                "flavor_info": {
                    "vcpu": 2,
                    "mem": 16
                },
                "switch_strategy": "Reliability",
                "charge_info": {
                    "charge_mode": "postPaid"
                },
                "backup_strategy": {
                    "start_time": "16:00-17:00",
                    "keep_days": 7
                },
                "maintenance_window": "18:00-22:00",
                "enterprise_project_id": "0",
                "time_zone": "UTC+08:00",
                "instance_mode":"enterprise"
            },
            {
                "id": "4ad42d079a3948d88c28d6236211b21ein14",
                "status": "ACTIVE",
                "name": "UTS-gauss-4336",
                "port": 8000,
                "type": "Enterprise",
                "ha": {
                    "consistency": "strong",
                    "replication_mode": "sync"
                },
                "region": "cn-xianhz-1",
                "datastore": {
                    "type": "GaussDB",
                    "version": "1.2"
                },
                "created": "2020-12-03 14:28:53 UTC",
                "updated": "2021-01-14 13:20:10 UTC",
                "volume": {
                    "type": "ULTRAHIGH",
                    "size": 40
                },
                "nodes": [
                    {
                        "id": "254dbda6f03643519ad64b39481bd11cno14",
                        "name": "UTS-gauss-4336_gaussdbv5dn1_2",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az1xahz"
                    },
                    {
                        "id": "6ad76d4db26443c2a93b280739a31558no14",
                        "name": "UTS-gauss-4336_gaussdbv5dn1_1",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az1xahz"
                    },
                    {
                        "id": "9fdebf821bdf444a8689b19c0ff588ceno14",
                        "name": "UTS-gauss-4336_gaussdbv5cn_0",
                        "role": "master",
                        "status": "FAILED",
                        "availability_zone": "az1xahz",
                        "private_ip": "192.168.30.93"
                    },
                    {
                        "id": "dd64bdbc02a542d88823b1582f772d25no14",
                        "name": "UTS-gauss-4336_gaussdbv5cn_1",
                        "role": "master",
                        "status": "ACTIVE",
                        "availability_zone": "az1xahz",
                        "private_ip": "192.168.29.232"
                    },
                    {
                        "id": "de3c41461045466faf6c2b96eb709540no14",
                        "name": "UTS-gauss-4336_gaussdbv5dn1_0",
                        "role": "slave",
                        "status": "ACTIVE",
                        "availability_zone": "az1xahz"
                    }
                ],
                "private_ips": [
                    "192.168.30.93 / 192.168.29.232"
                ],
                
                "db_user_name": "root",
                "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
                "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
                "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
                "flavor_ref": "gaussdb.opengauss.ee.dn.m6.large.8.in",
                "flavor_info": {
                    "vcpu": 2,
                    "mem": 16
                },
                "switch_strategy": "Reliability",
                "charge_info": {
                    "charge_mode": "postPaid"
                },
                "backup_strategy": {
                    "start_time": "18:00-19:00",
                    "keep_days": 7
                },
                "maintenance_window": "18:00-22:00",
                "enterprise_project_id": "0",
                "time_zone": "UTC+08:00",
                "instance_mode":"enterprise"
            }
        ],
        "total_count": 4
    }
  • Querying instance details
    {
        "instances": [
            {
                "id": "706c65c3dd7d497ab16f5b3a113690abin14",
                "status": "ACTIVE",
                "name": "UTS-gauss-7362",
                "port": 8000,
                "type": "Enterprise",
                "ha": {
                    "consistency": "strong",
                    "replication_mode": "sync"
                },
    	    "region": "aaa",
                "datastore": {
                    "type": "GaussDB",
                    "version": "1.4"
                },
                "created": "2020-12-23 03:21:41 UTC",
                "updated": "2021-01-15 02:32:13 UTC",
                "volume": {
                    "type": "ULTRAHIGH",
                    "size": 80
                },
                "nodes": [
                    {
                        "id": "25b7f16ee4084b7884d52f1bdfab4e68no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_2",
                        "role": "master",
                        "status": "ACTIVE",
    	            "region": "bbb",
                    },
                    {
                        "id": "ad6f02f31744422fa8ce487e81c9e7afno14",
                        "name": "UTS-gauss-7362_gaussdbv5cn_0",
                        "role": "master",
                        "status": "ACTIVE",
    	            "region": "bbb",
                        "private_ip": "192.168.26.70"
                    },
                    {
                        "id": "b30c56582bf44a548e3bb5b5af6c4773no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_1",
                        "role": "slave",
                        "status": "ACTIVE",
    	            "region": "bbb",
                    },
                    {
                        "id": "f79ea0600cba42b2888bd9bd67e52a79no14",
                        "name": "UTS-gauss-7362_gaussdbv5dn1_0",
                        "role": "slave",
                        "status": "ACTIVE",
    	            "region": "bbb",
                    }
                ],
                "private_ips": [
                    "192.168.26.70"
                ],
    
                "db_user_name": "root",
                "vpc_id": "5f84a5c4-2f93-41de-8359-d7acedb585cc",
                "subnet_id": "300036af-a92f-4e9e-8e9f-7d20e7878b05",
                "security_group_id": "2dcfd40a-8f32-46b8-8a47-6cfab5eba163",
                "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
                "flavor_info": {
                    "vcpu": 8,
                    "mem": 64
                },
                "switch_strategy": "Reliability",
                "charge_info": {
                    "charge_mode": "postPaid"
                },
                "backup_strategy": {
                    "start_time": "16:00-17:00",
                    "keep_days": 7
                },
                "maintenance_window": "18:00-22:00",
                "enterprise_project_id": "0",
                "time_zone": "UTC+08:00",
                "instance_mode":"enterprise"
            }
        ],
        "total_count": 1
    }

Status Code

Error Code

For details, see Error Codes.