DescribeDBInstances_云数据库 RDS_API文档-阿里云OpenAPI开发者门户

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

流控信息

请求速率为6000/60(s)。更多流控信息，请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称	字段详情
ClientTokenstring	用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。示例值:ETnLKlblzczshOTUbOCz****
proxyIdstring	废弃参数，无需配置。示例值:API
Enginestring	数据库类型，取值：展开详情示例值:MySQL
ZoneIdstring	可用区 ID。示例值:cn-hangzhou-a
ResourceGroupIdstring	资源组 ID。示例值:rg-acfmy****参考取值来源: DescribeResourceDetails
DBInstanceStatusstring	实例状态，详情请参见实例状态表。示例值:Running
Expiredstring	实例的过期状态，取值：展开详情示例值:True
SearchKeystring	可基于实例 ID 或者实例备注模糊搜索。示例值:rm-uf6w
DBInstanceIdstring	实例 ID。示例值:rm-uf6wjk5****参考取值来源: CloneDBInstance CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeGadInstances GetDbProxyInstanceSsl CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink
DBInstanceTypestring	实例类型，取值：展开详情示例值:Primary参考取值来源: CalculateDBInstanceWeight DescribeDBInstanceNetInfo
RegionIdstring	地域 ID。可调用 DescribeRegions 获取。示例值:cn-hangzhou参考取值来源: DescribeRegions
PageSizeinteger<int32>	每页记录数，取值：1~100。展开详情示例值:30取值 <= 100
PageNumberinteger<int32>	页码，取值：大于 0 且不超过 Integer 的最大值。展开详情示例值:1取值 <= 21474836
InstanceNetworkTypestring	实例的网络类型，取值：展开详情示例值:Classic参考取值来源: DescribeDBInstanceNetInfo
VpcIdstring	VPC ID。示例值:vpc-uf6f7l4fg90****
VSwitchIdstring	交换机 ID。示例值:vsw-uf6adz52c2p****参考取值来源: DescribeVSwitches
DBInstanceClassstring	实例规格，详见实例规格表。示例值:rds.mys2.small参考取值来源: CreateDBInstance DescribeDBInstancesForClone
EngineVersionstring	数据库版本。示例值:8.0参考取值来源: DescribeDBMiniEngineVersions
PayTypestring	付费类型，取值：展开详情示例值:Postpaid
ConnectionModestring	实例的访问模式，取值：展开详情示例值:Standard
Tagsstring	查询绑定有该标签的实例，包括 TagKey 和 TagValue。单次最多支持传入 5 组值，格式：{"key1":"value1","key2":"value2"...}。示例值:{"key1":"value1"}参考取值来源: DescribeTags
DedicatedHostGroupIdstring	专属集群 ID。示例值:dhg-7a9****参考取值来源: DescribeDedicatedHostGroups
DedicatedHostIdstring	专属集群内的主机 ID。示例值:i-bp****参考取值来源: DescribeDedicatedHosts
InstanceLevelinteger<int32>	是否返回实例系列（Category）信息，取值：展开详情示例值:0
ConnectionStringstring	实例的连接地址。通过该连接地址查询对应的实例。示例值:rm-uf6wjk5****.mysql.rds.aliyuncs.com参考取值来源: AllocateInstancePublicConnection
NextTokenstring	翻页凭证。取值为上一次调用 DescribeDBInstances 接口时返回的 NextToken 参数值。如果调用结果分多页展示，再次调用接口时传入该值便可以展示下一页的内容。示例值:o7PORW5o2TJg****
MaxResultsinteger<int32>	每页记录数。取值：1~100。展开详情示例值:30取值 <= 100
Filterstring	实例过滤条件参数及其值的 JSON 串示例值:{"babelfishEnabled":"true"}
Categorystring	实例的系列。取值：展开详情示例值:cluster

请求说明

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

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

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

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

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

返回参数

字段名称	字段详情
Itemsobject
NextTokenstring	翻页凭证。如果调用结果分多页展示，再次调用接口时在 NextToken 处传入该值便可以展示下一页的内容。示例值:o7PORW5o2TJg****
PageNumberinteger<int32>	页码。展开详情示例值:1
PageRecordCountinteger<int32>	当前页实例个数。示例值:10
RequestIdstring	请求 ID。示例值:1AD222E9-E606-4A42-BF6D-8A4442913CEF
TotalRecordCountinteger<int32>	总记录数。展开详情示例值:100

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	Invalid.NextToken	The parameter NextToken is invalid.	诊断
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter DBInstanceType is not valid.	诊断
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	诊断
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.	诊断
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	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.	诊断
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.	诊断
400	KmsApiError	User secret key invalid.	诊断
400	System.SaleValidateFailed	Sales expression validation system error.	诊断
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	诊断
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.	诊断
400	Pay.NoCreditCard	No credit cards.	诊断
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	诊断
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.	诊断
403	InvalidUserOperatorPermission	The user permission does not support this operation.	诊断
403	InvalidVswitchId	Specified conn vswitch id is not valid.	诊断
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.	诊断
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.	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-08-15	变更错误码400
	2024-04-02	变更返回参数
	2024-04-01	变更返回参数
	2024-01-04	变更返回参数
	2023-05-26	新增请求参数Category 变更返回参数
	2023-05-15	变更错误码400
	2023-05-11	新增请求参数Filter
	2022-09-01	变更错误码400

1
2
10 条/页

DescribeDBInstances_云数据库 RDS_API文档

接口说明

适用引擎

流控信息

授权信息

请求参数

请求说明

返回参数

返回示例

错误码

变更历史

相关示例