TDSQL MySQL版查询实例列表

1. 接口描述

接口请求域名： dcdb.tencentcloudapi.com 。

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

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDCDBInstances。
Version	是	String	公共参数，本接口取值：2018-04-11。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceIds.N	否	Array of String	按照一个或者多个实例 ID 查询。实例 ID 形如：dcdbt-2t4cf98d 示例值：["dcdbt-52s53yyh\n"]
SearchName	否	String	搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。示例值：instancename
SearchKey	否	String	搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。示例值：dcdbt-52s53yyh
ProjectIds.N	否	Array of Integer	按项目 ID 查询示例值：[1077640,1077641]
IsFilterVpc	否	Boolean	是否根据 VPC 网络来搜索示例值：true
VpcId	否	String	私有网络 ID， IsFilterVpc 为 1 时有效示例值：vpc-737mtr2f
SubnetId	否	String	私有网络的子网 ID， IsFilterVpc 为 1 时有效示例值：subnet-au6ics6s
OrderBy	否	String	排序字段， projectId， createtime， instancename 三者之一示例值：createtime
OrderByType	否	String	排序类型， desc 或者 asc 示例值：asc
Offset	否	Integer	偏移量，默认为 0 示例值：0
Limit	否	Integer	返回数量，默认为 10，最大值为 100。示例值：20
ExclusterType	否	Integer	1非独享集群，2独享集群， 0全部示例值：0
IsFilterExcluster	否	Boolean	标识是否使用ExclusterType字段, false不使用，true使用示例值：false
ExclusterIds.N	否	Array of String	独享集群ID 示例值：["dbdc-4ih6uct9"]
TagKeys.N	否	Array of String	按标签key查询示例值：["负责人", "备份负责人"]
Tags.N	否	Array of Tag	标签
FilterInstanceType	否	String	实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔示例值：2
Status.N	否	Array of Integer	按实例状态筛选。状态值 -2：已删除； -1：已隔离；0：创建中；1：流程处理中；2：运行中示例值：[1,2]
ExcludeStatus.N	否	Array of Integer	排除实例状态。状态值 -2：已删除； -1：已隔离；0：创建中；1：流程处理中；2：运行中示例值：[-1,-2]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合条件的实例数量示例值：1
Instances	Array of DCDBInstanceInfo	实例详细信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://dcdb.tencentcloudapi.com/?Action=DescribeDCDBInstances
&InstanceIds.0=tdsqlshard-hptutl5t
&<公共请求参数>

输出示例

{
    "Response": {
        "Instances": [
            {
                "AppId": 251000022,
                "AutoRenewFlag": 1,
                "Cpu": 2,
                "CreateTime": "2021-03-26 16:14:31",
                "DbEngine": "MariaDB",
                "DbVersion": "10.1.9",
                "DcnDstNum": 0,
                "DcnFlag": 0,
                "DcnStatus": 0,
                "ExclusterId": "",
                "Id": 2000091,
                "InstanceId": "tdsqlshard-hptutl5t",
                "InstanceName": "tdsqlshard-hptutl5t",
                "InstanceType": 2,
                "Ipv6Flag": 0,
                "IsAuditSupported": 1,
                "IsTmp": 0,
                "IsolatedTimestamp": "0000-00-00 00:00:00",
                "Locker": 0,
                "Memory": 4,
                "NodeCount": 2,
                "Paymode": "prepaid",
                "PeriodEndTime": "2021-04-26 16:14:31",
                "Pid": 1001670,
                "ProjectId": 0,
                "Region": "ap-guangzhou",
                "ShardCount": 2,
                "ShardDetail": [
                    {
                        "Cpu": 1,
                        "Createtime": "2021-03-26 16:14:31",
                        "Memory": 2,
                        "NodeCount": 1,
                        "Pid": 1001670,
                        "ShardId": 12208,
                        "ShardInstanceId": "shard-qihco4rx",
                        "ShardSerialId": "set_1616746585_1",
                        "Status": 2,
                        "Storage": 10
                    },
                    {
                        "Cpu": 1,
                        "Createtime": "2021-03-26 16:14:31",
                        "Memory": 2,
                        "NodeCount": 1,
                        "Pid": 1001670,
                        "ShardId": 12209,
                        "ShardInstanceId": "shard-d3moxo2r",
                        "ShardSerialId": "set_1616746676_3",
                        "Status": 2,
                        "Storage": 10
                    }
                ],
                "Status": 2,
                "StatusDesc": "运行中",
                "Storage": 20,
                "SubnetId": 1479311,
                "Uin": "918700682",
                "UniqueSubnetId": "subnet-au6ics6s",
                "UniqueVpcId": "vpc-737mtr2f",
                "UpdateTime": "2021-03-29 15:35:33",
                "Vip": "10.1.0.6",
                "Vipv6": "",
                "VpcId": 74809,
                "Vport": 3306,
                "WanDomain": "",
                "WanPort": 0,
                "WanPortIpv6": 0,
                "WanStatus": 0,
                "WanStatusIpv6": 0,
                "WanVip": "",
                "WanVipv6": "",
                "Zone": "ap-guangzhou-1",
                "ResourceTags": [
                    {
                        "TagKey": "name",
                        "TagValue": "liu"
                    }
                ],
                "DbVersionId": "8.0"
            }
        ],
        "RequestId": "a44a3d24-1e71-4bbf-bc22-f6d583b084d8",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

近期搜索热词

云服务器

云硬盘

容器服务

弹性伸缩

负载均衡

私有网络

云函数

API 网关

专线接入

批量计算

微服务平台 TSF

对象存储

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

内容分发网络 CDN

云数据库 Redis®

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

腾讯云可观测平台

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

DDoS 防护

标签

密钥管理系统

Web 应用防火墙

域名注册

操作审计

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

腾讯云数据仓库 TCHouse-P

口语评测（基础版）

流计算 Oceanus

Elasticsearch Service

集团账号管理

图像识别

文字识别

人脸识别

媒体处理

云直播

云联络中心

物联网通信

机器翻译

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

游戏多媒体引擎

腾讯云 BI

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

智能视图计算平台

微瓴同业开放平台

消息队列 RocketMQ 版

Cloud Studio（云端 IDE）

数据安全治理中心

实时互动-教育版

设备安全

腾讯健康组学平台

腾讯云数据仓库 TCHouse-C

计费相关