调用DescribeFlowLogs接口查询流日志。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFlowLogs

要执行的操作,取值:DescribeFlowLogs

RegionId String cn-hangzhou

流日志所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

FlowLogName String myFlowlog

流日志名称。长度为2~128个字符,必须以字母或中文开头,可包含数字,半角句号(.),下划线(_)和短划线(-)。但不能以http://https://开头。

FlowLogId String fl-bp1f6qqhsrc2c12ta****

流日志ID。

Description String test flowlog

流日志描述信息。

ResourceType String NetworkInterface

要捕获的流量的资源类型:

  • NetworkInterface:弹性网卡。
  • VSwitch:交换机内的所有弹性网卡。
  • VPC:专有网络内的所有弹性网卡。
ResourceId String eni-askldfas****

要捕获的流量的资源ID。

TrafficType String All

采集的流量类型:

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

存储捕获到的流量的Project。

LogStoreName String FlowLogStore

存储捕获到的流量的LogStore。

Status String Active

流日志的状态。

  • Active:流日志为启动状态。
  • Inactive:流日志为未启动状态。
PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 20

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

VpcId String vpc-bp1nwd16gvo1wgs****

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

返回数据

名称 类型 示例值 描述
FlowLogs Array of FlowLog

流日志列表。

FlowLog
CreationTime String 2021-01-21T03:08:50Z

创建时间。

Description String test flowlog

流日志描述信息。

FlowLogId String fl-bp1f6qqhsrc2c12ta****

流日志ID。

FlowLogName String myFlowlog

流日志名称。

LogStoreName String FlowLogStore

存储捕获到的流量的LogStore。

ProjectName String FlowLogProject

存储捕获到的流量的Project。

RegionId String cn-hangzhou

流日志所属地域ID。

ResourceId String eni-askldfas****

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

ResourceType String NetworkInterface

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

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

流日志的状态。

  • Active:流日志为启动状态。
  • Inactive:流日志为未启动状态。
TrafficType String All

流日志捕获的流量类型:

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

列表的页码。

PageSize String 20

分页查询时每页的行数。

RequestId String F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

请求ID。

Success String true

是否调用成功。

  • true:调用成功。
  • false:调用失败。
TotalCount String 1

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFlowLogs
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeFlowLogsResponse>
  <TotalCount>1</TotalCount>
  <FlowLogs>
        <FlowLog>
              <Status>Active</Status>
              <FlowLogName>myFlowlog</FlowLogName>
              <LogStoreName>FlowLogStore</LogStoreName>
              <Description>test flowlog</Description>
              <ProjectName>FlowLogProject</ProjectName>
              <ResourceId>eni-askldfas****</ResourceId>
              <CreationTime>2021-01-21T03:08:50Z</CreationTime>
              <ResourceType>NetworkInterface</ResourceType>
              <RegionId>cn-hangzhou</RegionId>
              <FlowLogId>fl-bp1f6qqhsrc2c12ta****</FlowLogId>
              <TrafficType>All</TrafficType>
        </FlowLog>
  </FlowLogs>
  <PageSize>20</PageSize>
  <RequestId>F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1</RequestId>
  <PageNumber>1</PageNumber>
  <Success>true</Success>
</DescribeFlowLogsResponse>

JSON格式

{
    "TotalCount": 1,
    "FlowLogs": {
        "FlowLog": {
            "Status": "Active",
            "FlowLogName": "myFlowlog",
            "LogStoreName": "FlowLogStore",
            "Description": "test flowlog",
            "ProjectName": "FlowLogProject",
            "ResourceId": "eni-askldfas****",
            "CreationTime": "2021-01-21T03:08:50Z",
            "ResourceType": "NetworkInterface",
            "RegionId": "cn-hangzhou",
            "FlowLogId": "fl-bp1f6qqhsrc2c12ta****",
            "TrafficType": "All"
        }
    },
    "PageSize": 20,
    "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
    "PageNumber": 1,
    "Success": true
}

错误码

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