All Products
Search

This Product

    Virtual Private Cloud:ListTrafficMirrorSessions

    Document Center

    Virtual Private Cloud:ListTrafficMirrorSessions

    Last Updated:Mar 27, 2026

    Queries traffic mirror sessions.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    Operation Access level Resource type Condition key Associated operation
    vpc:ListTrafficMirrorSessions list
    *TrafficMirrorSession
    acs:vpc:{#regionId}:{#accountId}:trafficmirrorsession/*
      none
    		 none

    Request parameters

    Parameter Type Required Description Example
    TrafficMirrorSessionName string No

    The name of the traffic mirror session.

    The name must be 1 to 128 characters in length, and cannot start with http:// or https://.

    		 abc
    MaxResults integer No

    The maximum number of entries to return. Valid values: 1 to 100. Default value: 10.

    		 10
    NextToken string No

    The token that is used for the next query. Valid values:

    • If this is your first query and no next queries are to be sent, ignore this parameter.
    • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
    		 FFmyTO70tTpLG6I3FmYAXGKPd****
    TrafficMirrorSourceId string No

    The ID of the traffic mirror source. You can specify only an elastic network interface (ENI) as the mirror source.

    		 eni-j6c8znm5l1yt4sox*****
    TrafficMirrorTargetId string No

    The ID of the traffic mirror destination. You can specify only an ENI or a Server Load Balancer (SLB) instance as a traffic mirror destination.

    		 eni-j6c2fp57q8rr47rp****
    TrafficMirrorFilterId string No

    The ID of the traffic mirror filter.

    		 tmf-j6cmls82xnc86vtpe****
    VirtualNetworkId integer No

    The VXLAN network identifier (VNI) that is used to distinguish different mirrored traffic. Valid values: 0 to 16777215. You can use VNIs to identify mirrored traffic from different sessions at the traffic mirror destination. You can specify a custom VNI or use a random VNI that is allocated by the system. If you want the system to randomly allocate a VNI, ignore this parameter.

    		 10
    Priority integer No

    The priority of the traffic mirror session. Valid values: 1 to 32766.

    A smaller value indicates a higher priority. You cannot specify identical priorities for traffic mirror sessions that are created in the same region by using the same account.

    		 1
    Enabled boolean No

    Specifies whether to enable the traffic mirror session. Valid values:

    • false: does not enable the traffic mirror session.
    • true: enables the traffic mirror session.
    		 false
    TrafficMirrorSessionIds array No

    The IDs of the traffic mirror session. The maximum value of N is 100, which indicates that you can query up to 100 traffic mirror sessions at a time.
    string No

    The ID of the traffic mirror session. The maximum value of N is 100, which indicates that you can query up to 100 traffic mirror sessions at a time.

    		 tms-j6cla50buc44ap8tu****
    RegionId string Yes

    The ID of the region to which the traffic mirror session belongs. You can call the DescribeRegions operation to query the most recent region list. For more information about regions that support traffic mirror, see Overview of traffic mirror.

    		 cn-hongkong
    ResourceGroupId string No

    The ID of the resource group to which the mirrored traffic belongs.

    		 rg-bp67acfmxazb4ph****
    Tags array<object> No

    The tags of the resource.
    object No

    The tag of the resource.
    Key string No

    The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.

    The key cannot exceed 64 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The key must start with a letter but cannot start with aliyun or acs:. The key cannot contain http:// or https://.

    		 FinanceDept
    Value string No

    The tag value. You can specify at most 20 tag values. The tag value can be an empty string.

    The tag value cannot exceed 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with aliyun or acs:. It cannot contain http:// or https://.

    		 FinanceJoshua

    Response parameters

    Parameter Type Description Example
    object
    NextToken string

    The token that is used for the next query. Valid values:

    • If no value is returned for NextToken, no next queries are sent.
    • If a value of NextToken is returned, the value is the token that is used for the subsequent query.
    		 FFmyTO70tTpLG6I3FmYAXGKPd****
    RequestId string

    The ID of the request.

    		 739CA01C-92EB-4C69-BCC0-280149C6F41E
    TotalCount string

    The total number of entries returned.

    		 1
    TrafficMirrorSessions array<object>

    The details about the traffic mirror session.
    TrafficMirrorSession object
    TrafficMirrorTargetId string

    The ID of the traffic mirror destination.

    		 eni-j6c2fp57q8rr47rp****
    TrafficMirrorSessionId string

    The ID of the traffic mirror session.

    		 tms-j6cla50buc44ap8tu****
    Priority integer

    The priority of the traffic mirror session.

    A smaller value indicates a higher priority.

    		 1
    TrafficMirrorTargetType string

    The type of the traffic mirror destination. Valid values:

    • NetworkInterface: an elastic network interface (ENI)
    • SLB: an internal-facing Server Load Balancer (SLB) instance
    		 NetworkInterface
    PacketLength integer

    The maximum transmission unit.

    		 1500
    TrafficMirrorSessionDescription string

    The description of the traffic mirror session.

    		 This is a session.
    TrafficMirrorSessionStatus string

    The status of the traffic mirror session. Valid values:

    • Creating
    • Created
    • Modifying
    • Deleting
    		 Created
    Enabled boolean

    Indicates whether the traffic mirror session was enabled.

    • false
    • true
    		 false
    TrafficMirrorSessionBusinessStatus string

    The status of the traffic mirror session.

    • Normal
    • FinancialLocked
    		 Normal
    VirtualNetworkId integer

    You can specify VNIs to distinguish different mirrored traffic.

    		 10
    TrafficMirrorFilterId string

    The ID of the filter.

    		 tmf-j6cmls82xnc86vtpe****
    TrafficMirrorSessionName string

    The name of the traffic mirror session.

    		 abc
    TrafficMirrorSourceIds array

    The ID of the traffic mirror source.
    TrafficMirrorSourceId string

    The ID of the traffic mirror source.

    		 eni-j6c8znm5l1yt4sox****
    ResourceGroupId string

    The ID of the resource group to which the traffic mirror session belongs.

    		 rg-bp67acfmxazb4ph****
    Tags array<object>

    The tag list.
    Tag object
    Key string

    The tag key.

    		 FinanceDept
    Value string

    The tag value.

    		 FinanceJoshua
    CreationTime string

    The time when the session is created.

    		 2023-09-05T15:26Z

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status code Error code Error message Description
    400 IllegalParam.NextToken The specified NextToken is invalid. The specified NextToken is invalid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change time Summary of changes Operation
    2024-07-31 The Error code has changed View Change Details
    2023-12-18 The response structure of the API has changed View Change Details
    2023-08-30 API Description Update View Change Details