DescribeFlowlogs - 查詢流日誌 -

查詢流日誌。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:DescribeFlowlogs

get

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/*

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/{#FlowLogId}

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-42665544****
RegionId	string	否	流日誌所屬地區 ID。您可以通過調用 DescribeChildInstanceRegions 介面擷取地區 ID。	cn-hangzhou
FlowLogName	string	否	流日誌的名稱。名稱可以為空白或長度為 1～128 個字元，不能以 http://或 https://開頭。	myFlowlog
FlowLogId	string	否	流日誌 ID。	flowlog-m5evbtbpt****
Description	string	否	流日誌的描述資訊。描述可以為空白或長度為 1～256 個字元，不能以 http://或 https://開頭。	myFlowlog
CenId	string	否	雲企業網執行個體 ID。	cen-7qthudw0ll6jmc****
ProjectName	string	否	儲存捕獲流量的 Project 名稱。 Project 名稱長度為 3~63 字元，必須以小寫字母或者數字開頭和結尾，只能包括小寫字母、數字和短劃線（-）。	FlowLogProject
LogStoreName	string	否	儲存捕獲流量的 LogStore 名稱。 Logstore 名稱長度為 3~63 字元，必須以小寫字母或者數字開頭和結尾，只能包括小寫字母、數字、短劃線（-）和底線（_）。	FlowLogStore
Status	string	否	流日誌的狀態。取值： Active：已啟動。 Inactive：未啟動。	Active
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的條目數。最小值：1。預設值：20。	20
Tag	array	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
	object	否
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空白字串。最多支援 64 個字元，不能以`aliyun`或者`acs:`開頭，不能包含`http://`或者`https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	TagKey
Value	string	否	資源的標籤值。標籤值可以為空白或輸入不超過 128 個字元的字串，不能以`aliyun`或者`acs:`開頭，不能包含`http://`或者`https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue
TransitRouterAttachmentId	string	否	網路執行個體串連 ID。	tr-attach-qieks13jnt1cchy***
TransitRouterId	string	否	轉寄路由器執行個體 ID。	tr-uf654ttymmljlvh2x****
Interval	integer	否	流日誌捕獲流量的捕獲視窗時間長度。單位：秒。取值：60 或 600。預設值：600。	600
FlowLogVersion	string	否	流日誌的版本。建立流日誌時自動使用系統支援的最新版本，當前為 3。	3

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
PageSize	string	分頁查詢時每頁的條目數。	20
PageNumber	string	列表的頁碼。	1
RequestId	string	請求 ID。	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	列表條目數。	1
Success	string	當前介面調用是否成功。 true：成功。 false：失敗。	true
FlowLogs	object
FlowLog	array	流日誌資訊列表。
	object	流日誌的資訊。
Status	string	流日誌的狀態。 Active：已啟動。 Inactive：未啟動。	Active
CreationTime	string	流日誌的建立時間。時間按照 ISO8601 標準表示，並使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ。	2021-07-24T13:00:52Z
FlowLogName	string	流日誌的名稱。	myFlowlog
Description	string	流日誌的描述資訊。	myFlowlog
ProjectName	string	儲存捕獲流量的 Project 名稱。	FlowLogProject
CenId	string	雲企業網執行個體 ID。	cen-7qthudw0ll6jmc****
LogStoreName	string	儲存捕獲流量的 LogStore 名稱。	FlowLogStore
RegionId	string	流日誌所屬地區 ID。	cn-hangzhou
FlowLogId	string	流日誌 ID。	flowlog-m5evbtbpt****
TransitRouterAttachmentId	string	網路執行個體串連 ID。	tr-attach-5x4o4ynzuqbv6g****
TransitRouterId	string	轉寄路由器執行個體 ID。	tr-bp1g9313sx675zr1lajmj
LogFormatString	string	自訂流日誌記錄格式的字串。格式定義為： `${欄位 1}${欄位 2}${欄位 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	流日誌的版本。建立流日誌時自動使用系統支援的最新版本，當前為 3。	3
Interval	integer	流日誌捕獲流量的捕獲視窗時間長度。單位：秒。取值：60 或 600。預設值：600。	60
Tags	object
Tag	array	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue

樣本

正常返回樣本

JSON格式

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2021-07-24T13:00:52Z",
        "FlowLogName": "myFlowlog",
        "Description": "myFlowlog",
        "ProjectName": "FlowLogProject",
        "CenId": "cen-7qthudw0ll6jmc****",
        "LogStoreName": "FlowLogStore",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "flowlog-m5evbtbpt****",
        "TransitRouterAttachmentId": "tr-attach-5x4o4ynzuqbv6g****",
        "TransitRouterId": "tr-bp1g9313sx675zr1lajmj",
        "LogFormatString": "${srcaddr}${dstaddr}${bytes}",
        "FlowLogVersion": "3",
        "Interval": 60,
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	OperationUnsupported.action	This action is not support.	當前地區不支援該操作。
400	InvalidFlowlogId.NotFound	The specified flowlog id does not exist or does not match the cen Id.	參數中指定的flowlog不存在。
400	IllegalParam.TagValue	The tag values are not valid.	參數中指定的tag value不合法。
400	IllegalParam.TagKey	The tag keys are not valid.	參數中指定的tag key不合法。
400	InvalidDescription	Description is invalid.	描述不合法。
400	InvalidName	Name is invalid.	name不合法。
400	InvalidParameter.Interval	Interval is invalid.	指定的採樣頻率不合法。
400	InvalidParameter.FlowLogVersion	Flowlog version is invalid.	指定的flowlog版本不合法。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無許可權操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。