文档

DescribeDBInstances - 查询实例

更新时间:

查询实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
selectdb:DescribeDBInstanceslist
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

资源组 ID。

rg-4690g37929****
DBInstanceIdsstring

实例 ID,多个实例 ID 之间用英文逗号(,)分隔。

selectdb-cn-7213cjv****
DBInstanceStatusstring

实例的状态,取值说明:

  • CREATING:创建中。

  • ACTIVATION:运行中。

  • RESOURCE_CHANGING:变配中。

  • ORDER_PREPARING:订单确认中。

  • READONLY_RESOURCE_CHANGING:资源变配中(实例写入锁定)。

  • DELETING:删除中。

ACTIVATION
DBInstanceDescriptionstring

实例备注信息。

新建实例测试
PageSizelong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageNumberlong

页数。

1
RegionIdstring

地域 ID。

cn-hangzhou
Tagarray<object>

实例标签列表信息。

object

实例标签列表。

Keystring

标签键。

testKey
Valuestring

标签值。

testValue

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

BC854513-E85E-54F3-9842-B9CCD3308CDD
PageNumberlong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
PageSizelong

页数。

1
TotalRecordCountlong

总记录数。

2
Itemsarray<object>

实例详情列表。

object

实例详情列表。

connectionStringstring

连接地址。

暂不返回
DBInstanceIdstring

实例 ID。

selectdb-cn-7213cjv****
Descriptionstring

实例备注信息。

新建实例测试
Enginestring

数据库类型。

selectdb
EngineVersionstring

数据库版本。

2.4
InstanceUsedTypestring

实例使用类型。

Instance
RegionIdstring

地域 ID。

cn-hangzhou
ZoneIdstring

可用区 ID。

cn-hangzhou-i
ChargeTypestring

实例的付费类型。取值:

  • Postpaid:后付费(按量付费)

  • Prepaid:预付费(包年包月)

PrePaid
Categorystring

实例的系列,默认为基础版(basic)。

basic
Statusstring

实例的状态,取值说明:

  • CREATING:创建中。

  • ACTIVATION:运行中。

  • RESOURCE_CHANGING:变配中。

  • ORDER_PREPARING:订单确认中。

  • READONLY_RESOURCE_CHANGING:资源变配中(实例写入锁定)。

  • DELETING:删除中。

ACTIVATION
VpcIdstring

VPC ID。

vpc-bp175iuvg8nxqraf2****
VswitchIdstring

交换机 ID。

vsw-bp1gzt31twhlo0sa5****
ResourceCpulong

资源 CPU。

8
ResourceMemorylong

资源内存。

64
ScaleMinlong

实例 RCU(RDS Capacity Unit)自动扩缩范围的最小值。

0
ScaleMaxlong

实例 RCU(RDS Capacity Unit)的自动扩缩范围最大值。

0
ScaleReplicalong

多余字段。

StorageSizelong

存储空间大小。

100
StorageTypestring

实例存储类型。

cloud_essd
ObjectStoreSizelong

实例存储大小,单位:GB。

200
ExpireTimestring

集群到期时间。

说明 仅付费方式为 Prepaid(包年包月)的集群会返回具体参数值,Postpaid(按量付费)集群则返回空值。
2024-03-29T03:47:05Z
LockModelong

实例锁定模式。

0
LockReasonstring

被锁定的原因。

nolock
IsDeletedboolean

实例是否已删除,取值说明:

  • true:删除。

  • fasle:未删除。

false
MaintainStarttimestring

实例可维护时间的开始时间。

保留参数,暂不返回
MaintainEndtimestring

实例可维护时间的结束时间。

保留参数,暂不返回
GmtCreatedstring

任务创建时间(GMT)。

2023-08-12T04:14Z
GmtModifiedstring

任务修改时间(GMT)。

2023-08-12T19:05Z
ParentInstancestring

创建时间。

保留参数,暂不返回
ResourceGroupIdstring

资源组 ID。

保留参数,暂不返回
MaintainStartTimeStrstring

可维护时间的开始时间戳。

保留参数,暂不返回
MaintainEndTimeStrstring

可维护时间的结束时间戳。

保留参数,暂不返回
TenantClusterIdstring

prometheus 监控集群 ID。

保留参数,暂不返回
TenantTokenstring

prometheus 监控接入 Token。

保留参数,暂不返回
TenantUserIdstring

prometheus 监控用户账号 label。

保留参数,暂不返回
Tagsarray<object>

实例标签列表信息。

object

实例标签列表。

TagKeystring

标签键。

testKey
TagValuestring

标签值。

testValue
ClusterCountinteger

总集群数。

1

示例

正常返回示例

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
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidPageNumber.MalformedThe specified parameter "PageNumber" is not valid.每页记录数参数不合法。
400DocumentConvertFailed.ExceedFileSizeLimitThe conversion has been failed, exceed file size limit.文档转换失败,文件大小超过系统限额。
400ForbiddenUser not authorized to operate on the specified resource, or this API does not support RAM.子账号权限不足,请先获取授权。
400InvalidDBNameThe specified database name is not allowed.数据库名称不符合要求,请确认数据名称是否正确。
400CreateOrderFailedFailed to create order.创建订单失败。
403DBClusterNotSupportedThe requested operation can not be performed while the cluster is not sale.当集群未运行时,无法执行请求的操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403InstanceEngineType.NotSupportThe instance engine and type does not support operations.操作失败,实例引擎和类型不支持该操作。
403InvalidDBInstanceState.NotSupportThe specified instance state does't support this operation.指定的实例状态不支持此操作。
403MoneyLessThan100The Account Monet less Than 100.当前阿里云账号余额不足100,请充值。
403OperationDenied.DBNameAndAccountPrivilegeCountThe operation is not permitted due to count of database or account privilege.操作失败,数据库与权限的数量不一致。
403InsufficientResourceCapacityThe resource is out of usage.资源不足,请您稍后再试。
404DBInstanceLockedThe current instance lock mode does not support this operation.操作失败,当前实例已锁定。
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.交换机参数无效。
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确,请注意确认大小写。
404InvalidDBInstance.NotFoundThe specified instance is not found.没有找到指定的实例,请检查实例的正确性。
404InvalidDBInstanceClass.NotFoundThe specified instance classic does not exist.当前选择的配置或规格不存在或已停售,请重新选择。
404InvalidRegionId.NotFoundThe provided RegionId does not exist in our records.操作失败,输入的地域及可用区不存在。
404QueryPrice.FailedThe inquiry failed. Contact Alibaba Cloud customer service representatives.询价失败,请联系客服同学。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-24OpenAPI 错误码发生变更查看变更详情
2024-06-12OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-12-27OpenAPI 返回结构发生变更查看变更详情