DescribeDBInstanceLogToCLS

Download

Focus Mode

Font Size

Last updated: 2026-06-09 16:30:27

1. API Description

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

This API is used to query the configuration of slow log and error log delivery to CLS for an instance. It filters out the present instance log delivery configuration to CLS by AppId, Region, and instance ID.

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: DescribeDBInstanceLogToCLS.
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, which can be obtained through the DescribeDBInstances API.
ClsRegion	No	String	Region of the CLS service

3. Output Parameters

Parameter Name	Type	Description
ErrorLog	LogToCLSConfig	Error log delivery CLS configuration
SlowLog	LogToCLSConfig	Slow log delivery CLS configuration
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 Log Delivery to CLS Configuration

In instance log management, configure slow log and error log delivery to CLS.

Input Example

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

{
    "InstanceId": "cdb-70zdmgg1"
}

Output Example

{
    "Response": {
        "ErrorLog": {
            "ClsRegion": "ap-guangzhou",
            "Status": "ON",
            "LogSetId": "8dff8d62-fa10-4d6c-bee0-6e31a0ade975",
            "LogTopicId": "09c3c2d1-ac46-4e4e-b688-b73950e64682"
        },
        "SlowLog": {
            "ClsRegion": "ap-guangzhou",
            "Status": "OFF",
            "LogSetId": "8dff8d62-fa10-4d6c-bee0-6e31a0ade976",
            "LogTopicId": "09c3c2d1-ac46-4e4e-b688-b73950e64681"
        },
        "RequestId": "8a96c7fec3c747adb83cb0868c0107d5"
    }
}

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.TimeoutError	The query timed out.
InternalError.CauthError	Authentication failed.
InternalError.UnknownError	Unknown error
InvalidParameter.ControllerNotFoundError	This API was not found.
InvalidParameterValue	Invalid parameter value
MissingParameter	Missing parameter
OperationDenied.OperationDeniedError	Operation denied
OperationDenied.ResourceNotFundError	The resource was not found.

Help and Support

Was this page helpful?

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

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

TencentDB for MySQL