tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAudit

Last updated: 2023-01-04 11:45:01
This document is currently invalid. Please refer to the documentation page of the product.

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 Params. The value used for this API: DescribeAudit.
Version Yes String Common Params. The value used for this API: 2019-03-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou.
AuditName Yes String Tracking set name

3. Output Parameters

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

4. Example

Example1 Querying the details of tracking set

This example shows you how to query the details of a tracking set.

Input Example

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

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,
        "KeyId": "xx",
        "IsEnableKmsEncry": 0,
        "KmsRegion": "xx",
        "KmsAlias": "xx",
        "RequestId": "e23ee347-d011-482a-83fa-12e7d318dd9f"
    }
}

5. Developer Resources

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 An error occurred while querying tracking set details. Submit a ticket for assistance.
ResourceNotFound.AuditNotExist The tracking set does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy