- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- CLB Instance
- CLB Listener
- CLB Listener Overview
- Configuring a TCP Listener
- Configuring a UDP Listener
- Configuring a TCP SSL Listener
- Configuring an HTTP Listener
- Configuring an HTTPS Listener
- Load Balancing Methods
- Session Persistence
- Configuring Layer-7 Redirection
- Layer-7 Custom Configuration
- Layer-7 Domain Name Forwarding and URL Rules
- Using QUIC Protocol on CLB
- SNI Support for Binding Multiple Certificates to a CLB Instance
- Real Server
- Health Check
- Certificate Management
- Monitoring and Alarm
- Log Management
- Cloud Access Management
- Classic CLB
- Best Practices
- Troubleshooting
- OPS Guidelines
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Instance APIs
- Listener APIs
- Real Server APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- Cloud Load Balancer APIs
- Classic CLB APIs
- Data Types
- Error Codes
- CLB API 2017
- FAQs
- Service Agreement
- Contact Us
- Glossary
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- CLB Instance
- CLB Listener
- CLB Listener Overview
- Configuring a TCP Listener
- Configuring a UDP Listener
- Configuring a TCP SSL Listener
- Configuring an HTTP Listener
- Configuring an HTTPS Listener
- Load Balancing Methods
- Session Persistence
- Configuring Layer-7 Redirection
- Layer-7 Custom Configuration
- Layer-7 Domain Name Forwarding and URL Rules
- Using QUIC Protocol on CLB
- SNI Support for Binding Multiple Certificates to a CLB Instance
- Real Server
- Health Check
- Certificate Management
- Monitoring and Alarm
- Log Management
- Cloud Access Management
- Classic CLB
- Best Practices
- Troubleshooting
- OPS Guidelines
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Instance APIs
- Listener APIs
- Real Server APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- Cloud Load Balancer APIs
- Classic CLB APIs
- Data Types
- Error Codes
- CLB API 2017
- FAQs
- Service Agreement
- Contact Us
- Glossary
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.
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 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 |
| DeleteProtect | No | Boolean | Specifies whether to enable deletion protection. |
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 instance
Input Example
https://clb.tencentcloudapi.com/?Action=ModifyLoadBalancerAttributes
&LoadBalancerId=lb-6efswuxa
&LoadBalancerName=newlbname
&<Common request parameters>
Output Example
{
"Response": {
"DealName": null,
"RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
}
}
Example2 Setting the cross-region attribute of CLB instance
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
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.Duplicate | Duplicate parameter value. |
| InvalidParameterValue.Length | Wrong parameter length. |
| LimitExceeded | Quota exceeded. |
| MissingParameter | Missing parameter. |
| ResourceInsufficient | Insufficient resources. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?