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	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、すべてのリクエスト間で一意である必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメータを設定しない場合、ClientToken は RequestId の値に設定されます。各 API リクエストの RequestId の値は異なる場合があります。	123e4567-e89b-12d3-a456-42665544****
RegionId	string	任意	フローログがデプロイされているリージョンの ID。 DescribeChildInstanceRegions 操作を呼び出して、最新のリージョン一覧を照会できます。	cn-hangzhou
FlowLogName	string	任意	フローログの名前。名前は省略可能です。名前を入力する場合、1 ～ 128 文字の長さである必要があり、http:// または https:// で始めることはできません。	myFlowlog
FlowLogId	string	任意	フローログの ID。	flowlog-m5evbtbpt****
Description	string	任意	フローログの説明。説明は省略可能です。説明を入力する場合、1 ～ 256 文字の長さである必要があり、http:// または https:// で始めることはできません。	myFlowlog
CenId	string	任意	Cloud Enterprise Network (CEN) インスタンスの ID。	cen-7qthudw0ll6jmc****
ProjectName	string	任意	フローログが保存されるプロジェクトの名前。名前は 3 ～ 63 文字の長さである必要があり、小文字、数字、ハイフン (-) を含めることができます。小文字または数字で始まるか終わる必要があります。	FlowLogProject
LogStoreName	string	任意	フローログが保存される Logstore の名前。名前は 3 ～ 63 文字の長さである必要があり、小文字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。小文字または数字で始まるか終わる必要があります。	FlowLogStore
Status	string	任意	フローログのステータス。有効な値: Active: フローログは有効です。 Inactive: フローログは無効です。	Active
PageNumber	integer	任意	返されるページのページ番号。デフォルト値: 1。	1
PageSize	integer	任意	ページあたりのエントリ数。最小値: 1。デフォルト値: 20。	20
Tag	array<object>	任意	タグに関する情報。各呼び出しで最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	タグキー。タグキーを空文字列にすることはできません。タグキーは最大 64 文字の長さで、`acs:` または `aliyun` で始めることはできません。`http://` または `https://` を含めることはできません。最大 20 個のタグキーを指定できます。	TagKey
Value	string	任意	タグ値。タグ値は 0 ～ 128 文字の長さで、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。各タグキーには一意のタグ値が必要です。各呼び出しで最大 20 個のタグ値を指定できます。	TagValue
TransitRouterAttachmentId	string	任意	ネットワークインスタンス接続の ID。	tr-attach-qieks13jnt1cchy****
TransitRouterId	string	任意	トランジットルーターの ID。	tr-uf654ttymmljlvh2x****
Interval	integer	任意	ログデータを収集する時間ウィンドウ。単位: 秒。有効な値: 60 または 600。デフォルト値: 600。	600
FlowLogVersion	string	任意	フローログのバージョン。フローログは最新バージョン (3) で自動的に作成されます。	3

レスポンスフィールド

フィールド	型	説明	例
	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	The status of the flow log. Valid values: Active: The flow log is enabled. Inactive: The flow log is disabled.	Active
CreationTime	string	The time when the flow log was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2021-07-24T13:00:52Z
FlowLogName	string	The name of the flow log.	myFlowlog
Description	string	The description of the flow log.	myFlowlog
ProjectName	string	The name of the project that stores the captured traffic data.	FlowLogProject
CenId	string	The ID of the Cloud Enterprise Network (CEN) instance.	cen-7qthudw0ll6jmc****
LogStoreName	string	The Logstore that stores the captured traffic data.	FlowLogStore
RegionId	string	The region ID of the flow log.	cn-hangzhou
FlowLogId	string	The ID of the flow log.	flowlog-m5evbtbpt****
TransitRouterAttachmentId	string	The ID of the network instance connection	tr-attach-5x4o4ynzuqbv6g****
TransitRouterId	string	The ID of the transit router.	tr-bp1g9313sx675zr1lajmj
LogFormatString	string	The string that defines the format of the flow log. Format: `${Field 1}${Field 2}${Field 3}`	${srcaddr}${dstaddr}${bytes}
FlowLogVersion	string	The flow log version. Flow logs are automatically created in the latest version, which is 3.	3
Interval	integer	The time window for collecting log data. Unit: seconds. Valid values: 60 or 600 Default value: 600.	60
Tags	object
Tag	array<object>	The tags.
	object	Tag N to add to the instance.
Key	string	The tag key.	TagKey
Value	string	The tag value.	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.

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

変更履歴

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