調用DescribeDBInstanceAttribute接口獲取實例屬性。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeDBInstanceAttribute | 系統規定參數。取值:DescribeDBInstanceAttribute。 |
RegionId | String | 是 | cn-hangzhou | 實例所在地域。 |
DBInstanceName | String | 是 | pxc-******** | 實例名。 |
ResourceGroupId | String | 否 | rg-aekzaxhezhs5*** | 資源組ID。 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
RequestId | String | 9B2F3840-5C98-475C-B269-2D5C3A31797C | 請求ID。 |
DBInstance | Object | 數據庫實例信息。 |
|
Type | String | ReadWrite | 實例類型:
|
Status | String | Running | 實例狀態,詳情請參見實例狀態表。 |
RightsSeparationStatus | String | disabled | 三權分立狀態:
|
DBNodeCount | Integer | 2 | 實例節點數量。 |
Expired | String | false | 是否過期:
|
CreateTime | String | 2021-08-31T08:56:25.000+0000 | 創建時間。 |
PayType | String | Postpaid | 實例付費方式,取值:
|
Port | String | 3306 | 內網連接端口。 |
LockMode | String | Unlock | 實例鎖定模式:
|
Description | String | test instance | 實例描述。 |
ConnectionString | String | pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com | 內網連接信息。 |
StorageUsed | Long | 17042505728 | 已經使用的存儲,單位為B。 |
ExpireDate | String | 2022-08-31T16:00:00.000+0000 | 到期時間。格式為yyyy-MM-ddTHH:mm:ss.sss+0000(UTC時間)。 |
CommodityCode | String | drds_polarxpost_public_cn | 實例商品種類,固定取值為drds_polarxpost_public_cn。 |
MaintainStartTime | String | 06:00 | 實例可維護開始時間,此處為UTC時間,加8小時才是控制臺上顯示的可維護時間段。 |
DBInstanceType | String | ReadWrite | 實例類型:
|
DBNodeClass | String | polarx.x4.large.2e | 實例節點規格。 |
LatestMinorVersion | String | polarx-kernel_5.4.11-16301083_xcluster-20210805 | 當前實例支持的最新內核版本。 |
MaintainEndTime | String | 06:00 | 實例可維護結束時間,此處為UTC時間,加8小時為控制臺上顯示的可維護時間段。 |
DBType | String | polarx | 數據庫類型,固定取值為polarx。 |
RightsSeparationEnabled | Boolean | false | 三權分立狀態:
|
VPCId | String | vpc-xxxxx | VPC ID。 |
MinorVersion | String | polarx-kernel_5.4.11-16301083_xcluster-20210805 | 當前內核版本。 |
RegionId | String | cn-hangzhou | 實例所在地域。 |
Network | String | VPC | 實例的網絡類型,僅支持取值VPC,表示專有網絡。 |
DBVersion | String | 5.5 | 數據庫版本。 |
VSwitchId | String | vsw-******** | 交換機ID。 |
ZoneId | String | cn-hangzhou-a | 實例所在可用區。 |
Engine | String | polarx | 數據庫類型,固定取值為polarx。 |
KindCode | Integer | 18 | 實例引擎版本,內部參數。 |
Id | String | pxc-zkralxpc5d**** | 主實例的ID,如果沒有返回此參數則表示該實例是主實例。 |
DBNodes | Array of DBNode | 數據庫節點信息。 |
|
ComputeNodeId | String | pxc-i-******** | 計算節點名稱。 |
NodeClass | String | polarx.x4.large.2e | 節點規格。 |
DataNodeId | String | pxc-xdb-xxxxxx | 存儲節點名稱。 |
ZoneId | String | cn-hangzhou-a | 節點所在可用區名稱。 |
Id | String | pxi-********* | 邏輯節點ID。 |
RegionId | String | cn-hangzhou | 節點所在地域ID。 |
ConnAddrs | Array of ConnAddr | 連接地址信息。 |
|
Type | String | VPC | 連接的種類,VPC為內網連接,PUBLIC為公網連接。 |
VSwitchId | String | vsw-********* | 交換機ID。 |
Port | Long | 3306 | 連接端口號。 |
VPCId | String | vpc-xxxxxx | VPC ID。 |
ConnectionString | String | polardbx-xxx.aliyuncs.com | 連接地址。 |
VpcInstanceId | String | pxc-zkralxpc5d**** | vpc 內部CloudInstanceId,可以忽略 |
ReadDBInstances | Array of String | pxr-********* | 只讀實例名稱。 |
ResourceGroupId | String | rg-********* | 資源組ID。 |
TagSet | Array of TagSet | 標簽集合。 |
|
Key | String | key2 | 標簽名稱。 |
Value | String | value2 | 標簽值。 |
CnNodeCount | Integer | 2 | CN節點數量。 |
DnNodeCount | Integer | 2 | DN節點數量。 |
CnNodeClassCode | String | polarx.x4.xlarge.2e | CN節點規格:
|
DnNodeClassCode | String | mysql.x8.large.25 | DN節點規格:
|
Series | String | enterprise | 實例系列,取值如下:
|
LTSVersions | Array of String | X.X.X.X | LTS版本號。 |
TopologyType | String | 3azones | 拓撲類型:
|
PrimaryZone | String | cn-shenzhen-e | 主可用區。 |
SecondaryZone | String | cn-shenzhen-a | 次可用區。 |
TertiaryZone | String | cn-shenzhen-e | 第三可用區。 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&ResourceGroupId=rg-aekzaxhezhs5***
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceAttributeResponse>
<RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
<DBInstance>
<Type>ReadWrite</Type>
<Status>Running</Status>
<RightsSeparationStatus>disabled</RightsSeparationStatus>
<DBNodeCount>2</DBNodeCount>
<Expired>false</Expired>
<CreateTime>2021-08-31T08:56:25.000+0000</CreateTime>
<PayType>Postpaid</PayType>
<Port>3306</Port>
<LockMode>Unlock</LockMode>
<Description>test instance</Description>
<ConnectionString>pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com</ConnectionString>
<StorageUsed>17042505728</StorageUsed>
<ExpireDate>2022-08-31T16:00:00.000+0000</ExpireDate>
<CommodityCode>drds_polarxpost_public_cn</CommodityCode>
<MaintainStartTime>06:00</MaintainStartTime>
<DBInstanceType>ReadWrite</DBInstanceType>
<DBNodeClass>polarx.x4.large.2e</DBNodeClass>
<LatestMinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</LatestMinorVersion>
<MaintainEndTime>06:00</MaintainEndTime>
<DBType>polarx</DBType>
<RightsSeparationEnabled>false</RightsSeparationEnabled>
<VPCId>vpc-xxxxx</VPCId>
<MinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</MinorVersion>
<RegionId>cn-hangzhou</RegionId>
<Network>VPC</Network>
<DBVersion>5.5</DBVersion>
<VSwitchId>vsw-********</VSwitchId>
<ZoneId>cn-hangzhou-a</ZoneId>
<Engine>polarx</Engine>
<KindCode>18</KindCode>
<Id>pxc-zkralxpc5d****</Id>
<DBNodes>
<ComputeNodeId>pxc-i-********</ComputeNodeId>
<NodeClass>polarx.x4.large.2e</NodeClass>
<DataNodeId>pxc-xdb-xxxxxx</DataNodeId>
<ZoneId>cn-hangzhou-a</ZoneId>
<Id>pxi-*********</Id>
<RegionId>cn-hangzhou</RegionId>
</DBNodes>
<ConnAddrs>
<Type>VPC</Type>
<VSwitchId>vsw-*********</VSwitchId>
<Port>3306</Port>
<VPCId>vpc-xxxxxx</VPCId>
<ConnectionString>polardbx-xxx.aliyuncs.com</ConnectionString>
<VpcInstanceId>pxc-zkralxpc5d****</VpcInstanceId>
</ConnAddrs>
<ReadDBInstances>pxr-*********</ReadDBInstances>
<ResourceGroupId>rg-*********</ResourceGroupId>
<TagSet>
<Key>key2</Key>
<Value>value2</Value>
</TagSet>
<CnNodeCount>2</CnNodeCount>
<DnNodeCount>2</DnNodeCount>
<CnNodeClassCode>polarx.x4.xlarge.2e</CnNodeClassCode>
<DnNodeClassCode>mysql.x8.large.25</DnNodeClassCode>
<Series>enterprise</Series>
<LTSVersions>X.X.X.X</LTSVersions>
<TopologyType>3azones</TopologyType>
<PrimaryZone>cn-shenzhen-e</PrimaryZone>
<SecondaryZone>cn-shenzhen-a</SecondaryZone>
<TertiaryZone>cn-shenzhen-e</TertiaryZone>
</DBInstance>
</DescribeDBInstanceAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
"DBInstance" : {
"Type" : "ReadWrite",
"Status" : "Running",
"RightsSeparationStatus" : "disabled",
"DBNodeCount" : 2,
"Expired" : "false",
"CreateTime" : "2021-08-31T08:56:25.000+0000",
"PayType" : "Postpaid",
"Port" : "3306",
"LockMode" : "Unlock",
"Description" : "test instance",
"ConnectionString" : "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
"StorageUsed" : 17042505728,
"ExpireDate" : "2022-08-31T16:00:00.000+0000",
"CommodityCode" : "drds_polarxpost_public_cn",
"MaintainStartTime" : "06:00",
"DBInstanceType" : "ReadWrite",
"DBNodeClass" : "polarx.x4.large.2e",
"LatestMinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"MaintainEndTime" : "06:00",
"DBType" : "polarx",
"RightsSeparationEnabled" : false,
"VPCId" : "vpc-xxxxx",
"MinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"RegionId" : "cn-hangzhou",
"Network" : "VPC",
"DBVersion" : "5.5",
"VSwitchId" : "vsw-********",
"ZoneId" : "cn-hangzhou-a",
"Engine" : "polarx",
"KindCode" : 18,
"Id" : "pxc-zkralxpc5d****",
"DBNodes" : [ {
"ComputeNodeId" : "pxc-i-********",
"NodeClass" : "polarx.x4.large.2e",
"DataNodeId" : "pxc-xdb-xxxxxx",
"ZoneId" : "cn-hangzhou-a",
"Id" : "pxi-*********",
"RegionId" : "cn-hangzhou"
} ],
"ConnAddrs" : [ {
"Type" : "VPC",
"VSwitchId" : "vsw-*********",
"Port" : 3306,
"VPCId" : "vpc-xxxxxx",
"ConnectionString" : "polardbx-xxx.aliyuncs.com",
"VpcInstanceId" : "pxc-zkralxpc5d****"
} ],
"ReadDBInstances" : [ "pxr-*********" ],
"ResourceGroupId" : "rg-*********",
"TagSet" : [ {
"Key" : "key2",
"Value" : "value2"
} ],
"CnNodeCount" : 2,
"DnNodeCount" : 2,
"CnNodeClassCode" : "polarx.x4.xlarge.2e",
"DnNodeClassCode" : "mysql.x8.large.25",
"Series" : "enterprise",
"LTSVersions" : [ "X.X.X.X" ],
"TopologyType" : "3azones",
"PrimaryZone" : "cn-shenzhen-e",
"SecondaryZone" : "cn-shenzhen-a",
"TertiaryZone" : "cn-shenzhen-e"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。