Delete a traffic mirror filter by calling DeleteTrafficMirrorFilter - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

DeleteTrafficMirrorFilter is an asynchronous operation. After you send a request, the system returns a request ID, but the traffic mirror filter is not yet deleted. The deletion task runs in the background. You can call ListTrafficMirrorFilters to query the deletion status of the traffic mirror filter:
- If the traffic mirror filter is in the Deleting state, the traffic mirror filter is being deleted.
- If the specified traffic mirror filter cannot be found, the traffic mirror filter is deleted.
DeleteTrafficMirrorFilter does not support concurrent deletion of the same 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:DeleteTrafficMirrorFilter

delete

*TrafficMirrorFilter

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

None

Request parameters

Parameter	Type	Required	Description	Example
TrafficMirrorFilterId	string	Yes	The instance ID of the traffic mirror 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 token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId as the ClientToken. The RequestId may differ for each API request.	0c593ea1-3bea-11e9-b96b-88e9fe63****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes the check, the traffic mirror filter is deleted.	false
RegionId	string	Yes	The region ID of the traffic mirror. You can call DescribeRegions to query the most recent region list. For more information about the regions that support traffic mirroring, see Overview of traffic mirroring.	cn-hongkong

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	07F272E2-6AD5-433A-8207-A607C76F1676

Examples

Success response

JSON format

{
  "RequestId": "07F272E2-6AD5-433A-8207-A607C76F1676"
}

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.TrafficMirrorRule	The status of traffic mirror rule is incorrect.	The filter rule is in an invalid state.
400	DependencyViolation.TrafficMirrorSession	Some traffic mirror sessions depend on the specified resource.	The traffic mirror session depends on the current resource.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.