Modifies the configuration of a traffic mirror session.
Operation description
Usage notes
-
UpdateTrafficMirrorSessionAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListTrafficMirrorSessions operation to query the status of the task.
- If the traffic mirror session is in the Modifying state, the configuration of the traffic mirror session is being modified.
- If the traffic mirror session is in the Created state, the configuration of the traffic mirror session is modified.
-
You cannot repeatedly call the UpdateTrafficMirrorSessionAttribute operation within a specific 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 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:UpdateTrafficMirrorSessionAttribute | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TrafficMirrorSessionDescription | string | No | The new description of the traffic mirror session. The description must be 1 to 256 characters in length and cannot start with | This is a new session. |
TrafficMirrorSessionName | string | No | The new name of the traffic mirror session. The name must be 1 to 128 characters in length, and cannot start with | abc |
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 request ID as the client token. The request ID may be different for each request.
| 0c593ea1-3bea-11e9-b96b-88e9fe63**** |
DryRun | boolean | No | Specifies whether to perform a dry run. Valid values:
| false |
TrafficMirrorSessionId | string | Yes | The ID of the traffic mirror session. | tms-j6cla50buc44ap8tu**** |
TrafficMirrorTargetId | string | No | The ID of the traffic mirror destination. | eni-j6c2fp57q8rr47rp***** |
TrafficMirrorTargetType | string | No | The new type of the traffic mirror destination. Valid values:
| NetworkInterface |
TrafficMirrorFilterId | string | No | The ID of the traffic mirror filter. | tmf-j6cmls82xnc86vtpe**** |
VirtualNetworkId | integer | No | The VXLAN network identifier (VNI) that is used to distinguish different mirrored traffic. Valid values: 0 to 16777215. You can use VNIs to identify mirrored traffic from different sessions at the traffic mirror destination. If you do not specify a VNI, the system randomly allocates a VNI. If you want the system to randomly allocate a VNI, ignore this parameter. | 10 |
Priority | integer | No | The new priority of the traffic mirror session. Valid values: 1 to 32766. A smaller value indicates a higher priority. You cannot specify identical priorities for traffic mirror sessions that are created in the same region by using the same account. | 2 |
PacketLength | integer | No | The maximum transmission unit (MTU). Valid values: 64 to 9600. Default value: 1500. | 1500 |
Enabled | boolean | No | Specifies whether to enable the traffic mirror session. Valid values:
| false |
RegionId | string | Yes | The region ID of the traffic mirror session. You can call the DescribeRegions operation 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 parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "64DCAF03-E2C7-479A-ACEA-38B79876B006"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IncorrectBusinessStatus.TrafficMirror | The business status of traffic mirror is incorrect. | Traffic mirroring is in an invalid state. |
400 | OptInRequired.TrafficMirror | You need to subscribe to the traffic mirror service first. | Traffic mirroring is disabled. |
400 | DuplicatedParam.Priority | The specified priority conflicts with the existing priority. | The specified priority is the same as an existing one. |
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 | 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 | QuotaExceeded.FilterRelatedSession | The quota of the number of traffic mirror sessions related to one filter is exceeded. | The number of traffic mirror sessions associated with the filter has reached the upper limit. |
400 | ResourceNotFound.NetworkInterface | The specified resource of network interface is not found. | The specified ENI does not exist. |
400 | ResourceNotFound.EcsInstance | The specified resource of ECS instance is not found. | - |
400 | ResourceNotFound.Slb | The specified resource of SLB is not found. | - |
400 | OperationDenied.SlbNotInVpc | The specified SLB is not in any VPC. | - |
400 | QuotaExceeded.NetworkInterfaceRelatedSession | The quota of the number of traffic mirror sessions related to one network interface is exceeded. | The number of traffic mirror sessions associated with an ENI has reached the upper limit. |
400 | QuotaExceeded.SlbRelatedSession | The quota of the number of traffic mirror sessions related to one SLB is exceeded. | The number of traffic mirror sessions associated with an SLB instance has reached the upper limit. |
400 | OperationDenied.EcsNotSupportTrafficMirror | The ECS instance does not support traffic mirroring. | - |
400 | OperationDenied.DuplicateRole | The network interface must not be the source and the target of traffic mirror sessions at the same time. | - |
400 | InvalidLoadBalancerId.NotFound | The specified resource of load balancer is not found. | The SLB instance does not exist. |
400 | OperationDenied.FreeNetworkInterface | The network interface is not attached to any ECS instance. | The ENI is not associated with an ECS instance. |
400 | OperationDenied.ClassicSLB | The operation is not allowed because of ClassicSLB. | The error message returned because you cannot perform the operation on a CLB instance. |
400 | QuotaExceeded.SourceNumPerTarget | The maximum number of traffic mirror sources for a target is exceeded. | The number of traffic mirror sources associated with the image exceeds the upper limit. |
400 | OperationFailed.NotSupportBizType | The specified instance type does not support the operation. | The specified instance type does not support the operation. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-10-25 | The Error code has changed | View Change Details |
2024-09-11 | The Error code has changed | View Change Details |
2024-01-15 | The Error code has changed | View Change Details |
2023-08-30 | API Description Update. The Error code has changed | View Change Details |
2023-08-03 | The Error code has changed | View Change Details |
2023-07-05 | The Error code has changed | View Change Details |
2023-04-14 | The Error code has changed. The request parameters of the API has changed | View Change Details |