API domain name: cloudaudit.tencentcloudapi.com.
Parameter requirements:
Default API request rate limit: 20 requests/sec.
The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, please 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. |
| 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. |
| 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. Please enter it carefully to avoid data loss. |
| KmsRegion | No | String | KMS region. Currently supported regions can be obtained through ListKmsEnableRegion. This must be the same as the COS region. |
| 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. Valid values: 1 (read-only), 2 (write-only), 3 (read/write). |
| Parameter Name | Type | Description |
|---|---|---|
| IsSuccess | Integer | Whether update is successful. |
| RequestId | String | Unique ID of request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
This example shows you how to update a tracking set.
https://cloudaudit.tencentcloudapi.com/?Action=UpdateAudit
&AuditName=xxxxx
&CosBucketName=sss
&CosRegion=ap-hongkong
&LogFilePrefix=wwwwww
&<Common request parameters>{
"Response": {
"IsSuccess": 1,
"RequestId": "45cb39e2-4b94-4d9c-bf95-db7daba5740d"
}
}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 comes with SDKs that support multiple programming languages and make it easier to call the APIs.
The following only lists the error codes related to this API. For other error codes, please 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 permission 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 | 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?