查询实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
selectdb:DescribeDBInstances |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceGroupId |
string |
否 |
资源组 ID。 |
rg-4690g37929**** |
| DBInstanceIds |
string |
否 |
实例 ID，多个实例 ID 之间用英文逗号（,）分隔。 |
selectdb-cn-7213cjv**** |
| DBInstanceStatus |
string |
否 |
实例的状态，取值说明：
|
ACTIVATION |
| DBInstanceDescription |
string |
否 |
实例备注信息。 |
新建实例测试 |
| PageSize |
integer |
否 |
每页记录数，取值：
|
30 |
| PageNumber |
integer |
否 |
页数。 |
1 |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| Tag |
array<object> |
否 |
实例标签列表信息。 |
|
|
object |
否 |
实例标签列表。 |
||
| Key |
string |
否 |
标签键。 |
testKey |
| Value |
string |
否 |
标签值。 |
testValue |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
BC854513-E85E-54F3-9842-B9CCD3308CDD |
| PageNumber |
integer |
每页记录数，取值：
|
30 |
| PageSize |
integer |
页数。 |
1 |
| TotalRecordCount |
integer |
总记录数。 |
2 |
| Items |
array<object> |
实例详情列表。 |
|
|
object |
实例详情列表。 |
||
| connectionString |
string |
连接地址。 |
暂不返回 |
| DBInstanceId |
string |
实例 ID。 |
selectdb-cn-7213cjv**** |
| Description |
string |
实例备注信息。 |
新建实例测试 |
| Engine |
string |
数据库类型。 |
selectdb |
| EngineVersion |
string |
数据库版本。 |
2.4 |
| InstanceUsedType |
string |
实例使用类型。 |
Instance |
| RegionId |
string |
地域 ID。 |
cn-hangzhou |
| ZoneId |
string |
可用区 ID。 |
cn-hangzhou-i |
| ChargeType |
string |
实例的付费类型。取值：
|
PrePaid |
| Category |
string |
实例的系列，默认为基础版（basic）。 |
basic |
| Status |
string |
实例的状态，取值说明：
|
ACTIVATION |
| VpcId |
string |
VPC ID。 |
vpc-bp175iuvg8nxqraf2**** |
| VswitchId |
string |
交换机 ID。 |
vsw-bp1gzt31twhlo0sa5**** |
| ResourceCpu |
integer |
资源 CPU。 |
8 |
| ResourceMemory |
integer |
资源内存。 |
64 |
| ScaleMin |
integer |
实例 RCU（RDS Capacity Unit）自动扩缩范围的最小值。 |
0 |
| ScaleMax |
integer |
实例 RCU（RDS Capacity Unit）的自动扩缩范围最大值。 |
0 |
| ScaleReplica |
integer |
多余字段。 |
空 |
| StorageSize |
integer |
存储空间大小。 |
100 |
| StorageType |
string |
实例存储类型。 |
cloud_essd |
| ObjectStoreSize |
integer |
实例存储大小，单位：GB。 |
200 |
| ExpireTime |
string |
集群到期时间。 说明
仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。 |
2024-03-29T03:47:05Z |
| LockMode |
integer |
实例锁定模式。 |
0 |
| LockReason |
string |
被锁定的原因。 |
nolock |
| IsDeleted |
boolean |
实例是否已删除，取值说明：
|
false |
| MaintainStarttime |
string |
实例可维护时间的开始时间。 |
保留参数，暂不返回 |
| MaintainEndtime |
string |
实例可维护时间的结束时间。 |
保留参数，暂不返回 |
| GmtCreated |
string |
任务创建时间（GMT）。 |
2023-08-12T04:14Z |
| GmtModified |
string |
任务修改时间（GMT）。 |
2023-08-12T19:05Z |
| ParentInstance |
string |
创建时间。 |
保留参数，暂不返回 |
| ResourceGroupId |
string |
资源组 ID。 |
保留参数，暂不返回 |
| MaintainStartTimeStr |
string |
可维护时间的开始时间戳。 |
保留参数，暂不返回 |
| MaintainEndTimeStr |
string |
可维护时间的结束时间戳。 |
保留参数，暂不返回 |
| TenantClusterId |
string |
prometheus 监控集群 ID。 |
保留参数，暂不返回 |
| TenantToken |
string |
prometheus 监控接入 Token。 |
保留参数，暂不返回 |
| TenantUserId |
string |
prometheus 监控用户账号 label。 |
保留参数，暂不返回 |
| Tags |
array<object> |
实例标签列表信息。 |
|
|
object |
实例标签列表。 |
||
| TagKey |
string |
标签键。 |
testKey |
| TagValue |
string |
标签值。 |
testValue |
| ClusterCount |
integer |
总集群数。 |
1 |
| DeployScheme |
string |
实例部署模式：
|
single_az |
| MultiZone |
array<object> |
多可用区配置。 |
|
|
object |
多可用区列表。 |
||
| ZoneId |
string |
可用区 ID。 |
cn-beijing-k |
| VSwitchIds |
array |
交换机 ID 列表。 |
|
|
string |
交换机 ID。 |
vsw-bp1pla4vl8bs9uw9c7l2w |
|
| EngineMinorVersion |
string |
实例的内核小版本号。 |
4.0.4 |
| Serverless |
boolean |
示例
正常返回示例
JSON格式
{
"RequestId": "BC854513-E85E-54F3-9842-B9CCD3308CDD",
"PageNumber": 30,
"PageSize": 1,
"TotalRecordCount": 2,
"Items": [
{
"connectionString": "暂不返回",
"DBInstanceId": "selectdb-cn-7213cjv****",
"Description": "新建实例测试",
"Engine": "selectdb",
"EngineVersion": "2.4",
"InstanceUsedType": "Instance",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"ChargeType": "PrePaid",
"Category": "basic",
"Status": "ACTIVATION",
"VpcId": "vpc-bp175iuvg8nxqraf2****",
"VswitchId": "vsw-bp1gzt31twhlo0sa5****",
"ResourceCpu": 8,
"ResourceMemory": 64,
"ScaleMin": 0,
"ScaleMax": 0,
"ScaleReplica": 0,
"StorageSize": 100,
"StorageType": "cloud_essd",
"ObjectStoreSize": 200,
"ExpireTime": "2024-03-29T03:47:05Z",
"LockMode": 0,
"LockReason": "nolock",
"IsDeleted": false,
"MaintainStarttime": "保留参数，暂不返回",
"MaintainEndtime": "保留参数，暂不返回",
"GmtCreated": "2023-08-12T04:14Z\n",
"GmtModified": "2023-08-12T19:05Z",
"ParentInstance": "保留参数，暂不返回",
"ResourceGroupId": "保留参数，暂不返回",
"MaintainStartTimeStr": "保留参数，暂不返回",
"MaintainEndTimeStr": "保留参数，暂不返回",
"TenantClusterId": "保留参数，暂不返回\n",
"TenantToken": "保留参数，暂不返回\n",
"TenantUserId": "保留参数，暂不返回\n",
"Tags": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
],
"ClusterCount": 1,
"DeployScheme": "single_az",
"MultiZone": [
{
"ZoneId": "cn-beijing-k",
"VSwitchIds": [
"vsw-bp1pla4vl8bs9uw9c7l2w"
]
}
],
"EngineMinorVersion": "4.0.4",
"Serverless": true
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidPageNumber.Malformed | The specified parameter "PageNumber" is not valid. | 每页记录数参数不合法。 |
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | 文档转换失败，文件大小超过系统限额。 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | 子账号权限不足，请先获取授权。 |
| 400 | InvalidDBName | The specified database name is not allowed. | 数据库名称不符合要求，请确认数据名称是否正确。 |
| 400 | CreateOrderFailed | Failed to create order. | 创建订单失败。 |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | 当集群未运行时，无法执行请求的操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | 操作失败，实例引擎和类型不支持该操作。 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | 指定的实例状态不支持此操作。 |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | 当前阿里云账号余额不足100，请充值。 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | 操作失败，数据库与权限的数量不一致。 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | 资源不足，请您稍后再试。 |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | 操作失败，当前实例已锁定。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | 没有找到指定的实例，请检查实例的正确性。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | 当前选择的配置或规格不存在或已停售，请重新选择。 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | 操作失败，输入的地域及可用区不存在。 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | 询价失败，请联系客服同学。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。