负载均衡修改负载均衡实例的属性-实例相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： clb.tencentcloudapi.com 。

修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
注意：非带宽上移用户的 CLB 实例必须加入带宽包才可以设置跨域属性。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyLoadBalancerAttributes。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
LoadBalancerId	是	String	负载均衡的唯一ID 示例值：lb-6efswuxa
LoadBalancerName	否	String	负载均衡实例名称示例值：newlbname
TargetRegionInfo	否	TargetRegionInfo	设置负载均衡跨地域绑定1.0的后端服务信息
InternetChargeInfo	否	InternetAccessible	网络计费相关参数
LoadBalancerPassToTarget	否	Boolean	Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。示例值：true
SnatPro	否	Boolean	是否开启跨地域绑定2.0功能示例值：false
DeleteProtect	否	Boolean	是否开启删除保护示例值：false
ModifyClassicDomain	否	Boolean	将负载均衡二级域名由mycloud.com改为tencentclb.com，子域名也会变换。修改后mycloud.com域名将失效。示例值：true

3. 输出参数

参数名称	类型	描述
DealName	String	切换负载均衡计费方式时，可用此参数查询切换任务是否成功。注意：此字段可能返回 null，表示取不到有效值。示例值：null
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改负载均衡实例名称

修改负载均衡

输入示例

POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoadBalancerAttributes
<公共请求参数>

{
    "LoadBalancerName": "newlbname",
    "LoadBalancerId": "lb-6efswuxa"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.ResourceInOperating	正在操作指定的资源，请稍后重试。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.FormatError	参数格式错误。
InvalidParameter.LBIdNotFound	负载均衡实例ID错误。
InvalidParameter.RegionNotFound	地域无效。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Duplicate	参数值有重复。
InvalidParameterValue.Length	参数长度错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
ResourceInsufficient	资源不足。
UnauthorizedOperation	未授权操作。

修改负载均衡实例的属性

本页目录：