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 です。リージョン ID は、DescribeRegions インターフェイスを呼び出すことで取得できます。	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: Elastic Network Interface (ENI)。 VSwitch: VSwitch 内のすべての ENI。 VPC: VPC 内のすべての ENI。	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	任意	ページネーションクエリにおける 1 ページあたりの項目数です。最大値は 50、デフォルト値は 20 です。	20
VpcId	string	任意	フローログを表示する VPC の ID です。	vpc-bp1nwd16gvo1wgs****
ResourceGroupId	string	任意	フローログのリソースグループ ID です。	rg-bp67acfmxazb4ph****
Tags	array<object>	任意	タグのリストです。
	object	任意	タグのリストです。
Key	string	任意	タグキーです。最大 20 個のタグキーがサポートされます。この値を渡す必要がある場合、空文字列にすることはできません。タグキーは最大 128 文字で、`aliyun` または `acs:` で開始することはできません。また、`http://` または `https://` を含んではいけません。	FinanceDept
Value	string	任意	タグ値です。最大 20 個のタグ値がサポートされます。この値を渡す必要がある場合、空文字列にすることもできます。タグ値は最大 128 文字で、`aliyun` または `acs:` で開始することはできません。また、`http://` または `https://` を含んではいけません。	FinanceJoshua

レスポンスフィールド

フィールド	型	説明	例
	object	フローログの詳細情報です。
PageSize	string	ページネーションクエリにおける 1 ページあたりの項目数です。	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: Elastic Network Interface。 VSwitch: VSwitch 内のすべての Elastic Network Interface。 VPC: VPC 内のすべての Elastic Network Interface。	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

例

成功レスポンス

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"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidInstanceId	Instance does not exist.
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.
400	SourceProjectNotExist	The Source Project or logstore does not exist.
400	Unauthorized	This api does not support sub user or role.
400	ParameterInvalid	Invalid parameter.
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.

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

変更履歴

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