1. 接口描述
接口请求域名: mariadb.tencentcloudapi.com 。
本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。
如果不指定任何筛选条件,则默认返回20条实例记录,单次请求最多支持返回100条实例记录。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 按照一个或者多个实例 ID 查询。实例 ID 形如:tdsql-ow728lmc。每次请求的实例的上限为100。 示例值:["tdsql-722d255z\n"] |
SearchName | 否 | String | 搜索的字段名,当前支持的值有:instancename、vip、all。传 instancename 表示按实例名进行搜索;传 vip 表示按内网IP进行搜索;传 all 将会按实例ID、实例名和内网IP进行搜索。 |
SearchKey | 否 | String | 搜索的关键字,支持模糊搜索。多个关键字使用换行符('\n')分割。 |
ProjectIds.N | 否 | Array of Integer | 按项目 ID 查询 |
IsFilterVpc | 否 | Boolean | 是否根据 VPC 网络来搜索 |
VpcId | 否 | String | 私有网络 ID, IsFilterVpc 为 1 时有效 |
SubnetId | 否 | String | 私有网络的子网 ID, IsFilterVpc 为 1 时有效 |
OrderBy | 否 | String | 排序字段, projectId, createtime, instancename 三者之一 |
OrderByType | 否 | String | 排序类型, desc 或者 asc |
Offset | 否 | Integer | 偏移量,默认为 0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 |
OriginSerialIds.N | 否 | Array of String | 按 OriginSerialId 查询 |
IsFilterExcluster | 否 | Boolean | 标识是否使用ExclusterType字段, false不使用,true使用 |
ExclusterType | 否 | Integer | 实例所属独享集群类型。取值范围:1-非独享集群,2-独享集群, 0-全部 |
ExclusterIds.N | 否 | Array of String | 按独享集群ID过滤实例,独享集群ID形如dbdc-4ih6uct9 |
TagKeys.N | 否 | Array of String | 按标签key查询 |
Tags.N | 否 | Array of Tag | 标签 |
FilterInstanceType | 否 | String | 实例类型过滤,1-独享实例,2-主实例,3-灾备实例,多个按逗号分隔 |
Status.N | 否 | Array of Integer | 按照实例状态进行筛选 |
ExcludeStatus.N | 否 | Array of Integer | 排除实例状态 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的实例数量 示例值:1 |
Instances | Array of DBInstance | 实例详细信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据实例ID查询实例列表
输入示例
https://mariadb.tencentcloudapi.com/?Action=DescribeDBInstances
&InstanceIds.0=tdsql-dj77jd0p
&<公共请求参数>
输出示例
{
"Response": {
"Instances": [
{
"AppId": 251000022,
"AutoRenewFlag": 1,
"Cpu": 1,
"CreateTime": "2021-03-26 15:28:23",
"DbEngine": "Percona",
"DbVersion": "5.7.17",
"DcnDstNum": 0,
"DcnFlag": 0,
"DcnStatus": 0,
"ExclusterId": "",
"Id": 2000090,
"InstanceId": "tdsql-dj77jd0p",
"InstanceName": "tdsql-dj77jd0p",
"InstanceType": 2,
"Ipv6Flag": 0,
"IsAuditSupported": 1,
"IsEncryptSupported": 1,
"IsTmp": 0,
"Locker": 0,
"Machine": "TS85",
"Memory": 2,
"NodeCount": 2,
"OriginSerialId": "set_1616743781_36017514",
"Paymode": "prepaid",
"PeriodEndTime": "2021-04-26 15:28:23",
"Pid": 1002231,
"ProjectId": 0,
"Qps": 2100,
"Region": "ap-guangzhou",
"Status": 2,
"StatusDesc": "运行中",
"Storage": 10,
"SubnetId": 1479311,
"TdsqlVersion": "基于Percona 5.7.17设计(兼容Mysql 5.7)",
"Uin": "918700682",
"UniqueSubnetId": "subnet-au6ics6s",
"UniqueVpcId": "vpc-737mtr2f",
"UpdateTime": "2021-03-29 17:20:05",
"Vip": "10.1.0.10",
"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": "66c4d0c5-bdef-45bd-aa5b-05642802d034",
"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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.CamAuthFailed | CAM鉴权请求失败。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.FenceError | 查询独享集群信息失败。 |
InternalError.GetVpcFailed | 查询虚拟私有网络信息失败。 |
InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
InvalidParameter.SubnetNotFound | 找不到指定的虚拟私有网络子网。 |
InvalidParameterValue.IllegalExclusterID | 找不到数据库实例所属的独享集群。 |
InvalidParameterValue.SpecIdIllegal | 找不到数据库实例对应的规格信息。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |