AddSourcesToTrafficMirrorSession - Virtual Private Cloud

Adds a traffic mirror source to a traffic mirror session.

Operation description

AddSourcesToTrafficMirrorSession 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 traffic mirror source is being added to the traffic mirror session.
- If the traffic mirror session is in the Created state, the traffic mirror source is added to the traffic mirror session.
You cannot repeatedly call the AddSourcesToTrafficMirrorSession operation to add a traffic mirror source to a traffic mirror session 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.

Debug

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:AddSourcesToTrafficMirrorSession	update	TrafficMirrorSession acs:vpc:{#regionId}:{#accountId}:trafficmirrorsession/{#TrafficMirrorSessionId}	none	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 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 only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails 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 performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
TrafficMirrorSessionId	string	Yes	The ID of the traffic mirror session.	tms-j6cla50buc44ap8tu****
TrafficMirrorSourceIds	array	Yes	The ID of the traffic mirror source. You can specify only an elastic network interface (ENI) as the traffic mirror source. The default value of N is 1, which indicates that you can add only one traffic mirror source to a traffic mirror session.
	string	Yes	The ID of the traffic mirror source. You can specify only an elastic network interface (ENI) as the traffic mirror source. The default value of N is 1, which indicates that you can add only one traffic mirror source to a traffic mirror session.	eni-j6c8znm5l1yt4sox****
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

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	87F70089-5B38-41A8-BAD8-0B55E2F8DC57

Examples

Sample success responses

JSONformat

{
  "RequestId": "87F70089-5B38-41A8-BAD8-0B55E2F8DC57"
}

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.SourceInstanceIds	The parameter of source instance IDs contains duplicate values.	Duplicate values are set for TrafficMirrorSourceIds.N.
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	ResourceAlreadyAssociated.TrafficMirrorSource	The specified traffic mirror source and session are already associated.	-
400	ResourceNotFound.NetworkInterface	The specified resource of %s is not found.	The error message returned because NetworkInterface is set to an invalid value.
400	ResourceNotFound.EcsInstance	The specified resource of ECS instance is not found.	-
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	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	OperationDenied.FreeNetworkInterface	The network interface is not attached to any ECS instance.	The ENI is not associated with an ECS instance.
400	QuotaExceeded.SourceNumPerSession	The quota of the number of traffic mirror sources per session is exceeded.	The number of traffic mirror sources associated with a traffic mirror session has reached the upper limit.
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	OperationUnsupported.BondingNetworkInterface	The specified traffic mirror source is bonding eni without slave.	The operation does not support a bond ENI without a slave ENI.

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

Change history

Change time	Summary of changes	Operation
2024-01-15	The Error code has changed	View Change Details
2023-08-03	The Error code has changed	View Change Details
2023-07-18	The Error code has changed	View Change Details
2023-07-05	API Description Update. The Error code has changed	View Change Details
2023-06-25	The Error code has changed	View Change Details
2023-03-16	The Error code has changed	View Change Details