Queries the details of a traffic mirror session.
Debugging
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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|
| 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 | 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:
| 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 |
| 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 mirroring, see Overview of traffic mirroring. | 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 | 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 | FinanceJoshua |
Response parameters
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
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 |