All Products
Search
Document Center

Virtual Private Cloud:UpdateTrafficMirrorFilterAttribute

Last Updated:Aug 28, 2026

Modifies the configuration of a traffic mirror filter.

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:UpdateTrafficMirrorFilterAttribute

update

*TrafficMirrorFilter

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

None None

Request parameters

Parameter

Type

Required

Description

Example

TrafficMirrorFilterId

string

Yes

The ID of the filter.

tmf-j6cmls82xnc86vtpe****

TrafficMirrorFilterDescription

string

No

The description of the filter.

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

This is a new filter.

TrafficMirrorFilterName

string

No

The name of the filter.

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

test

ClientToken

string

No

The client token used to ensure the idempotence of the request.

You can use the client to generate the token value, but you must ensure that it is unique across 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.

0c593ea1-3bea-11e9-b96b-88e9fe637760

DryRun

boolean

No

Specifies whether to perform a dry run without executing the operation. Valid values:

  • true: performs a dry run. The system validates the required parameters, request syntax, and limits. If the request fails validation, an error message is returned. If the request passes validation, the DryRunOperation error code is returned.

  • false (default): sends the request. If the request passes validation, a 2xx HTTP status code is returned and the operation is performed.

false

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.

5816D35F-94D5-48CE-838F-2327C8EE8D49

Examples

Success response

JSON format

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

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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.