ListTrafficMirrorSessions - 查詢鏡像會話的詳細資料

更新時間:
Copy as MD

查詢鏡像會話的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ListTrafficMirrorSessions

list

*TrafficMirrorSession

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

請求參數

名稱

類型

必填

描述

樣本值

TrafficMirrorSessionName

string

鏡像會話的名稱。

名稱長度為 1~128 個字元,不能以http://https://開頭。

abc

MaxResults

integer

本次查詢的最大記錄條數。取值範圍:1~100。預設值:10

10

NextToken

string

是否擁有下一次查詢的令牌(Token)。取值:

  • 第一次查詢和沒有下一次查詢時,均無需填寫。

  • 如果有下一次查詢,取值為上一次 API 呼叫返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****

TrafficMirrorSourceId

string

鏡像源的執行個體 ID,目前支援彈性網卡作為鏡像源。

eni-j6c8znm5l1yt4sox*****

TrafficMirrorTargetId

string

鏡像目的的執行個體 ID,目前支援彈性網卡和私網Server Load Balancer執行個體作為鏡像目的。

eni-j6c2fp57q8rr47rp****

TrafficMirrorFilterId

string

流量鏡像篩選條件的執行個體 ID。

tmf-j6cmls82xnc86vtpe****

VirtualNetworkId

integer

指定 VNI,用來區分不同的鏡像流量,取值範圍為 0~16777215。您可以通過 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 介面擷取地區 ID。關於流量鏡像支援的地區,請參見流量鏡像概述

cn-hongkong

ResourceGroupId

string

需要查詢的流量鏡像所屬的資源群組 ID。

rg-bp67acfmxazb4ph****

Tags

array<object>

標籤列表。

object

標籤列表。

Key

string

資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值,則不能輸入Null 字元串。

一個標籤鍵最多支援 128 個字元,不能以aliyunacs:開頭,不能包含http://或者https://

FinanceDept

Value

string

資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值,可以輸入Null 字元串。

最多支援 128 個字元,不能以aliyunacs:開頭,不能包含http://或者https://

FinanceJoshua

返回參數

名稱

類型

描述

樣本值

object

是否擁有下一次查詢的令牌(Token)。取值:

  • 如果 NextToken 為空白表示沒有下一次查詢。

  • 如果 NextToken 有傳回值,該取值表示下一次查詢開始的令牌。

NextToken

string

是否擁有下一次查詢的令牌(Token)。取值:

  • 如果 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:彈性網卡。

  • SLB:私網Server Load Balancer執行個體。

NetworkInterface

PacketLength

integer

指定被鏡像的原始報文長度(不包含 VXLAN 報文長度),預設值 1500,取值範圍:648500,單位:位元組。

  • 該參數的大小會影響鏡像目的收到的報文長度,詳情請參見流量鏡像概述中的鏡像報文長度和 MTU 限制。

  • 該參數僅在部分地區可用,詳情請參見建立和管理流量鏡像中的鏡像報文長度參數描述。

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

樣本

正常返回樣本

JSON格式

{
  "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 status code

錯誤碼

錯誤資訊

描述

400 IllegalParam.NextToken The specified NextToken is invalid. 參數NextToken非法.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情