tencent cloud

Feedback

ExportInstanceErrorLogs

Last updated: 2023-08-23 14:22:55

1. API Description

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

This API is used to export the error logs of an instance.

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: ExportInstanceErrorLogs.
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.
InstanceId Yes String Instance ID
StartTime No String Log start time
EndTime No String Log end time
Limit No Integer The max number of returned results
Offset No Integer Offset
LogLevels.N No Array of String Log level
KeyWords.N No Array of String
FileType No String The template type. Valid values: csv, original.
OrderBy No String Valid value: Timestamp
OrderByType No String Valid values: ASC or DESC.

3. Output Parameters

Parameter Name Type Description
ErrorLogItems Array of ErrorLogItemExport Export content of the error log Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Exporting the error logs

This example shows you how to export the error logs.

Input Example

POST / HTTP/1.1Host: cynosdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ExportInstanceErrorLogs<common request parameters>{    "InstanceId": "cynosdbmysql-ins-xxxxxxxx",    "StartTime": "2019-07-04 16:45:32",    "EndTime": "2019-07-04 16:55:32",    "Limit": 10,    "Offset": 0,    "LogLevels": [        "error"    ],    "KeyWords": [        "abc"    ],    "FileType": "csv",    "OrderBy": "Timestamp",    "OrderByType": "ASC"}

Output Example

{
    "Response": {
        "ErrorLogItems": [
            {
                "Timestamp": "2019-07-04 16:45:32",
                "Level": "error",
                "Content": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

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.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
UnauthorizedOperation.PermissionDenied CAM authentication failed.