DescribeInstanceErrorLogs

Download PDF

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

DescribeInstanceErrorLogs

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

Download PDF

1. API Description

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

This API is used to query the list of instance error logs.

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: DescribeInstanceErrorLogs.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Instance ID
Limit	No	Integer	Limit on the number of logs
Offset	No	Integer	Offset of the log number
StartTime	No	String	Start time
EndTime	No	String	End time
OrderBy	No	String	Sorting field. Valid value: 'Timestamp'.
OrderByType	No	String	Sorting order. Valid values: `ASC`, `DESC`.
LogLevels.N	No	Array of String	Log level, which supports combo search by multiple levels. Valid values: `error`, `warning`, `note`.
KeyWords.N	No	Array of String

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of logs.
ErrorLogs	Array of CynosdbErrorLogItem	Error log list.
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 This API is used to query error logs.

This API is used to query error logs.

Input Example

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

{
    "InstanceId": "cynosdbmysql-ins-m6f0hkkd",
    "Limit": 1,
    "Offset": 0,
    "StartTime": "2024-10-28 10:19:21",
    "EndTime": "2024-10-28 10:20:01",
    "OrderBy": "Timestamp",
    "OrderByType": "DESC",
    "LogLevels": [
        "note"
    ],
    "KeyWords": [
        "unconnected"
    ]
}

Output Example

{
    "Response": {
        "ErrorLogs": [
            {
                "Content": "Aborted connection 562579 to db: 'unconnected' user: 'unauthenticated' host: '169.214.18.1' (Got an error reading communication packets)",
                "Level": "note",
                "Timestamp": 1730182001
            }
        ],
        "RequestId": "32f291cb-38c8-4a0c-8fd0-5a4c370ac6df",
        "TotalCount": 3
    }
}

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
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.SystemError	Internal system error.
InvalidParameter.ControllerNotFoundError	This API was not found.
InvalidParameterValue.InstanceNotFound	The instance does not exist.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value.
InvalidParameterValue.ValueNotFound	No data found
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

Was this page helpful?

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

Yes

Feedback

tencent cloud