UpdateTrafficMirrorFilterRuleAttribute - Virtual Private Cloud

Modifies the configuration of an inbound or outbound rule for traffic mirroring.

Operation description

The UpdateTrafficMirrorFilterRuleAttribute operation is asynchronous. After you send the request, the system returns a request ID. However, the operation is still being performed in the system background. You can call the ListTrafficMirrorFilters operation to query the status of an inbound or outbound rule:
- If the rule is in the Modifying state, the rule is being modified.
- If the rule is in the Created state, the rule is modified.
You cannot repeatedly call the UpdateTrafficMirrorFilterRuleAttribute operation to modify an inbound or outbound rule within the specified period of time.

Debugging

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

Debug

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 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:UpdateTrafficMirrorFilterRuleAttribute	update	TrafficMirrorFilter acs:vpc:{#regionId}:{#accountId}:trafficmirrorfilter/{#TrafficMirrorFilterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
TrafficMirrorFilterRuleId	string	Yes	The ID of the inbound or outbound rule.	tmr-j6c89rzmtd3hhdugq****
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.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to check the request without performing the operation. Valid values: true: only checks the API request. The configuration of the inbound or outbound rule is not modified. The system checks the required parameters, request syntax, and limits. If the request fails to pass the check, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false: sends the request. This is the default value. If the request passes the check, a 2xx HTTP status code is returned and the configuration of the inbound or outbound rule is modified.	false
Priority	integer	No	The new priority of the inbound or outbound rule. A smaller value indicates a higher priority.	1
Protocol	string	No	The new protocol that is used by the traffic to be mirrored by the inbound or outbound rule. Valid values: ALL: all protocols ICMP: Internet Control Message Protocol (ICMP) TCP: TCP UDP: User Datagram Protocol (UDP)	ICMP
RuleAction	string	No	The new action of the inbound or outbound rule. Valid values: accept: accepts network traffic. drop: drops network traffic.	accept
DestinationCidrBlock	string	No	The new destination CIDR block of the inbound or outbound traffic.	10.0.0.0/24
SourceCidrBlock	string	No	The new source CIDR block of the inbound or outbound traffic.	0.0.0.0/0
DestinationPortRange	string	No	The new destination port range of the inbound or outbound traffic. Note If you set Protocol to ICMP, you cannot change the port range.	-1/-1
SourcePortRange	string	No	The new source port range of the inbound or outbound traffic. Note If you set Protocol to ICMP, you cannot change the port range.	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 mirroring, see Overview of traffic mirroring.	cn-hongkong

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	02EB8585-D4DC-4E29-A0F4-7C588C82863C

Examples

Sample success responses

JSONformat

{
  "RequestId": "02EB8585-D4DC-4E29-A0F4-7C588C82863C"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.TrafficMirrorRule	The specified resource of traffic mirror rule is not found.	-
400	IncorrectStatus.TrafficMirrorRule	The status of traffic mirror rule is incorrect.	The filter rule is in an invalid state.
400	DuplicatedParam.Priority	The specified priority conflicts with the existing priority.	The specified priority is the same as an existing one.

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

Change history

Change time	Summary of changes	Operation
2023-08-30	API Description Update. The Error code has changed	View Change Details