tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAudit

Last updated: 2023-01-04 11:45:02
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.

Parameter requirements:

  1. If the value of IsCreateNewBucket exists, cosRegion and osBucketName are required.
  2. If the value of IsEnableCmqNotify is 1, IsCreateNewQueue, CmqRegion, and CmqQueueName are required.
  3. If the value of IsEnableCmqNotify is 0, IsCreateNewQueue, CmqRegion, and CmqQueueName cannot be passed in.
  4. If the value of IsEnableKmsEncry is 1, KmsRegion and KeyId are required.

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: CreateAudit.
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.
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 event. Valid values: 1 (read-only), 2 (write-only), 3 (read/write).
AuditName Yes String Tracking set name, which can contain 3–128 ASCII letters (a–z; A–Z), digits (0–9), and underscores (_).
CosRegion Yes String COS region. Supported regions can be queried through the ListCosEnableRegion API.
IsCreateNewBucket Yes Integer Whether to create a COS bucket. 1: Yes; 0: No.
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. Enter the name with caution to avoid log delivery failure and consequent data loss.
KeyId No String Globally unique ID of the CMK. This value is required if it is not a newly created KMS element. It can be obtained through ListKeyAliasByRegion. CloudAudit will not verify the validity of the KeyId. Enter it carefully to avoid data loss.
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. Enter the name with caution to avoid log delivery failure and consequent data loss.
KmsRegion No String KMS region. Currently supported regions can be obtained through ListKmsEnableRegion. This must be the same as the COS region.
IsEnableKmsEncry No Integer Whether to enable KMS encryption. 1: Yes, 0: No. If KMS encryption is enabled, the data will be encrypted when delivered to COS.
CmqRegion No String Region where the queue is located. Supported CMQ regions can be queried through the ListCmqEnableRegion API. This field is required if the value of IsEnableCmqNotify is 1.
LogFilePrefix No String Log file prefix, 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.
IsCreateNewQueue No Integer Whether to create a queue. 1: Yes; 0: No. This field is required if the value of IsEnableCmqNotify is 1.

3. Output Parameters

Parameter Name Type Description
IsSuccess Integer Whether creation succeeded.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating tracking set

This example shows you how to 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 parameters>

Output Example

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

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
FailedOperation.CreateBucketFail Failed to create the COS bucket.
InternalError.CmqError An exception occurred while creating the CMQ queue, probably because the CMQ queue to be created already exists, or your account has no permission or has overdue payments.
InternalError.CreateAuditError An error occurred while creating the tracking set. Submit a ticket for assistance.
InvalidParameterValue.AuditNameError The 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 indicates not to create a bucket, while 1 indicates to create a bucket.
InvalidParameterValue.IsCreateNewQueueError The value of IsCreateNewQueue can be 0 or 1. 0 indicates not to create a queue, while 1 indicates to create a queue.
InvalidParameterValue.IsEnableCmqNotifyError The value of IsEnableCmqNotify can be 0 or 1. 0 indicates not to enable CMQ delivery, while 1 indicates to enable CMQ delivery.
InvalidParameterValue.LogFilePrefixError The log prefix format is incorrect.
InvalidParameterValue.QueueNameError The entered queue name is non-compliant.
InvalidParameterValue.ReadWriteAttributeError Valid values of the read/write attribute: 1 (read-only), 2 (write-only), 3 (read/write).
LimitExceeded.OverAmount The maximum number of tracking sets has been exceeded.
MissingParameter.MissAuditName The tracking set name is missing.
MissingParameter.MissCosBucketName The COS bucket parameter is missing.
MissingParameter.MissCosRegion The 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.
ResourceNotFound.RoleNotExist The role doesn’t exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy