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.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| 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 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.
| 0c593ea1-3bea-11e9-b96b-88e9fe63**** |
| DryRun | boolean | No | Specifies whether to to perform a dry run. Valid values:
| false |
| TrafficMirrorSessionId | string | Yes | The ID of the traffic mirror session. | tms-j6cla50buc44ap8tu**** |
| RegionId | string | Yes | 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. | cn-hongkong |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. | - |
| 400 | IncorrectStatus.TrafficMirrorSession | The status of traffic mirror session is incorrect. | - |
| 400 | IncorrectStatus.TrafficMirrorFilter | The 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 time | Summary of changes | Operation |
|---|---|---|
| 2022-12-07 | API Description Update. The Error code has changed | View Change Details |