You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/实例/CloneLoadBalancer
CloneLoadBalancer
最近更新时间：2024.12.12 15:26:01首次发布时间：2024.12.12 15:26:01
我的收藏

请求说明

API 名称：CloneLoadBalancer
API 域名：open.volcengineapi.com
API 描述：复制 ALB 实例。复制 ALB 实例时，新实例会默认继承原实例的配置。您也可以指定部分参数的配置，新实例将会按照您指定的配置创建。新实例和原实例的网络类型相同。

说明

如需使用该接口，请提交工单进行申请。

使用限制

节流限制：每秒最多提交 40 个 API 请求。

调用

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称

类型

是否必选

格式

说明

Action

String

是

[a-zA-Z]+

API 名称，如 CloneLoadBalancer 。

Version

String

是

YYYY-MM-DD

API 版本信息。该参数的取值是 2020-04-01 。

X-Expires

Integer

否

900

表示签名的有效时间，单位是秒，默认值是 900。

请求参数

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数

类型

是否必选

参数说明

示例

RegionId

String

是

请求的 Region ID。

cn-beijing

LoadBalancerId

String

是

ALB 实例的 ID。

alb-bp1b6c719dfa08ex****

LoadBalancerName

String

否

ALB 实例的名称。命名规则如下：

  • 允许字母、汉字、数字和以下特殊字符：._-。
  • 必须以字母或汉字开头。
  • 最多允许 128 个字符。

如果您不指定该参数或者参数值为空时，实例 ID 将作为实例名称。

alb-bp1o94dp5i6ea****

Description

String

否

ALB 实例的描述。须符合以下要求：

  • 允许字母、汉字、数字、空格和以下特殊字符：,._=-，。。
  • 必须以字母或汉字开头。
  • 最多允许 255 个字符。

This is an ALB instance.

EipBillingConfig.ISP

String

否

公网 ALB 实例的 IPv4 公网 IP 的线路类型。取值范围：

  • BGP：BGP 多线。

说明

EipBillingConfig.ISP、EipBillingConfig.EipBillingType 和 EipBillingConfig.Bandwidth 参数的使用说明如下：

  • 如果您不指定这三个参数，则参数的值继承原 ALB 实例的配置。
  • 如果您仅指定 EipBillingConfig.ISP，则其他两个参数的值会被设置为默认值。EipBillingConfig.EipBillingType 参数的默认值为 2（按量计费-按带宽上限计费）。EipBillingConfig.Bandwidth 参数的默认值为 1。
  • 如果您未指定 EipBillingConfig.ISP 但是指定了其他两个参数，则指定的参数值不生效，参数值仍继承原 ALB 实例的配置。

BGP

EipBillingConfig.EipBillingType

Integer

否

公网 ALB 实例的 IPv4 公网 IP 的计费方式。取值范围：

  • 2：按量计费-按带宽上限计费。
  • 3：按量计费-按实际流量计费。

说明

使用该参数时请您关注使用限制。具体请参考 EipBillingConfig.ISP 参数的描述。

2

EipBillingConfig.Bandwidth

Integer

否

公网 ALB 实例的 IPv4 公网 IP 的带宽峰值。单位为 Mbps。
取值范围：

  • EipBillingConfig.EipBillingType 参数的值为 2 时：取值范围是 1 ～ 500。
  • EipBillingConfig.EipBillingType 参数的值为 3 时：取值范围是 1 ～ 200。

说明

使用该参数时请您关注使用限制。具体请参考 EipBillingConfig.ISP 参数的描述。

10

Ipv6EipBillingConfig.ISP

String

否

公网 ALB 实例的 IPv6 公网带宽的线路类型。取值范围：

  • BGP：BGP多线。

说明

Ipv6EipBillingConfig.ISP、Ipv6EipBillingConfig.EipBillingType 和 Ipv6EipBillingConfig.Bandwidth 参数的使用说明如下：

  • 如果您不指定这三个参数，则参数的值继承原 ALB 实例的配置。
  • 如果您仅指定 Ipv6EipBillingConfig.ISP，则其他两个参数的值会被设置为默认值。Ipv6EipBillingConfig.EipBillingType 参数的默认值为 3 （按量计费-按实际流量计费）。Ipv6EipBillingConfig.Bandwidth 参数的默认值为 1。
  • 如果您未指定 Ipv6EipBillingConfig.ISP 但是指定了其他两个参数，则指定的参数值不生效，参数值仍继承原 ALB 实例的配置。

BGP

Ipv6EipBillingConfig.BillingType

Integer

否

公网 ALB 实例的 IPv6 公网带宽的计费类型。取值范围：

  • 2：按量计费-按带宽上限计费。
  • 3：按量计费-按实际流量计费。

说明

使用该参数时请您关注使用限制。具体请参考 Ipv6EipBillingConfig.ISP 参数的描述。

2

Ipv6EipBillingConfig.Bandwidth

Integer

否

公网 ALB 实例的 IPv6 公网带宽的带宽上限，单位为 Mbps。
取值范围：

  • Ipv6Address.BillingType 参数的值为 2 时：取值范围是 1 ~ 500。
  • Ipv6Address.BillingType 参数的值为 3 时：取值范围是 1 ~ 200。

说明

使用该参数时请您关注使用限制。具体请参考 Ipv6EipBillingConfig.ISP 参数的描述。

200

DeleteProtection

String

否

是否开启 ALB 实例的删除保护功能。取值范围：

  • off：关闭删除保护功能。
  • on：开启删除保护功能。

off

ZoneMappings

Array

否

可用区及子网映射列表，具体参见下表 ZoneMappings。

-

BandwidthPackageId

String

否

创建 ALB 公网实例时，指定公网 IP 要加入的共享带宽包 ID。

bwp-6248cim0mayon3gd5tv****

ProjectName

String

否

实例所属项目名称。

default

说明

SubnetId 字段即将下线，请使用 ZoneMappings 字段接入服务，指定需要部署的可用区和子网信息。

ZoneMappings

参数

类型

是否必选

参数说明

示例

ZoneMappings.N.SubnetId

String

否

子网 ID。ALB 实例在此可用区下的私网 IP 地址将从此子网网段中分配。

ZoneMappings.1.SubnetId=subnet-bp12mw1f8k3jgy****&ZoneMappings.2.SubnetId=subnet-bp0ohf1f8k3jgy****

ZoneMappings.N.ZoneId

String

否

ALB 实例的可用区 ID。

  • 您可以通过调用 DescribeZones 接口获取实例可部署的可用区的 ID。
  • 子网 ID 与 可用区 ID 需要匹配。

ZoneMappings.1.ZoneId=cn-beijing-a&ZoneMappings.2.ZoneId=cn-beijing-b

返回参数

参数

类型

参数说明

示例值

LoadBalancerId

String

ALB 实例 ID。

alb-bp1o94dp5i6ea****

RequestId

String

请求 ID。

20210811152539010225146063030****

请求示例

GET /?Action=CloneLoadBalancer&Version=2020-04-01&LoadBalancerId=alb-bp1b6c719dfa08ex****&ZoneMappings.1.SubnetId=subnet-2fe6iauhyn3ls5oxruuyf****&ZoneMappings.1.ZoneId=cn-beijing-a
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202412102539010225146063030****",
        "Action": "CloneLoadBalancer",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    }, 
    "Result": {
        "RequestId": "202412102539010225146063030****",
        "LoadBalancerId": "alb-bp1o94dp5i6ea****"
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code

错误码

错误信息

错误描述

400

InvalidLoadBalancerName.Malformed

The specified LoadBalancerName is malformed.

指定的 LoadBalancerName 参数格式不合法。

400

InvalidDescription.Malformed

The specified Description is malformed.

指定的 Description 参数格式不合法。

400

InvalidDeleteProtection.Malformed

The specified DeleteProtection is malformed.

指定的 DeleteProtection 参数格式不合法。

400

InvalidIndexOrder.Malformed

The specified index order is malformed.

指定的索引顺序参数格式不合法。

400

OperationDenied.ZoneUnsupported

The request on the specified LoadBalancer is denied due to the specified zone is unsupported. DescribeZones will tell you which zones ALB supports.

因指定的可用区内不支持创建 ALB 实例，对于该 ALB 实例的操作请求被拒绝。通过调用 DescribeZones 接口，可获得 ALB 实例支持部署的可用区信息。

400

LoadBalancerBillingType.Malformed

The specified LoadBalancerBillingType is malformed.

指定的 LoadBalancerBillingType 参数格式不合法。

400

InvalidZoneMappings.ZoneId.Duplicated

The specified ZoneMappings.ZoneId is duplicated.

指定的 ZoneMappings.ZoneId 重复。

400

OperationFailed.QueryProject

The request on the specified resource failed due to the query on project failed.

因查询项目失败，对于该资源的操作请求失败。

400

InvalidSubnet.ZoneMismatch

The specified subnet and zone do not match.

指定的子网和可用区不匹配。

400

OperationDenied.Ipv6NotEnabled

The request on the specified LoadBalancer is denied due to subnet is not IPv6 enabled.

因子网未启用 IPv6，对于该 ALB 实例的操作请求被拒绝。

400

OperationFailed.QueryVpc

The request on the specified resource failed due to the query on VPC failed.

因请求 VPC 失败，对于该资源的操作请求失败。

400

QuotaExceed.Eip

You've reached the limit on the number of EIP that you can create.

已达到可创建的 EIP 的数量上限。

400

QuotaExceed.Eni

You've reached the limit on the number of Eni that you can create.

已达到创建弹性网卡的数量上限。

400

InvalidEipBillingConfig.EipBillingType.Malformed

The specified EipBillingConfig.EipBillingType is malformed.

指定的 EipBillingConfig.EipBillingType 参数格式不合法。

400

InvalidISPForEip.BandwidthPackageMismatch

The specified ISP for EIP and BandwidthPackage do not match.

指定的 EIP 与共享带宽包的 ISP 不匹配。

400

InvalidIpv6EipBillingConfig.ISP.Malformed

The specified Ipv6EipBillingConfig.ISP is malformed.

指定的 Ipv6EipBillingConfig.ISP 参数格式不合法。

400

InvalidIpv6EipBillingConfig.BillingType.Malformed

The specified Ipv6EipBillingConfig.BillingType is malformed.

指定的 Ipv6EipBillingConfig.BillingType 参数格式不合法。

400

OperationFailed.QueryIAM

The request on the specified resource failed due to the query on IAM failed.

因请求 IAM 失败，对于该资源的操作请求失败。

400

OperationFailed.QueryIpv6Gateway

The request on the specified resource failed due to the query on ipv6 gateway failed.

因请求 IPv6 网关失败，对于该资源的操作请求失败。

400

InvalidIpv6EipBillingConfig.Bandwidth.Malformed

The specified Ipv6EipBillingConfig.Bandwidth is malformed.

指定的 Ipv6EipBillingConfig.Bandwidth 参数格式不合法。

400

OperationDenied.Ipv6NotEnabled

The request on the specified LoadBalancer is denied due to the vpc does not have an IPv6 gateway.

因待创建的 ALB 实例所在的 VPC 未开通 IPv6 网关，对于该 ALB 实例的操作请求被拒绝。

400

InvalidIpv6Gateway.InvalidStatus

The specified IPv6Gateway of VPC is not in the correct status for the request.

指定的 VPC 对应的 IPv6 网关所处状态无法响应该请求。

400

QuotaExceed.InstancePerRegion

You've reached the limit on the number of loadbalancers the current region you can create in, usage xx/xx.

已达到当前地域可创建的 ALB 实例的数量上限。目前已使用xxx，配额为xxx。

400

QuotaExceed.EipInBandwidthPackage

You've reached the limit on the number of EIP per bandwidth package you can add in.

已达到共享带宽包内可加入的 EIP 的数量上限。

400

OperationFailed.CreatePreOrderFailed

The request on the specified LoadBalancer failed due to creating a pre order failed.

因配置单下单失败，对于该 ALB 实例的操作请求失败。

400

OperationFailed.CreatePrivateEniFailed

The request on the specified LoadBalancer failed due to creating private eni failed.

因辅助网卡创建失败，对于该 ALB 实例的操作请求失败。

400

OperationFailed.CreateOrderFailed

The request on the specified LoadBalancer failed due to creating an order failed.

因下单支付失败，对于该 ALB 实例的操作请求失败。

400

OperationFailed.AccountBalanceNotEnough

The request on the specified Resource failed due to the account balance and available vouchers are less than 100 yuan in total.

因账户余额及可用代金券共不足 100 元，对于该资源的操作请求失败。请充值后重试。

403

Forbidden

You are not authorized to create dualstack loadbalancer.

您无权限创建双栈类型 ALB 实例。

404

InvalidRegion.NotFound

The specified Region does not exist.

指定的 Region 不存在。

404

InvalidProject.NotFound

The specified Project does not exist.

指定的项目不存在。

404

InvalidSubnet.NotFound

The specified Subnet does not exist.

指定的子网不存在。

404

InvalidVpc.NotFound

The specified VPC does not exist.

指定的 VPC 不存在。

404

InvalidBandwidthPackage.NotFound

The specified BandwidthPackage does not exist.

指定的共享带宽包不存在。

404

InvalidEip.NotFound

The specified EIP does not exist.

指定的 EIP 不存在。

400

InvalidLoadBalancer.InvalidStatus

The specified LoadBalancer is not in the correct status for the request.

指定的 ALB 实例所处状态无法响应该请求。

404

InvalidTopic.NotFound

The specified Topic does not exist.

指定的日志主题不存在。

400

OperationDenied.CloneLoadBalancer

The request on the specified LoadBalancer is denied due to the LoadBalancer is associated with different EIP attributes.

因 ALB 实例绑定的 EIP 属性不一致，对于该 ALB 实例的操作请求被拒绝。

400

OperationDenied.Ipv6NotEnabled

The request on the specified LoadBalancer is denied due to the vpc does not have an IPv6 gateway.

因待创建的 ALB 实例所在的 VPC 未开通 IPv6 网关，对于该 ALB 实例的操作请求被拒绝。

400

QuotaExceed.ListenerPerAcl

You've reached the limit on the number of listeners per ACL you can associate with, resource {resource}, usage {usage}/{tag}.

已达到每个 ACL 可关联的监听器的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。

400

QuotaExceed.ListenerPerCustomizedCfg

You've reached the limit on the number of listeners per CustomizedCfg you can associate with, resource {resource}, usage {usage}/{tag}.

已达到每个个性化配置可关联的监听器的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。

400

QuotaExceed.ListenerPerInstanceForClone

You've reached the limit on the number of listeners per ALB you can add in for clone, resource {resource}, usage {usage}/{tag}.

已达到每个复制 ALB 实例可创建的监听器的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。

400

QuotaExceed.RulePerGroup

You've reached the limit on the number of rules per server group you can associate with, resource {resource}, usage {usage}/{tag}.

已达到每个服务器组可关联转发规则的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。

400

QuotaExceed.RulePerInstanceForClone

You've reached the limit on the number of rules per ALB you can create in for clone, resource {resource}, usage {usage}/{tag}.

已达到每个复制实例可创建转发规则的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。

400

QuotaExceed.ServerPerInstanceForClone

You've reached the limit on the number of backend servers per ALB you can associate with for clone, resource {resource}, usage {usage}/{tag}.

已达到每个复制实例可关联的后端服务器的数量上限。资源是{resource}，目前已使用{usage}，配额为{tag}。