DescribeFlowLogs - Virtual Private Cloud - Alibaba Cloud ドキュメントセンター

フローログを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeFlowLogs

get

*FlowLog。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	フローログのリージョン ID。	cn-hangzhou。
FlowLogName	string	任意	フローログの名前。	myFlowlog。
FlowLogId	string	任意	フローログの ID。	fl-bp1f6qqhsrc2c12ta****
Description	string	任意	フローログの説明。	This is my Flowlog.
ResourceType	string	任意	キャッチするトラフィックのリソースタイプ。有効な値:	NetworkInterface。
ResourceId	string	任意	トラフィックをキャプチャするリソースの ID。	eni-askldfas****
TrafficType	string	任意	収集するトラフィックタイプ。有効な値:	All。
ProjectName	string	任意	キャプチャされたトラフィックを管理するプロジェクトの名前。	FlowLogProject。
LogStoreName	string	任意	キャプチャされたトラフィックを保存する Logstore の名前。	FlowLogStore。
Status	string	任意	フローログのステータス。有効な値:	Active。
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 20。	20
VpcId	string	任意	フローログをクエリする VPC の ID。	vpc-bp1nwd16gvo1wgs****
ResourceGroupId	string	任意	フローログが属するリソースグループの ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	任意	タグのリスト。
	object	任意	タグのリスト。
Key	string	任意	リソースのタグキー。最大 20 個のタグキーを指定できます。タグキーを空文字列にすることはできません。	FinanceDept。
Value	string	任意	リソースのタグ値。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。	FinanceJoshua。

レスポンスフィールド

フィールド	型	説明	例
	object	フローログの詳細。
PageSize	string	ページングクエリの 1 ページあたりのエントリ数。	20
PageNumber	string	ページ番号。	1
RequestId	string	リクエスト ID。	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	返されたエントリの総数。	1
Success	string	呼び出しが成功したかどうかを示します。有効な値:	true。
FlowLogs	object
FlowLog	array<object>	フローログのリスト。
	array<object>	フローログのリスト。
Status	string	フローログのステータス。有効な値:	Active。
CreationTime	string	フローログが作成された時間。	2022-01-21T03:08:50Z
FlowLogName	string	フローログの名前。	myFlowlog。
TrafficType	string	フローログがキャプチャするトラフィックタイプ。有効な値:	All。
ResourceType	string	フローログがキャプチャするトラフィックのリソースタイプ。有効な値:	NetworkInterface。
Description	string	フローログの説明。	Description。
ProjectName	string	キャプチャされたトラフィックを管理するプロジェクトの名前。	FlowLogProject。
LogStoreName	string	キャプチャされたトラフィックを保存する Logstore の名前。	FlowLogStore。
ResourceId	string	フローログによってトラフィックがキャプチャされるリソースの ID。	eni-askldfas****
RegionId	string	フローログのリージョン ID。	cn-hangzhou。
FlowLogId	string	フローログの ID。	fl-bp1f6qqhsrc2c12ta****
BusinessStatus	string	ビジネスステータス。有効な値:	Normal
AggregationInterval	integer	フローログのサンプリング間隔。単位: 分。	10
TrafficPath	object
TrafficPathList	array	収集されたトラフィックパス。有効な値:
	string	収集されたトラフィックパス。有効な値:	all。
ServiceType	string	クラウドサービスのマネージドタイプ。	sls。
ResourceGroupId	string	フローログが属するリソースグループの ID。	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	タグのリスト。
	object	タグのリスト。
Key	string	タグキー。	FinanceDept。
Value	string	タグ値。	FinanceJoshua。
FlowLogDeliverStatus	string	フローログの配信ステータス。有効な値:	FAILED。
FlowLogDeliverErrorMessage	string	フローログの log delivery が失敗した場合に返されるエラーメッセージ。考えられるエラーメッセージ:	UnavaliableTarget。
IpVersion	string	フローログによって収集されたトラフィックの IP アドレスタイプ。	IPv4
LogFormat	string

例

成功レスポンス

JSONJSON

{
  "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",
        "LogFormat": ""
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidInstanceId	Instance does not exist.	ENI インスタンスが存在しません。
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	指定されたプロジェクトまたは Logstore が存在しません。
400	SourceProjectNotExist	The Source Project or logstore does not exist.	指定された Simple Log Service のソースプロジェクトまたは Logstore が存在しません。
400	Unauthorized	This api does not support sub user or role.	この API オペレーションは RAM ユーザーまたはロールをサポートしていません。
400	ParameterInvalid	Invalid parameter.	入力パラメーターが無効です。
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。