全部产品
Search
文档中心

专有网络 VPC:DescribeFlowLogs - 查询流日志

更新时间:May 14, 2024

调用DescribeFlowLogs接口查询流日志。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeFlowLogsRead
  • FlowLog
    acs:vpc:{#regionId}:{#accountId}:flowlog/*

请求参数

名称类型必填描述示例值
RegionIdstring

流日志所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
FlowLogNamestring

流日志名称。

名称长度为 1~128 个字符,不能以http://https://开头。

myFlowlog
FlowLogIdstring

流日志 ID。

fl-bp1f6qqhsrc2c12ta****
Descriptionstring

流日志描述信息。

描述长度为 1~256 个字符,不能以http://https://开头。

This is my Flowlog.
ResourceTypestring

要捕获的流量的资源类型。取值:

  • NetworkInterface:弹性网卡。

  • VSwitch:交换机内的所有弹性网卡。

  • VPC:专有网络内的所有弹性网卡。

NetworkInterface
ResourceIdstring

要捕获的流量的资源 ID。

eni-askldfas****
TrafficTypestring

采集的流量类型。取值:

  • All:全部流量。

  • Allow:访问控制允许的流量。

  • Drop:访问控制拒绝的流量。

All
ProjectNamestring

管理捕获到的流量的 Project。

FlowLogProject
LogStoreNamestring

存储捕获到的流量的 Logstore。

FlowLogStore
Statusstring

流日志的状态。取值:

  • Active:流日志为启动状态。

  • Activating:流日志正在创建中。

  • Inactive:流日志为未启动状态。

Active
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 20

20
VpcIdstring

所要查看流日志的 VPC 的 ID。

vpc-bp1nwd16gvo1wgs****
ResourceGroupIdstring

流日志所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

流日志详细信息。

PageSizestring

分页查询时每页的行数。

20
PageNumberstring

列表的页码。

1
RequestIdstring

请求 ID。

F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCountstring

查询到的流日志列表条目数。

1
Successstring

是否调用成功。取值:

  • true:调用成功。
  • false:调用失败。
true
FlowLogsobject []

流日志列表。

Statusstring

流日志的状态。取值:

  • Active:流日志为启动状态。

  • Activating:流日志正在创建中。

  • Inactive:流日志为未启动状态。

Active
CreationTimestring

流日志的创建时间。

2022-01-21T03:08:50Z
FlowLogNamestring

流日志名称。

myFlowlog
TrafficTypestring

流日志捕获的流量类型。取值:

  • All:全部流量。
  • Allow:访问控制允许的流量。
  • Drop:访问控制拒绝的流量。
All
ResourceTypestring

流日志捕获的流量的资源类型:

  • NetworkInterface:弹性网卡。
  • VSwitch:交换机内的所有弹性网卡。
  • VPC:专有网络内的所有弹性网卡。
NetworkInterface
Descriptionstring

流日志描述信息。

Description
ProjectNamestring

管理捕获到的流量的 Project。

FlowLogProject
LogStoreNamestring

存储捕获到的流量的 Logstore。

FlowLogStore
ResourceIdstring

流日志捕获的流量的资源 ID。

eni-askldfas****
RegionIdstring

流日志所属地域 ID。

cn-hangzhou
FlowLogIdstring

流日志 ID。

fl-bp1f6qqhsrc2c12ta****
BusinessStatusstring

业务状态。取值:

  • Normal:正常状态。
  • FinancialLocked:欠费锁定。
Normal
AggregationIntervalinteger

流日志的采样间隔。单位:分钟。

10
TrafficPatharray

采集的流量路径。取值:

  • all:表示全量采集。
  • internetGateway:表示公网流量采集。
string

采集的流量路径。取值:

  • all(默认值):表示全量采集。
  • internetGateway:表示公网流量采集。
说明 流量路径功能默认不开放,如需使用,请提交工单申请。
all
ServiceTypestring

云服务的托管类型。

  • 可以为空,表示该流日志为用户自己创建。
  • 非空时只支持取值为:sls,表示该流日志为通过日志服务控制台创建。
说明 通过日志服务控制台创建的流日志实例可以展示在 VPC 列表中,但在 VPC 中无法对该流日志实例进行修改、启动、停止、删除操作,如果您需要对该流日志进行相关操作,您可以登录日志服务控制台对其进行修改、启动、停止、删除操作。
sls
ResourceGroupIdstring

流日志所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsobject []

标签列表。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua
FlowLogDeliverStatusstring

流日志的投递状态,取值:

  • SUCCESS:投递成功。
  • FAILED:投递失败。
FAILED
FlowLogDeliverErrorMessagestring

当流日志投递失败时,可以根据报错信息排查问题,可能的报错信息有:

  • UnavaliableTarget:日志服务 SLS 的 Logstore 不可用,无法接收日志。建议查看对应 Logstore 是否真实存在且可访问。
  • ProjectNotExist: 日志服务 SLS 的 Project 不存在。建议删除原流日志,创建新流日志指向真实存在的 Project。
  • UnknownError:发生内部错误,请稍后重试。
UnavaliableTarget

示例

正常返回示例

JSON格式

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2022-01-21T03:08:50Z",
        "FlowLogName": "myFlowlog",
        "TrafficType": "All",
        "ResourceType": "NetworkInterface",
        "Description": "Description",
        "ProjectName": "FlowLogProject",
        "LogStoreName": "FlowLogStore",
        "ResourceId": "eni-askldfas****",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "fl-bp1f6qqhsrc2c12ta****",
        "BusinessStatus": "Normal",
        "AggregationInterval": 10,
        "TrafficPath": {
          "TrafficPathList": [
            "all"
          ]
        },
        "ServiceType": "sls",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "FlowLogDeliverStatus": "FAILED",
        "FlowLogDeliverErrorMessage": "UnavaliableTarget"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidInstanceIdInstance does not exist.实例不存在。
400ProjectOrLogstoreNotExistThe specified project or logstore does not exist.指定的项目或logstore不存在。
400SourceProjectNotExistThe Source Project or logstore does not exist.SLS源项目或日志库不存在。
400UnauthorizedThis api does not support sub user or role.此API不支持子用户或角色。
400ParameterInvalidInvalid parameter.入参非法
400InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-06OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-03-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更