Domain name for API request: ecm.tencentcloudapi.com.
This API is used to purchase a CLB instance.
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: CreateLoadBalancer. |
Version | Yes | String | Common Params. The value used for this API: 2019-07-19. |
Region | No | String | Common Params. This parameter is not required for this API. |
EcmRegion | Yes | String | ECM region, such as ap-xian-ecm . |
LoadBalancerType | Yes | String | Network type of the CLB instance. Currently, you can pass in only OPEN , which indicates public network. |
VipIsp | Yes | String | CMCC: China Mobile; CTCC: China Telecom; CUCC: China Unicom. |
LoadBalancerName | No | String | CLB instance name, which will take effect only when one instance is created. It can contain 1–50 letters, digits, hyphens, and underscores. Note: if the name of the new CLB instance already exists, a default name will be generated automatically. |
VpcId | No | String | Network ID of the target device on the CLB backend, such as vpc-12345678 . |
Number | No | Integer | Number of CLB instances to be created. Default value: 1. |
InternetAccessible | No | LoadBalancerInternetAccessible | CLB information such as bandwidth limit. |
Tags.N | No | Array of TagInfo | Tags. |
SecurityGroups.N | No | Array of String | Security groups. |
AddressIPVersion | No | String | IP version. Valid values: IPV4 (default), IPv6FullChain (IPv6 version). This parameter is only for public network CLB instances. |
SubnetId | No | String | Subnet ID. This parameter is required for IPv6 CLB instances. |
Parameter Name | Type | Description |
---|---|---|
LoadBalancerIds | Array of String | Array of CLB instance IDs Note: this field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to purchase a CLB instance.
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLoadBalancer
<Common request parameters>
{
"VipIsp": "CUCC",
"VpcId": "vpc-12345678",
"InternetAccessible": {
"InternetMaxBandwidthOut": "2000"
},
"LoadBalancerType": "OPEN",
"LoadBalancerName": "testname",
"EcmRegion": "ap-hangzhou-ecm"
}
{
"Response": {
"LoadBalancerIds": [
"lb-mov2697v"
],
"RequestId": "88487432-ee86-4e5d-861b-774374123f89"
}
}
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 |
---|---|
FailedOperation | Operation failed. |
FailedOperation.InternalOperationFailure | Internal error. |
InternalError | Internal error. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.FormatError | The parameter format is incorrect. |
InvalidParameter.InvalidDataFormat | The data format is incorrect. |
InvalidParameterValue | The parameter value is incorrect. |
InvalidParameterValue.InvalidEcmRegion | The region parameter is invalid. |
InvalidParameterValue.InvalidISPInNode | The ISP is invalid. |
InvalidParameterValue.InvalidLoadBalancerNum | The number of CLB instances is invalid. |
InvalidParameterValue.InvalidLoadBalancerType | The CLB instance type is invalid. |
InvalidParameterValue.InvalidPublicParam | The common parameter is invalid. |
InvalidParameterValue.InvalidSubnetInZone | The node does not exist in this subnet. |
InvalidParameterValue.Length | The parameter length is incorrect. |
InvalidParameterValue.Range | The parameter value is not in the specified range. |
InvalidParameterValue.TagNumOutOfRange | The number of tags exceeds the limit. |
LimitExceeded | The quota limit is exceeded. |
LimitExceeded.LBLimitExceeded | The number of CLB instances applied for exceeds the limit. |
MissingParameter | The parameter is missing. |
ResourceInsufficient | Insufficient resource. |
ResourcesSoldOut.LoadBalancerSoldOut | CLB instances have been sold out. |
UnauthorizedOperation.ForbiddenOperation | You don't have the permission to perform this operation. |
Was this page helpful?