Help & DocumentationCloud Load BalancerAPI DocumentationCLB APIsModifyLoadBalancerAttributes

ModifyLoadBalancerAttributes

Last updated: 2020-03-16 17:04:10

PDF

1. API Description

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

This API is used to modify the attributes of a CLB instance such as name and cross-region attributes.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: ModifyLoadBalancerAttributes.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String Unique CLB ID
LoadBalancerName No String CLB instance name
TargetRegionInfo No TargetRegionInfo Region information of the real server bound to a CLB.
InternetChargeInfo No InternetAccessible Network billing parameter
LoadBalancerPassToTarget No Boolean Whether the target opens traffic from CLB to the internet. If yes (true), only security groups on CLB will be verified; if no (false), security groups on both CLB and backend instance need to be verified.
SnatPro No Boolean Whether to enable SnatPro

3. Output Parameters

Parameter Name Type Description
DealName String This parameter can be used to query whether CLB billing mode switch is successful.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Renaming CLB instances

Input Example

https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&LoadBalancerName=newlbname
&<Common request parameters>

Output Example

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

Example2 Setting cross-region attribute of CLB instances

Input Example

https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&TargetRegionInfo.Region=ap-shanghai
&TargetRegionInfo.VpcId=vpc-abcd1234
&<Common request parameters>

Output Example

{
  "Response": {
    "DealName": null,
    "RequestId": "78a40898-8210-44c7-8bc6-f83e5087ad54"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Wrong parameter value.
InvalidParameterValue.Duplicate Duplicate parameter value.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Reached quota.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resource.
UnauthorizedOperation Unauthorized operation.