DescribeFlowlogs - Cloud Enterprise Network - 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cen:DescribeFlowlogs

get

*Flowlog

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

*Flowlog

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。	123e4567-e89b-12d3-a456-42665544****
RegionId	string	任意	フローログのリージョン ID。	cn-hangzhou。
FlowLogName	string	任意	フローログの名前。	myFlowlog。
FlowLogId	string	任意	フローログの ID。	flowlog-m5evbtbpt****
Description	string	任意	フローログの説明。	myFlowlog。
CenId	string	任意	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-7qthudw0ll6jmc****
ProjectName	string	任意	キャプチャされたトラフィックを保存するプロジェクトの名前。	FlowLogProject。
LogStoreName	string	任意	キャプチャされたトラフィックを保存する Logstore の名前。	FlowLogStore。
Status	string	任意	フローログのステータス。有効な値:	Active。
PageNumber	integer	任意	ページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最小値: 1。デフォルト値: 20。	20
Tag	array<object>	任意	タグ情報。フォーマットについては、以下のサブパラメーターの説明を参照してください。
	object	任意
Key	string	任意	リソースのタグキー。時間などの他のパラメーターとは無関係です。	TagKey。
Value	string	任意	リソースのタグ値。時間などの他のパラメーターとは無関係です。	TagValue。
TransitRouterAttachmentId	string	任意	ネットワークインスタンス接続の ID。	tr-attach-qieks13jnt1cchy***
TransitRouterId	string	任意	トランジットルーターインスタンスの ID。	tr-uf654ttymmljlvh2x****
Interval	integer	任意	フローログのキャプチャウィンドウの持続時間。単位: 秒。有効な値: 60 または 600。デフォルト値: 600。	600
FlowLogVersion	string	任意	フローログのバージョン。API 呼び出し時にフローログを作成する場合、システムでサポートされている最新バージョンが自動的に使用されます。現在のバージョンは 3 です。	3

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
PageSize	string	ページングクエリの 1 ページあたりのエントリ数。	20
PageNumber	string	ページ番号。	1
RequestId	string	リクエスト ID。	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1
TotalCount	string	返されたエントリの総数。	1
Success	string	現在の API 呼び出しが成功したかどうかを示します。	true。
FlowLogs	object
FlowLog	array<object>	フローログのリスト。
	array<object>	フローログ情報。フォーマットの詳細については、以下のフィールドを参照してください。
Status	string	フローログのステータス。有効な値: Active: フローログは有効です。 Inactive: フローログは無効です。	Active
CreationTime	string	フローログが作成された時刻。時刻は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式に従います。時刻は UTC で表示されます。	2021-07-24T13:00:52Z
FlowLogName	string	フローログの名前。	myFlowlog
Description	string	フローログの説明。	myFlowlog
ProjectName	string	キャプチャされたトラフィックデータを保存するプロジェクトの名前。	FlowLogProject
CenId	string	Cloud Enterprise Network (CEN) インスタンスの 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	フローログのフォーマットを定義する文字列。フォーマット: `${Field 1}${Field 2}${Field 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	フローログのバージョン。フローログは最新バージョン (3) で自動的に作成されます。	3
Interval	integer	ログデータを収集する時間ウィンドウ。単位: 秒。有効な値: 60 または 600。デフォルト値: 600。	60
Tags	object
Tag	array<object>	タグ。
	object	インスタンスに追加するタグ N。
Key	string	タグキー。	TagKey
Value	string	タグ値。	TagValue

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
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.	パラメーターで指定されたフローログが存在しません。
400	IllegalParam.TagValue	The tag values are not valid.	リクエストに指定されたタグ値が無効です。
400	IllegalParam.TagKey	The tag keys are not valid.	リクエストに指定されたタグキーが無効です。
400	InvalidDescription	Description is invalid.	説明が無効です。
400	InvalidName	Name is invalid.	名前が無効です。
400	InvalidParameter.Interval	Interval is invalid.	指定されたサンプリング周波数が無効です。
400	InvalidParameter.FlowLogVersion	Flowlog version is invalid.	指定されたフローログのバージョンが無効です。
400	InvalidParameter	Invalid parameter.	パラメーターが無効です。
400	Unauthorized	The AccessKeyId is unauthorized.	アカウントにこの操作を実行する権限がありません。

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

変更履歴

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