SetCustomizedConfigForLoadBalancer

Last updated: 2025-11-25 10:11:09

SetCustomizedConfigForLoadBalancer

Last updated: 2025-11-25 10:11:09

1. API Description

Domain name for API request: clb.intl.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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
OperationType	Yes	String	Operation type. -ADD. specifies the creation. - DELETE: DELETE. -UPDATE: modify. -BIND: specifies the binding status. -UNBIND: unbind.
UconfigId	No	String	Personalized configuration ID. this field is required except when creating a custom configuration, for example: pz-1234abcd.
ConfigContent	No	String	Specifies the personalized configuration content. this field is required when creating or modifying custom configuration. Specifies specific restrictions. view layer-7 personalized configuration (https://www.tencentcloud.comom/document/product/214/15171?from_cn_redirect=1).
ConfigName	No	String	Custom configuration name. specifies the name when creating or modifying a custom configuration. this field is required.
LoadBalancerIds.N	No	Array of String	CLB instance ID. this field is required for bind/unbind operations. Can be queried through the DescribeLoadBalancers api.

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.intl.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

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	Operation failed.
FailedOperation.ResourceInCloning	The specified resource is being cloned. please try again later.
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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud