调用 DescribeDBInstances 接口查看实例列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	否	mysql-1d797b6f****	实例 ID。
InstanceName	String	否	TestDB	实例名称。
InstanceStatus	String	否	Running	实例状态，取值： Creating：创建中。 Running：运行中。 Deleting：删除中。 Restarting：重启中。 Updating：变更中。 Restoring：恢复中。 Error：错误。 Upgrading：升级中。 Released：回收中。 Recycled：已回收。 MasterChanging：主节点切换中。 TDEUpdating：TDE 修改中。 Closed：关停。 Maintaining：维护中。 CreateFailed：创建失败。 Closing：关停中。 SSLUpdating：SSL 变更中。 AllowListMaintaining：白名单变更中。 Unknown：未知。 ProxyCreating：代理开启中。 ProxyDeleting：代理关闭中。 ChargeTypeChanging：计费类型变更中。 NetWorkChanging：网络变更中。
DBEngineVersion	String	否	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。 MySQL 8.4：MySQL 8.4 版本。
CreateTimeStart	String	否	2022-01-01T10:10:10Z	查询创建实例创建时间范围。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
CreateTimeEnd	String	否	2022-01-01T10:10:10Z	查询创建实例创建时间范围。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ZoneId	String	否	cn-beijing-a	实例所属可用区。
ChargeType	String	否	PostPaid	计费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
InstanceType	String	否	DoubleNode	实例类型。取值如下： DoubleNode：双节点类型。 MultiNode：多节点类型。 SingleNode：单节点类型。
NodeSpec	String	否	rds.mysql.1c2g	主节点规格。关于节点规格的详细信息，请参见产品规格。
TagFilters	Array of TagFilterObject	否	[ { "Key":"key1", "Value":"value1" } ]	用于查询筛选的标签键值对数组。说明单次最多支持同时传入 10 组标签键值对进行查询筛选。需同时设置 key 和 value 两个字段。
ProjectName	String	否	testProject	项目名称。
PageNumber	Integer	否	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 1000。默认值为 10。
PrivateNetworkIpAddress	String	否	192...19	实例默认终端的 IP 地址，用于按照 IP 地址查询实例。
KernelVersion	Array of String	否	["MySQL 5.7.32_20240415","MySQL 8.0.32_20240815"]	内核小版本。可通过该字段筛选指定内核小版本的实例。可传入多个内核小版本的版本号。关于 MySQL 内核小版本的详细信息，可参见内核版本发布记录。
PrivateNetworkVpcId	String	否	vpc-3rebt5uf5fr405zsk2if9****	私有网络的 ID。可通过该字段筛选使用指定私有网络的实例。
StorageType	String	否	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
EngineType	String	否	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。

TagFilterObject

参数	类型	是否必选	示例值	描述
Key	String	是	ExampleKey	用于查询筛选的标签键。
Value	String	否	ExampleValue	用于查询筛选的标签值。说明若绑定标签时，设置了标签值，则筛选时该参数必填。
Values	Array of String	否	["ExampleValue1","ExampleValue2"]	用于查询筛选的标签值。说明如果 Value 和 Values 同时存在，优先以 Values 为准。

返回参数

参数	类型	示例值	描述
Total	Integer	1	实例总数。
Instances	Array of InstanceInfoObject	请参见返回示例。	实例列表。

InstanceInfoObject

参数	类型	示例值	描述
AddressObject	Array of AddressObject	[ { "Domain":"mysql77c004ac****.rds.ivolces.com", "EipId":"", "IPAddress":"", "NetworkType":"Private", "Port":"3306", "SubnetId":"" } ]	默认终端的连接信息。
AllowListVersion	String	v2	IP 白名单版本，取值可以为 0，v1 或 v2。
ChargeDetail	Object of ChargeDetailObject	无。	付费方式。
CreateTime	String	2022-01-01T10:10:10Z	实例的创建时间（UTC 时间）。
CurrentKernelVersion	String	MySQL 5.7.32_20241015	实例的内核小版本。
DBEngineVersion	String	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。 MySQL 8.4：MySQL 8.4 版本。
DeletionProtection	String	Enabled	是否启用实例的删除保护功能。取值： Enabled：是。 Disabled：否。默认值。
EngineType	String	RocksDB	数据库引擎类型。取值： InnoDB：InnoDB 引擎。 RocksDB：RocksDB 引擎。说明作为请求参数时，默认值为 InnoDB。
InstanceId	String	mysql-h441603c****	实例 ID。
InstanceName	String	实例名称	实例名称。
InstanceStatus	String	Running	实例状态，取值： Creating：创建中。 Running：运行中。 Deleting：删除中。 Restarting：重启中。 Updating：变更中。 Restoring：恢复中。 Error：错误。 Upgrading：升级中。 Released：回收中。 Recycled：已回收。 MasterChanging：主节点切换中。 TDEUpdating：TDE 修改中。 Closed：关停。 Maintaining：维护中。 CreateFailed：创建失败。 Closing：关停中。 SSLUpdating：SSL 变更中。 AllowListMaintaining：白名单变更中。 Unknown：未知。 ProxyCreating：代理开启中。 ProxyDeleting：代理关闭中。 ChargeTypeChanging：计费类型变更中。 NetWorkChanging：网络变更中。
InstanceType	String	DoubleNode	绿色实例的实例类型。取值： DoubleNode，双节点类型。 MultiNode，多节点类型。 SingleNode，单节点类型。说明如蓝色实例的实例类型为单节点，可为绿色实例选择单节点或双节点的实例类型。如蓝色实例的实例类型为双节点，可为绿色实例选择双节点或多节点的实例类型。如蓝色实例的实例类型为多节点，只能为绿色实例选择多节点的实例类型。
LowerCaseTableNames	String	1	表名是否区分大小写，默认值为 1。取值范围： 0：表名被存储成固定且表名称大小写敏感。 1：表名将被存储成小写且表名称大小写不敏感。
MaintenanceWindow	Object of MaintenanceWindowObject	{ "DayKind": "Week", "DayOfMonth": [], "DayOfWeek": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "MaintenanceTime": "18:00Z-21:59Z" }	可维护时间段。
NodeCPUUsedPercentage	Double	0.3	实例主节点 CPU 使用率近一分钟的平均值。
NodeMemoryUsedPercentage	Double	8.67	实例主节点内存使用率近一分钟的平均值。
NodeNumber	Integer	2	节点数量。
NodeSpaceUsedPercentage	Double	21.49	实例主节点磁盘使用率近一分钟的平均值。
NodeSpec	String	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。
ProjectName	String	Default	所属项目。
RegionId	String	cn-beijing	地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。
StorageSpace	Integer	200	实例总存储空间。单位为 GiB。
StorageType	String	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
SubnetId	String	subnet-rrzzs6dzof0gv0x58b****	子网 ID。
Tags	Array of TagObject	[ { "Key": "key1", "Value": "value1" } ]	绑定的标签键和标签值数组对象。
TimeZone	String	UTC + 08：00	时区。
VpcId	String	vpc-13g2qkkzntfy83n6nu4z1****	专有网络（VPC） ID。
ZoneId	String	cn-beijing-a	实例主节点所在可用区。
ZoneIds	Array of String	[ "cn-beijing-a", "cn-beijing-b" ]	实例各节点所在的可用区列表。
DrDtsTaskId	String	df5a93434880466cb8422b2db93d****	主实例与灾备实例之间的数据同步链路在 DTS 数据同步任务的 ID。
GADInstanceRole	String		全球数据库实例角色

AddressObject

参数	类型	示例值	描述
DNSVisibility	Boolean	false	false：火山引擎私网解析（默认）。 true：火山引擎私网以及公网解析。
Domain	String	mysql1d797b6f****.rds.ivolces.com	连接域名。
EipId	String	eip-13g6t81tglmgw3n6nu4vt****	EIP 的 ID，仅对 Public 地址有效。
IPAddress	String	10...3	IP 地址。
InternetProtocol	String	IPv4	IP 协议版本。取值为 IPv4。
NetworkType	String	Private	网络地址类型，取值为： Private：私网地址。 Public：公网地址。
Port	String	3306	端口。
SubnetId	String	subnet-2bzr8zdx5o8ao2dx0efq4****	子网 ID，仅对 Private 地址有效。
EipLocked	Boolean	false	连接终端使用的 EIP 是否因欠费关停。取值： true：是。 false：否。

ChargeDetailObject

参数	类型	示例值	描述
AutoRenew	Boolean	true	预付费场景下是否自动续费。 true：到期自动续费。 false：到期不自动续费。
ChargeEndTime	String	2025-08-22T15:59:59.000Z	包年包月实例的计费结束时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明如查询的是按量计费实例，该字段返回为空。
ChargeStartTime	String	2025-07-22T13:10:15.000Z	实例的计费开始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
ChargeStatus	String	Normal	实例的计费状态。取值： Normal：正常。 Overdue：欠费。 Unpaid：等待支付。
ChargeType	String	PostPaid	付费类型。取值： PostPaid：按量付费（后付费）。 PrePaid：包年包月（预付费）。
OverdueReclaimTime	String	2025-08-29T15:59:59.000Z	实例欠费关停（按量付费）或到期关停（包年包月）后，预计被释放的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
OverdueTime	String	2025-08-23T04:00:00.000Z	实例欠费关停（按量付费）或到期关停（包年包月）的时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。
Period	Integer	1	预付费场景下的购买时长。说明该参数作为请求参数时，默认值为 1。当 PeriodUnit 的取值为 Year 时，Period 的取值范围为 1~3。当 PeriodUnit 的取值为 Month时，Period 的取值范围为 1~9。
PeriodUnit	String	Month	预付费场景下的购买周期。 Month：购买周期为月。 Year：购买周期为年。说明该参数作为请求参数时，默认值为 Month。
TempModifyStartTime	String	2022-01-01T10:10:10.000Z	临时升配的开始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明未处于临时升配期的实例，不返回该字段。
TempModifyEndTime	String	2022-01-01T10:10:09.000Z	临时升配的还原时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。说明未处于临时升配期的实例，不返回该字段。

MaintenanceWindowObject

参数	类型	示例值	描述
DayKind	String	Week	可维护周期粒度，取值为 Week，周。
DayOfWeek	Array of String	["Monday","Tuesday"]	指定修改每周哪一天的可维护时间段，取值为：Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday，可多选。如果不指定该值或者为空，则默认一周七天都指定。
MaintenanceTime	String	22:00Z-02:00Z	实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC 时间）。

TagObject

参数	类型	示例值	描述
Key	String	tagkey	实例标签的标签键。标签键的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。 volc: 为系统预留的标签键，添加标签时，标签键的开头不能设置为任何大小写形式的 volc:。标签键的长度需为 1~128 个字符。
Value	String	tagvalue	实例标签的标签值。标签值的设置规则如下：支持任何语言字母或文字（如中文、英文字母等）、数字、空格。支持特殊字符：_.:/=+-@。标签值的长度需为 0~256 个字符，即标签值可以为空。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

云数据库 MySQL 版