调用DescribeDBInstanceAttribute接口查询AnalyticDB PostgreSQL版实例详情。
使用说明
本接口一般用于查看AnalyticDB PostgreSQL版实例的规格、网络类型、实例状态等信息。
QPS限制
本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
本文档中的QPS仅为默认参考值,准确信息请参见API速率配额列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceAttribute |
系统规定参数。取值:DescribeDBInstanceAttribute。 |
DBInstanceId | String | 是 | gp-bp*************** |
实例ID。 说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 51981F2C-4109-53F7-9B95-************ |
请求ID。 |
Items | Array of DBInstanceAttribute |
实例详情列表。 |
|
DBInstanceAttribute | |||
VpcId | String | vpc-rj******************* |
VPC ID。 |
CreationTime | String | 2021-11-30T08:34:33Z |
实例创建时间。 |
DBInstanceCpuCores | Integer | 2 |
CPU核数。 |
SegmentCounts | Integer | 1 |
计算组个数。 说明 该参数仅适用存储预留模式的实例。
|
StoragePerNode | Integer | 80 |
单副本的存储大小,单位请参见StorageUnit参数。 说明 该参数仅适用存储预留模式的实例。
|
DBInstanceMemory | Long | 16 |
计算节点的内存。 说明 存储预留模式和Serverless版本的单位为MB;存储弹性模式单位为GB。
|
HostType | String | 0 |
计算组机器类型,取值说明:
说明 该参数仅适用存储预留模式的实例。
|
PayType | String | Postpaid |
计费类型,取值说明:
|
Tags | Array of Tag |
标记键值对。 |
|
Tag | |||
Key | String | test-key |
标签键。 |
Value | String | test-value |
标签值。 |
StorageType | String | cloud_essd |
存储类型,取值说明:
说明 该参数仅适用存储弹性模式的实例。
|
AvailabilityValue | String | 100.0% |
查询当前实例可用性状态,单位:百分比(%)。 说明 该参数仅适用存储预留模式的实例。
|
ReadDelayTime | String | null |
该参数已废弃,故不会返回参数值。 |
CpuCoresPerNode | Integer | 1 |
单节点的CPU核数。 说明 该参数仅适用存储预留模式的实例。
|
Port | String | 5432 |
实例的端口号。 |
ConnectionMode | String | LVS |
访问模式,取值说明:
|
LockMode | String | Unlock |
锁定方式,取值说明:
|
EngineVersion | String | 6.0 |
数据库版本。 |
StorageUnit | String | GB SSD |
存储单位,取值说明:
说明 该参数仅适用存储预留模式和Serverless版本的实例。
|
MemoryPerNode | Integer | 8 |
单副本的内存大小,单位请参见MemoryUnit参数。 说明 该参数仅适用存储预留模式的实例。
|
ConnectionString | String | gp-bp***************.gpdb.rds.aliyuncs.com |
实例连接地址。 |
InstanceNetworkType | String | VPC |
实例网络类型,取值说明:
|
SecurityIPList | String | 127.0.0.1 |
允许访问实例的IP白名单。 |
MemoryUnit | String | GB |
内存单位。 说明 该参数仅适用存储预留模式的实例。
|
DBInstanceClassType | String | x |
实例规格族,取值说明:
|
DBInstanceDescription | String | gp-bp*************** |
实例描述。 |
DBInstanceGroupCount | String | 2 |
计算组数量。 说明 该参数仅适用存储预留模式的实例。
|
ExpireTime | String | 2999-09-08T16:00:00Z |
实例到期时间(UTC时间)。 说明 按量付费实例的到期时间为
2999-09-08T16:00:00Z 。
|
DBInstanceNetType | String | 2 |
实例网卡类型,取值说明:
|
MaintainStartTime | String | 18:00Z |
可维护开始时间。 |
MaintainEndTime | String | 22:00Z |
可维护结束时间。 |
LockReason | String | null |
该参数已废弃,故不会返回参数值。 |
DBInstanceStatus | String | Running |
实例状态,详见实例状态表。 |
RegionId | String | cn-hangzhou |
地域ID。 |
DBInstanceDiskMBPS | Long | 150 |
计算组最大的BPS(磁盘吞吐量),单位:Mbps。 说明 该参数仅适用存储预留模式的实例。
|
DBInstanceStorage | Long | 50 |
单个副本的最大存储空间,单位:GB。 |
ZoneId | String | cn-hangzhou-j |
可用区ID。 |
MaxConnections | Integer | 500 |
实例的最大并发连接数。 说明 该参数仅适用存储预留模式的实例。
|
DBInstanceId | String | gp-bp*************** |
实例ID。 |
DBInstanceClass | String | gpdb.group.segsdx1 |
实例规格。 说明 该参数仅适用存储预留模式的实例。
|
Engine | String | gpdb |
数据库引擎。 |
DBInstanceCategory | String | HighAvailability |
实例系列,取值说明:
|
CpuCores | Integer | 2 |
计算节点CPU核数,单位Core。 |
MemorySize | Long | 16 |
计算节点内存大小。 说明 存储预留模式和Serverless版本的单位为MB;存储弹性模式单位为GB。
|
StorageSize | Long | 50 |
存储空间大小,单位GB。 |
SegNodeNum | Integer | 4 |
Segment节点数量。 说明 该参数仅适用存储弹性模式和Serverless版本的实例。
|
MasterNodeNum | Integer | 1 |
Master节点数量。 |
DBInstanceMode | String | StorageElastic |
实例资源类型,取值说明:
|
MinorVersion | String | 6.3.9.0-202204081027 |
内核小版本。 |
SupportRestore | Boolean | true |
是否支持备份恢复,取值说明:
|
VSwitchId | String | vsw-bp******************* |
vSwitch ID。 |
EncryptionKey | String | 0d2470df-da7b-4786-b981-************ |
加密密钥。 说明 仅开启云盘加密的实例会返回该参数。
|
EncryptionType | String | CloudDisk |
加密类型,取值说明:
说明 仅云盘加密的实例会返回该参数。
|
CoreVersion | String | mm.v6.3.9.0-202204081027 |
内核小版本号。 |
示例
请求示例
http(s)://gpdb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=gp-bp***************
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceAttributeResponse>
<code>200</code>
<data>
<RequestId>51981F2C-4109-53F7-9B95-************</RequestId>
<Items>
<DBInstanceAttribute>
<MasterNodeNum>1</MasterNodeNum>
<DBInstanceMemory>16</DBInstanceMemory>
<CpuCoresPerNode>0</CpuCoresPerNode>
<Port>5432</Port>
<SegNodeNum>4</SegNodeNum>
<MemoryPerNode>0</MemoryPerNode>
<EncryptionKey>0d2470df-da7b-4786-b981-************</EncryptionKey>
<InstanceNetworkType>VPC</InstanceNetworkType>
<DBInstanceClassType>x</DBInstanceClassType>
<SupportRestore>true</SupportRestore>
<DBInstanceCategory>HighAvailability</DBInstanceCategory>
<MaintainEndTime>22:00</MaintainEndTime>
<DBInstanceId>gp-bp***************</DBInstanceId>
<DBInstanceStorage>50</DBInstanceStorage>
<DBInstanceDescription>gp-bp***************</DBInstanceDescription>
<MaintainStartTime>18:00Z</MaintainStartTime>
<Engine>gpdb</Engine>
<Tags>
<Tag>
<Value>test-value</Value>
<Key>test-key</Key>
</Tag>
</Tags>
<SegmentCounts>0</SegmentCounts>
<MemorySize>16</MemorySize>
<EncryptionType>CloudDisk</EncryptionType>
<MemoryUnit/>
<StorageType>cloud_essd</StorageType>
<EngineVersion>6.0</EngineVersion>
<DBInstanceStatus>Running</DBInstanceStatus>
<ZoneId>cn-hangzhou-j</ZoneId>
<DBInstanceCpuCores>2</DBInstanceCpuCores>
<VSwitchId>vsw-bp*******************</VSwitchId>
<StorageSize>50</StorageSize>
<MinorVersion>6.3.5.7-202111221001</MinorVersion>
<CoreVersion>mm.v6.3.9.0-202204081027</CoreVersion>
<StorageUnit/>
<PayType>Postpaid</PayType>
<LockMode>Unlock</LockMode>
<VpcId>vpc-rj*******************</VpcId>
<StoragePerNode>0</StoragePerNode>
<DBInstanceMode>StorageElastic</DBInstanceMode>
<CreationTime>2021-11-30T08:34:33Z</CreationTime>
<ConnectionMode>LVS</ConnectionMode>
<CpuCores>2</CpuCores>
<RegionId>cn-hangzhou</RegionId>
<ConnectionString>gp-bp***************.gpdb.rds.aliyuncs.com</ConnectionString>
<ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
</DBInstanceAttribute>
</Items>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>51981F2C-4109-53F7-9B95-************</requestId>
<successResponse>true</successResponse>
</DescribeDBInstanceAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200",
"data" : {
"RequestId" : "51981F2C-4109-53F7-9B95-************",
"Items" : {
"DBInstanceAttribute" : [ {
"MasterNodeNum" : 1,
"DBInstanceMemory" : 16,
"CpuCoresPerNode" : 0,
"Port" : "5432",
"SegNodeNum" : 4,
"MemoryPerNode" : 0,
"EncryptionKey" : "0d2470df-da7b-4786-b981-************",
"InstanceNetworkType" : "VPC",
"DBInstanceClassType" : "x",
"SupportRestore" : true,
"DBInstanceCategory" : "HighAvailability",
"MaintainEndTime" : "22:00",
"DBInstanceId" : "gp-bp***************",
"DBInstanceStorage" : 50,
"DBInstanceDescription" : "gp-bp***************",
"MaintainStartTime" : "18:00Z",
"Engine" : "gpdb",
"Tags" : {
"Tag" : [ {
"Value" : "test-value",
"Key" : "test-key"
} ]
},
"SegmentCounts" : 0,
"MemorySize" : 16,
"EncryptionType" : "CloudDisk",
"MemoryUnit" : "",
"StorageType" : "cloud_essd",
"EngineVersion" : "6.0",
"DBInstanceStatus" : "Running",
"ZoneId" : "cn-hangzhou-j",
"DBInstanceCpuCores" : 2,
"VSwitchId" : "vsw-bp*******************",
"StorageSize" : 50,
"MinorVersion" : "6.3.5.7-202111221001",
"CoreVersion" : "mm.v6.3.9.0-202204081027",
"StorageUnit" : "",
"PayType" : "Postpaid",
"LockMode" : "Unlock",
"VpcId" : "vpc-rj*******************",
"StoragePerNode" : 0,
"DBInstanceMode" : "StorageElastic",
"CreationTime" : "2021-11-30T08:34:33Z",
"ConnectionMode" : "LVS",
"CpuCores" : 2,
"RegionId" : "cn-hangzhou",
"ConnectionString" : "gp-bp***************.gpdb.rds.aliyuncs.com",
"ExpireTime" : "2999-09-08T16:00:00Z"
} ]
}
},
"httpStatusCode" : "200",
"requestId" : "51981F2C-4109-53F7-9B95-************",
"successResponse" : true
}
错误码
访问错误中心查看更多错误码。