API 中心
开发与运维产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>负载均衡>实例相关接口>克隆负载均衡实例

克隆负载均衡实例

最近更新时间：2024-12-25 01:20:13

我的收藏

本页目录：

1. 接口描述

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

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

注：查询实例创建状态可以根据返回值中的requestId访问DescribeTaskStatus接口

限制说明
实例属性维度限制：

  • 支持克隆网络计费模式为按量计费与包年包月的实例，包年包月实例克隆后的新实例网络计费模式会转换为按小时带宽计费，其带宽、规格与原实例设置保持一致。
  • 不支持克隆未关联实例计费项的 CLB。
  • 不支持克隆传统型负载均衡实例和高防 CLB。
  • 不支持克隆基础网络类型的实例。
  • 不支持克隆 Anycast 类型的实例。
  • 不支持克隆 IPv6 NAT64 版本的实例。
  • 不支持克隆被封禁或冻结的实例。
  • 执行克隆操作前，请确保实例上没有使用已过期证书，否则会导致克隆失败。
    配额维度限制：
  • 当实例的监听器个数超过 50 个时，不支持克隆。
  • 当共享型实例的公网带宽上限超过 2G 时，不支持克隆。

通过接口调用：
BGP带宽包必须传带宽包id
独占集群克隆必须传对应的参数，否则按共享型创建

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CloneLoadBalancer。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
LoadBalancerId 是 String 负载均衡ID。
示例值：lb-xxxxx
LoadBalancerName 否 String 克隆出负载均衡实例的名称，规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。
注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。
示例值：test-name
ProjectId 否 Integer 负载均衡实例所属的项目 ID，可以通过 DescribeLoadBalancers 接口获取。不传此参数则视为默认项目。
示例值：0
MasterZoneId 否 String 仅适用于公网负载均衡。设置跨可用区容灾时的主可用区ID，例如 100001 或 ap-guangzhou-1
注：主可用区是需要承载流量的可用区，备可用区默认不承载流量，主可用区不可用时才使用备可用区，平台将为您自动选择最佳备可用区。可通过 DescribeResources 接口查询一个地域的主可用区的列表。
示例值：ap-guangzhou-1
SlaveZoneId 否 String 仅适用于公网负载均衡。设置跨可用区容灾时的备可用区ID，例如 100001 或 ap-guangzhou-1
注：备可用区是主可用区故障后，需要承载流量的可用区。可通过 DescribeResources 接口查询一个地域的主/备可用区的列表。
示例值：ap-guangzhou-1
ZoneId 否 String 仅适用于公网负载均衡。可用区ID，指定可用区以创建负载均衡实例。如：ap-guangzhou-1。不传则查询所有可用区的 CVM 实例。如需指定可用区，可调用查询可用区列表DescribeZones接口查询。
示例值：ap-guangzhou-1
InternetAccessible 否 InternetAccessible 仅适用于公网负载均衡。负载均衡的网络计费模式。
VipIsp 否 String 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。
示例值：CMCC
Vip 否 String 指定Vip申请负载均衡。
示例值：139.X.X.X
Tags.N 否 Array of TagInfo 购买负载均衡同时，给负载均衡打上标签。
ExclusiveCluster 否 ExclusiveCluster 独占集群信息。
BandwidthPackageId 否 String 带宽包ID，指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE）。
示例值：bwp-pnbe****
SnatPro 否 Boolean 是否支持绑定跨地域/跨Vpc绑定IP的功能。
示例值：true
SnatIps.N 否 Array of SnatIp 开启绑定跨地域/跨Vpc绑定IP的功能后，创建SnatIp。
ClusterIds.N 否 Array of String 公网独占集群ID或者CDCId。
示例值：["cluster-gbo2****"]
SlaType 否 String 性能容量型规格。
  • clb.c2.medium（标准型）
  • clb.c3.small（高阶型1）
  • clb.c3.medium（高阶型2）
  • clb.c4.small（超强型1）
  • clb.c4.medium（超强型2）
  • clb.c4.large（超强型3）
  • clb.c4.xlarge（超强型4）

    • 示例值：clb.c2.medium
    ClusterTag 否 String Stgw独占集群的标签。
    示例值：ziyan
    Zones.N 否 Array of String 仅适用于私有网络内网负载均衡。内网就近接入时，选择可用区下发。可调用DescribeZones接口查询可用区列表。
    示例值：["ap-guangzhou-3"]
    EipAddressId 否 String EIP 的唯一 ID，形如：eip-11112222，仅适用于内网负载均衡绑定EIP。
    示例值：eip-1111****

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 克隆负载均衡

    克隆负载均衡。

    输入示例

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

{
    "LoadBalancerId": "lb-p10fcs**"
}

    输出示例

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

    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状态异常。
    FailedOperation.ResourceInOperating 正在操作指定的资源，请稍后重试。
    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 资源售罄。
    中国站
    文档活动
    message-icon联系我们
    目录