CreateAudit

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

1. API Description

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

This API is used to create 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: CreateAudit
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, which can contain 3-128 ASCII letters (a-z; A-Z), digits (0-9), and underscores (_).
CosBucketName Yes String User-defined COS bucket name, which can only contain 1-40 lowercase letters (a-z), digits (0-9), and dashes (-) and cannot begin or end with "-". If a bucket is not newly created, CloudAudit will not verify whether it actually exists. Please enter the name with caution so as to avoid log delivery failure and consequent data loss.
CosRegion Yes String COS region. Supported regions can be queried using the ListCosEnableRegion API.
IsCreateNewBucket Yes Integer Whether to create a COS bucket. 1: yes; 0: no.
IsEnableCmqNotify Yes Integer Whether to enable CMQ message notification. 1: yes; 0: no. Only CMQ queue service is currently supported. If CMQ message notification is enabled, CloudAudit will deliver your log contents to the designated queue in the specified region in real time.
ReadWriteAttribute Yes Integer Manages the read/write attribute of an event. Value range: 1 (read-only), 2 (write-only), 3 (read/write).
CmqQueueName No String Queue name, which must begin with a letter and can contain up to 64 letters, digits, and dashes (-). This field is required if the value of IsEnableCmqNotify is 1. If a queue is not newly created, CloudAudit will not verify whether it actually exists. Please enter the name with caution so as to avoid log delivery failure and consequent data loss.
CmqRegion No String Region where the queue is located. Supported CMQ regions can be queried using the ListCmqEnableRegion API. This field is required if the value of IsEnableCmqNotify is 1.
IsCreateNewQueue No Integer Whether to create a queue. 1: yes; 0: no. This field is required if the value of IsEnableCmqNotify is 1.
LogFilePrefix No String Prefix of a log file, which can only contain 3-40 ASCII letters (a-z; A-Z) and digits (0-9). It can be left empty and is the account ID by default.

3. Output Parameters

Parameter Name Type Description
IsSuccess Integer Whether creation is successful.
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Example

Example1 Creating a Tracking Set

Create a tracking set.

Input Example

https://cloudaudit.tencentcloudapi.com/?Action=CreateAudit
&AuditName=auditTest_1
&CmqQueueName=cmq-01
&CmqRegion=sh
&CosBucketName=cos-01
&CosRegion=ap-shanghai
&IsCreateNewBucket=1
&IsCreateNewQueue=1
&IsEnableCmqNotify=1
&LogFilePrefix=akshsb1j
&ReadWriteAttribute=2
&<Common request parameter>

Output Example

{
  "Response": {
    "IsSuccess": 1,
    "RequestId": "e9501707-784a-474c-b524-67ed9d3a6b50"
  }
}

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.CmqError An exception occurred during CMQ queue creation, probably because the CMQ queue to be created already exists, or your account has no permissions or is in arrears.
InternalError.CreateAuditError Error occurs creating the tracking set. Please submit a ticket.
InvalidParameterValue.AuditNameError Tracking set name is non-compliant.
InvalidParameterValue.CmqRegionError CloudAudit currently does not support the entered CMQ region.
InvalidParameterValue.CosNameError The entered COS bucket name is non-compliant.
InvalidParameterValue.CosRegionError CloudAudit currently does not support the entered COS region.
InvalidParameterValue.IsCreateNewBucketError The value of IsCreateNewBucket can be 0 or 1. 0 represents not creating a bucket, while 1 creating a bucket.
InvalidParameterValue.IsCreateNewQueueError The value of IsCreateNewQueue can be 0 or 1. 0 represents not creating a queue, while 1 creating a queue.
InvalidParameterValue.IsEnableCmqNotifyError The value of IsEnableCmqNotify can be 0 or 1. 0 represents not enabling CMQ delivery, while 1 enabling.
InvalidParameterValue.LogFilePrefixError Invalid log prefix format.
InvalidParameterValue.QueueNameError The entered queue name is non-compliant.
InvalidParameterValue.ReadWriteAttributeError Value range of the read/write attribute: 1 (read-only), 2 (write-only), 3 (read/write).
LimitExceeded.OverAmount The maximum number of tracking sets is exceeded.
MissingParameter.MissAuditName Tracking set name is missing.
MissingParameter.MissCosBucketName COS bucket parameter is missing.
MissingParameter.MissCosRegion COS region parameter is missing.
MissingParameter.cmq If the value of IsEnableCmqNotify is 1, IsCreateNewQueue, CmqQueueName, and CmqRegion are required.
ResourceInUse.AlreadyExistsSameAudit A tracking set with the same name already exists.
ResourceInUse.AlreadyExistsSameAuditCmqConfig A tracking set with the same CMQ delivery configuration already exists.
ResourceInUse.AlreadyExistsSameAuditCosConfig A tracking set with the same COS delivery configuration already exists.
ResourceInUse.CosBucketExists The COS bucket already exists.