Wang , Deng Ke a96a12ecf1 openGauss API 20221109 version

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>

2022-11-14 16:40:26 +00:00

83 KiB

Raw Permalink Blame History

Querying Details About DB Instances

Function

This API is used to query DB instances according to search criteria.

Before calling an API, you need to understand the API in Using APIs.
Before calling this API, obtain the required region and endpoint.

URI

URI format
GET https://{Endpoint}/opengauss/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}
Example
- Querying all DB instances
  https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/97b026aa9cc4417888c14c84a1ad9860/instances
- Querying DB instances based on search criteria
  https://gaussdb.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Enterprise&datastore_type=GaussDB(openGauss)&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

Parameter description

**Table 1** Parameter description
Name	Type	Mandatory	Description
project_id	String	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
id	String	No	Specifies the DB 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 (*).
name	String	No	Specifies the DB 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 (*).
type	String	No	Specifies the instance type-based query. Currently, the value is only Enterprise (case-sensitive), indicating the distributed instance (Enterprise Edition).
datastore_type	String	No	Specifies the database type. Its value is case-sensitive. GaussDB(openGauss)
vpc_id	String	No	Specifies the VPC ID. Method 1: Log in to VPC console and view the VPC ID in the VPC details. Method 2: See the "Querying VPCs" section in the Virtual Private Cloud API Reference.
subnet_id	String	No	Specifies the network ID of the 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 the "Querying Subnets" section in the Virtual Private Cloud API Reference. Method 2: See the "Querying Subnets" section under "APIs" or the "Querying Networks" section under "OpenStack Neutron APIs" in the Virtual Private Cloud API Reference.
offset	Integer	No	Specifies the index position. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a positive number.
limit	Integer	No	Specifies the number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100.

Request

None

Response

Normal response

**Table 2** Parameter description
Name	Type	Description
instances	Array of objects	Indicates the DB instance information. For details, see Table 3.
total_count	Integer	Indicates the total number of records.

**Table 3** instances field data structure description
Name	Type	Description
id	String	Indicates the DB instance ID.
name	String	Indicates the created DB instance name.
status	String	Indicates the DB instance status. Value: If the value is BUILD, the DB instance is being created. If the value is ACTIVE, the DB instance is normal. If the value is FAILED, the DB instance is abnormal. If the value is EXPANDING, CNs or shards are being added to the DB instance. If the value is REBOOTING, the DB instance is being rebooted. If the value is BACKING UP, the DB instance is being backed up.
private_ips	List<String>	Indicates the private IP address list. It is a blank string until an ECS is created.
public_ips	List<String>	Indicates the public IP address list.
port	Integer	Indicates the database port number. The GaussDB(openGauss) database port ranges 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). If this parameter is not specified, the default value of GaussDB(openGauss) is 8000.
type	String	Indicates the instance type. The value is Enterprise, indicating the distributed instance (Enterprise Edition).
ha	Object	Returned when a distributed instance is obtained. For details, see Table 4.
region	String	Indicates the region where the DB instance is deployed.
datastore	Object	Indicates the database information. For details, see Table 5.
created	String	Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100. The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
updated	String	Indicates the update time. The format is the same as that of the created field. The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.
db_user_name	String	Indicates the default username.
vpc_id	String	Indicates the VPC ID.
subnet_id	String	Indicates the network ID of the subnet.
security_group_id	String	Indicates the security group ID.
flavor_ref	String	Indicates the specification code. For details on how to obtain the GaussDB(openGauss) specification code, see Table 1.
volume	Object	Indicates the volume information. For details, see Table 6.
switch_strategy	String	Indicates the database switchover policy. The value can be reliability or availability, indicating the reliability first and availability first, respectively.
backup_strategy	Object	Indicates the backup policy. For details, see Table 7.
maintenance_window	String	Indicates the start time of the maintenance time window in the UTC format.
nodes	Array of objects	Indicates the instance node information. For details, see Table 8.
related_instance	Array of objects	Indicates the list of associated DB instances. The parameters are not involved in GaussDB(openGauss).
time_zone	String	Indicates the time zone.

**Table 4** ha field data structure description
Name	Type	Description
replication_mode	String	Indicates the replication mode for the standby node. The value cannot be empty. For GaussDB(openGauss), the value is sync. NOTE: sync indicates the synchronous replication mode.

**Table 5** datastore field data structure description
Name	Type	Description
type	String	Indicates the DB engine.
version	String	Indicates the database version.

**Table 6** volume field data structure description
Name	Type	Description
type	String	Indicates the volume type.
size	Integer	Indicates the volume size.

**Table 7** backup_strategy field data structure description
Name	Type	Description
start_time	String	Indicates the backup time window. Automated backups will be triggered during the backup time window. The time is in the UTC format.
keep_days	Integer	Indicates the number of days to retain the generated backup files. The value ranges from 0 to 732. If the value is 0, the automated backup policy is not configured or has been disabled.

**Table 8** nodes field data structure description
Name	Type	Description
id	String	Indicates the node ID.
name	String	Indicates the node name.
role	String	Indicates the node type. The value can be master or slave, indicating the primary node and standby node respectively.
status	String	Indicates the node status.
availability_zone	String	Indicates the AZ.

Example normal response

Querying DB instances based on search criteria:

{
    "instances":[
        {
            "id":"3f6ee7c5e98f4c4d8c52be76cbf922efin14",
            "status":"ACTIVE",
            "name":"user1-no-delete-ng-B132_1",
            "port":8000,
            "type":"Enterprise",
            "ha":{
                "replication_mode":"sync"
            },
            "region":"eu-de",
            "datastore":{
                "type":"GaussDB(openGauss)",
                "version":"1.1"
            },
            "created":"2020-06-25T03:09:02+0000",
            "updated":"2020-06-25T05:34:53+0000",
            "volume":{
                "type":"ULTRAHIGH",
                "size":160
            },
            "nodes":[
                {
                    "id":"0218f10e317a4021ac8419c4b7e57dc2no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cms_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"24e233feb5c44075a2b0f650289c74fdno14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cn_1",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"2a8e9e6c55eb47759ade245af95a110fno14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"331dee7a09cf4e95a1d8eced07d1727ano14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"43b815a387fa4f2883659202e0c9a470no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"6274ceece9934a118dc5e5ff7f7f45c9no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cn_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"650101ff9b3943d6b57f7f7098c3c0afno14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"792859c1ec084b5da65532f4ad960b69no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cms_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"c59f81381f9c4e8d8ccded4792b7870fno14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"c6e15561a78548f6b94bd932356eb4a4no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"cfc1dfb875ca4601bd488d5b313277d9no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5gtm_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"d5846a820b214ae1863fe1cc41c1af93no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn2_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"eb0916d8fca4402b87686d8b085a7f53no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cn_2",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"f486bc86fd254f80865221ca837524b6no14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5dn1_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"fa49d05061204bbb90dd5b0e5839961ano14",
                    "name":"user1-no-delete-ng-B132_1_gaussdbv5cms_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                }
            ],
            "private_ips":[
                "10.0.0.0 / 10.0.0.1 / 10.0.0.3"
            ],
            "public_ips":[

            ],
            "db_user_name":"root",
            "vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy":"reliability",
            "charge_info":{
                "charge_mode":"postPaid"
            },
            "backup_strategy":{
                "start_time":"",
                "keep_days":0
            },
            "maintenance_window":"18:00-22:00",
            "related_instance":[

            ],
            "time_zone":"UTC+08:00"
        }
    ],
    "total_count":1
}

{
    "instances": [
        {
            "id": "3f6ee7c5e98f4c4d8c52be76cbf922efin14",
            "status": "ACTIVE",
            "name": "user1-no-delete-ng-B132_1",
            "port": 8000,
            "type": "Enterprise",
            "ha": {
                "replication_mode": "sync"
            },
            "region": "cn-xianhz-1",
            "datastore": {
                "type": "GaussDB(openGauss)",
                "version": "1.1"
            },
            "created": "2020-06-25T03:09:02+0000",
            "updated": "2020-06-25T05:34:53+0000",
            "volume": {
                "type": "ULTRAHIGH",
                "size": 160
            },
            "nodes": [
                {
                    "id": "0218f10e317a4021ac8419c4b7e57dc2no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cms_1",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "24e233feb5c44075a2b0f650289c74fdno14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cn_1",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "2a8e9e6c55eb47759ade245af95a110fno14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_2",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "331dee7a09cf4e95a1d8eced07d1727ano14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_1",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "43b815a387fa4f2883659202e0c9a470no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_0",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "6274ceece9934a118dc5e5ff7f7f45c9no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cn_0",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "650101ff9b3943d6b57f7f7098c3c0afno14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_0",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "792859c1ec084b5da65532f4ad960b69no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cms_2",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "c59f81381f9c4e8d8ccded4792b7870fno14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_1",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "c6e15561a78548f6b94bd932356eb4a4no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_1",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "cfc1dfb875ca4601bd488d5b313277d9no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5gtm_2",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "d5846a820b214ae1863fe1cc41c1af93no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn2_0",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "eb0916d8fca4402b87686d8b085a7f53no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cn_2",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "f486bc86fd254f80865221ca837524b6no14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5dn1_2",
                    "role": "slave",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                },
                {
                    "id": "fa49d05061204bbb90dd5b0e5839961ano14",
                    "name": "user1-no-delete-ng-B132_1_gaussdbv5cms_0",
                    "role": "master",
                    "status": "ACTIVE",
                    "availability_zone": "az1xahz"
                }
            ],
            "private_ips": [
                "10.0.0.0 / 10.0.0.1 / 10.0.0.3"
            ],
            "public_ips": [],
            "db_user_name": "root",
            "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy": "reliability",
            "charge_info": {
                "charge_mode": "postPaid"
            },
            "backup_strategy": {
                "start_time": "",
                "keep_days": 0
            },
            "maintenance_window": "18:00-22:00",
            "related_instance": [],
            "time_zone": "UTC+08:00"
        }
    ],
    "total_count": 1
}

Querying all DB instances:

{
    "instances":[
        {
            "id":"4670359c9cb94644bf0e0111e3b0158bin14",
            "status":"ACTIVE",
            "name":"user_upgrade_test6_x86",
            "port":8000,
            "type":"Enterprise",
            "ha":{
                "replication_mode":"sync"
            },
            "region":"cn-xianhz-1",
            "datastore":{
                "type":"GaussDB(openGauss)",
                "version":"1.1"
            },
            "created":"2020-06-22T12:45:41+0000",
            "updated":"2020-06-22T12:45:41+0000",
            "volume":{
                "type":"ULTRAHIGH",
                "size":120
            },
            "nodes":[
                {
                    "id":"409ff2a1c8aa44db98c4df339bf5f9d6no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"595a235a51ab482ab997d1d0cff6dfb7no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cn_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"5b944393b7434aa684b53b11fc572fcano14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"5c2d2f451a274113a0ae441e9187ae26no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"718091e1229245af876f28cf8713225cno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"96949fe1373b486ebab8c9c87c9cb1ddno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"973d5816100841388b4a6b822aff6e20no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"a06bf305f995426f87b747aa98a94a4ano14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"ab7793dfc70c4ae7a535921639233d9cno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"d6b081f12d984d3ba8804dadbb8920deno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                }
            ],
             "private_ips":[
                "10.0.0.0"
            ],
            "public_ips":[

            ],
            "db_user_name":"root",
            "vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy":"reliability",
            "charge_info":{
                "charge_mode":"postPaid"
            },
            "backup_strategy":{
                "start_time":"",
                "keep_days":0
            },
            "maintenance_window":"18:00-22:00",
            "related_instance":[

            ],
            "time_zone":"UTC+08:00"
        },
        {
            "id":"08a693683a394bbd82907f300ea219abin14",
            "status":"ACTIVE",
            "name":"user_x86_01",
            "port":8000,
            "type":"Enterprise",
            "ha":{
                "replication_mode":"sync"
            },
            "region":"cn-xianhz-1",
            "datastore":{
                "type":"GaussDB(openGauss)",
                "version":"1.1"
            },
            "created":"2020-06-22T08:54:50+0000",
            "updated":"2020-06-22T08:54:50+0000",
            "volume":{
                "type":"ULTRAHIGH",
                "size":120
            },
            "nodes":[
                {
                    "id":"271ec8ed56d842839f117382582a631fno14",
                    "name":"user_x86_01_gaussdbv5dn1_0",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"54bfeea3d28d40ec9d49df7458f2ebe3no14",
                    "name":"user_x86_01_gaussdbv5dn1_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"688e0d16c0004a1ca0d4697cb8d74a32no14",
                    "name":"user_x86_01_gaussdbv5gtm_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"81b682997ca84c668d1d0b727ee9662fno14",
                    "name":"user_x86_01_gaussdbv5gtm_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"847f153d9f524e4a845b39f2291742e6no14",
                    "name":"user_x86_01_gaussdbv5dn1_1",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"a7fb4fb4d14940bb90a558d2fe7343c2no14",
                    "name":"user_x86_01_gaussdbv5gtm_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"b3f496af3a9745ae891bb5f4fc553a3eno14",
                    "name":"user_x86_01_gaussdbv5cms_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"c3a0fa4d919f40559000fa5e61fd1047no14",
                    "name":"user_x86_01_gaussdbv5cn_1",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"cecfb26dbef846499e5e20fa3efd42f4no14",
                    "name":"user_x86_01_gaussdbv5cn_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"cfc23c4642524a59a2d33dbf038f9f4bno14",
                    "name":"user_x86_01_gaussdbv5cms_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                },
                {
                    "id":"efb7f9059e7c439a9b8d53a991f5e526no14",
                    "name":"user_x86_01_gaussdbv5cms_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"az2xahz"
                }
            ],
            "private_ips":[
                "10.0.0.0 / 10.0.0.1"
            ],
            "public_ips":[

            ],
            "db_user_name":"root",
            "vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy":"reliability",
            "charge_info":{
                "charge_mode":"postPaid"
            },
            "backup_strategy":{
                "start_time":"",
                "keep_days":0
            },
            "maintenance_window":"18:00-22:00",
            "related_instance":[

            ],
            "time_zone":"UTC+08:00"
        }
    ],
    "total_count":2
}

{
    "instances":[
        {
            "id":"4670359c9cb94644bf0e0111e3b0158bin14",
            "status":"ACTIVE",
            "name":"user_upgrade_test6_x86",
            "port":8000,
            "type":"Enterprise",
            "ha":{
                "replication_mode":"sync"
            },
            "region":"eu-de",
            "datastore":{
                "type":"GaussDB(openGauss)",
                "version":"1.1"
            },
            "created":"2020-06-22T12:45:41+0000",
            "updated":"2020-06-22T12:45:41+0000",
            "volume":{
                "type":"ULTRAHIGH",
                "size":120
            },
            "nodes":[
                {
                    "id":"409ff2a1c8aa44db98c4df339bf5f9d6no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"595a235a51ab482ab997d1d0cff6dfb7no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cn_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"5b944393b7434aa684b53b11fc572fcano14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"5c2d2f451a274113a0ae441e9187ae26no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"718091e1229245af876f28cf8713225cno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"96949fe1373b486ebab8c9c87c9cb1ddno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"973d5816100841388b4a6b822aff6e20no14",
                    "name":"user_upgrade_test6_x86_gaussdbv5cms_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"a06bf305f995426f87b747aa98a94a4ano14",
                    "name":"user_upgrade_test6_x86_gaussdbv5gtm_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"ab7793dfc70c4ae7a535921639233d9cno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"d6b081f12d984d3ba8804dadbb8920deno14",
                    "name":"user_upgrade_test6_x86_gaussdbv5dn1_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                }
            ],
            "private_ips":[
                "10.0.0.0"
            ],
            "public_ips":[

            ],
            "db_user_name":"root",
            "vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy":"reliability",
            "charge_info":{
                "charge_mode":"postPaid"
            },
            "backup_strategy":{
                "start_time":"",
                "keep_days":0
            },
            "maintenance_window":"18:00-22:00",
            "related_instance":[

            ],
            "time_zone":"UTC+08:00"
        },
        {
            "id":"08a693683a394bbd82907f300ea219abin14",
            "status":"ACTIVE",
            "name":"user_x86_01",
            "port":8000,
            "type":"Enterprise",
            "ha":{
                "replication_mode":"sync"
            },
            "region":"eu-de",
            "datastore":{
                "type":"GaussDB(openGauss)",
                "version":"1.1"
            },
            "created":"2020-06-22T08:54:50+0000",
            "updated":"2020-06-22T08:54:50+0000",
            "volume":{
                "type":"ULTRAHIGH",
                "size":120
            },
            "nodes":[
                {
                    "id":"271ec8ed56d842839f117382582a631fno14",
                    "name":"user_x86_01_gaussdbv5dn1_0",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"54bfeea3d28d40ec9d49df7458f2ebe3no14",
                    "name":"user_x86_01_gaussdbv5dn1_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"688e0d16c0004a1ca0d4697cb8d74a32no14",
                    "name":"user_x86_01_gaussdbv5gtm_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"81b682997ca84c668d1d0b727ee9662fno14",
                    "name":"user_x86_01_gaussdbv5gtm_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"847f153d9f524e4a845b39f2291742e6no14",
                    "name":"user_x86_01_gaussdbv5dn1_1",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"a7fb4fb4d14940bb90a558d2fe7343c2no14",
                    "name":"user_x86_01_gaussdbv5gtm_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"b3f496af3a9745ae891bb5f4fc553a3eno14",
                    "name":"user_x86_01_gaussdbv5cms_2",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"c3a0fa4d919f40559000fa5e61fd1047no14",
                    "name":"user_x86_01_gaussdbv5cn_1",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"cecfb26dbef846499e5e20fa3efd42f4no14",
                    "name":"user_x86_01_gaussdbv5cn_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"cfc23c4642524a59a2d33dbf038f9f4bno14",
                    "name":"user_x86_01_gaussdbv5cms_0",
                    "role":"master",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                },
                {
                    "id":"efb7f9059e7c439a9b8d53a991f5e526no14",
                    "name":"user_x86_01_gaussdbv5cms_1",
                    "role":"slave",
                    "status":"ACTIVE",
                    "availability_zone":"eu-de-01"
                }
            ],
            "private_ips":[
                "10.0.0.0 / 10.0.0.1"
            ],
            "public_ips":[

            ],
            "db_user_name":"root",
            "vpc_id":"1f011c32-2de2-4aa8-a161-9498dbcef329",
            "subnet_id":"54a44bec-e36f-441e-86bb-d749ace9c189",
            "security_group_id":"c6123999-8532-421c-9db6-e078013ff58f",
            "flavor_ref":"gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
            "switch_strategy":"reliability",
            "charge_info":{
                "charge_mode":"postPaid"
            },
            "backup_strategy":{
                "start_time":"",
                "keep_days":0
            },
            "maintenance_window":"18:00-22:00",
            "related_instance":[

            ],
            "time_zone":"UTC+08:00"
        }
    ],
    "total_count":2
}

Abnormal response
For details, see Abnormal Request Results.

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DB Instance Management

83 KiB Raw Permalink Blame History