ListTrafficMirrorSessions - 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:ListTrafficMirrorSessions

list

*TrafficMirrorSession

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TrafficMirrorSessionName	string	任意	ミラーセッションの名前です。名前の長さは 1～128 文字で、`http://` または `https://` で開始することはできません。	abc
MaxResults	integer	任意	返されるエントリの最大数です。有効値：1～100。デフォルト値：10。	10
NextToken	string	任意	次のクエリに使用するトークンです。有効値：初回クエリであり、後続のクエリを送信しない場合は、このパラメーターを無視してください。後続のクエリを送信する場合は、前回の呼び出しで返された NextToken の値を設定してください。	FFmyTO70tTpLG6I3FmYAXGKPd****
TrafficMirrorSourceId	string	任意	ミラーソースの ID です。ミラーソースとして指定できるのは、Elastic Network Interface (ENI) のみです。	eni-j6c8znm5l1yt4sox*****
TrafficMirrorTargetId	string	任意	ミラーターゲットの ID です。ミラーターゲットとして指定できるのは、ENI または Server Load Balancer (SLB) インスタンスのみです。	eni-j6c2fp57q8rr47rp****
TrafficMirrorFilterId	string	任意	トラフィックミラーフィルターの ID です。	tmf-j6cmls82xnc86vtpe****
VirtualNetworkId	integer	任意	異なるミラー化トラフィックを区別するために使用される VXLAN ネットワーク識別子 (VNI) です。有効値：0～16777215。VNI を使用して、ミラーターゲット側で異なるセッションからのミラー化トラフィックを識別できます。カスタム VNI を指定するか、システムが割り当てるランダムな VNI を使用できます。システムにランダムな VNI を割り当てさせたい場合は、このパラメーターを無視してください。	10
Priority	integer	任意	ミラーセッションの優先度です。有効値：1～32766。値が小さいほど優先度が高くなります。同一リージョンで同一アカウントにより作成されたミラーセッションには、同じ優先度を指定できません。	1
Enabled	boolean	任意	ミラーセッションを有効にするかどうかを指定します。有効値： false：ミラーセッションを有効にしません。 true：ミラーセッションを有効にします。	false
TrafficMirrorSessionIds	array	任意	ミラーセッションの ID です。N の最大値は 100 で、一度に最大 100 個のミラーセッションをクエリできます。	tms-j6cla50buc44ap8tu****
	string	任意	ミラーセッションの ID です。N の最大値は 100 で、一度に最大 100 個のミラーセッションをクエリできます。	tms-j6cla50buc44ap8tu****
RegionId	string	必須	ミラーセッションが属するリージョンの ID です。DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。トラフィックミラーをサポートするリージョンの詳細については、「トラフィックミラーの概要」をご参照ください。	cn-hongkong
ResourceGroupId	string	任意	ミラー化トラフィックが属するリソースグループの ID です。	rg-bp67acfmxazb4ph****
Tags	array<object>	任意	リソースのタグです。
	object	任意	リソースのタグです。
Key	string	任意	タグキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列であってはなりません。キーの長さは最大 64 文字で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。キーは英字で始まる必要がありますが、`aliyun` または `acs:` で始まってはいけません。`http://` または `https://` を含んではいけません。	FinanceDept
Value	string	任意	タグ値です。最大 20 個のタグ値を指定できます。タグ値は空文字列であっても構いません。タグ値の長さは最大 128 文字で、数字、ピリオド (.)、アンダースコア (_)、ハイフン (-) を含めることができます。タグ値は英字で始まる必要がありますが、`aliyun` または `acs:` で始まってはいけません。`http://` または `https://` を含んではいけません。	FinanceJoshua

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のクエリに使用するトークンです。有効値： NextToken が返されない場合、後続のクエリは送信されません。 NextToken の値が返される場合、その値が後続のクエリに使用されるトークンとなります。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	リクエストの ID です。	739CA01C-92EB-4C69-BCC0-280149C6F41E
TotalCount	string	返されたエントリの総数です。	1
TrafficMirrorSessions	array<object>	ミラーセッションの詳細です。
	array<object>
TrafficMirrorTargetId	string	ミラーターゲットの ID です。	eni-j6c2fp57q8rr47rp****
TrafficMirrorSessionId	string	ミラーセッションの ID です。	tms-j6cla50buc44ap8tu****
Priority	integer	ミラーセッションの優先度です。値が小さいほど優先度が高くなります。	1
TrafficMirrorTargetType	string	ミラーターゲットのタイプです。有効値： NetworkInterface：Elastic Network Interface (ENI) SLB：内部向け Server Load Balancer (SLB) インスタンス	NetworkInterface
PacketLength	integer	最大転送単位です。	1500
TrafficMirrorSessionDescription	string	ミラーセッションの説明です。	This is a session.
TrafficMirrorSessionStatus	string	ミラーセッションのステータスです。有効値： Creating Created Modifying Deleting	Created
Enabled	boolean	ミラーセッションが有効になっているかどうかを示します。 false true	false
TrafficMirrorSessionBusinessStatus	string	ミラーセッションのステータスです。 Normal FinancialLocked	Normal
VirtualNetworkId	integer	VNI を指定して、異なるミラー化トラフィックを区別できます。	10
TrafficMirrorFilterId	string	フィルターの ID です。	tmf-j6cmls82xnc86vtpe****
TrafficMirrorSessionName	string	ミラーセッションの名前です。	abc
TrafficMirrorSourceIds	array	ミラーソースの ID です。
	string	ミラーソースの ID です。	eni-j6c8znm5l1yt4sox****
ResourceGroupId	string	ミラーセッションが属するリソースグループの ID です。	rg-bp67acfmxazb4ph****
Tags	array<object>	タグリストです。
	object
Key	string	タグキーです。	FinanceDept
Value	string	タグ値です。	FinanceJoshua
CreationTime	string	セッションが作成された時刻です。	2023-09-05T15:26Z

例

成功レスポンス

JSONJSON

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "739CA01C-92EB-4C69-BCC0-280149C6F41E",
  "TotalCount": "1",
  "TrafficMirrorSessions": [
    {
      "TrafficMirrorTargetId": "eni-j6c2fp57q8rr47rp****",
      "TrafficMirrorSessionId": "tms-j6cla50buc44ap8tu****",
      "Priority": 1,
      "TrafficMirrorTargetType": "NetworkInterface",
      "PacketLength": 1500,
      "TrafficMirrorSessionDescription": "This is a session.",
      "TrafficMirrorSessionStatus": "Created",
      "Enabled": false,
      "TrafficMirrorSessionBusinessStatus": "Normal",
      "VirtualNetworkId": 10,
      "TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
      "TrafficMirrorSessionName": "abc",
      "TrafficMirrorSourceIds": [
        "eni-j6c8znm5l1yt4sox****"
      ],
      "ResourceGroupId": "rg-bp67acfmxazb4ph****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ],
      "CreationTime": "2023-09-05T15:26Z"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	IllegalParam.NextToken	The specified NextToken is invalid.

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

変更履歴

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