1. 接口描述
接口请求域名： bmlb.tencentcloudapi.com 。
获取流量镜像实例的列表信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTrafficMirrors。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TrafficMirrorIds.N | 否 | Array of String | 流量镜像实例ID的数组，支持批量查询 |
| Aliases.N | 否 | Array of String | 流量镜像实例别名数组。 |
| VpcIds.N | 否 | Array of String | 流量镜像实例所属的私有网络ID数组，形如：vpc-xxx。 |
| Offset | 否 | Integer | 分页的偏移量，也即从第几条记录开始查询 |
| Limit | 否 | Integer | 单次查询返回的条目数，默认值：500。 |
| OrderField | 否 | String | 排序字段。trafficMirrorId或者createTime。 |
| Order | 否 | Integer | 排序方式，取值：0:增序(默认)，1:降序 |
| SearchKey | 否 | String | 模糊匹配trafficMirrorId或者alias字段。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 流量镜像总数。 |
| TrafficMirrorSet | Array of TrafficMirror | 对象数组。数组元素为流量镜像信息，具体结构描述如list结构所示。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取流量镜像实例的列表信息
输入示例
https://bmlb.tencentcloudapi.com/?Action=DescribeTrafficMirrors
&TrafficMirrorIds.0=bmtm-lmep0eit
&Aliases.0=test
&VpcIds.0=vpc-muinpf9p
&<公共请求参数>输出示例
{
"Response": {
"TrafficMirrorSet": [
{
"TrafficMirrorId": "bmtm-lmep0eit",
"Alias": "test",
"VpcId": "vpc-muinpf9p",
"HealthSwitch": 0,
"HealthNum": 3,
"UnhealthNum": 3,
"IntervalTime": 5,
"HttpCheckDomain": "",
"HttpCheckPath": "",
"HttpCodes": []
}
],
"TotalCount": 1,
"RequestId": "d2796e3b-cc73-424e-97d1-31d26fd0d1d7"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |