DescribeDBInstanceLogToCLS

最后更新时间：2024-01-30 10:25:49

1. API Description

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

The API DescribeDBInstanceLogToCLS is used to query the configurations of sending slow and error logs of an instance (InstanceId) filtered by AppId and Region to Cloud Log Service (CLS).

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	No	String	Common Params. This parameter is not required for this API.
InstanceId	Yes	String	Instance ID.

3. Output Parameters

Parameter Name	Type	Description
ErrorLog	LogToCLSConfig	Configurations of sending error logs to CLS. Note: The return value may be null, indicating that no valid data can be obtained.
SlowLog	LogToCLSConfig	Configurations of sending slow logs to CLS. Note: The return value may be null, indicating that no valid data 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 Query configurations of sending instance logs to CLS

This API is used to query the configurations of sending slow and error logs to CLS in the Operation Log module.

Input Example

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

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

Output Example

{
    "Response": {
        "ErrorLog": {
            "Status": "ON",
            "LogSetId": "test",
            "LogTopicId": "test"
        },
        "SlowLog": {
            "Status": "OFF",
            "LogSetId": "test",
            "LogTopicId": "test"
        },
        "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.

tencent cloud

Recent Pages