TencentDB for MySQL
- Release Notes and Announcements
- Announcements
- Product Introduction
- Database Architecture
- Database Instance
- Kernel Features
- Kernel Version Release Notes
- Functionality Features
- Performance Features
- Parallel Query
- Security Features
- Stability Features
- Purchase Guide
- Getting Started
- Connecting to MySQL Instance
- Database Audit
- Audit Rule Template
- MySQL Cluster Edition
- Maintenance Management Instance
- Operation Guide
- Instance Management and Maintenance
- Instance Upgrade
- CPU Elastic Expansion
- Read-Only/Disaster Recovery Instances
- Database Proxy
- Database Proxy Kernel Features
- Database Proxy Management
- Automatic Read/Write Separation Feature
- Connection Pool Feature
- Other Features
- Account Management
- Database Management Center (DMC)
- Parameter Configuration
- Network and Security
- Backup and Rollback
- Restoring Database from Backup File
- Monitoring and Alarms
- Operation Logs
- Practical Tutorial
- Calling MySQL APIs in Python
- White Paper
- Performance White Paper
- Performance Test Report
- Troubleshooting
- Connections
- API Documentation
- Data Import APIs
- Rollback APIs
- Parameter APIs
- Making API Requests
- Instance APIs
- Database Proxy APIs
- Database Audit APIs
- Security APIs
- Account APIs
- Backup APIs
- Database APIs
- Monitoring APIs
- Log-related API
- FAQs
- Backup
- Connection and Login
- Instance Upgrade
- Performance and Memory
- Service Agreement
- Reference
OpenAuditService
Last updated: 2024-11-20 11:15:28
1. API Description
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.
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: 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). |
3. Output Parameters
| 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. |
4. Example
Example1 Enabling instance audit service
None
Input Example
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" ] } ] } ]}
Output Example
{ "Response": { "RequestId": "{ "Response": { "RequestId": "
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No