DescribeAuditInstanceList

Last updated:2025-11-13 20:51:51

DescribeAuditInstanceList

Last updated: 2025-11-13 20:51:51

1. API Description

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

This API is used to obtain the instance list of database audit.

A maximum of 100 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: DescribeAuditInstanceList.
Version	Yes	String	Common Params. The value used for this API: 2019-01-07.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
AuditSwitch	No	Integer	Enabling status of instance audit. 1 - enabled; 0 - not enabled.
Filters.N	No	Array of AuditInstanceFilters	Filtering conditions for querying the instance list.
AuditMode	No	Integer	Instance audit rule mode. 1 - rule-based audit; 0 - full audit.
Limit	No	Integer	Number of entries returned per request. The default value is 30, and the maximum value is 100.
Offset	No	Integer	Offset. The default value is 0.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of instances meeting the query conditions.
Items	Array of InstanceAuditStatus	List of detailed information about the audit instance.
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 Retrieve the Audit Instance List

This example shows you how to retrieve the audit instance list.

Input Example

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

{
    "AuditMode": 0,
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "cynosdbmysql-ins-6990cckk"
            ],
            "Name": "InstanceId",
            "ExactMatch": true
        }
    ],
    "AuditSwitch": 0,
    "Offset": 1
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "43-12121-812w1221213-62usf9093",
        "Items": [
            {
                "RealStorage": 0,
                "BillingAmount": 0,
                "LowRealStorage": 0,
                "InstanceId": "cynosdbmysql-ins-6990cckk",
                "CreateAt": "2022-03-02 10:09:08",
                "AuditStatus": "1",
                "LogExpireDay": 1,
                "AuditAll": true,
                "InstanceInfo": {
                    "ProjectId": 0,
                    "TagList": [
                        {
                            "TagKey": "name",
                            "TagValue": "zhang"
                        }
                    ]
                },
                "HighRealStorage": 0,
                "HighLogExpireDay": 30,
                "LowLogExpireDay": 7
            }
        ]
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError.HttpError	Network error

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud