Domain name for API request: cloudaudit.tencentcloudapi.com.
Parameter requirements:
IsCreateNewBucket exists, cosRegion and cosBucketName are required.IsEnableCmqNotify is 1, IsCreateNewQueue, CmqRegion, and CmqQueueName are required.IsEnableCmqNotify is 0, IsCreateNewQueue, CmqRegion, and CmqQueueName cannot be passed in.IsEnableKmsEncry is 1, KmsRegion and KeyId are required.A maximum of 20 requests can be initiated per second for this API.
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. This API only supports: ap-guangzhou, ap-taipei |
| 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 through 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 through the ListCosEnableRegion API. |
| IsCreateNewBucket | No | Integer | Whether to create a COS bucket. Valid values: 1: yes; 0: no. |
| IsCreateNewQueue | No | Integer | Whether to create a queue. Valid values: 1: yes; 0: no. This field is required if the value of IsEnableCmqNotify is 1. |
| IsEnableCmqNotify | No | Integer | Whether to enable CMQ message notification. Valid values: 1: yes; 0: no. Currently, only CMQ is supported for message queue services. If CMQ message notification is enabled, CloudAudit will deliver your log contents to the designated queue in the specified region in real time. |
| IsEnableKmsEncry | No | Integer | Whether to enable KMS encryption. Valid values: 1: yes, 0: no. If KMS encryption is enabled, the data will be encrypted when delivered to COS. |
| 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 via the ListKeyAliasByRegion API. CloudAudit will not verify the validity of the KeyId. Please enter it with caution to avoid consequent data loss. |
| KmsRegion | No | String | KMS region. Currently supported regions can be obtained via the ListKmsEnableRegion API. This must be the same as the COS region. |
| LogFilePrefix | No | String | Log file prefix, 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 event. Valid values: 1 (read-only), 2 (write-only), 3 (read/write). |
| Parameter Name | Type | Description |
|---|---|---|
| IsSuccess | Integer | Indicates if the update was completed successfully |
| RequestId | String | Unique ID of request. Each request returns a unique ID. The RequestId is required for troubleshooting. |
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 when creating the CMQ queue. Possible causes include that the CMQ queue to be created already exists, or your account does not have the necessary permissions or is in arrears. |
| InternalError.UpdateAuditError | Internal error. Please submit a ticket for assistance. |
| InvalidParameterValue.CmqRegionError | CloudAudit currently does not support the entered CMQ region. |
| InvalidParameterValue.CosRegionError | CloudAudit currently does not support the entered COS region. |
| InvalidParameterValue.ReadWriteAttributeError | Valid values 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. |
Was this page helpful?