调用DescribeDBInstances接口查询实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
polardbx:DescribeDBInstances |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
实例所属地域 ID。 |
cn-hangzhou |
| PageNumber |
integer |
否 |
分页下标：从 1 开始。 |
1 |
| PageSize |
integer |
否 |
页面大小，取值如下：
|
30 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-acfmyst47****** |
| Tags |
string |
否 |
标签列表。 |
[{\"TagKey\":\"test\",\"TagValue\":\"test-value\"}] |
| InstanceId |
string |
否 |
实例 ID。 |
dinga93c84f4d*** |
| Series |
string |
否 |
实例系列，取值如下：
|
enterprise |
| MustHasCdc |
boolean |
否 |
是否必须有日志引擎。 |
true |
| DbVersion |
string |
否 |
||
| Description |
string |
否 |
数据库描述/备注 |
app-test |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息列表。 |
||
| RequestId |
string |
请求 ID。 |
C458B1E8-1683-3645-B154-6BA32080EEA |
| PageNumber |
integer |
页面下标。 |
1 |
| PageSize |
integer |
页面大小。 |
30 |
| TotalNumber |
integer |
总数。 |
30 |
| DBInstances |
array<object> |
实例列表。 |
|
|
array<object> |
实例详情。 |
||
| Type |
string |
实例类型：
|
ReadWrite |
| Status |
string |
实例状态，详情请参见实例状态表。 |
Running |
| CommodityCode |
string |
商品类型。 |
drds_polarxpre_public_cn |
| ExpireTime |
string |
过期时间。 |
2021-12-01T16:00:00.000+0000 |
| Expired |
boolean |
是否过期。 |
false |
| CreateTime |
string |
创建时间。 |
2021-11-01T03:49:50.000+0000 |
| PayType |
string |
实例付费方式，取值：
|
Prepaid |
| LockReason |
string |
锁定原因。 |
欠费 |
| DBType |
string |
数据库类型。 |
polarx |
| LockMode |
string |
是否锁定。 |
Unlock |
| VPCId |
string |
VPC ID。 |
VPCID |
| MinorVersion |
string |
当前内核版本。 |
polarx-kernel_5.4.12-16349923_xcluster-20210926 |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| Network |
string |
网络类型。 |
VPC |
| DBVersion |
string |
数据库版本。 |
5.7 |
| Description |
string |
数据库描述。 |
测试 |
| NodeClass |
string |
规格。 |
polarx.x4.large.2e |
| StorageUsed |
integer |
存储使用。 |
40658534400 |
| NodeCount |
integer |
节点个数。 |
5 |
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-g |
| Engine |
string |
引擎型号。 |
polarx |
| Id |
string |
实例 ID。 |
pxc-hzr2yeov****** |
| Nodes |
array<object> |
节点列表。 |
|
|
object |
节点列表。 |
||
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-g |
| Id |
string |
节点 ID。 |
pxi-zd89wrzqh****** |
| RegionId |
string |
区域 ID。 |
cn-hangzhou-g-aliyun |
| ClassCode |
string |
实例规格。 |
polarx.x4.large.2e |
| Name |
string |
||
| ReadDBInstances |
array |
只读实例列表。 |
|
|
string |
只读实例名称。 |
pxr-hzr2yeov****** |
|
| ColumnarReadDBInstances |
array |
列存只读实例信息。 |
|
|
string |
列存只读实例信息。 |
xxxxxxxx |
|
| ResourceGroupId |
string |
资源组 ID |
rg-xxxxxx |
| TagSet |
array<object> |
标签集合。 |
|
|
object |
标签集合。 |
||
| Key |
string |
标签名称。 |
key1 |
| Value |
string |
标签值。 |
value1 |
| DBInstanceName |
string |
数据库实例名称。 |
pxc-xxxxx |
| DnNodeCount |
integer |
DN 节点个数。 |
2 |
| CnNodeCount |
integer |
CN 节点个数。 |
2 |
| CnNodeClassCode |
string |
CN 节点规格。
|
polarx.x4.large.2e |
| DnNodeClassCode |
string |
DN 节点规格。
|
mysql.n4.medium.25 |
| Series |
string |
实例系列，取值如下：
|
enterprise |
| ContainBinlogX |
boolean |
是否包含多流日志服务，取值如下：
|
true |
| SupportBinlogX |
boolean |
当前实例是否支持多流，取值如下：
|
true |
| CdcInstanceName |
string |
日志节点名称。 |
pxc-c-dmlgit**** |
| TopologyType |
string |
拓扑类型：
|
3azones |
| TertiaryZone |
string |
第三可用区。 |
cn-hangzhou-k |
| PrimaryZone |
string |
主可用区。 |
cn-hangzhou-j |
| SecondaryZone |
string |
次可用区。 |
cn-hangzhou-l |
| ColumnarInstanceName |
string |
列存引擎实例名称。 |
xxxxxxxx |
| isInGdn |
boolean |
||
| gdnRole |
string |
||
| CpuType |
string |
||
| PrimaryInstanceId |
string |
||
| StorageType |
string |
||
| EngineVersion |
string |
示例
正常返回示例
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": "欠费",
"DBType": "polarx",
"LockMode": "Unlock",
"VPCId": "VPCID",
"MinorVersion": "polarx-kernel_5.4.12-16349923_xcluster-20210926",
"RegionId": "cn-hangzhou",
"Network": "VPC",
"DBVersion": "5.7",
"Description": "测试",
"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******",
"RegionId": "cn-hangzhou-g-aliyun",
"ClassCode": "polarx.x4.large.2e",
"Name": ""
}
],
"ReadDBInstances": [
"pxr-hzr2yeov******"
],
"ColumnarReadDBInstances": [
"xxxxxxxx"
],
"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": "xxxxxxxx",
"isInGdn": true,
"gdnRole": "",
"CpuType": "",
"PrimaryInstanceId": "",
"StorageType": "",
"EngineVersion": ""
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。