DescribeAudit

Last updated: 2020-02-15 11:44:33

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.

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.
AuditName Yes String Tracking set name

3. Output Parameters

Parameter Name Type Description
AuditName String Tracking set name.
AuditStatus Integer Tracking set status. Value range: 1 (enabled), 0 (disabled).
CmqQueueName String Queue name.
CmqRegion String Region where the queue is located.
CosBucketName String COS bucket name.
CosRegion String Region where the COS bucket is located.
IsEnableCmqNotify Integer Whether to enable CMQ message notification. 1: yes; 0: no.
LogFilePrefix String Log prefix.
ReadWriteAttribute Integer Manages the read/write attribute of an event. Value range: 1 (read-only), 2 (write-only), 3 (read/write)
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Example

Example1 Querying Tracking Set Details

Query the tracking set details.

Input Example

https://cloudaudit.tencentcloudapi.com/?Action=DescribeAudit
&AuditName=xxxxx_cloudaudit_2
&<Common request parameter>

Output Example

{
  "Response": {
    "AuditName": "xxxxx_cloudaudit_2",
    "CmqQueueName": "xxxxx-cloudaudit-2",
    "CmqRegion": "hk",
    "CosBucketName": "xxxxx-cloudaudit-2",
    "CosRegion": "ap-hongkong",
    "IsEnableCmqNotify": 1,
    "LogFilePrefix": "xxx2312",
    "ReadWriteAttribute": 1,
    "AuditStatus": 1,
    "RequestId": "e23ee347-d011-482a-83fa-12e7d318dd9f"
  }
}

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.

SDK

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 Error occurs querying tracking set details. Please submit a ticket.
ResourceNotFound.AuditNotExist The tracking set does not exist.