All Products
Document Center

Virtual Private Cloud:DeleteTrafficMirrorSession

Last Updated:Dec 02, 2023

Deletes a traffic mirror session.

Operation Description

  • DeleteTrafficMirrorSession is an asynchronous operation. After you send the request, the system returns a request ID and runs the task in the background. You can call the ListTrafficMirrorSessions operation to query the status of a traffic mirror session.

    • If the traffic mirror session is in the Deleting state, the traffic mirror session is being deleted.
    • If you cannot query the traffic mirror session, the traffic mirror session is deleted.
  • You cannot repeatedly call the DeleteTrafficMirrorSession operation to delete a traffic mirror session within the specified period of time.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


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
  • TrafficMirrorSession

Request parameters


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 all requests. ClientToken can contain only ASCII characters.

Note If you do not specify this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.

Specifies whether to 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): performs a dry run and sends the request. If the request passes the dry run, the operation is performed.

The ID of the traffic mirror session.


The ID of the region to which the traffic mirror session 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


The ID of the request.



Sample success responses


  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.TrafficMirrorSessionThe specified resource of traffic mirror session is not found.-
400IncorrectStatus.TrafficMirrorSessionThe status of traffic mirror session is incorrect.-
400IncorrectStatus.TrafficMirrorFilterThe status of traffic mirror filter is incorrect.The filter is in an invalid state.

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

Change history

Change timeSummary of changesOperation
2022-12-07API Description Update,The error codes of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    Error Codes 400 change