All Products
Search

This Product

    Virtual Private Cloud:AddSourcesToTrafficMirrorSession

    Document Center

    Virtual Private Cloud:AddSourcesToTrafficMirrorSession

    Last Updated:Mar 22, 2024

    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.

    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
    vpc:AddSourcesToTrafficMirrorSessionWrite
    • TrafficMirrorSession
      acs:vpc:{#regionId}:{#accountId}:trafficmirrorsession/{#TrafficMirrorSessionId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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****
    DryRunbooleanNo

    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
    TrafficMirrorSessionIdstringYes

    The ID of the traffic mirror session.

    		tms-j6cla50buc44ap8tu****
    TrafficMirrorSourceIdsarrayYes

    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.

    stringYes

    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****
    RegionIdstringYes

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		87F70089-5B38-41A8-BAD8-0B55E2F8DC57

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectBusinessStatus.TrafficMirrorThe business status of traffic mirror is incorrect.Traffic mirroring is in an invalid state.
    400OptInRequired.TrafficMirrorYou need to subscribe to the traffic mirror service first.Traffic mirroring is disabled.
    400DuplicatedParam.SourceInstanceIdsThe parameter of source instance IDs contains duplicate values.Duplicate values are set for TrafficMirrorSourceIds.N.
    400ResourceNotFound.TrafficMirrorSessionThe specified resource of traffic mirror session is not found.-
    400IncorrectStatus.TrafficMirrorSessionThe status of traffic mirror session is incorrect.-
    400ResourceAlreadyAssociated.TrafficMirrorSourceThe specified traffic mirror source and session are already associated.-
    400ResourceNotFound.NetworkInterfaceThe specified resource of %s is not found.The error message returned because NetworkInterface is set to an invalid value.
    400ResourceNotFound.EcsInstanceThe specified resource of ECS instance is not found.-
    400OperationDenied.EcsNotSupportTrafficMirrorThe ECS instance does not support traffic mirroring.-
    400OperationDenied.DuplicateRoleThe network interface must not be the source and the target of traffic mirror sessions at the same time.-
    400QuotaExceeded.NetworkInterfaceRelatedSessionThe 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.
    400OperationDenied.FreeNetworkInterfaceThe network interface is not attached to any ECS instance.The ENI is not associated with an ECS instance.
    400QuotaExceeded.SourceNumPerSessionThe 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.
    400QuotaExceeded.SourceNumPerTargetThe 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.
    400OperationUnsupported.BondingNetworkInterfaceThe 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 timeSummary of changesOperation
    2024-01-15The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-08-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-07-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-07-05API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-06-25The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-03-16The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400