DescribeDBInstances
調(diào)用DescribeDBInstances接口查詢實(shí)例列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求參數(shù)
名稱 |
類(lèi)型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeDBInstances | 系統(tǒng)規(guī)定參數(shù)。取值:DescribeDBInstances。 |
RegionId | String | 是 | cn-hangzhou | 實(shí)例所屬地域ID。 |
PageNumber | Integer | 否 | 1 | 分頁(yè)下標(biāo):從1開(kāi)始。 |
PageSize | Integer | 否 | 20 | 頁(yè)面大小,取值范圍為:5~1000。 |
ResourceGroupId | String | 否 | rg-acfmyst47****** | 資源組ID。 |
Tags | String | 否 | [{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}] | 標(biāo)簽列表。 |
InstanceId | String | 否 | dinga93c84f4d*** | 實(shí)例ID。 |
Series | String | 否 | enterprise | 實(shí)例系列,取值如下:
|
MustHasCdc | Boolean | 否 | true | 是否必須有日志引擎。 |
返回?cái)?shù)據(jù)
名稱 |
類(lèi)型 |
示例值 |
描述 |
RequestId | String | C458B1E8-1683-3645-B154-6BA32080EEA | 請(qǐng)求ID。 |
PageNumber | Integer | 1 | 頁(yè)面下標(biāo)。 |
PageSize | Integer | 30 | 頁(yè)面大小。 |
TotalNumber | Integer | 30 | 總數(shù)。 |
DBInstances | Array of DBInstance | 實(shí)例列表。 |
|
Type | String | ReadWrite | 實(shí)例類(lèi)型:
|
Status | String | Running | 實(shí)例狀態(tài),詳情請(qǐng)參見(jiàn)實(shí)例狀態(tài)表。 |
CommodityCode | String | drds_polarxpre_public_cn | 商品類(lèi)型。 |
ExpireTime | String | 2021-12-01T16:00:00.000+0000 | 過(guò)期時(shí)間。 |
Expired | Boolean | false | 是否過(guò)期。 |
CreateTime | String | 2021-11-01T03:49:50.000+0000 | 創(chuàng)建時(shí)間。 |
PayType | String | Prepaid | 實(shí)例付費(fèi)方式,取值:
|
LockReason | String | 欠費(fèi) | 鎖定原因。 |
DBType | String | polarx | 數(shù)據(jù)庫(kù)類(lèi)型。 |
LockMode | String | Unlock | 是否鎖定。 |
VPCId | String | VPCID | VPC ID。 |
MinorVersion | String | polarx-kernel_5.4.12-16349923_xcluster-20210926 | 當(dāng)前內(nèi)核版本。 |
RegionId | String | cn-hangzhou | 地域ID。 |
Network | String | VPC | 網(wǎng)絡(luò)類(lèi)型。 |
DBVersion | String | 5.7 | 數(shù)據(jù)庫(kù)版本。 |
Description | String | 測(cè)試 | 數(shù)據(jù)庫(kù)描述。 |
NodeClass | String | polarx.x4.large.2e | 規(guī)格。 |
StorageUsed | Long | 40658534400 | 存儲(chǔ)使用。 |
NodeCount | Integer | 5 | 節(jié)點(diǎn)個(gè)數(shù)。 |
ZoneId | String | cn-hangzhou-g | 可用區(qū)ID。 |
Engine | String | polarx | 引擎型號(hào)。 |
Id | String | pxc-hzr2yeov****** | 實(shí)例ID。 |
Nodes | Array of PolarDBXNode | 節(jié)點(diǎn)列表。 |
|
ZoneId | String | cn-hangzhou-g | 可用區(qū)ID。 |
Id | String | pxi-zd89wrzqh****** | 節(jié)點(diǎn)ID。 |
ClassCode | String | polarx.x4.large.2e | 實(shí)例規(guī)格。 |
RegionId | String | cn-hangzhou-g-aliyun | 區(qū)域ID。 |
ReadDBInstances | Array of String | pxr-hzr2yeov****** | 只讀實(shí)例名稱。 |
ColumnarReadDBInstances | Array of String | xxxxxxxx | 列存只讀實(shí)例信息。 |
ResourceGroupId | String | rg-xxxxxx | 資源組ID |
TagSet | Array of TagSet | 標(biāo)簽集合。 |
|
Key | String | key1 | 標(biāo)簽名稱。 |
Value | String | value1 | 標(biāo)簽值。 |
DBInstanceName | String | pxc-xxxxx | 數(shù)據(jù)庫(kù)實(shí)例名稱。 |
DnNodeCount | Integer | 2 | DN節(jié)點(diǎn)個(gè)數(shù)。 |
CnNodeCount | Integer | 2 | CN節(jié)點(diǎn)個(gè)數(shù)。 |
CnNodeClassCode | String | polarx.x4.large.2e | CN節(jié)點(diǎn)規(guī)格。
|
DnNodeClassCode | String | mysql.n4.medium.25 | DN節(jié)點(diǎn)規(guī)格。
|
Series | String | enterprise | 實(shí)例系列,取值如下:
|
ContainBinlogX | Boolean | true | 是否包含多流日志服務(wù),取值如下:
|
SupportBinlogX | Boolean | true | 當(dāng)前實(shí)例是否支持多流,取值如下:
|
CdcInstanceName | String | pxc-c-dmlgit**** | 日志節(jié)點(diǎn)名稱。 |
TopologyType | String | 3azones | 拓?fù)漕?lèi)型:
|
TertiaryZone | String | cn-hangzhou-k | 第三可用區(qū)。 |
PrimaryZone | String | cn-hangzhou-j | 主可用區(qū)。 |
SecondaryZone | String | cn-hangzhou-l | 次可用區(qū)。 |
ColumnarInstanceName | String | xxxxxxxx | 列存引擎實(shí)例名稱。 |
示例
請(qǐng)求示例
http(s)://[Endpoint]/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=20
&ResourceGroupId=rg-acfmyst47******
&Tags=[{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}]
&InstanceId=dinga93c84f4d***
&Series=enterprise
&MustHasCdc=true
&公共請(qǐng)求參數(shù)
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstancesResponse>
<RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
<PageNumber>1</PageNumber>
<PageSize>30</PageSize>
<TotalNumber>30</TotalNumber>
<DBInstances>
<Type>ReadWrite</Type>
<Status>Running</Status>
<CommodityCode>drds_polarxpre_public_cn</CommodityCode>
<ExpireTime>2021-12-01T16:00:00.000+0000</ExpireTime>
<Expired>false</Expired>
<CreateTime>2021-11-01T03:49:50.000+0000</CreateTime>
<PayType>Prepaid</PayType>
<LockReason>欠費(fèi)</LockReason>
<DBType>polarx</DBType>
<LockMode>Unlock</LockMode>
<VPCId>VPCID</VPCId>
<MinorVersion>polarx-kernel_5.4.12-16349923_xcluster-20210926</MinorVersion>
<RegionId>cn-hangzhou</RegionId>
<Network>VPC</Network>
<DBVersion>5.7</DBVersion>
<Description>測(cè)試</Description>
<NodeClass>polarx.x4.large.2e</NodeClass>
<StorageUsed>40658534400</StorageUsed>
<NodeCount>5</NodeCount>
<ZoneId>cn-hangzhou-g</ZoneId>
<Engine>polarx</Engine>
<Id>pxc-hzr2yeov******</Id>
<Nodes>
<ZoneId>cn-hangzhou-g</ZoneId>
<Id>pxi-zd89wrzqh******</Id>
<ClassCode>polarx.x4.large.2e</ClassCode>
<RegionId>cn-hangzhou-g-aliyun</RegionId>
</Nodes>
<ReadDBInstances>pxr-hzr2yeov******</ReadDBInstances>
<ResourceGroupId>rg-xxxxxx</ResourceGroupId>
<TagSet>
<Key>key1</Key>
<Value>value1</Value>
</TagSet>
<DBInstanceName>pxc-xxxxx</DBInstanceName>
<DnNodeCount>2</DnNodeCount>
<CnNodeCount>2</CnNodeCount>
<CnNodeClassCode>polarx.x4.large.2e</CnNodeClassCode>
<DnNodeClassCode>mysql.n4.medium.25</DnNodeClassCode>
<Series>enterprise</Series>
<ContainBinlogX>true</ContainBinlogX>
<SupportBinlogX>true</SupportBinlogX>
<CdcInstanceName>pxc-c-dmlgit****</CdcInstanceName>
<TopologyType>3azones</TopologyType>
<TertiaryZone>cn-hangzhou-k</TertiaryZone>
<PrimaryZone>cn-hangzhou-j</PrimaryZone>
<SecondaryZone>cn-hangzhou-l</SecondaryZone>
<ColumnarInstanceName>xxxxx</ColumnarInstanceName>
</DBInstances>
</DescribeDBInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
"PageNumber" : 1,
"PageSize" : 30,
"TotalNumber" : 30,
"DBInstances" : [ {
"Type" : "ReadWrite",
"Status" : "Running",
"CommodityCode" : "drds_polarxpre_public_cn",
"ExpireTime" : "2021-12-01T16:00:00.000+0000",
"Expired" : false,
"CreateTime" : "2021-11-01T03:49:50.000+0000",
"PayType" : "Prepaid",
"LockReason" : "欠費(fèi)",
"DBType" : "polarx",
"LockMode" : "Unlock",
"VPCId" : "VPCID",
"MinorVersion" : "polarx-kernel_5.4.12-16349923_xcluster-20210926",
"RegionId" : "cn-hangzhou",
"Network" : "VPC",
"DBVersion" : "5.7",
"Description" : "測(cè)試",
"NodeClass" : "polarx.x4.large.2e",
"StorageUsed" : 40658534400,
"NodeCount" : 5,
"ZoneId" : "cn-hangzhou-g",
"Engine" : "polarx",
"Id" : "pxc-hzr2yeov******",
"Nodes" : [ {
"ZoneId" : "cn-hangzhou-g",
"Id" : "pxi-zd89wrzqh******",
"ClassCode" : "polarx.x4.large.2e",
"RegionId" : "cn-hangzhou-g-aliyun"
} ],
"ReadDBInstances" : [ "pxr-hzr2yeov******" ],
"ColumnarReadDBInstances" : [ ],
"ResourceGroupId" : "rg-xxxxxx",
"TagSet" : [ {
"Key" : "key1",
"Value" : "value1"
} ],
"DBInstanceName" : "pxc-xxxxx",
"DnNodeCount" : 2,
"CnNodeCount" : 2,
"CnNodeClassCode" : "polarx.x4.large.2e",
"DnNodeClassCode" : "mysql.n4.medium.25",
"Series" : "enterprise",
"ContainBinlogX" : true,
"SupportBinlogX" : true,
"CdcInstanceName" : "pxc-c-dmlgit****",
"TopologyType" : "3azones",
"TertiaryZone" : "cn-hangzhou-k",
"PrimaryZone" : "cn-hangzhou-j",
"SecondaryZone" : "cn-hangzhou-l",
"ColumnarInstanceName" : "xxxxx"
} ]
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。