Querying Tracking Set Details

Last updated: 2020-10-22 09:34:16

1. API Description

Domain name for API request: cloudaudit.tencentcloudapi.com.

This API is used to query the details of a tracking set.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeAudit.
Version Yes String Common parameter. The value used for this API: 2019-03-19.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-taipei
AuditName Yes String Tracking set name

3. Output Parameters

Parameter Name Type Description
AuditName String Tracking set name.
AuditStatus Integer Tracking set status. Valid values: 1: enabled, 0: disabled.
CmqQueueName String Queue name.
CmqRegion String Queue region.
CosBucketName String COS bucket name.
CosRegion String COS bucket region.
IsEnableCmqNotify Integer Whether to enable CMQ message notification. Valid values: 1: yes; 0: no.
IsEnableKmsEncry Integer Whether to enable KMS encryption. Valid values: 1: yes, 0: no. If KMS encryption is enabled, the data will be encrypted when delivered to COS.
KeyId String Globally unique CMK ID.
KmsAlias String CMK alias.
KmsRegion String KMS region.
LogFilePrefix String Log prefix.
ReadWriteAttribute Integer Manages the read/write attribute of event. Valid values: 1 (read-only), 2 (write-only), 3 (read/write)
RequestId String Unique ID of request. Each request returns a unique ID. The RequestId is required for troubleshooting.

4. Example

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.DescribeAuditError An error occurred when querying tracking set details. Please submit a ticket for assistance.
ResourceNotFound.AuditNotExist The tracking set does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback