Documentation | Tencent Cloud

Recent Pages

DescribeErrorLogData

Last updated: 2021-04-15 16:40:33

1. API Description

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

This API is used to query the details of instance error logs by search criteria. You can only query error logs within a month.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeErrorLogData.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-20.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID.
StartTime	Yes	Integer	Start timestamp.
EndTime	Yes	Integer	End timestamp.
KeyWords.N	No	Array of String	List of keywords to match. Up to 15 keywords are supported.
Limit	No	Integer	The number of results per page in paginated queries. Default value: 100. Maximum value: 400.
Offset	No	Integer	Offset. Default value: 0.
InstType	No	String	This parameter is valid only for source or disaster recovery instances. Valid value: `slave`, which indicates pulling logs from the replica.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible entries.
Items	Array of ErrlogItem	Returned result. 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 Querying instance error logs

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeErrorLogData
&InstanceId=cdb-c1nl9rpv
&StartTime=1585142640
&EndTime=1585142640
&KeyWords.0=keywords0
&Limit=400
&Offset=0
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TotalCount": 1,
    "Items": [
      {
        "Content": "show master status",
        "Timestamp": 1585142640
      }
    ]
  }
}

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.QueryLogError	Log query failed.
InternalError.DBError	Database exception
InternalError.DBOperationError	Database operation failed.
InternalError.DBRecordNotExistError	The database record does not exist.
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
OperationDenied	Operation denied.