DescribeDBInstances_云数据库 RDS_API调试-阿里云OpenAPI开发者门户

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

请求参数

字段名称	字段详情
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参考取值来源: DescribeDBInstanceNetInfo CalculateDBInstanceWeight
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

变更历史