Help & DocumentationAPIsCloudAuditCloudAudit APIsUpdateAudit

UpdateAudit

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

Contents：

1. API Description

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

Parameter requirements:

  1. If the value of IsCreateNewBucket exists, cosRegion and cosBucketName 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.

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: UpdateAudit
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
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.
CosBucketName No 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 No String COS region. Supported regions can be queried using the ListCosEnableRegion API.
IsCreateNewBucket No Integer Whether to create a COS bucket. 1: yes; 0: no.
IsCreateNewQueue No Integer Whether to create a queue. 1: yes; 0: no. This field is required if the value of IsEnableCmqNotify is 1.
IsEnableCmqNotify No 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.
LogFilePrefix No String Prefix of a log file, which can only contain 3-40 ASCII letters (a-z; A-Z) and digits (0-9).
ReadWriteAttribute No Integer Manages the read/write attribute of an event. Value range: 1 (read-only), 2 (write-only), 3 (read/write).

3. Output Parameters

Parameter Name Type Description
IsSuccess Integer Whether update 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 Updating a Tracking Set

Update a tracking set.

Input Example

https://cloudaudit.tencentcloudapi.com/?Action=UpdateAudit
&AuditName=xxxxx
&CosBucketName=sss
&CosRegion=ap-hongkong
&LogFilePrefix=wwwwww
&<Common request parameter>

Output Example

{
  "Response": {
    "IsSuccess": 1,
    "RequestId": "45cb39e2-4b94-4d9c-bf95-db7daba5740d"
  }
}

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.UpdateAuditError Internal error. Please submit a ticket.
InvalidParameterValue.CmqRegionError CloudAudit currently does not support the entered CMQ region.
InvalidParameterValue.CosRegionError CloudAudit currently does not support the entered COS region.
InvalidParameterValue.ReadWriteAttributeError Value range of the read/write attribute: 1 (read-only), 2 (write-only), 3 (read/write).
MissingParameter.cmq If the value of IsEnableCmqNotify is 1, IsCreateNewQueue, CmqQueueName, and CmqRegion are required.
ResourceNotFound.AuditNotExist The tracking set does not exist.