tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeErrorLogData

Last updated: 2024-11-20 11:14:43

    1. API Description

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

    This API is used to query the error logs of an instance over the past month by search criteria.
    Note: the HTTP response packet will be very large if it contain a single large error log, which causes the API call to time out. If this happens, we recommend you lower the value of the input parameter Limit to reduce the packet size so that the API can respond timely.

    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: DescribeErrorLogData.
    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 Integer Start timestamp, such as 1585142640.
    EndTime Yes Integer End timestamp, such as 1585142640.
    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, 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 instance error logs

    Input Example

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

{
    "InstanceId": "cdb-c1nl9rpv",
    "Limit": "400",
    "StartTime": "1585142640",
    "Offset": "0",
    "KeyWords": [
        "keywords0"
    ],
    "EndTime": "1585142640"
}

    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

    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.
    FailedOperation.TimeoutError The query timed out.
    InternalError.DBError Database exception
    InternalError.DBOperationError Database operation failed.
    InternalError.DBRecordNotExistError The database record does not exist.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    InvalidParameter.InvalidParameterError Invalid parameter value
    InvalidParameterValue.DataConvertError Data conversion failed.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value
    OperationDenied Operation denied.
    OperationDenied.ResultOverLimit The maximum number of results has been reached. Please narrow down your query.
    ResourceNotFound.CdbInstanceNotFoundError The instance cannot be found. Please check whether your instance status is normal.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy