Modifies the configuration of a filter for traffic mirroring.

Usage notes

You cannot repeatedly call the UpdateTrafficMirrorFilterAttribute operation to modify the configuration of a filter for traffic mirroring 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateTrafficMirrorFilterAttribute

The operation that you want to perform. Set the value to UpdateTrafficMirrorFilterAttribute.

TrafficMirrorFilterId String Yes tmf-j6cmls82xnc86vtpe****

The ID of the filter.

TrafficMirrorFilterDescription String No This is a new filter.

The description of the filter.

The description must be 1 to 256 characters in length and cannot start with http:// or https://.

TrafficMirrorFilterName String No test

The name of the filter.

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

ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

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 token can contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
DryRun Boolean No false

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 syntax, and limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.
RegionId String Yes cn-hongkong

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.

Response parameters

Parameter Type Example Description
RequestId String 5816D35F-94D5-48CE-838F-2327C8EE8D49

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateTrafficMirrorFilterAttribute
&TrafficMirrorFilterId=tmf-j6cmls82xnc86vtpe****
&TrafficMirrorFilterDescription=This is a new filter.
&TrafficMirrorFilterName=test
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&DryRun=false
&RegionId=cn-hongkong
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateTrafficMirrorFilterAttributeResponse>
    <RequestId>5816D35F-94D5-48CE-838F-2327C8EE8D49</RequestId>
</UpdateTrafficMirrorFilterAttributeResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5816D35F-94D5-48CE-838F-2327C8EE8D49"
}

Error codes

HttpCode Error code Error message Description
400 ResourceNotFound.TrafficMirrorFilter The specified resource of traffic mirror filter is not found. The error message returned because the specified filter does not exist.
400 IncorrectStatus.TrafficMirrorFilter The status of traffic mirror filter is incorrect. The error message returned because the filter is in an invalid state.

For a list of error codes, visit the API Error Center.