查询实例列表

最近更新时间: 2026-09-17 00:05:09

1. 接口描述

接口请求域名： dcdb.api3.fincloud.tencent.cn。

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

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

接口更新时间：2023-11-15 18:13:49。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeDCDBInstances
Version	是	否	String	公共参数，本接口取值：2018-04-11
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceIds	否	否	Array of String	按照一个或者多个实例 ID 查询。实例 ID 形如：dcdbt-2t4cf98d 示例值： ["tdsqlshard-8upuqubt"]
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-j0z018ka
OrderBy	否	否	String	排序字段， projectId， createtime， instancename 三者之一示例值： createtime
OrderByType	否	否	String	排序类型， desc（降序）或者 asc（升序）示例值： desc
Offset	否	否	Int64	偏移量，默认为 0 示例值： 0
Limit	否	否	Int64	返回数量，默认为 10，最大值为 100。示例值： 20
ExclusterType	否	否	Int64	1非独享集群，2独享集群， 0全部示例值： 0
IsFilterExcluster	否	否	Bool	标识是否使用ExclusterType字段, false不使用，true使用示例值： true
ExclusterIds	否	否	Array of String	独享集群ID 示例值： ["cluster1","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]

3. 输出参数

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

4. 错误码

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

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

5. 示例

示例1 根据实例ID查询实例列表

输入示例

https://dcdb.api3.fincloud.tencent.cn/?Action=DescribeDCDBInstances
&InstanceIds.0=dcdbt-52s53yyh
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "f5301a70-8a4b-4e5e-b7e4-68d9c2f9c7c6",
        "TotalCount": 1,
        "Instances": [
            {
                "Id": 40965,
                "InstanceId": "dcdbt-52s53yyh",
                "InstanceName": "dcdbt-52s53yyh",
                "AppId": 1251006373,
                "ProjectId": 0,
                "Region": "ap-region1",
                "Zone": "ap-region1-2",
                "VpcId": 75203,
                "SubnetId": 45109,
                "UniqueVpcId": "vpc-5rkcp0wb",
                "UniqueSubnetId": "subnet-6ffate6q",
                "Status": 2,
                "StatusDesc": "运行中",
                "Vip": "172.17.0.10",
                "Vport": 3306,
                "WanDomain": "",
                "WanVip": "",
                "WanPort": 0,
                "CreateTime": "2018-05-04 16:42:18",
                "UpdateTime": "2018-05-20 18:04:17",
                "AutoRenewFlag": 0,
                "NodeCount": 2,
                "IsTmp": 0,
                "ExclusterId": "",
                "Memory": 4,
                "Storage": 20,
                "ShardCount": 2,
                "PeriodEndTime": "2018-05-11 16:42:18",
                "IsolatedTimestamp": "0000-00-00 00:00:00",
                "DbVersion": "10.1.9",
                "DbEngine": "MySQL",
                "Uin": "20548499",
                "Pid": 11128,
                "ShardDetail": [
                    {
                        "ShardId": 10240,
                        "ShardInstanceId": "shard-8m3rgssh",
                        "ShardSerialId": "set_1525423498_1",
                        "Status": 2,
                        "Createtime": "2018-05-04 16:42:19",
                        "Memory": 2,
                        "Storage": 10,
                        "Pid": 11128,
                        "NodeCount": 2
                    },
                    {
                        "ShardId": 10241,
                        "ShardInstanceId": "shard-n8f80yrv",
                        "ShardSerialId": "set_1525427618_3",
                        "Status": 2,
                        "Createtime": "2018-05-04 16:42:19",
                        "Memory": 2,
                        "Storage": 10,
                        "Pid": 11128,
                        "NodeCount": 2
                    }
                ]
            }
        ]
    }
}