All Products
Search
Document Center

Virtual Private Cloud:OpenTrafficMirrorService

Last Updated:Dec 02, 2023

Enables traffic mirroring.

Operation Description

Usage notes

You can enable traffic mirroring for different regions. You cannot repeatedly call the OpenTrafficMirrorService operation to enable traffic mirroring for one region within the specified period of time.

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:OpenTrafficMirrorServiceWrite
  • TrafficMirrorService
    acs:vpc:{#regionId}:{#accountId}:trafficmirror/*
    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.
123e4567-e89b-12d3-a456-426655442222
RegionIdstringNo

The ID of the region to which the mirrored traffic belongs.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

4FCCF008-4C13-4231-BE77-D5203801A9E2
Codestring

The error code.

200
Messagestring

The information returned after traffic mirroring is enabled.

successful

Examples

Sample success responses

JSONformat

{
  "RequestId": "4FCCF008-4C13-4231-BE77-D5203801A9E2",
  "Code": "200",
  "Message": "successful"
}

Error codes

HTTP status codeError codeError messageDescription
400OperationFailed.ExceedPurchaseLimitYou have reached the limit of purchase quantity.-
400Forbidden.RAMUser not authorized to operate on the specified resourceThe RAM user is unauthorized to perform the operation.
400OperationFailed.AliGroupUserCanNotBuyInnerCommodityVpc_flowlog_public has no group cloud product label, and users within the group are not allowed to purchase.vpc_flowlog_public does not have a merchandise tag and cannot be purchased by an internal group user.
400OperationFailed.QuotaNotEnoughYour quota is insufficient. Please contact your channel partner to increase your quota-
400Order.NoRealNameAuthenticationReal-name verification has not been completed for the account.The error message returned because you have not completed real-name verification. Go to User Center to complete real-name verification.
400OperationFailed.BasicInfoUncompletedYou have not completed your basic personal information, please complete the information and try again.Your basic information is incomplete. Specify the information and try again.

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

Change history

Change timeSummary of changesOperation
2023-06-16API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    Error Codes 400 change
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: RegionId
    Added Input Parameters: RegionId
Output ParametersThe response structure of the API operation changes.