tencent cloud

All product documents
TencentDB for MySQL
DocumentationTencentDB for MySQLAPI DocumentationDatabase Audit APIsDescribeAuditLogs
DescribeAuditLogs
Download PDF
Last updated: 2024-11-20 11:15:32
DescribeAuditLogs
Last updated: 2024-11-20 11:15:32
Download PDF

1. API Description

Domain name for API request: cdb.intl.tencentcloudapi.com.

This API is used to query a database audit log.

A maximum of 20 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: DescribeAuditLogs.
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 Instance ID
StartTime Yes String Start time
EndTime Yes String End time
Limit No Integer The pagination parameter, which specifies the number of entries per page. Maximum value: 100 (default).
Offset No Integer Pagination offset
Order No String Sorting order Valid values: ASC (ascending), DESC` (descending).
OrderBy No String Sorting field Valid values:
timestamp: Timestamp,
affectRows: Number of affected rows,
execTime: Execution time.
LogFilter.N No Array of InstanceAuditLogFilters Filter. Multiple values are in AND relationship.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible audit logs
Items Array of AuditLog Audit log details
Note: This field may return null, indicating that no valid values can be obtained.
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 Querying a database audit log

Input Example

https://cdb.intl.tencentcloudapi.com/?Action=DescribeAuditLogs
&InstanceId=cdb-qwer1234
&StartTime=2023-06-18 00:00:00
&EndTime=2023-06-19 00:00:00
&Limit=100
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 1,
        "Items": [
            {
                "AffectRows": 1,
                "CheckRows": 0,
                "CpuTime": 375.786,
                "DBName": "wyang",
                "ErrCode": 0,
                "ExecTime": 1503,
                "Host": "100.122.76.176",
                "IoWaitTime": 7,
                "LockWaitTime": 1140,
                "NsTime": 104188594,
                "PolicyName": "sys_default",
                "SentRows": 0,
                "Sql": "INSERT INTO `test_db` values('John Smith',0)",
                "SqlType": "INSERT",
                "ThreadId": 162,
                "Timestamp": "2023-06-07 17:50:05.104",
                "TrxLivingTime": 1475,
                "User": "root"
            }
        ],
        "RequestId": "b3951c71-1da4-4b8f-9de5-ad71ab1e2917-0"
    }
}

Example2 Querying records within xx where the SQL statement contains "SELECT" and "UPDA", and the source IP contains 10.0.

SQL sample: select * from test_db limit 1;
sql INC selec cu200can be used for search.
sql WINC selec cannot be used for search.

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditLogs
<Common request parameters>

{
    "InstanceId": "cdb-0ei6rgrp",
    "StartTime": "2023-08-01 00:00:00",
    "EndTime": "2023-08-07 00:00:00",
    "Limit": 20,
    "LogFilter": [
        {
            "Type": "sql",
            "Compare": "INC",
            "Value": [
                "selec",
                "up"
            ]
        },
        {
            "Type": "host",
            "Compare": "INC",
            "Value": [
                "10.0."
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "Items": null,
        "RequestId": "90d90456-2a5b-4015-81b8-9e2fca52012b",
        "TotalCount": 0
    }
}

Example3 Querying records within xx where the SQL statement contains "SELECT" and "test_db", and the source IP is not 10.0.0.1 or 100.0.0.1

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAuditLogs
<Common request parameters>

{
    "InstanceId": "cdb-0ei6rgrp",
    "StartTime": "2023-08-01 00:00:00",
    "EndTime": "2023-08-07 00:00:00",
    "Limit": 20,
    "LogFilter": [
        {
            "Type": "sql",
            "Compare": "WINC",
            "Value": [
                "select"
            ]
        },
        {
            "Type": "sql",
            "Compare": "WINC",
            "Value": [
                "test_db"
            ]
        },
        {
            "Type": "host",
            "Compare": "NEQ",
            "Value": [
                "10.0.0.1",
                "100.0.0.1"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "Items": null,
        "RequestId": "90d90456-2a5b-4015-81b8-9e2fca52012b",
        "TotalCount": 0
    }
}

5. Developer Resources

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
FailedOperation.QueryAuditTaskFailError Failed to query the audit task
InternalError.AuditDescribeLogError Failed to query the audit log
InternalError.AuditError An error occurred in the internal service of the audit service.
InternalError.DBError Database exception
InternalError.DatabaseAccessError Internal database error.
InternalError.ServerError Internal error of the system.
InternalError.UnknownError Unknown error
InvalidParameter Parameter error.
InvalidParameter.ExceptionParam Parameter exception.
InvalidParameter.InvalidParameterError Invalid parameter value
InvalidParameterValue Invalid parameter value
InvalidParameterValue.DataConvertError Data conversion failed.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value
OperationDenied.QueryAuditLogsError Failed to query the audit log
OperationDenied.ResourceNotFoundError The resource was not found.
OperationDenied.ResourceNotFundError The resource was not found.
ResourceNotFound The resource does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support