查询实例列表

最近更新时间: 2026-07-12 00:28:08

1. 接口描述

接口请求域名: mariadb.api3.fincloud.tencent.com。

本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。
如果不指定任何筛选条件,则默认返回20条实例记录,单次请求最多支持返回100条实例记录。

默认接口请求频率限制:20次/秒。

接口更新时间:2025-09-03 16:09:10。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstances
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds Array of String 按照一个或者多个实例 ID 查询。实例 ID 形如:tdsql-ow728lmc。每次请求的实例的上限为100。
示例值: ["tdsql-722d255z"]
SearchName String 搜索的字段名,当前支持的值有:instancename、vip、all。传 instancename 表示按实例名进行搜索;传 vip 表示按内网IP进行搜索;传 all 将会按实例ID、实例名和内网IP进行搜索。
示例值: instancename
SearchKey String 搜索的关键字,支持模糊搜索。多个关键字使用换行符('\n')分割。
示例值: tdsql
ProjectIds Array of Int64 按项目 ID 查询
示例值: [11,22]
IsFilterVpc Bool 是否根据 VPC 网络来搜索
示例值: true
VpcId String 私有网络 ID, IsFilterVpc 为 1 时有效
示例值: vpc-grph5bup
SubnetId String 私有网络的子网 ID, IsFilterVpc 为 1 时有效
示例值: subnet-2t690uja
OrderBy String 排序字段, projectId, createtime, instancename 三者之一
示例值: createtime
OrderByType String 排序类型, desc(降序) 或者 asc(升序)
示例值: desc
Offset Int64 偏移量,默认为 0
示例值: 0
Limit Int64 返回数量,默认为 20,最大值为 100。
示例值: 20
OriginSerialIds Array of String 按 OriginSerialId 查询
示例值: [“set_1727257567_1060380”]
IsFilterExcluster Bool 标识是否使用ExclusterType字段, false不使用,true使用
示例值: true
ExclusterType Int64 实例所属独享集群类型。取值范围:1-非独享集群,2-独享集群, 0-全部
示例值: 0
ExclusterIds Array of String 按独享集群ID过滤实例,独享集群ID形如dbdc-4ih6uct9
示例值: ["feiteng5000c","machine1"]
TagKeys Array of String 按标签key查询
示例值: [   "label12",   "label14" ]
FilterInstanceType String 实例类型过滤,1-独享实例,2-主实例,3-灾备实例,多个按逗号分隔
示例值: 1
Status Array of Int64 过滤的实例状态
示例值: [1,2]
ExcludeStatus Array of Int64 排除的实例状态
示例值: [0,-1]
ExclusterName String 资源池名称
示例值: feiteng-5000c

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 符合条件的实例数量
示例值: 1
Instances Array of DBInstance 实例详细信息列表
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError.CamAuthFailed CAM鉴权请求失败。
InternalError.DbOperationFailed 查询数据库失败。
InternalError.FenceError 查询独享集群信息失败。
InternalError.GetVpcFailed 查询虚拟私有网络信息失败。
InvalidParameter.GenericParameterError 参数合法性校验错误。
InvalidParameterValue.IllegalExclusterID 找不到数据库实例所属的独享集群。
InvalidParameterValue.SpecIdIllegal 找不到数据库实例对应的规格信息。
UnauthorizedOperation.PermissionDenied 没有权限操作该接口或资源。
InvalidParameter.SubnetNotFound 找不到指定的虚拟私有网络子网。