All Products
Search

This Product

    Virtual Private Cloud:UpdateTrafficMirrorSessionAttribute

    Document Center

    Virtual Private Cloud:UpdateTrafficMirrorSessionAttribute

    Last Updated:Mar 22, 2024

    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

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TrafficMirrorSessionDescriptionstringNo

    The new description of the traffic mirror session.

    The description must be 1 to 256 characters in length and cannot start with http:// or https://.

    		This is a new session.
    TrafficMirrorSessionNamestringNo

    The new name of the traffic mirror session.

    The name must be 1 to 128 characters in length, and cannot start with http:// or https://.

    		abc
    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 a dry run. Valid values:

    • true: performs a dry run, without performing the actual request. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service 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: sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed. This is the default value.
    		false
    TrafficMirrorSessionIdstringYes

    The ID of the traffic mirror session.

    		tms-j6cla50buc44ap8tu****
    TrafficMirrorTargetIdstringNo

    The ID of the traffic mirror destination.

    		eni-j6c2fp57q8rr47rp*****
    TrafficMirrorTargetTypestringNo

    The new type of the traffic mirror destination. Valid values:

    • NetworkInterface: an elastic network interface (ENI)
    • SLB: an internal-facing Server Load Balancer (SLB) instance
    		NetworkInterface
    TrafficMirrorFilterIdstringNo

    The ID of the traffic mirror filter.

    		tmf-j6cmls82xnc86vtpe****
    VirtualNetworkIdintegerNo

    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
    PriorityintegerNo

    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
    PacketLengthintegerNo

    The maximum transmission unit (MTU).

    Valid values: 64 to 9600. Default value: 1500.

    		1500
    EnabledbooleanNo

    Specifies whether to enable the traffic mirror session. Valid values:

    • false (default)
    • true
    		false
    RegionIdstringYes

    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

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		64DCAF03-E2C7-479A-ACEA-38B79876B006

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "64DCAF03-E2C7-479A-ACEA-38B79876B006"
}

    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.PriorityThe specified priority conflicts with the existing priority.The specified priority is the same as an existing one.
    400ResourceNotFound.TrafficMirrorSessionThe specified resource of traffic mirror session is not found.-
    400IncorrectStatus.TrafficMirrorSessionThe status of traffic mirror session is incorrect.-
    400ResourceNotFound.TrafficMirrorFilterThe specified resource of traffic mirror filter is not found.The specified filter does not exist.
    400IncorrectStatus.TrafficMirrorFilterThe status of traffic mirror filter is incorrect.The filter is in an invalid state.
    400QuotaExceeded.FilterRelatedSessionThe 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.
    400ResourceNotFound.NetworkInterfaceThe specified resource of network interface is not found.The specified ENI does not exist.
    400ResourceNotFound.EcsInstanceThe specified resource of ECS instance is not found.-
    400ResourceNotFound.SlbThe specified resource of SLB is not found.-
    400OperationDenied.SlbNotInVpcThe specified SLB is not in any VPC.-
    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.
    400QuotaExceeded.SlbRelatedSessionThe 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.
    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.-
    400InvalidLoadBalancerId.NotFoundThe specified resource of load balancer is not found.The SLB instance does not exist.
    400OperationDenied.FreeNetworkInterfaceThe network interface is not attached to any ECS instance.The ENI is not associated with an ECS instance.
    400OperationDenied.ClassicSLBThe operation is not allowed because of ClassicSLB.The error message returned because you cannot perform the operation on a CLB instance.
    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.
    400OperationFailed.NotSupportBizTypeThe 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 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-30API 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-08-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-07-05The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-04-14The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PacketLength