Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to enable the audit service.
A maximum of 50 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 Params. The value used for this API: OpenAuditService. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | TencentDB for MySQL instance ID |
LogExpireDay | Yes | Integer | Retention period of the audit log. Valid values: 7 (one week), 30 (one month), 90 (three months), 180 (six months), 365 (one year), 1095 (three years), 1825 (five years). |
HighLogExpireDay | No | Integer | Retention period of high-frequency audit logs. Valid values: 7 (one week), 30 (one month). |
AuditRuleFilters.N | No | Array of AuditRuleFilters | Audit rule If both this parameter and RuleTemplateIds are left empty, full audit will be applied. |
RuleTemplateIds.N | No | Array of String | Rule template ID. If both this parameter and AuditRuleFilters are not specified, all SQL statements will be recorded. |
AuditAll | No | Boolean | Audit type. Valid values: true: Record all; false: Record by rules (default value). |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
None
POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: OpenAuditService<common request parameters>{ "InstanceId": "cdb-3u8h3h1w", "LogExpireDay": 30, "HighLogExpireDay": 7, "AuditRuleFilters": [ { "RuleFilters": [ { "Compare": "NEQ", "Type": "host", "Value": [ "127.0.0.1" ] } ] } ]}
{ "Response": { "RequestId": "{ "Response": { "RequestId": "
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 |
---|---|
FailedOperation.CreateAuditFailError | Failed to create the audit rule. |
InternalError.DBError | Database exception |
InternalError.HttpError | Exceptional HTTP request |
InternalError.UnknownError | Unknown error |
InvalidParameter.ControllerNotFoundError | This API was not found. |
InvalidParameter.ExceptionParam | Parameter exception. |
InvalidParameter.InvalidParameterError | Invalid parameter value |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
OperationDenied.AuditStatusError | Exceptional audit status. |
OperationDenied.AuditTaskConflictError | The audit tasks conflict. |
OperationDenied.InstanceStatusError | Exceptional instance status |
OperationDenied.UnsupportOpenAuditError | The audit feature cannot be enabled. |
ResourceNotFound.InstanceNotFundError | The instance does not exist. |
Was this page helpful?