Queries DescribeDBInstances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-hangzhou

The ID of the region.

DBInstanceDescription String No gp-xxxxxxxx

The description of the instances.

InstanceNetworkType String No VPC

The network type of the instance. Valid values:

  • VPC: Virtual Private Cloud
  • Classic: classic network
  • If you do not specify this parameter, instances of all network types are returned.
DBInstanceIds String No gp-xxxxxxxxx and gp-xxxxxxx

The IDs of the instances. Separate multiple instance IDs with commas (,).

Tag.N.Key String No key1

The key of a resource tag.

Tag.N.Value String No value1

The value of the tag.

PageSize Integer No 500

The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.

PageNumber Integer No 1

The number of the page to return. It must be greater than 0 and cannot exceed the maximum value of the Integer type. Default value: 1.

Response parameters

Prameter Type Sample response Description
RequestId String BBE00C04-A3E8-4114-881D-0480A72CB92E

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalRecordCount Integer 2

The total number of records that were returned.

PageRecordCount Integer 2

The number of records on the current page.

Items Array

The details of the instance.

DBInstanceId String gp-xxxxxxxx

The ID of the instance whose description is modified.

DBInstanceDescription String gp-xxxxxxxxxx

The description of the instance.

PayType String Prepaid: subscription

The billing method of the instance. Valid values:

  • Postpaid
  • Prepaid: Subscription
InstanceNetworkType String VPC

The network type of the read-only storage instance.

  • VPC: Virtual Private Cloud
  • Classic: classic network
ConnectionMode String Standard

The access mode of the instance.

  • The access mode of the instance. Valid values: Standard: standard mode
  • Safe: safe mode
RegionId Boolean cn-hangzhou

The ID of the region where the file system resides.

ZoneId String cn-hangzhou

The zone ID of the cluster.

ExpireTime String 2019-09-08T16:00:00Z

The time when the instance is scheduled to expire. Pay-as-you-go instances do not expire.

DBInstanceStatus String Running

The status of the instance. For more information, seeinstance state table.

Engine String gpdb

The engine type of the instance.

EngineVersion String 4.3

The version of the database engine.

DBInstanceNetType String Internet

The network interface controller type

LockMode String Unlock

The locking mode.

  • The locking mode of the instance. Valid values: Unlock: The instance is not locked.
  • ManualLock: The instance is locked manually.
  • LockByExpiration: The instance is locked automatically after it expires.
  • LockByRestoration: The instance is locked automatically before a rollback of the instance.
  • LockByDiskQuota: The instance is locked automatically when the disk space is full.
LockReason String Unknown

Reason for locking

CreateTime String 2019-09-08T16:00:00Z

The time when the cluster was created.

VpcId String vpc-xxxxxxxxxx

The ID of the VPC.

VSwitchId String vsw-xxxxxxxxx

The ID of the VSwitch associated with the specified VPC.

Tags Array

The tags of the instance.

Key String key1

The key of the tag.

Value String value1

The tag value of the disk.

Examples

Sample requests

https://gpdb.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success response

XML format

<Items>
    <DBInstance>
        <LockMode>Unlock</LockMode>
        <DBInstanceNetType>1</DBInstanceNetType>
        <DBInstanceId>gp-xxxxxxx</DBInstanceId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <DBInstanceDescription>gpdb_test</DBInstanceDescription>
        <InstanceNetworkType>Classic</InstanceNetworkType>
        <VSwitchId>vsw-xxxxxxx</VSwitchId>
        <VpcId>vpc-xxxxxxx</VpcId>
        <Engine>gpdb</Engine>
        <ExpireTime>2014-10-10T16:00:00Z</ExpireTime>
        <CreateTime>2018-06-27T12:07:11Z</CreateTime>
        <RegionId>cn-hangzhou</RegionId>
        <EngineVersion>5.5</EngineVersion>
        <LockReason/>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <PayType>Prepaid</PayType>
    </DBInstance>
    <DBInstance>
        <LockMode>Unlock</LockMode>
        <DBInstanceNetType>1</DBInstanceNetType>
        <DBInstanceId>gp-xxxxxxx</DBInstanceId>
        <ZoneId>cn-hangzhou-e</ZoneId>
        <DBInstanceDescription>gp-xxxxxxx</DBInstanceDescription>
        <InstanceNetworkType>Classic</InstanceNetworkType>
        <VSwitchId>vsw-xxxxxxx</VSwitchId>
        <VpcId>vpc-xxxxxxx</VpcId>
        <Engine>gpdb</Engine>
        <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
        <CreateTime>2018-06-27T11:51:46Z</CreateTime>
        <RegionId>cn-hangzhou</RegionId>
        <EngineVersion>5.5</EngineVersion>
        <LockReason/>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <PayType>Postpaid</PayType>
    </DBInstance>
</Items>
<PageNumber>1</PageNumber>
<TotalRecordCount>2</TotalRecordCount>
<RequestId>BBE00C04-A3E8-4114-881D-0480A72CB92E</RequestId>
<PageRecordCount>2</PageRecordCount>

JSON format

{
    "Items":{
        "DBInstance":[
            {
                "LockMode":"Unlock",
                "DBInstanceNetType":"1",
                "DBInstanceId":"gp-xxxxxxx",
                "ZoneId":"cn-hangzhou-e",
                "DBInstanceDescription":"gpdb_test",
                "InstanceNetworkType":"Classic",
                "VSwitchId":"vsw-xxxxxxx",
                "VpcId":"vpc-xxxxxxx",
                "Engine":"gpdb",
                "ExpireTime":"2019-06-27T16:00:00Z",
                "CreateTime":"2018-06-27T12:07:11Z",
                "RegionId":"cn-hangzhou",
                "EngineVersion":"4.3",
                "LockReason":"",
                "DBInstanceStatus":"Running",
                "PayType":"Prepaid"
            },
            {
                "LockMode":"Unlock",
                "DBInstanceNetType":"1",
                "DBInstanceId":"gp-xxxxxxx",
                "ZoneId":"cn-hangzhou-e",
                "DBInstanceDescription":"gp-xxxxxxx",
                "InstanceNetworkType":"Classic",
                "VSwitchId":"vsw-xxxxxxx",
                "VpcId":"vpc-xxxxxxx",
                "Engine":"gpdb",
                "ExpireTime":"2999-09-08T16:00:00Z",
                "CreateTime":"2018-06-27T11:51:46Z",
                "RegionId":"cn-hangzhou",
                "EngineVersion":"4.3",
                "LockReason":"",
                "DBInstanceStatus":"Running",
                "PayType":"Postpaid"
            }
        ]
    },
    "PageNumber":1,
    "TotalRecordCount":2,
    "RequestId":"BBE00C04-A3E8-4114-881D-0480A72CB92E",
    "PageRecordCount":2
}

Error codes.

For a list of error codes, visit the API Error Center.