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

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
DBEngineVersion	String	否	MySQL_8_0	实例兼容版本。取值范围： MySQL_8_0：表示兼容社区 MySQL 8.0 版本。 MySQL_5_7：表示兼容社区 MySQL 5.7 版本。
InstanceId	String	否	vedbm-d4mx2akm****	实例 ID。
InstanceName	String	否	test	实例名称，支持模糊查询。
InstanceStatus	String	否	Running	实例状态。说明关于实例状态的详细说明，请参见实例状态说明。
CreateTimeStart	String	否	2022-06-21T07:57:26Z	创建实例的开始时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
CreateTimeEnd	String	否	2022-06-21T07:57:26Z	创建实例的结束时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。说明同时传入 CreateTimeStart 和 CreateTimeEnd 参数时，创建实例的结束时间需晚于开始时间。
ZoneId	String	否	cn-beijing-a	实例所在可用区的 ID。说明您可以调用 DescribeAvailabilityZones 接口查询实例支持的可用区信息。
StorageType	String	否	IOOptimizedStorage	存储类型。取值范围： IOOptimizedStorage：IO 性能型。 SmartCompressedStorage：智能压缩型。
ChargeType	String	否	PostPaid	计算计费类型，取值： PostPaid：按量计费（后付费）。 PrePaid：包年包月（预付费）。
NodeSpec	String	否	vedb.mysql.x4.xlarge	实例的节点规格。说明关于实例节点规格的详细信息，请参见产品规格。
TagFilters	Array of TagFilterObject	否	请参见请求示例。	用于查询筛选的标签键值对数组。说明单次最多支持同时传入 10 组标签键值对进行查询筛选。
ProjectName	String	否	default	指定实例所属的项目名称。
PageSize	Integer	否	10	每页记录数。取值范围 1~500，默认值为 10。
PageNumber	Integer	否	1	页码，取值大于等于 1，且不超过 Integer 的最大值，默认值为 1。

TagFilterObject

参数	类型	是否必选	示例值	描述
Key	String	否	department	用于查询筛选的标签键。
Value	String	否	game	用于查询筛选的标签值。说明若绑定标签时，设置了标签值，则筛选时该参数必填。

返回参数

参数	类型	示例值	描述
Total	Integer	1	符合查询条件的实例数量。
Instances	Array of InstanceObject	请参见返回示例。	实例列表。

InstanceObject

参数	类型	示例值	描述
InstanceId	String	vedbm-d4mx2akm****	实例 ID。
InstanceName	String	test	实例名称。
InstanceStatus	String	Running	实例状态。说明关于实例状态的详细说明，请参见实例状态说明。
CreateTime	String	2022-06-21T07:54:05Z	实例的创建时间，格式：YYYY-MM-DDTHH:MM:SSZ（UTC 时间）。
DBEngineVersion	String	MySQL_8_0	实例兼容版本。取值范围： MySQL_8_0：表示兼容社区 MySQL 8.0 版本。 MySQL_5_7：表示兼容社区 MySQL 5.7 版本。
ProjectName	String	vedb_project	实例所属的项目名称。说明项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色管理这些资源的权限。更多详情，请参见资源管理。
ZoneIds	String	cn-beijing-a	实例所属的可用区。
VpcId	String	vpc-3ajzohyfaru9s340jz1rp****	私有网络（VPC）ID。
TimeZone	String	UTC +08:00	实例的时区。国内所有地域默认时区为 UTC +08:00。
StorageChargeType	String	PostPaid	存储计费类型，取值： PostPaid：按量计费（后付费）。 PrePaid：包年包月（预付费）。
PrePaidStorageInGB	Integer	50	预付费的存储总容量大小，单位 GiB。
StorageUsedGiB	Double	0.44	已使用存储空间大小，单位 GiB。
ChargeDetail	Object of ChargeDetailObject	请参见返回示例。	计费信息。
RegionId	String	cn-beijing	地域 ID。
SubnetId	String	subnet-1g15j13jtzgu88ibuxwqp****	子网 ID。子网必须属于所选的可用区。
Nodes	Array of NodeObject	请参见返回示例。	实例节点的详细信息。
Tags	Array of TagObject	请参见返回示例。	实例绑定的标签键和标签值数组对象。
DeletionProtection	String	enabled	实例是否开启了删除保护功能。取值范围： enabled：开启。 disabled：关闭。
DBRevisionVersion	String	3.0.2.1	实例的内核版本。关于实例内核版本的详细信息，请参见版本号管理。
SpecFamily	String	Exclusive	实例规格类型，取值： General：通用型。 Exclusive：独享型。
LowerCaseTableNames	String	1	表名是否区分大小写。取值范围： 0：表名称大小写敏感，后端根据实际表名存储。 1：表名称不区分大小写，后端存储时将表名称统一为小写字母。
StorageType	String	IOOptimizedStorage	存储类型。取值范围： IOOptimizedStorage：IO 性能型。 SmartCompressedStorage：智能压缩型。

ChargeDetailObject

参数	类型	示例值	描述
ChargeType	String	PostPaid	计算计费类型，取值： PostPaid：按量计费（后付费）。 PrePaid：包年包月（预付费）。
ChargeStatus	String	Normal	付费状态： Normal：正常。 Overdue：欠费。 Shutdown：关停。
OverdueReclaimTime	String	2022-09-27T06:09:20Z	欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime	String	2022-10-04T07:50:22Z	欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
AutoRenew	Boolean	true	预付费场景下是否自动续费。取值： true：自动续费。 false：不自动续费。
ChargeStartTime	String	2023-09-22T08:08:35Z	计费开始的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeEndTime	String	2023-09-22T08:08:35Z	预付费场景下计费到期的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

NodeObject

参数	类型	示例值	描述
NodeId	String	vedbm-h441603c68aaa**-	节点 ID。
ZoneId	String	cn-beijing-a	可用区 ID。
NodeType	String	Primary	节点类型。取值： Primary：主节点。 ReadOnly：只读节点。
vCPU	Integer	8	CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。
Memory	Integer	32	内存大小，单位为 GiB。
NodeSpec	String	vedb.mysql.x4.xlarge	实例的节点规格。说明关于实例节点规格的详细信息，请参见产品规格。
FailoverPriority	Integer	5	节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。

TagObject

参数	类型	示例值	描述
Key	String	department	实例绑定的标签键。
Value	String	game	实例绑定的标签值。

示例

请求示例

返回示例

错误码

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

云数据库 veDB MySQL 版