All Products
Search
Document Center

Virtual Private Cloud:DeleteTrafficMirrorFilter

Last Updated:Aug 29, 2024

Deletes a filter of traffic mirroring.

Operation description

  • The DeleteTrafficMirrorFilter 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 a filter:

    • If the filter is in the Deleting state, the filter is being deleted.
    • If you cannot query the filter, the filter is deleted.
  • You cannot repeatedly call the DeleteTrafficMirrorFilter operation to delete a filter 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DeleteTrafficMirrorFilterdelete
  • TrafficMirrorFilter
    acs:vpc:{#regionId}:{#accountId}:trafficmirrorfilter/{#TrafficMirrorFilterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TrafficMirrorFilterIdstringYes

The ID of the filter.

tmf-j6cmls82xnc86vtpe****
ClientTokenstringNo

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-88e9fe63****
DryRunbooleanNo

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 check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. After the request passes the check, the operation is performed.
false
RegionIdstringYes

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

07F272E2-6AD5-433A-8207-A607C76F1676

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.TrafficMirrorFilterThe specified resource of traffic mirror filter is not found.The specified filter does not exist.
400IncorrectStatus.TrafficMirrorFilterThe status of traffic mirror filter is incorrect.The filter is in an invalid state.
400IncorrectStatus.TrafficMirrorRuleThe status of traffic mirror rule is incorrect.The filter rule is in an invalid state.
400DependencyViolation.TrafficMirrorSessionSome traffic mirror sessions depend on the specified resource.The traffic mirror session depends on the current resource.

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

Change history

Change timeSummary of changesOperation
2023-08-30API Description Update. The Error code has changedView Change Details