调用DescribeDBInstances查询实例列表_云数据库 RDS(RDS)-阿里云帮助中心

该接口用于查询RDS的实例列表。

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rds:DescribeDBInstances	get	*DBInstance `acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}`	rds:ResourceTag	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。	ETnLKlblzczshOTUbOCz****
proxyId	string	否	废弃参数，无需配置。	API
Engine	string	否	数据库类型，取值： MySQL SQLServer PostgreSQL MariaDB 默认返回所有数据库类型。	MySQL
ZoneId	string	否	可用区 ID。	cn-hangzhou-a
ResourceGroupId	string	否	资源组 ID。	rg-acfmy****
DBInstanceStatus	string	否	实例状态，详情请参见实例状态表。	Running
Expired	string	否	实例的过期状态，取值： True：已过期 False：未过期	True
SearchKey	string	否	可基于实例 ID 或者实例备注模糊搜索。	rm-uf6w
DBInstanceId	string	否	实例 ID。	rm-uf6wjk5****
DBInstanceType	string	否	实例类型，取值： Primary：主实例 Readonly：只读实例 Guard：灾备实例 Temp：临时实例默认返回所有实例类型。	Primary
RegionId	string	是	地域 ID。可调用 DescribeRegions 获取。	cn-hangzhou
PageSize	integer	否	每页记录数，取值：1~100。默认值：30。	30
PageNumber	integer	否	页码，取值：大于 0 且不超过 Integer 的最大值。默认值：1。	1
InstanceNetworkType	string	否	实例的网络类型，取值： VPC：专有网络下的实例 Classic：经典网络下的实例默认返回所有网络类型下的实例。	Classic
VpcId	string	否	VPC ID。	vpc-uf6f7l4fg90****
VSwitchId	string	否	交换机 ID。	vsw-uf6adz52c2p****
DBInstanceClass	string	否	实例规格，详见实例规格表。	rds.mys2.small
EngineVersion	string	否	数据库版本。	8.0
PayType	string	否	付费类型，取值： Postpaid：按量付费 Prepaid：包年包月	Postpaid
ConnectionMode	string	否	实例的访问模式，取值： Standard：标准访问模式 Safe：数据库代理模式默认返回所有访问模式下的实例。	Standard
Tags	string	否	查询绑定有该标签的实例，包括 TagKey 和 TagValue。单次最多支持传入 5 组值，格式：{"key1":"value1","key2":"value2"...}。	{"key1":"value1"}
DedicatedHostGroupId	string	否	专属集群 ID。	dhg-7a9****
DedicatedHostId	string	否	专属集群内的主机 ID。	i-bp****
InstanceLevel	integer	否	是否返回实例系列（Category）信息，取值： 0：不返回 1：返回	0
ConnectionString	string	否	实例的连接地址。通过该连接地址查询对应的实例。	rm-uf6wjk5****.mysql.rds.aliyuncs.com
NextToken	string	否	翻页凭证。取值为上一次调用 DescribeDBInstances 接口时返回的 NextToken 参数值。如果调用结果分多页展示，再次调用接口时传入该值便可以展示下一页的内容。	o7PORW5o2TJg****
MaxResults	integer	否	每页记录数。取值：1~100。默认值：30。说明传入该参数，则 PageSize 和 PageNumber 参数不可用。	30
Filter	string	否	实例过滤条件参数及其值的 JSON 串	{"babelfishEnabled":"true"}
Category	string	否	实例的系列。取值： Basic：基础系列 HighAvailability：高可用系列 cluster：集群系列 serverless_basic：Serverless	cluster

本接口支持如下两种方式查看返回数据：

方式一：通过传入 MaxResults 参数设置每页的记录数，再通过 NextToken 参数设置翻页凭证来展示下一页的内容。NextToken 取值为上一次调用 DescribeDBInstances 接口返回的 NextToken 参数值。

说明首次调用接口进行分页查询时，您只需设置 MaxResults 参数，接口会返回第一页的数据和 NextToken 参数值。

方式二：通过 PageSize 参数设置每页的记录数，通过 PageNumber 参数进行翻页。

说明上述两种方式只能任选其一。当返回的记录数较多时，推荐使用方式一，可以获得更快的查询速度。

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
Items	array<object>	实例信息列表。
DBInstance	object	实例详情。
BpeEnabled	string	弃用参数。	0
BurstingEnabled	boolean	是否已开启 IO 突发。取值： true：已开启 false：未开启	false
Category	string	实例系列： Basic：基础系列 HighAvailability：高可用系列 Finance：三节点企业系列说明仅在 InstanceLevel 参数为 1 时返回。	Basic
ColdDataEnabled	boolean	预留参数。	false
ConnectionMode	string	实例的访问模式，取值： Standard：标准访问模式 Safe：数据库代理模式	Standard
ConnectionString	string	实例的连接地址。	rm-uf6wjk5****.mysql.rds.aliyuncs.com
CreateTime	string	创建时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2018-11-05T11:26:02Z
DBInstanceCPU	string	实例 CPU 数量。说明仅在 InstanceLevel 参数为 1 时返回。	2
DBInstanceClass	string	实例规格，详见实例规格表。	rds.mys2.small
DBInstanceDescription	string	实例描述。	testdb
DBInstanceId	string	实例 ID。	rm-uf6wjk5****
DBInstanceMemory	integer	节点的内存大小。单位：MB。说明仅在 InstanceLevel 参数为 1 时返回。	4096
DBInstanceNetType	string	实例的网络连接类型，取值： Internet：外网连接 Intranet：内网连接	Internet
DBInstanceStatus	string	实例状态，详情请参见实例状态表。	Running
DBInstanceStorageType	string	实例储存类型。	ModuleList.4.ModuleCode
DBInstanceType	string	实例类型，取值： Primary：主实例 Readonly：只读实例 Guard：灾备实例 Temp：临时实例	Primary
DedicatedHostGroupId	string	专属集群 ID。	dhg-7a9****
DedicatedHostGroupName	string	专属集群名称。	testhostgroup
DedicatedHostIdForLog	string	Log 节点所在主机的 ID。	dh-bp****
DedicatedHostIdForMaster	string	Master 节点所在主机的 ID。	dh-bp****
DedicatedHostIdForSlave	string	Slave 节点所在主机的 ID。	dh-bp****
DedicatedHostNameForLog	string	Log 节点所在主机的名称。	testlog
DedicatedHostNameForMaster	string	Master 节点所在主机的名称。	testmaster
DedicatedHostNameForSlave	string	Slave 节点所在主机的名称。	testslave
DedicatedHostZoneIdForLog	string	Log 节点所在主机的可用区 ID。	cn-hangzhou-b
DedicatedHostZoneIdForMaster	string	Master 节点所在主机的可用区 ID。	cn-hangzhou-c
DedicatedHostZoneIdForSlave	string	Slave 节点所在主机的可用区 ID。	cn-hangzhou-d
DeletionProtection	boolean	是否已开启释放保护功能。取值： true：已开启 false：未开启	false
DestroyTime	string	销毁时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2018-11-05T11:26:02Z
Engine	string	数据库类型。	MySQL
EngineVersion	string	数据库版本。	5.7
ExpireTime	string	到期时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。说明按量付费实例无到期时间。	2019-02-27T16:00:00Z
GeneralGroupName	string	专属集群 MySQL 通用版实例所属的组名。	TestGroup
GuardDBInstanceId	string	主实例如果有灾备实例，该参数即为灾备实例的 ID。	rm-uf64zsu****
InstanceNetworkType	string	实例的网络类型，取值： Classic：经典网络 VPC：VPC 网络	Classic
IoAccelerationEnabled	string	是否开启 IO 加速。取值含义如下： 1：已开启 0：未开启	0
LockMode	string	实例的锁定状态。取值： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：实例过期自动锁定。 LockByRestoration：实例回滚前自动锁定。 LockByDiskQuota：实例空间满自动锁定。 Released：实例已释放。此时实例无法进行解锁，只能使用备份数据重新创建新实例，重建时间较长，请耐心等待。	Unlock
LockReason	string	实例被锁定的原因。	instance_expired
MasterInstanceId	string	主实例的 ID，如果没有返回此参数（即为 null）则表示该实例是主实例。	rm-uf6wjk5****
MutriORsignle	boolean	是否是组合可用区。取值： true false 说明组合可用区即带有 MAZ 字样的可用区。例如：`cn-hangzhou-MAZ10(h,i)`。	true
PayType	string	实例的付费类型，取值： Postpaid：按量付费 Prepaid：包年包月	Postpaid
ReadOnlyDBInstanceIds	array<object>	主实例下如果有只读实例，该参数为只读实例的 ID 列表。
ReadOnlyDBInstanceId	object	只读实例详情。
DBInstanceId	string	只读实例 ID。	rr-uf6wjk5****
RegionId	string	地域 ID。	cn-hangzhou
ResourceGroupId	string	资源组 ID。	rg-acfmy****
SwitchWeight	integer	当前专属集群 MySQL 通用版实例是否支持高可用权重切换。返回值： 100：支持切换。 0：不支持切换。	100
TempDBInstanceId	string	主实例如果有临时实例，该参数即为临时实例的 ID。	rm-uf64zsu****
Tips	string	专属集群 MySQL 通用版实例的异常提示信息。	normal
TipsLevel	integer	专属集群 MySQL 通用版实例的异常提示等级。返回值： 1：正常。 2：只读实例和主实例规格不对齐，可能影响可用性，请按需调整实例规格。	1
VSwitchId	string	交换机 ID。	vsw-uf6adz52c2p****
VpcCloudInstanceId	string	专有网络实例 ID。	rm-uf6wjk5****
VpcId	string	VPC ID。	vpc-uf6f7l4fg90****
VpcName	string	VPC 名称。	test-huadong
ZoneId	string	可用区 ID。	cn-hangzhou-a
NextToken	string	翻页凭证。如果调用结果分多页展示，再次调用接口时在 NextToken 处传入该值便可以展示下一页的内容。	o7PORW5o2TJg****
PageNumber	integer	页码。说明若您传入了 MaxResults 或 NextToken 参数，则本返回值仅会返回 1，您可直接忽略。	1
PageRecordCount	integer	当前页实例个数。	10
RequestId	string	请求 ID。	1AD222E9-E606-4A42-BF6D-8A4442913CEF
TotalRecordCount	integer	总记录数。说明若您传入了 MaxResults 或 NextToken 参数，则本返回值仅会显示当前页的记录数，您可直接忽略。	100

示例

正常返回示例

JSON格式

{
  "Items": {
    "DBInstance": [
      {
        "BpeEnabled": "0",
        "BurstingEnabled": false,
        "Category": "Basic",
        "ColdDataEnabled": false,
        "ConnectionMode": "Standard",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "CreateTime": "2018-11-05T11:26:02Z",
        "DBInstanceCPU": "2",
        "DBInstanceClass": "rds.mys2.small",
        "DBInstanceDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceMemory": 4096,
        "DBInstanceNetType": "Internet",
        "DBInstanceStatus": "Running",
        "DBInstanceStorageType": "ModuleList.4.ModuleCode",
        "DBInstanceType": "Primary",
        "DedicatedHostGroupId": "dhg-7a9****",
        "DedicatedHostGroupName": "testhostgroup",
        "DedicatedHostIdForLog": "dh-bp****",
        "DedicatedHostIdForMaster": "dh-bp****",
        "DedicatedHostIdForSlave": "dh-bp****",
        "DedicatedHostNameForLog": "testlog",
        "DedicatedHostNameForMaster": "testmaster",
        "DedicatedHostNameForSlave": "testslave",
        "DedicatedHostZoneIdForLog": "cn-hangzhou-b",
        "DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
        "DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
        "DeletionProtection": false,
        "DestroyTime": "2018-11-05T11:26:02Z",
        "Engine": "MySQL",
        "EngineVersion": "5.7",
        "ExpireTime": "2019-02-27T16:00:00Z",
        "GeneralGroupName": "TestGroup",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "InstanceNetworkType": "Classic",
        "IoAccelerationEnabled": "0",
        "LockMode": "Unlock",
        "LockReason": "instance_expired",
        "MasterInstanceId": "rm-uf6wjk5****",
        "MutriORsignle": true,
        "PayType": "Postpaid",
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rr-uf6wjk5****"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmy****",
        "SwitchWeight": 100,
        "TempDBInstanceId": "rm-uf64zsu****",
        "Tips": "normal",
        "TipsLevel": 1,
        "VSwitchId": "vsw-uf6adz52c2p****",
        "VpcCloudInstanceId": "rm-uf6wjk5****",
        "VpcId": "vpc-uf6f7l4fg90****",
        "VpcName": "test-huadong",
        "ZoneId": "cn-hangzhou-a"
      }
    ]
  },
  "NextToken": "o7PORW5o2TJg****",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "TotalRecordCount": 100
}

错误码

HTTP status code	错误码	错误信息	描述
400	Invalid.NextToken	The parameter NextToken is invalid.	参数NextToken无效。
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter DBInstanceType is not valid.	-
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	操作失败，参数OwnerAccount不合法，请检查。
400	TimeoutRetryLater	Timeout, Please retry later.	-
400	InvalidExpired.Format	The instance expiration status parameter is incorrect.	实例过期状态参数有误。
400	Abs.InvalidAccount.NotFound	account is not found.	账户不存在。
400	Abs.ImageNotFound	The specified Image is disabled or is deleted.	指定的镜像已经失效或已经被删除了。
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	套餐实例不允许单独操作。
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	定价计划价格结果没有找到。
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	您还未通过实名认证，不符合购买条件，请登录费用与成本进行实名认证。
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	您的账户可用额度小于0，请先充值后再尝试购买。
400	CommodityServiceCalling.Exception	Failed to call commodity service.	调用商品服务返回失败。
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	您购买的模块不合法，请重新购买。
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	客户您好，该地域已裁撤。
400	Price.CommoditySys	Commodity system call exception.	商品系统调用异常。
400	Pay.InsufficientBalance	Insufficient available balance.	可用金不足。
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	您选购的周期有问题，请重新选购。
400	pay.noCreditCard	Account not bound to credit card.	账户未绑定信用卡。
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	您选购的服务存在未支付订单，请支付或作废后再下单。
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	您的基本信息未完善，请在操作前先完善您的基本信息。
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	您的账户出现异常，详情请联系客服。
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	您的信息不完整，请在操作前填写您的信息。
400	Api.NotSupport	Specified api is not supported.	当前接口不支持。
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	存在禁止下单的标签，请联系您的分销商处理
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	提供的DBInstanceId不存在。
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	当前实例规格不支持该存储类型。
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400	KmsApiError	User secret key invalid.	用户密钥失效。
400	System.SaleValidateFailed	Sales expression validation system error.	销售表达式校验系统错误。
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	sql命令执行失败或执行超时
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	当前实例引擎版本不支持归档冷数据。
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	当前内核版本不支持归档冷数据。
400	IncorrectTargetClasscode	The current instance type does not support this operation.	当前规格不支持此操作。
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	链接地址名重复，请重新设置连接字符串。
400	RequiredParam.NotFound	Required input param is not found.	没有传入必要的参数。
400	Parameters.Invalid	Parameter error, please check the parameters.	参数错误，请检查参数。
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400	InvalideStatus.Format	The instance status does not support this operation.	实例状态不支持此操作。
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	实例释放后的归档备份保留策略无效。
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	DB实例引擎类型不支持此操作。
400	Pay.NoCreditCard	No credit cards.	无信用卡。
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	vpc网络类型实例不支持此操作。
400	MirrorInsExists	Specified DB instance mirror ins already existed.	当前数据库实例镜像已存在。
400	UnsupportedClassCode	The specified DB instance class stops selling.	实例规格停止售卖。
400	InvalidBackupSet	The specified database does not exist in the backup set.	备份集中没有指定的数据库。
400	OrdTCommodityQueryError	Failed to query for product.	查询产品失败。
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	实例已释放，请核实后下单。
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	指定的地域无效。
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	实例当前存在未支付订单，请支付后重试。
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	缩容目标容量不能小于当前存储空间使用量
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD盘不支持此操作，请升级至ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	用户权限不支持此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的VSwitchId格式不正确或为空
403	IncorrectMinorVersion	Current engine minor version does not support operations.	当前引擎小版本不支持此操作。
403	OperationDenied.ZoneResource	There is no available zone for inventory.	没有可用的库存区域。
403	NotInFlowController	Sorry,no permission.	非集团上云用户不可用，无权限。
403	InvalidKmsKey	Kms key is disabled.	Kms key已禁用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	当前数据库实例级别不支持此操作。
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	当前实例未授权访问密钥管理服务。
404	Request.NotFound	The requested resource is not available.	请求的资源不可用。
404	HostInfo.NotFound	The specified host info is not found.	指定的主机信息不存在。
500	ExternalFailure	The request processing has failed due to external service failure.	请求服务失败，请稍后重试。
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	请求服务失败，请稍后再试或联系服务人员。
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	由于rds api服务失败，请求处理失败。

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

变更历史

变更时间	变更内容概要	操作
2024-08-15	OpenAPI 错误码发生变更	查看变更详情
2024-04-02	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-15	OpenAPI 错误码发生变更	查看变更详情
2023-05-11	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2022-09-01	OpenAPI 错误码发生变更	查看变更详情
2022-06-24	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2021-10-11	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情