
# 查询流日志列表 - ListFlowLogs
#### 功能介绍
查询企业路由器实例下的流日志列表
#### 接口约束
- 支持过滤查询，过滤条件有resource_type，resource_id，enterprise_project_id过滤条件可以重复和组合。
  
- 支持分页查询，limit和marker组合实现分页查询。
  
- 支持单字段排序功能，排序字段有\[id,name,state\]，不支持多字段排序。
  
 
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-er/er_02_0008.html)。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-er/er_02_0015.html)。
| 授权项              | 访问级别 | 资源类型（\*为必须）  | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| er:flowLogs:list | List | flowFlogs \* | -   | -  | -      |
   
#### URI
GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述        |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID      |
| er_id      | 是    | String | 企业路由器实例ID |
   
表2Query参数 
| 参数            | 是否必选 | 参数类型             | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| resource_type | 否    | String           | - 参数解释：流日志采集的资源类型   - 取值范围： - attachment：连接                                                                                                                                                                                                                                                                      |
| resource_id   | 否    | Array of strings | 连接对应的资源ID列表                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| limit         | 否    | Integer          | 每页返回的个数。 取值范围：1\~2000。 最小值：**1** 最大值：**2000**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| marker        | 否    | String           | 查询的页码id，为空时为查询第一页。 使用说明：必须与limit一起使用。 最小长度：**1** 最大长度：**128**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| sort_key      | 否    | Array of strings | - 参数解释：按关键字排序，默认按照id排序   - 取值范围: - id：资源标识   - name：资源名称   - state：资源状态      |
| sort_dir      | 否    | Array of strings | 返回结果按照升序或降序排列，默认为asc,降序为desc                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                        | 描述      |
|:---|:---|:---|
| flow_logs   | Array of [FlowLog] objects | 流日志详情   |
| request_id  | String                                                      | 请求ID    |
| total_count | Long                                                        | 总计数量    |
| page_info   | [PageInfo] object         | 分页查询的信息 |
   
 表4FlowLog 
| 参数                       | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|
| id                       | String  | 流日志ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| name                     | String  | 流日志名称                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| description              | String  | 流日志描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| project_id               | String  | 流日志任务创建者项目ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| resource_type            | String  | - 参数解释：流日志采集的资源类型   - 取值范围： - attachment：连接                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| resource_id              | String  | 采集的资源ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| log_group_id             | String  | 日志组ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| log_stream_id            | String  | 日志流ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| log_store_type           | String  | 流日志存储类型: - LTS: 云日志服务LTS，表示流日志存储在LTS服务侧                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| log_aggregation_interval | Integer | 日志聚合时间，单位s，取值范围：60-600                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| created_at               | String  | 创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| updated_at               | String  | 更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| state                    | String  | - 参数解释：日志资源状态   - 取值范围： - pending：等待中   - available：可用   - modifying：修改中   - deleting：删除中   - deleted：已删除   - failed：失败      |
| enabled                  | Boolean | - 参数解释：日志开关   - 取值范围： - true：开启   - false：关闭                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
 表5PageInfo 
| 参数            | 参数类型    | 描述                    |
|:---|:---|:---|
| next_marker   | String  | 下一个marker标识，为空时表示最后一页 |
| current_count | Integer | 当前列表中资源数量             |
   
#### 请求示例
查询流日志列表
```
GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs
```
#### 响应示例
**状态码：200**
OK
```
{
  "flow_logs" : [ {
    "id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
    "name" : "flow_log",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "resource_type" : "attachment",
    "resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
    "log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
    "log_store_type" : "LTS",
    "log_aggregation_interval" : 600,
    "created_at" : "2020-03-11T15:13:31.000Z",
    "updated_at" : "2022-03-11T15:13:31.000Z",
    "state" : "available",
    "enabled" : true,
    "description" : "ER流日志"
  } ],
  "page_info" : {
    "next_marker" : "1",
    "current_count" : 1
  },
  "total_count" : 1,
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.er.v3.region.ErRegion;
  import com.huaweicloud.sdk.er.v3.*;
  import com.huaweicloud.sdk.er.v3.model.*;
  public class ListFlowLogsSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          ErClient client = ErClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                  .build();
          ListFlowLogsRequest request = new ListFlowLogsRequest();
          request.withErId("{er_id}");
          try {
              ListFlowLogsResponse response = client.listFlowLogs(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdker.v3.region.er_region import ErRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdker.v3 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = ErClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(ErRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = ListFlowLogsRequest()
          request.er_id = "{er_id}"
          response = client.list_flow_logs(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      projectId := "{project_id}"
      auth, err := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := er.ErClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := er.NewErClient(hcClient)
      request := &model.ListFlowLogsRequest{}
  request.ErId = "{er_id}"
  response, err := client.ListFlowLogs(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ER/sdk?api=ListFlowLogs)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-er/ErrorCode.html)。
