華為云計算 云知識 查詢流日志列表ListFlowLogs
查詢流日志列表ListFlowLogs

 

功能介紹

查詢提交請求的租戶的所有流日志列表,并根據(jù)過濾條件進(jìn)行過濾。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

GET /v1/{project_id}/fl/flow_logs

樣例:

GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog

參數(shù)說明請參見表1。

表1 參數(shù)說明

名稱

是否必選

參數(shù)類型

說明

project_id

String

id

String

  • 功能說明:流日志ID

name

String

  • 流日志名稱
  • 取值范圍:0-64個字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

tenant_id

String

  • 功能說明:項目ID

description

String

  • 功能說明:流日志描述
  • 取值范圍:0-255個字符,不能包含“<”和“>”

resource_type

String

  • 功能說明:流日志采集的資源類型
  • 取值范圍:
    • port:網(wǎng)卡。
    • vpc:VPC內(nèi)所有的網(wǎng)卡。
    • network:子網(wǎng)內(nèi)所有的網(wǎng)卡。

resource_id

String

  • 功能說明:要采集的資源ID

traffic_type

String

  • 功能說明:流日志采集類型
  • 取值范圍:
    • all:采集指定資源的全部流量。
    • accept:采集指定資源允許傳入、傳出的流量。
    • reject:采集指定資源拒絕傳入、傳出的流量。

log_group_id

String

  • 功能說明:日志組ID。

請在 云日志 服務(wù)中獲取,詳情請參見《云日志服務(wù)用戶指南》。

log_topic_id

String

  • 功能說明:日志主題ID。

請在云日志服務(wù)中獲取,詳情請參見《云日志服務(wù)用戶指南》

log_store_type

String

  • 功能說明:流日志存儲類型。
  • 取值范圍:
    • lts:存儲類型為云日志服務(wù)( LTS )。

status

String

流日志狀態(tài)

  • ACTIVE:開啟
  • DOWN:關(guān)閉
  • ERROR:異常故障

limit

Integer

分頁查詢每頁返回的記錄個數(shù),取值范圍為0~intmax(2^31-1),默認(rèn)值2000。

limit需要和marker配合使用,詳細(xì)規(guī)則請見marker的參數(shù)說明。

marker

String

分頁查詢的起始資源ID,表示從指定資源的下一條記錄開始查詢。

marker需要和limit配合使用:

  • 若不傳入marker和limit參數(shù),查詢結(jié)果返回第一頁全部資源記錄。
  • 若不傳入marker參數(shù),limit為10,查詢結(jié)果返回第1~10條資源記錄。
  • 若marker為第10條記錄的資源ID,limit為10,查詢結(jié)果返回第11~20條資源記錄。
  • 若marker為第10條記錄的資源ID,不傳入limit參數(shù),查詢結(jié)果返回第11條及之后的所有資源記錄。

請求參數(shù)

請求示例

GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog

響應(yīng)參數(shù)

表2 響應(yīng)參數(shù)

名稱

參數(shù)類型

說明

flow_logs

Array of FlowLog objects

FlowLog對象列表,請參見表3。

表3 FlowLog對象說明

名稱

參數(shù)類型

說明

id

String

  • 功能說明:流日志ID

name

String

  • 功能說明:流日志名稱
  • 取值范圍:0-64個字符,支持?jǐn)?shù)字、字母、中文、_(下劃線)、-(中劃線)、.(點(diǎn))

tenant_id

String

  • 功能說明:項目ID

description

String

  • 功能說明:流日志描述
  • 取值范圍:0-255個字符,不能包含“<”和“>”

resource_type

String

  • 功能說明:流日志采集的資源類型
  • 取值范圍:
    • port:網(wǎng)卡。
    • vpc:VPC內(nèi)所有的網(wǎng)卡。
    • network:子網(wǎng)內(nèi)所有的網(wǎng)卡。

resource_id

String

  • 功能說明:要采集的資源ID

traffic_type

String

  • 功能說明:流日志采集類型
  • 取值范圍:
    • all:采集指定資源的全部流量。
    • accept:采集指定資源允許傳入、傳出的流量。
    • reject:采集指定資源拒絕傳入、傳出的流量。

log_group_id

String

  • 功能說明:日志組ID。

請在云日志服務(wù)中獲取,詳情請參見《云日志服務(wù)用戶指南》

log_topic_id

String

  • 功能說明:日志主題ID。

請在云日志服務(wù)中獲取,詳情請參見《云日志服務(wù)用戶指南》。

log_store_type

String

  • 功能說明:流日志存儲類型。
  • 取值范圍:
    • lts:存儲類型為云日志服務(wù)(LTS)。

admin_state

Boolean

  • 功能說明:是否開啟流日志

status

String

  • 功能說明:流日志狀態(tài)
  • 取值范圍:
    • ACTIVE:開啟
    • DOWN:關(guān)閉
    • ERROR:異常故障

created_at

String

  • 功能說明:流日志創(chuàng)建時間
  • 取值范圍:UTC時間格式,yyyy-MM-ddTHH:mm:ss

updated_at

String

  • 功能說明:流日志更新時間
  • 取值范圍:UTC時間格式,yyyy-MM-ddTHH:mm:ss

響應(yīng)示例

{
    "flow_logs": [
        {
            "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a",
            "name": "flowlog",
            "description": "just a test",
            "tenant_id": "b2782e6708b8475c993e6064bc456bf8",
            "resource_type": "port",
            "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde",
            "traffic_type": "reject",
            "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
            "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
            "log_store_type": "lts",
            "created_at": "2019-01-14T11:03:02",
            "updated_at": "2019-01-14T11:03:02",
            "status": "ACTIVE",
            "admin_state": true
        }
    ]
}

狀態(tài)碼

請參見狀態(tài)碼。

錯誤碼

請參考錯誤碼