All Products
Search
Document Center

Virtual Private Cloud:GetTrafficMirrorServiceStatus

Last Updated:Nov 27, 2024

Queries the status of the traffic mirroring feature.

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.

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:GetTrafficMirrorServiceStatusget
*All Resources
*
    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 client 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-426655440000
RegionIdstringYes

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.

Enabledboolean

Indicates whether the traffic mirroring feature is enabled. Valid values:

  • true
  • false
true
RequestIdstring

The request ID.

37626066-2C6C-4B62-ADD3-498920C409C5

Examples

Sample success responses

JSONformat

{
  "Enabled": true,
  "RequestId": "37626066-2C6C-4B62-ADD3-498920C409C5"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-31The Error code has changedView Change Details
2023-06-16API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details