Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to clone a Cloud Load Balancer instance. Based on the designated CLB instance, it creates a new instance with identical rules and binding relationships. The cloning operation is asynchronous. The cloned data is based on the call to CloneLoadBalancer. If the cloned CLB changes after calling CloneLoadBalancer, the change rules will not be cloned.
Limitation notes:
Does not support basic networks, classic CLB, IPv6, or NAT64.
Unsupported Monthly Subscription CLB
The listener does not support QUIC or port ranges.
No support for backend types: target group, Serverless Cloud Function (SCF).
Personalized configuration, redirection configuration, and security group default allow switch will not be cloned and must be manually configured.
API calling
BGP bandwidth package must include bandwidth package ID
Exclusive cluster cloning must pass corresponding parameters, otherwise shared instance creation is used.
The feature is in beta test. You can submit a beta test application.
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: CloneLoadBalancer. |
| Version | Yes | String | Common Params. The value used for this API: 2023-04-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LoadBalancerId | Yes | String | CLB ID. |
| LoadBalancerName | No | String | The name of the cloned CLB instance. Rule: 1-60 English letters, Chinese characters, digits, hyphens "-", or underscores "_". Note: If the name is the same as an existing Cloud Load Balancer instance in the system, the system will automatically generate the name of the created CLB instance. |
| ProjectId | No | Integer | The project ID associated with the Cloud Load Balancer instance can be obtained through the DescribeLoadBalancers API. If this parameter is not specified, it will be used as the default project. |
| MasterZoneId | No | String | Applicable only to public network CLB. Sets the primary AZ ID for cross-AZ disaster recovery, such as 100001 or ap-guangzhou-1. Note: The primary AZ loads traffic, while the secondary AZ does not load traffic by default and is used only if the primary AZ becomes unavailable. The platform will automatically select the optimal secondary AZ. You can call the DescribeResources API to query the primary AZ list of a region. |
| SlaveZoneId | No | String | Applicable only to public network CLB. Sets the secondary AZ ID for cross-AZ disaster recovery, such as 100001 or ap-guangzhou-1. Note: The secondary AZ sustains traffic when the primary AZ encounters faults. You can call the DescribeResources API to query the list of primary/secondary AZs in a region. |
| ZoneId | No | String | Applicable only to public network CLB. Availability zone ID. Specify an availability zone to create a Cloud Load Balancer instance, for example, ap-guangzhou-1. If not specified, queries CVM instances in all AZs. If needed, call the DescribeZones API (https://www.tencentcloud.com/document/product/213/15707?from_cn_redirect=1) to query the availability zone list. |
| InternetAccessible | No | InternetAccessible | CLB network billing mode, applicable only to public network CLB instances. |
| VipIsp | No | String | It only applies to public CLB. Currently, the static single-line IP type is supported only for the regions of Guangzhou, Shanghai, Nanjing, Jinan, Hangzhou, Fuzhou, Beijing, Shijiazhuang, Wuhan, Changsha, Chengdu, and Chongqing. If you need to experience it, contact your business manager. After approval, you can select the ISP type as China Mobile (CMCC), China Unicom (CUCC), or China Telecom (CTCC). The network billing mode should be selected as billing by bandwidth package (BANDWIDTH_PACKAGE). If this parameter is not specified, BGP is used by default. You can use the DescribeResources API to query ISPs supported for a region. |
| Vip | No | String | Designate a Vip to apply for Cloud Load Balancer. |
| Tags.N | No | Array of TagInfo | When you purchase Cloud Load Balancer (CLB), you can tag it. |
| ExclusiveCluster | No | ExclusiveCluster | Exclusive cluster information. |
| BandwidthPackageId | No | String | Bandwidth package ID. If this parameter is specified, the network billing mode (InternetAccessible.InternetChargeType) supports only billing by bandwidth package (BANDWIDTH_PACKAGE). |
| SnatPro | No | Boolean | Whether to support the feature of binding IP addresses across regions/VPCs. |
| SnatIps.N | No | Array of SnatIp | SNAT IP addresses to be created when the feature of cross-region/cross-VPC IP address binding is enabled. |
| ClusterIds.N | No | Array of String | Public network exclusive cluster ID or CDCId. |
| SlaType | No | String | Performance capacity specification. |
| ClusterTag | No | String | Exclusive STGW cluster tag. |
| Zones.N | No | Array of String | Applicable only to private network CLB. When connected to nearby via private network, select availability zone for deployment. You can call the DescribeZones API to query the availability zone list. |
| EipAddressId | No | String | Unique ID of an EIP, in the format of eip-11112222, which is applicable only for binding EIP to private network CLB. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
Clone a Cloud Load Balancer
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloneLoadBalancer
<Common request parameters>
{
"LoadBalancerId": "lb-xxxx"
}
{
"Response": {
"RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"
}
}
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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation means the request will be successful, but the DryRun parameter is passed. |
| FailedOperation | Operation failed. |
| FailedOperation.InvalidLBStatus | LB status exception. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Incorrect parameter format. |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameter.ListenerIdNotFound | Listener ID error. |
| InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
| InvalidParameter.PortCheckFailed | Listener port check due to port conflicts or other reasons. |
| InvalidParameter.ProtocolCheckFailed | Listener protocol check failed because, for example, the protocol used is incompatible with the corresponding operation. |
| InvalidParameter.RegionNotFound | Invalid region. |
| LimitExceeded | The quota limit is exceeded. |
| MissingParameter | Parameters are missing. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourcesSoldOut | Resources are sold out. |
피드백