Delete a traffic mirror session with DeleteTrafficMirrorSession - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Operation description

DeleteTrafficMirrorSession is an asynchronous operation. After you send a request, the system returns a request ID. However, the traffic mirror session is not yet deleted. The deletion task runs in the background. You can call ListTrafficMirrorSessions to query the deletion status of the traffic mirror session:
- If the traffic mirror session is in the Deleting state, the traffic mirror session is being deleted.
- If the specified traffic mirror session cannot be found, the traffic mirror session is deleted.
DeleteTrafficMirrorSession does not support concurrent deletion of the same traffic mirror session.

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

delete

*TrafficMirrorSession

acs:vpc:{#regionId}:{#accountId}:trafficmirrorsession/{#TrafficMirrorSessionId}

None

Request parameters

Parameter	Type	Required	Description	Example
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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	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 syntax, 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 traffic mirror session is deleted.	false
TrafficMirrorSessionId	string	Yes	The instance ID of the traffic mirror session.	tms-j6cla50buc44ap8tu****
RegionId	string	Yes	The region ID of the traffic mirror session. You can call DescribeRegions to query the most recent region list. For more information about regions that support traffic mirroring, see Traffic mirroring overview.	cn-hongkong

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.TrafficMirrorSession	The specified resource of traffic mirror session is not found.	The specified traffic mirror session does not exist.
400	IncorrectStatus.TrafficMirrorSession	The status of traffic mirror session is incorrect.	The traffic mirror session is in an incorrect state.
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.