操作指南

API 文档

克隆负载均衡实例

最近更新时间:2022-01-13 08:18:13

我的收藏

1. 接口描述

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

克隆负载均衡实例,根据指定的负载均衡实例,复制出相同规则和绑定关系的负载均衡实例。克隆接口为异步操作,克隆的数据以调用CloneLoadBalancer时为准,如果调用CloneLoadBalancer后克隆CLB发生变化,变化规则不会克隆。

限制说明:
不支持基础网络和传统型负载均衡、IPv6和NAT64
不支持包年包月CLB
不支持监听器为 QUIC、端口段
不支持后端类型为 目标组、SCF云函数
个性化配置、重定向配置、安全组默认放通开关 将不会被克隆,须手工配置

权限说明:
调用克隆接口用户需要具有:CreateLoadBalancer、CreateLoadBalancerListeners、CreateListenerRules、BatchRegisterTargets、SetLoadBalancerSecurityGroups、ModifyLoadBalancerAttributes、SetLoadBalancerClsLog、DeleteLoadBalancer权限,其中DeleteLoadBalancer用于克隆失败回滚流程,如果没有该接口权限,克隆失败后可能会残留克隆失败的CLB数据。

通过接口调用:
BGP带宽包必须传带宽包id
独占集群克隆必须传对应的参数,否则按共享型创建
功能内测中,申请开通

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CloneLoadBalancer。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
LoadBalancerId String 负载均衡ID。
LoadBalancerName String 克隆出负载均衡实例的名称,规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
注意:如果名称与系统中已有负载均衡实例的名称相同,则系统将会自动生成此次创建的负载均衡实例的名称。
ProjectId Integer 负载均衡实例所属的项目 ID,可以通过 DescribeProject 接口获取。不传此参数则视为默认项目。
MasterZoneId String 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区,平台将为您自动选择最佳备可用区。
SlaveZoneId String 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID,例如 100001 或 ap-guangzhou-1
注:备可用区是主可用区故障后,需要承载流量的可用区。可通过 DescribeMasterZones 接口查询一个地域的主/备可用区的列表。
ZoneId String 仅适用于公网负载均衡。可用区ID,指定可用区以创建负载均衡实例。如:ap-guangzhou-1。
InternetAccessible InternetAccessible 仅适用于公网负载均衡。负载均衡的网络计费模式。
VipIsp String 仅适用于公网负载均衡。CMCC | CTCC | CUCC,分别对应 移动 | 电信 | 联通,如果不指定本参数,则默认使用BGP。可通过 DescribeSingleIsp 接口查询一个地域所支持的Isp。如果指定运营商,则网络计费式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。
Vip String 指定Vip申请负载均衡。
Tags.N Array of TagInfo 购买负载均衡同时,给负载均衡打上标签。
ExclusiveCluster ExclusiveCluster 独占集群信息。
BandwidthPackageId String 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE)。
SnatPro Boolean 是否支持绑定跨地域/跨Vpc绑定IP的功能。
SnatIps.N Array of SnatIp 开启绑定跨地域/跨Vpc绑定IP的功能后,创建SnatIp。
ClusterIds.N Array of String 公网独占集群ID或者CDCId。
SlaType String 性能保障规格。
ClusterTag String Stgw独占集群的标签。
Zones.N Array of String 仅适用于私有网络内网负载均衡。内网就近接入时,选择可用区下发。
EipAddressId String EIP 的唯一 ID,形如:eip-11112222,仅适用于内网负载均衡绑定EIP。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 克隆负载均衡

输入示例

https://clb.tencentcloudapi.com/?Action=CloneLoadBalancer
&LoadBalancerId=lb-xxxx
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
FailedOperation.InvalidLBStatus LB状态异常。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameter.LBIdNotFound 负载均衡实例ID错误。
InvalidParameter.ListenerIdNotFound 监听器ID错误。
InvalidParameter.LocationNotFound 查找不到符合条件的转发规则。
InvalidParameter.PortCheckFailed 监听器端口检查失败,比如端口冲突。
InvalidParameter.ProtocolCheckFailed 监听器协议检查失败,比如相关协议不支持对应操作。
InvalidParameter.RegionNotFound 地域无效。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourcesSoldOut 资源售罄。
目录