产品动态
产品公告
Domain name for API request: clb.intl.tencentcloudapi.com.
This API is used to clone a load balancing instance with identical rules and binding relationships based on the designated Cloud Load Balancer. The cloning process is an asynchronous operation. The cloned data is based on the status when calling CloneLoadBalancer. If the source CLB changes after calling CloneLoadBalancer, the change rules will not be cloned.
Note: The instance creation status can be queried based on the returned requestId by accessing the DescribeTaskStatus API (https://www.tencentcloud.com/document/product/214/30683?from_cn_redirect=1).
This API is used to describe restriction descriptions.
This API is used to set instance attribute restrictions.
-The cloning feature supports both pay-as-you-go and monthly subscription instances. For cloned monthly subscription instances, the new instance's network billing mode switches to billing by hourly bandwidth, with its bandwidth and specifications remaining consistent with the settings of the original instance.
-CLB instances not associated with billable items cannot be cloned (historic free activity creation).
-Classic CLB instances and Anti-DDoS CLBs cannot be cloned.
-Cloning of classic network-based instances is not supported.
-Anycast instances cannot be cloned.
-IPv6 NAT64 edition instances cannot be cloned.
-Blocked or frozen instances cannot be cloned.
-Before performing the cloning operation, make sure that all certificates used on the instance have not expired, otherwise cloning will fail.
This API is used to set quota dimension restrictions.
-Cloning is not supported when the number of instance listeners exceeds 50.
-Cloning is not supported when the public network bandwidth cap of a shared instance exceeds 2G.
This API is used to call APIs.
This API is used to specify the BGP bandwidth package ID.
This API is used to perform exclusive cluster cloning with corresponding parameters, otherwise shared instance creation will be used.
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: 2018-03-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| LoadBalancerId | Yes | String | Specifies the clb ID. you can call the DescribeLoadBalancers API to obtain the ID. |
| LoadBalancerName | No | String | Specifies the name of the cloned load balancing instance. rule: 1-60 english letters, chinese characters, digits, connecting lines "-", or underscores "_". Note: if the name is identical to that of an existing load balancing instance in the system, the system will automatically generate a name for the created cloud load balancer instance. |
| ProjectId | No | Integer | ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API. If this parameter is not passed in, the default project will be used. |
| MasterZoneId | No | String | Sets the primary AZ ID for cross-AZ disaster recovery, such as 100001 or ap-guangzhou-1, which is applicable only to public network CLB.Note: A primary AZ loads traffic, while a secondary AZ does not load traffic by default and will be used only if the primary AZ becomes unavailable. The platform will automatically select the optimal secondary AZ. You can use the DescribeResource API to query the primary AZ list of a region. |
| SlaveZoneId | No | String | Specifies the secondary AZ ID for cross-AZ disaster recovery, such as 100001 or ap-guangzhou-1. It is applicable only to public network CLB.Note: A secondary AZ will load traffic if the primary AZ is faulty. You can use the DescribeMasterZones API to query the primary and secondary AZ list of a region. |
| ZoneId | No | String | Applicable only to public network clb. AZ ID, both availability zone ID and name are supported. specify availability zone to create a load balancing instance, for example: 100001 or ap-guangzhou-1. if not passed, queries CVM instances in all azs. if needed, call the API for the query DescribeZones (https://www.tencentcloud.com/document/product/213/15707?from_cn_redirect=1) to specify availability zone. |
| 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 | Specifies the Vip to apply for cloud load balancer. |
| Tags.N | No | Array of TagInfo | Proceed to purchase cloud load balancer and Tag it at the same time. |
| ExclusiveCluster | No | ExclusiveCluster | Exclusive cluster information. |
| BandwidthPackageId | No | String | BANDWIDTH PACKAGE ID, which can be obtained through the DescribeBandwidthPackages api. specifies this parameter indicates the network billing mode (InternetAccessible.InternetChargeType) supports only billing by BANDWIDTH PACKAGE (BANDWIDTH_PACKAGE). |
| SnatPro | No | Boolean | Specifies whether the cross-regional or cross-Vpc IP binding feature is supported. |
| SnatIps.N | No | Array of SnatIp | Enables cross-regional or cross-Vpc IP binding and creates a SnatIp. |
| ClusterIds.N | No | Array of String | Public network exclusive cluster ID or CDCId. can be obtained through the DescribeExclusiveClusters api. |
| SlaType | No | String | Performance capacity specification. |
| ClusterTag | No | String | Specifies the Tag of the Stgw exclusive cluster. |
| Zones.N | No | Array of String | Applicable only to private network clb. when connected to nearby, select availability zone for deployment. you can call DescribeZones (https://www.tencentcloud.com/document/product/213/15707?from_cn_redirect=1) to query the availability zone list. |
| EipAddressId | No | String | The unique ID of EIP, such as EIP-qhx8udkc, applicable only to private network clb binding EIP, can be queried through the DescribeAddresses API (https://www.tencentcloud.com/document/product/215/16702?from_cn_redirect=1). |
| 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. |
This example shows you how to clone a CLB instance.
POST / HTTP/1.1
Host: clb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloneLoadBalancer
<Common request parameters>
{
"LoadBalancerId": "lb-p10fcs**"
}{
"Response": {
"RequestId": "83129908-a282-4f9f-8ab-131a3025****"
}
}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, which means the DryRun parameter is passed in yet the request will still be successful. |
| FailedOperation | Operation failed. |
| FailedOperation.InvalidLBStatus | Exceptional CLB instance status |
| FailedOperation.ResourceInOperating | The specified resource is currently being operated. Please try again later. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.FormatError | Wrong parameter format. |
| InvalidParameter.LBIdNotFound | Wrong CLB instance ID. |
| InvalidParameter.ListenerIdNotFound | Wrong listener ID. |
| InvalidParameter.LocationNotFound | Unable to find eligible forwarding rules. |
| InvalidParameter.PortCheckFailed | Listener port checks failed due to port conflicts or other reasons. |
| InvalidParameter.ProtocolCheckFailed | Listener protocol checks failed because the protocol used is incompatible with the corresponding operation. |
| InvalidParameter.RegionNotFound | Invalid region. |
| LimitExceeded | Quota exceeded. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resources. |
| ResourcesSoldOut | The resources have been sold out. |
文档反馈