tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyDBInstanceLogToCLS

Last updated: 2024-01-30 10:25:47

    1. API Description

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

    This API is used to enable or disable the feature of sending CDB slow and error logs to 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: ModifyDBInstanceLogToCLS.
    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.
    LogType Yes String Log type. Valid values: error and slowLog.
    Status Yes String Enabling status. Valid values: ON and OFF.
    CreateLogset No Boolean Indicates whether a log set needs to be created.
    Logset No String Log set name if the log set is to be created or ID of the selected existing log set.
    CreateLogTopic No Boolean Indicates whether a log topic needs to be created.
    LogTopic No String Log topic name if the topic is to be created or ID of the selected existing topic.
    Period No Integer Log topic validity period, which is 30 days by default if not specified.
    CreateIndex No Boolean Indicates whether to create an index when creating the log topic.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Enable or disable the feature of sending CDB logs to CLS

    This API is used to enable or disable the feature of sending slow and error logs of a CDB instance to CLS.

    Input Example

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

{
    "InstanceId": "cdb-ewa3b",
    "LogType": "errorLog",
    "Status": "ON",
    "CreateLogset": true,
    "Logset": "sub_fyrtjbqw",
    "CreateLogTopic": true,
    "LogTopic": "my_test",
    "Period": "1",
    "CreateIndex": true
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

    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
    InternalError.UnknownError Unknown error
    InvalidParameter.ControllerNotFoundError This API was not found.
    InvalidParameter.InvalidParameterError Invalid parameter value
    InvalidParameter.JsonUnmarshalError Failed to deserialize JSON.
    MissingParameter.MissingParamError Required parameters are missing.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy