查詢流日志。
調試
您可以在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 |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的條目數。最小值：1。默認值：20。 | 20 |
| Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
| object | 否 | |||
| Key | string | 否 | 資源的標簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
| Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串，不能以 每一個標簽鍵對應一個標簽值，一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
| TransitRouterAttachmentId | string | 否 | 網絡實例連接 ID。 | tr-attach-qieks13jnt1cchy*** |
| TransitRouterId | string | 否 | 轉發路由器實例 ID。 | tr-uf654ttymmljlvh2x**** |
| Interval | integer | 否 | 流日志捕獲流量的捕獲窗口時長。單位：秒。取值：60 或 600。默認值：600。 | 600 |
| FlowLogVersion | string | 否 | 流日志的版本。 創建流日志時自動使用系統支持的最新版本，當前為 3。 | 3 |
返回參數
示例
正常返回示例
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. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-14 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-05-22 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-12-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-01-09 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2022-12-02 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2022-09-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2022-09-14 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |