Call CreateTrafficMirrorFilterRules to create inbound and outbound traffic mirror rules - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Creates an inbound or outbound rule for traffic mirror.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:CreateTrafficMirrorFilterRules

create

*TrafficMirrorFilter

acs:vpc:{#regionId}:{#accountId}:trafficmirrorfilter/{#TrafficMirrorFilterId}

None

Request parameters

Parameter	Type	Required	Description	Example
TrafficMirrorFilterId	string	Yes	The ID of the filter.	tmf-j6cmls82xnc86vtpe****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not set this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to check the request without performing the operation. Valid values: true: checks the request without performing the operation. The system checks the required parameters, request format, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false (default): sends the request. After the request passes the check, the operation is performed.	false
IngressRules	array<object>	No	The information about the inbound rules.
	object	No	The information about the inbound rule.
Action	string	No	The policy of the inbound rule. Valid values: accept: collects network traffic. drop: drops network traffic.	accept
SourceCidrBlock	string	No	The source CIDR block of the inbound traffic.	10.0.0.0/24
Protocol	string	No	The protocol that is used by the inbound traffic to be mirrored. Valid values: ALL: all protocols ICMP: Internet Control Message Protocol. TCP: Transmission Control Protocol. UDP: User Datagram Protocol.	TCP
IpVersion	string	Yes	The IP version of the instance. The following value may be returned: IPv4: IPv4 IPv6: IPv6	IPv4
DestinationPortRange	string	No	The destination port range of the inbound traffic. Valid value: 1 to 65535. Separate the first and the last port with a forward slash (/). For example, 1/200 or 80/80. Note If the IngressRules.N.Protocol parameter is set to ALL or ICMP, you do not need to set this parameter. In this case, all ports are available.	80/120
Priority	integer	No	The priority of the inbound rule. A smaller value indicates a higher priority. The maximum value of N is 10. You can configure up to 10 inbound rules for a filter.	1
DestinationCidrBlock	string	No	The destination CIDR block of the inbound traffic.	10.0.0.0/24
SourcePortRange	string	No	The source port range of the inbound traffic. Valid value: 1 to 65535. Separate the first and last port with a forward slash (/). For example 1/200 and 80/80. You cannot set this parameter to -1/-1, which indicates all ports. Note If the IngressRules.N.Protocol parameter is set to ALL or ICMP, you do not need to set this parameter. In this case, all ports are available.	80/120
EgressRules	array<object>	No	The information about the outbound rule.
	object	No	The information about the outbound rule.
Action	string	Yes	The collection policy of the outbound rule. Valid values: accept: accepts network traffic. drop: drops network traffic.	accept
SourceCidrBlock	string	No	The source CIDR block of the outbound traffic.	10.0.0.0/24
Protocol	string	Yes	The protocol that is used by the outbound traffic to be mirrored. Valid values: ALL: all protocols ICMP: Internet Control Message Protocol. TCP: Transmission Control Protocol. UDP: User Datagram Protocol.	TCP
IpVersion	string	Yes	The IP version of the instance. Valid values: IPv4: IPv4 IPv6: IPv6	IPv4
DestinationPortRange	string	No	The destination port range of the outbound traffic. Valid value: 1 to 65535. Separate the first and last port with a forward slash (/). For example 1/200 and 80/80. You cannot set this parameter to -1/-1, which indicates all ports. Note If EgressRules.N.Protocol is set to ALL or ICMP, you do not need to set this parameter. In this case, all ports are available.	22/40
Priority	integer	No	The priority of the outbound rule. A smaller value indicates a higher priority. The maximum value of N is 10. You can configure up to 10 outbound rules for a filter.	1
DestinationCidrBlock	string	No	The destination CIDR block of the outbound traffic.	10.0.0.0/24
SourcePortRange	string	No	The source port range of the outbound traffic. Valid value: 1 to 65535. Separate the first and last port with a forward slash (/). For example 1/200 and 80/80. You cannot set this parameter to -1/-1, which indicates all ports. Note If EgressRules.N.Protocol is set to ALL or ICMP, you do not need to set this parameter. In this case, all ports are available.	22/40
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 mirror, see Overview of traffic mirror.	cn-hongkong

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	07F272E2-6AD5-433A-8207-A607C76F1676
IngressRules	array<object>	The list of inbound rules.
	object
InstanceId	string	The ID of the inbound rule.	tmr-j6c6rtallo51ouzv3****
EgressRules	array<object>	The list of outbound rules.
	object
InstanceId	string	The ID of the outbound rule.	tmr-j6cok23ugp53eeib5****

Examples

Success response

JSON format

{
  "RequestId": "07F272E2-6AD5-433A-8207-A607C76F1676",
  "IngressRules": [
    {
      "InstanceId": "tmr-j6c6rtallo51ouzv3****"
    }
  ],
  "EgressRules": [
    {
      "InstanceId": "tmr-j6cok23ugp53eeib5****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.TrafficMirrorFilter	The specified resource of traffic mirror filter is not found.	The specified filter does not exist.
400	IncorrectStatus.TrafficMirrorFilter	The status of traffic mirror filter is incorrect.	The filter is in an invalid state.
400	IncorrectStatus.TrafficMirrorSession	The status of traffic mirror session is incorrect.
400	QuotaExceeded.TrafficMirrorRulesPerFilter	The quota of the number of traffic mirror rules per filter is exceeded.	The number of rules associated with the filter has reached the upper limit.
400	DuplicatedParam.Priority	The specified priority conflicts with the existing priority.	The specified priority is the same as an existing one.
400	UnsupportedRegion	The feature is not supported in current region.	The feature is not supported in the current region.
400	IllegalParam.CidrBlock	The specified CidrBlock is illegal.	The operation failed because CidrBlock is set to an invalid value.
400	IllegalParam.SourceCidrBlock	The param of SourceCidrBlock %s is illegal.
400	IllegalParam.DestinationCidrBlock	The param of DestinationCidrBlock %s is illegal.
400	IllegalParam.Protocol	The specified Protocol %s is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.