tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

SetLoadBalancerClsLog

最后更新时间：2023-10-24 11:16:03

    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 CLS logset ID
  • Enter the ID of logset you need to add or update. You can acquire the ID by invoking DescribeLogsets.
  • To delete the log set, set this parameter to null.
    		•
    LogTopicId Yes String CLS log topic ID
  • Enter the ID of log topic you need to add or update. You can acquire the ID by invoking DescribeTopics.
  • To delete the log set, 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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Setting CLS topic

    This example shows you how to add or modify the CLS topic 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"
    }
}

    Example2 Deleting CLS topic

    This example shows you how to delete the CLS topic 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"
    }
}

    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
    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.
    隐私条款服务条款缓存条款