tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SetLoadBalancerClsLog

Last updated: 2024-09-05 19:29:23

    1. API Description

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

    This API is used to add, delete, and update the CLS topic of a CLB 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 Params. The value used for this API: SetLoadBalancerClsLog.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    LoadBalancerId Yes String CLB instance ID
    LogSetId Yes String Logset ID of the Cloud Log Service (CLS).
  • When adding or updating a log topic, call the DescribeLogsets API to obtain the logset ID.
  • When deleting a log topic, set this parameter to null.
    		•
    LogTopicId Yes String Log topic ID of the CLS.
  • When adding or updating a log topic, call the DescribeTopics API to obtain the log topic ID.
  • When deleting a log topic, set this parameter to null.
    		•
    LogType No String Log type:
  • ACCESS: access logs
  • HEALTH: health check logs

    • Default: ACCESS

    3. Output Parameters

    Parameter Name Type Description
    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 Deleting CLS Topics

    This example shows you how to delete Cloud Log Service (CLS) topics of a CLB instance.

    Input Example

    https://clb.tencentcloudapi.com/?Action=SetLoadBalancerClsLog
&LoadBalancerId=lb-cuxw2r00
&LogSetId= 
&LogTopicId= 
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
    }
}

    Example2 Setting CLS Topics

    This example shows you how to add or modify CLS topics of a CLB instance.

    Input Example

    https://clb.tencentcloudapi.com/?Action=SetLoadBalancerClsLog
&LoadBalancerId=lb-cuxw2r00
&LogSetId=xxxx-xx-xx-xx-xxxxxxxx
&LogTopicId=xxxx-xx-xx-xx-yyyyyyyy
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
    }
}

    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.TokenFailure Token error.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameter.LBIdNotFound Wrong CLB instance ID.
    InvalidParameter.RegionNotFound Invalid region.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy