릴리스 노트
제품 공지
Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to modify the attributes of a CLB instance, such as name and cross-region attributes.
Non-bandwidth-upshift users must add their CLB instance to a bandwidth package to configure cross-domain attributes. To modify the network billing mode, go to the console.
This API is used to perform asynchronous operations. After returning a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyLoadBalancerAttributes. |
| 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. |
| LoadBalancerId | Yes | String | Specifies the unique ID of the cloud load balancer. you can call the DescribeLoadBalancers API to obtain the ID. |
| LoadBalancerName | No | String | Load balancing instance name. rule: 1-60 english letters, chinese characters, digits, hyphens "-", or underscores "_". |
| TargetRegionInfo | No | TargetRegionInfo | The backend service information of cross-region binding 1.0 |
| InternetChargeInfo | No | InternetAccessible | Network billing parameter |
| LoadBalancerPassToTarget | No | Boolean | Specifies whether to allow CLB traffic to the Target. Enable pass-through (true): verify security groups on CLB only. Denies CLB traffic to the target (false): verify security groups on both CLB and backend instances. Specifies no modification if left blank. |
| SnatPro | No | Boolean | Specifies whether the cross-region binding 2.0 feature is enabled. leave blank for no modification. |
| DeleteProtect | No | Boolean | Specifies whether to enable deletion protection. leave it blank to keep the current setting. |
| ModifyClassicDomain | No | Boolean | Modifies the second-level domain name of cloud load balancer from mycloud.com to tencentclb.com. the subdomain will be transformed, and the mycloud.com domain name will become invalid after modification. leave it blank if no modification is required. |
| AssociateEndpoint | No | String | The associated endpoint Id, which can be queried via the DescribeVpcEndPoint api. input an empty string to unbind. |
| 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, 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. |
Modifies a CLB instance.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancerAttributes
<Common request parameters>
{
"LoadBalancerName": "newlbname",
"LoadBalancerId": "lb-6efswuxa"
}{
"Response": {
"DealName": null,
"RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
| 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. |
피드백