ListTrafficMirrorFilters - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries filters for traffic mirroring.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TrafficMirrorFilterName	string	No	The name of the filter.	abc
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
TrafficMirrorFilterIds	array	No	The ID of the traffic mirror filter. The maximum value of N is 100, which specifies that you can query up to 100 filters at a time.
	string	No	The ID of the traffic mirror filter. The maximum value of N is 100, which specifies that you can query up to 100 filters at a time.	tmf-j6cmls82xnc86vtpe****
RegionId	string	Yes	The ID of the region to which the mirrored traffic 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 tag list.
	object	No	The tag list.
Key	string	No	The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and 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 can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value is returned for NextToken, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	739CA01C-92EB-4C69-BCC0-280149C6F41E
TotalCount	string	The number of entries returned.	1
MaxResults	integer	The maximum number of entries returned.	20
Count	integer	The number of entries returned.	5
TrafficMirrorFilters	array<object>	The information about the filters.
	object
TrafficMirrorFilterStatus	string	The status of the filter. Valid values: Creating Created Modifying Deleting	Created
TrafficMirrorFilterDescription	string	The description of the filter.	This is a filter.
TrafficMirrorFilterId	string	The ID of the filter.	tmf-j6cmls82xnc86vtpe****
TrafficMirrorFilterName	string	The filter name.	abc
IngressRules	array<object>	The information about the inbound rules.
	object
TrafficMirrorFilterRuleStatus	string	The status of the inbound rule. Valid values: Creating Created Modifying Deleting	Created
Action	string	The action of the inbound rule. Valid values: accept drop	accept
SourceCidrBlock	string	The source CIDR block of the inbound traffic.	0.0.0.0/0
TrafficDirection	string	The direction of the network traffic. Valid values: egress ingress	ingress
Protocol	string	The protocol that is used by the inbound traffic to be mirrored. Valid values: ALL ICMP TCP UDP	ALL
DestinationPortRange	string	The destination port range of the inbound traffic.	-1/-1
TrafficMirrorFilterRuleId	string	The ID of the inbound rule.	tmr-j6cezu8e68rnpepet****
DestinationCidrBlock	string	The destination CIDR block of the inbound traffic.	0.0.0.0/0
Priority	integer	The priority of the inbound rule. A smaller value indicates a higher priority.	1
TrafficMirrorFilterId	string	The ID of the filter associated with the inbound rule.	tmf-j6cmls82xnc86vtpe****
SourcePortRange	string	The destination port range of the inbound traffic.	-1/-1
EgressRules	array<object>	The information about the outbound rules.
	object
TrafficMirrorFilterRuleStatus	string	The status of the outbound rule. Valid values: Creating Created Modifying Deleting	Created
Action	string	The action of the outbound rule. Valid values: accept drop	accept
SourceCidrBlock	string	The source CIDR block of the outbound traffic.	10.0.0.0/24
TrafficDirection	string	The direction of the network traffic. Valid values: egress ingress	egress
Protocol	string	The protocol that is used by the outbound traffic to be mirrored. Valid values: ALL ICMP TCP UDP	TCP
DestinationPortRange	string	The destination port range of the outbound traffic.	22/40
TrafficMirrorFilterRuleId	string	The ID of the outbound rule.	tmr-j6c89rzmtd3hhdugq****
DestinationCidrBlock	string	The destination CIDR block of the outbound traffic.	10.0.0.0/24
Priority	integer	The priority of the outbound rule. A smaller value indicates a higher priority.	1
TrafficMirrorFilterId	string	The ID of the filter associated with the outbound rule.	tmf-j6cmls82xnc86vtpe****
SourcePortRange	string	The source port range of the outbound traffic.	22/40
ResourceGroupId	string	The ID of the resource group to which the traffic mirror session belongs.	rg-bp67acfmxazb4ph****
Tags	array<object>	The tag list.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
CreationTime	string	The time when the filter is created.	2023-09-05T15:26Z

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "739CA01C-92EB-4C69-BCC0-280149C6F41E",
  "TotalCount": "1",
  "MaxResults": 20,
  "Count": 5,
  "TrafficMirrorFilters": [
    {
      "TrafficMirrorFilterStatus": "Created",
      "TrafficMirrorFilterDescription": "This is a filter.",
      "TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
      "TrafficMirrorFilterName": "abc",
      "IngressRules": [
        {
          "TrafficMirrorFilterRuleStatus": "Created",
          "Action": "accept",
          "SourceCidrBlock": "0.0.0.0/0",
          "TrafficDirection": "ingress",
          "Protocol": "ALL",
          "DestinationPortRange": "-1/-1",
          "TrafficMirrorFilterRuleId": "tmr-j6cezu8e68rnpepet****",
          "DestinationCidrBlock": "0.0.0.0/0",
          "Priority": 1,
          "TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
          "SourcePortRange": "-1/-1"
        }
      ],
      "EgressRules": [
        {
          "TrafficMirrorFilterRuleStatus": "Created",
          "Action": "accept",
          "SourceCidrBlock": "10.0.0.0/24",
          "TrafficDirection": "egress",
          "Protocol": "TCP",
          "DestinationPortRange": "22/40",
          "TrafficMirrorFilterRuleId": "tmr-j6c89rzmtd3hhdugq****",
          "DestinationCidrBlock": "10.0.0.0/24",
          "Priority": 1,
          "TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
          "SourcePortRange": "22/40"
        }
      ],
      "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
2023-12-18	The response structure of the API has changed	View Change Details
2023-06-25	The response structure of the API has changed	View Change Details