tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SetCustomizedConfigForLoadBalancer

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

    1. API Description

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

    This API is used to create or manage a user-defined CLB configuration template.

    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: SetCustomizedConfigForLoadBalancer.
    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.
    OperationType Yes String Operation type: ADD, DELETE, UPDATE, BIND, UNBIND
    UconfigId No String This field is required except for creating custom configurations, such as "pz-1234abcd".
    ConfigContent No String This field is required when creating or modifying custom configurations.
    ConfigName No String This field is required when creating or renaming custom configurations.
    LoadBalancerIds.N No Array of String This field is required when binding/unbinding resources.

    3. Output Parameters

    Parameter Name Type Description
    ConfigId String Configuration ID, such as "pz-1234abcd"
    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 Creating custom configurations at the CLB instance level

    Input Example

    https://clb.tencentcloudapi.com/?Action=SetCustomizedConfigForLoadBalancer
&OperationType=ADD
&ConfigContent=client_max_body_size 222M;
&ConfigName=config_test
&<Common request parameters>

    Output Example

    {
    "Response": {
        "ConfigId": "pz-1234abcd",
        "RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"
    }
}

    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.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    LimitExceeded Quota exceeded.
    MissingParameter Missing parameter.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy