调用DescribeDBInstances接口查询AnalyticDB PostgreSQL版数据库实例列表。
使用说明
本接口用于查看目标地域下的AnalyticDB PostgreSQL版实例的实例类型、网络类型、实例状态等信息。
QPS限制
本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
本文档中的QPS仅为默认参考值,准确信息请参见API速率配额列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstances |
系统规定参数。取值:DescribeDBInstances。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 说明 您可以通过DescribeRegions接口查看可用的地域ID。
|
DBInstanceDescription | String | 否 | gp-bp12ga6v69h86**** |
实例描述。 |
InstanceNetworkType | String | 否 | VPC |
实例网络类型,取值说明:
说明 如果不填,则返回所有网络类型的实例。
|
DBInstanceIds | String | 否 | gp-bp*************** |
实例ID,多个实例ID之间用英文半角逗号(,)分隔。 |
PageSize | Integer | 否 | 50 |
每页记录数,取值说明:
默认值:30。 |
PageNumber | Integer | 否 | 1 |
页码,大于0且不超过Integer的最大值,默认值:1。 |
Tag.N.Key | String | 否 | test-key |
标签键。 |
Tag.N.Value | String | 否 | test-value |
标签值。 |
InstanceDeployTypes | Array of String | 否 | null |
该参数已废弃,无需传入该参数。 |
DBInstanceStatuses | Array of String | 否 | running |
实例运行状态,多个值用英文逗号(,)分隔。实例的运行状态的值,请参见实例状态表。 说明 该参数的传入值须为小写字母。
|
DBInstanceCategories | Array of String | 否 | basic,highavailability |
实例系列,多个值用英文逗号(,)分隔。取值说明:
|
DBInstanceModes | Array of String | 否 | storageelastic,serverless |
资源类型,多个值用英文逗号(,)分隔。取值说明:
|
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
实例所在的企业资源组ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalRecordCount | Integer | 1 |
总记录数。 |
PageRecordCount | Integer | 1 |
当前页记录数。 |
RequestId | String | 53EA07B7-FC2A-521B-AB7C-27********** |
请求ID。 |
PageNumber | Integer | 1 |
当前页码。 |
Items | Array of DBInstance |
实例详情列表。 |
|
DBInstance | |||
VpcId | String | vpc-bp******************* |
VPC ID。 |
ExpireTime | String | 2999-09-08T16:00:00Z |
实例到期时间(UTC时间)。 说明 按量付费实例的到日时间为
2999-09-08T16:00:00Z 。
|
DBInstanceNetType | String | 2 |
实例网卡类型,取值说明:
|
InstanceDeployType | String | cluster |
实例资源类型,取值说明:
|
StorageType | String | cloud_essd |
实例存储类型,取值说明:
|
CreateTime | String | 2021-10-09T04:54:08Z |
实例创建时间(UTC时间)。 |
PayType | String | Postpaid |
计费类型,取值说明:
|
Tags | Array of Tag |
实例标签。 |
|
Tag | |||
Key | String | test-key |
标签键。 |
Value | String | test-value |
标签值。 |
LockReason | String | 0 |
被锁定的原因,取值说明:
说明 存储预留模式实例正常情况下返回值为空。
|
DBInstanceStatus | String | Running |
实例状态,详见实例状态表。 |
ConnectionMode | String | null |
该参数已废弃,故不会返回参数值。 如需查询访问模式可以通过DescribeDBInstanceAttribute接口查询。 |
LockMode | String | Unlock |
实例锁定模式,取值说明:
|
EngineVersion | String | 6.0 |
数据库版本。 |
RegionId | String | cn-hangzhou |
地域ID。 |
VSwitchId | String | vsw-bp******************* |
vSwitch ID。 |
InstanceNetworkType | String | VPC |
实例网络类型,取值说明:
|
ZoneId | String | cn-hangzhou-h |
可用区ID。 |
DBInstanceId | String | gp-bp*************** |
实例ID。 |
Engine | String | gpdb |
数据库类型。 |
DBInstanceDescription | String | gp-bp*************** |
实例描述。 |
SegNodeNum | String | 4 |
Segment节点数量。 |
StorageSize | String | 50 |
存储空间大小,单位GB。 |
MasterNodeNum | Integer | 1 |
Master节点数量。 |
DBInstanceCategory | String | HighAvailability |
实例系列,取值说明:
|
DBInstanceMode | String | StorageElastic |
资源类型,取值说明:
|
ResourceGroupId | String | rg-bp67acfmxazb4p**** |
实例所在的企业资源组ID。 |
示例
请求示例
http(s)://gpdb.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstancesResponse>
<code>200</code>
<data>
<TotalRecordCount>1</TotalRecordCount>
<PageRecordCount>1</PageRecordCount>
<RequestId>53EA07B7-FC2A-521B-AB7C-27**********</RequestId>
<PageNumber>1</PageNumber>
<Items>
<DBInstance>
<MasterNodeNum>1</MasterNodeNum>
<StorageType>cloud_essd</StorageType>
<EngineVersion>6.0</EngineVersion>
<DBInstanceStatus>Running</DBInstanceStatus>
<ZoneId>cn-hangzhou-h</ZoneId>
<DBInstanceNetType>2</DBInstanceNetType>
<CreateTime>2021-10-09T04:54:08Z</CreateTime>
<VSwitchId>vsw-bp*******************</VSwitchId>
<SegNodeNum>4</SegNodeNum>
<StorageSize>50</StorageSize>
<PayType>Postpaid</PayType>
<LockMode>Unlock</LockMode>
<InstanceNetworkType>VPC</InstanceNetworkType>
<DBInstanceCategory>HighAvailability</DBInstanceCategory>
<VpcId>vpc-bp*******************</VpcId>
<DBInstanceId>gp-bp***************</DBInstanceId>
<DBInstanceMode>StorageElastic</DBInstanceMode>
<InstanceDeployType>cluster</InstanceDeployType>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
<LockReason>0</LockReason>
<Engine>gpdb</Engine>
<DBInstanceDescription>gp-bp***************</DBInstanceDescription>
<Tags>
<Tag>
<Value>test-value</Value>
<Key>test-key</Key>
</Tag>
</Tags>
</DBInstance>
</Items>
</data>
<requestId>1439F852-06E3-1238-8BC6-F74CABD28D5D</requestId>
</DescribeDBInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : 200,
"data" : {
"TotalRecordCount" : 1,
"PageRecordCount" : 1,
"RequestId" : "53EA07B7-FC2A-521B-AB7C-27**********",
"PageNumber" : 1,
"Items" : {
"DBInstance" : {
"MasterNodeNum" : 1,
"StorageType" : "cloud_essd",
"EngineVersion" : 6,
"DBInstanceStatus" : "Running",
"ZoneId" : "cn-hangzhou-h",
"DBInstanceNetType" : 2,
"CreateTime" : "2021-10-09T04:54:08Z",
"VSwitchId" : "vsw-bp*******************",
"SegNodeNum" : 4,
"StorageSize" : 50,
"PayType" : "Postpaid",
"LockMode" : "Unlock",
"InstanceNetworkType" : "VPC",
"DBInstanceCategory" : "HighAvailability",
"VpcId" : "vpc-bp*******************",
"DBInstanceId" : "gp-bp***************",
"DBInstanceMode" : "StorageElastic",
"InstanceDeployType" : "cluster",
"RegionId" : "cn-hangzhou",
"ExpireTime" : "2999-09-08T16:00:00Z",
"LockReason" : 0,
"Engine" : "gpdb",
"DBInstanceDescription" : "gp-bp***************",
"Tags" : {
"Tag" : {
"Value" : "test-value",
"Key" : "test-key"
}
}
}
}
},
"requestId" : "1439F852-06E3-1238-8BC6-F74CABD28D5D"
}
错误码
访问错误中心查看更多错误码。