获取流量镜像实例的列表信息

最近更新时间:2019-07-24 15:02:23

1. 接口描述

接口请求域名: bmlb.tencentcloudapi.com 。

获取流量镜像实例的列表信息。

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

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。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 流量镜像总数。
TrafficMirrorSet Array of TrafficMirror 对象数组。数组元素为流量镜像信息,具体结构描述如list结构所示。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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",
        "LBType": 0,
        "HealthSwitch": 0,
        "HealthNum": 3,
        "UnhealthNum": 3,
        "IntervalTime": 5,
        "HttpCheckDomain": "",
        "HttpCheckPath": "",
        "HttpCodes": []
      }
    ],
    "TotalCount": 1,
    "RequestId": "d2796e3b-cc73-424e-97d1-31d26fd0d1d7"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InternalError 内部错误
InvalidParameter 参数错误
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在