DescribeSlowLogs

Last updated: 2021-10-12 17:21:14

1. API Description

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

This API (DescribeSlowLogs) is used to query the slow logs of a TencentDB 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 parameter. The value used for this API: DescribeSlowLogs.
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 in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
Offset No Integer Offset. Minimum value: 0.
Limit No Integer Number of entries per page. Value range: 1-100. Default value: 20.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible slow logs.
Items Array of SlowLogInfo Details of eligible slow logs.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying slow logs

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeSlowLogs
&InstanceId=cdb-c1nl9rpv
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "TotalCount": 3,
    "Items": [
      {
        "Name": "ivansqwutestdr_slowlog_20170425.log",
        "IntranetUrl": "",
        "Date": "2017-04-26 00:00:08",
        "InternetUrl": "",
        "Type": "slowlog",
        "Size": 0
      },
      {
        "Name": "ivansqwutestdr_slowlog_20170426.log",
        "IntranetUrl": "http://gz.xxxxxxxxxx",
        "Date": "2017-04-27 00:00:07",
        "InternetUrl": "http://gz.xxxxxxxxxx",
        "Type": "slowlog",
        "Size": 212
      },
      {
        "Name": "ivansqwutestdr_slowlog_20170427.log",
        "IntranetUrl": "",
        "Date": "2017-04-28 00:00:09",
        "InternetUrl": "",
        "Type": "slowlog",
        "Size": 0
      }
    ]
  }
}

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
AuthFailure CAM signature/authentication error.
CdbError Backend or process error.
CdbError.TaskError Backend task error.
InternalError.DatabaseAccessError Internal database error.
InternalError.InternalServiceErrorErr An error occurred while accessing internal service.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value
OperationDenied.WrongStatus The backend task status is invalid.