DescribeFlowLogs - 查詢流日誌 - Virtual Private Cloud

調用DescribeFlowLogs介面查詢流日誌。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeFlowLogs

get

*FlowLog

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	流日誌所屬的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
FlowLogName	string	否	流日誌名稱。名稱長度為 1～128 個字元，不能以`http://`或`https://`開頭。	myFlowlog
FlowLogId	string	否	流日誌 ID。	fl-bp1f6qqhsrc2c12ta****
Description	string	否	流日誌描述資訊。描述長度為 1～256 個字元，不能以`http://`或`https://`開頭。	This is my Flowlog.
ResourceType	string	否	要擷取的流量的資源類型。取值： NetworkInterface：彈性網卡。 VSwitch：交換器內的所有彈性網卡。 VPC：專用網路內的所有彈性網卡。	NetworkInterface
ResourceId	string	否	要擷取的流量的資源 ID。	eni-askldfas****
TrafficType	string	否	採集的流量類型。取值： All：全部流量。 Allow：存取控制允許的流量。 Drop：存取控制拒絕的流量。	All
ProjectName	string	否	管理捕獲到的流量的 Project。	FlowLogProject
LogStoreName	string	否	儲存捕獲到的流量的 Logstore。	FlowLogStore
Status	string	否	流日誌的狀態。取值： Active：流日誌為啟動狀態。 Activating：流日誌正在建立中。 Inactive：流日誌為未啟動狀態。	Active
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的行數，最大值為 50，預設值為 20。	20
VpcId	string	否	所要查看流日誌的 VPC 的 ID。	vpc-bp1nwd16gvo1wgs****
ResourceGroupId	string	否	流日誌所屬的資源群組 ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	否	標籤列表。
	object	否	標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	FinanceJoshua

返回參數

名稱	類型	描述	樣本值
	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>	流日誌列表。
	array<object>	流日誌列表。
Status	string	流日誌的狀態。取值： Active：流日誌為啟動狀態。 Activating：流日誌正在建立中。 Inactive：流日誌為未啟動狀態。	Active
CreationTime	string	流日誌的建立時間。	2022-01-21T03:08:50Z
FlowLogName	string	流日誌名稱。	myFlowlog
TrafficType	string	流日誌擷取的流量類型。取值： All：全部流量。 Allow：存取控制允許的流量。 Drop：存取控制拒絕的流量。	All
ResourceType	string	流日誌擷取的流量的資源類型： NetworkInterface：彈性網卡。 VSwitch：交換器內的所有彈性網卡。 VPC：專用網路內的所有彈性網卡。	NetworkInterface
Description	string	流日誌描述資訊。	Description
ProjectName	string	管理捕獲到的流量的 Project。	FlowLogProject
LogStoreName	string	儲存捕獲到的流量的 Logstore。	FlowLogStore
ResourceId	string	流日誌擷取的流量的資源 ID。	eni-askldfas****
RegionId	string	流日誌所屬地區 ID。	cn-hangzhou
FlowLogId	string	流日誌 ID。	fl-bp1f6qqhsrc2c12ta****
BusinessStatus	string	業務狀態。取值： Normal：正常狀態。 FinancialLocked：欠費鎖定。	Normal
AggregationInterval	integer	流日誌的採樣間隔。單位：分鐘。	10
TrafficPath	object
TrafficPathList	array	採集的流量路徑。取值： all：表示全量採集。 internetGateway：表示公網流量採集。
	string	採集的流量路徑。取值： all（預設值）：表示全量採集。 internetGateway：表示公網流量採集。說明流量路徑功能預設不開放，如需使用，請提交工單申請。	all
ServiceType	string	雲端服務的託管類型。可以為空白，表示該流日誌為使用者自己建立。非空時只支援取值為：sls，表示該流日誌為通過Log Service控制台建立。說明通過Log Service控制台建立的流日誌執行個體可以展示在 VPC 列表中，但在 VPC 中無法對該流日誌執行個體進行修改、啟動、停止、刪除操作，如果您需要對該流日誌進行相關操作，您可以登入Log Service控制台對其進行修改、啟動、停止、刪除操作。	sls
ResourceGroupId	string	流日誌所屬的資源群組 ID。	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	FinanceDept
Value	string	標籤值。	FinanceJoshua
FlowLogDeliverStatus	string	流日誌的投遞狀態，取值： SUCCESS：投遞成功。 FAILED：投遞失敗。	FAILED
FlowLogDeliverErrorMessage	string	當流日誌投遞失敗時，可以根據報錯資訊排查問題，可能的報錯資訊有： UnavaliableTarget：Log Service SLS 的 Logstore 不可用，無法接收日誌。建議查看對應 Logstore 是否真實存在且可訪問。 ProjectNotExist： Log Service SLS 的 Project 不存在。建議刪除原流日誌，建立新流日誌指向真實存在的 Project。 UnknownError：發生內部錯誤，請稍後重試。	UnavaliableTarget
IpVersion	string	流日誌採集流量的 IP 位址類型。	IPv4

樣本

正常返回樣本

JSON格式

{
  "PageSize": "20",
  "PageNumber": "1",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1",
  "TotalCount": "1",
  "Success": "true",
  "FlowLogs": {
    "FlowLog": [
      {
        "Status": "Active",
        "CreationTime": "2022-01-21T03:08:50Z",
        "FlowLogName": "myFlowlog",
        "TrafficType": "All",
        "ResourceType": "NetworkInterface",
        "Description": "Description",
        "ProjectName": "FlowLogProject",
        "LogStoreName": "FlowLogStore",
        "ResourceId": "eni-askldfas****",
        "RegionId": "cn-hangzhou",
        "FlowLogId": "fl-bp1f6qqhsrc2c12ta****",
        "BusinessStatus": "Normal",
        "AggregationInterval": 10,
        "TrafficPath": {
          "TrafficPathList": [
            "all"
          ]
        },
        "ServiceType": "sls",
        "ResourceGroupId": "rg-bp67acfmxazb4ph****",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "FlowLogDeliverStatus": "FAILED",
        "FlowLogDeliverErrorMessage": "UnavaliableTarget",
        "IpVersion": "IPv4"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidInstanceId	Instance does not exist.	執行個體不存在。
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	指定的專案或logstore不存在。
400	SourceProjectNotExist	The Source Project or logstore does not exist.	SLS源專案或日誌庫不存在。
400	Unauthorized	This api does not support sub user or role.	此API不支援子使用者或角色。
400	ParameterInvalid	Invalid parameter.	入參非法
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.

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

變更歷史

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