查询流日志集合

最近更新时间:2020-07-13 08:53:27

1. 接口描述

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

本接口(DescribeFlowLogs)用于查询获取流日志集合

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFlowLogs。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcId String 私用网络ID或者统一ID,建议使用统一ID
FlowLogId String 流日志唯一ID
FlowLogName String 流日志实例名字
ResourceType String 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE
ResourceId String 资源唯一ID
TrafficType String 流日志采集类型,ACCEPT|REJECT|ALL
CloudLogId String 流日志存储ID
CloudLogState String 流日志存储ID状态
OrderField String 按某个字段排序,支持字段:flowLogName,createTime,默认按createTime
OrderDirection String 升序(asc)还是降序(desc),默认:desc
Offset Integer 偏移量,默认为0。
Limit Integer 每页行数,默认为10
Filters Filter 过滤条件,参数不支持同时指定FlowLogIds和Filters。
  • tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
  • 3. 输出参数

    参数名称 类型 描述
    FlowLog Array of FlowLog 流日志实例集合
    TotalNum Integer 流日志总数目
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询流日志集合

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeFlowLogs
    &Offset=0&Limit=10
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "FlowLog": [
          {
            "CloudLogId": "219d5186-eab0-4510-905b-84925d8ec35e",
            "CloudLogState": "SUCCESS",
            "CreatedTime": "2019-05-07 18:00:26",
            "FlowLogDescription": "",
            "FlowLogId": "fl-2edhcclz",
            "FlowLogName": "yuemingtest",
            "ResourceId": "eni-78ysaex1",
            "ResourceType": "NETWORKINTERFACE",
            "TrafficType": "ACCEPT",
            "VpcId": "vpc-pq9vxykj"
          },
          {
            "CloudLogId": "dfb8f1a2-8522-47c1-8571-67905167ab3f",
            "CloudLogState": "SUCCESS",
            "CreatedTime": "2019-05-08 10:48:26",
            "FlowLogDescription": "",
            "FlowLogId": "fl-f42uhpkj",
            "FlowLogName": "test",
            "ResourceId": "eni-78ysaex1",
            "ResourceType": "NETWORKINTERFACE",
            "TrafficType": "ACCEPT",
            "VpcId": "vpc-pq9vxykj"
          }
        ],
        "TotalNum": 2,
        "RequestId": "404428db-f850-40c2-803d-0aae49aba43a"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    目录