1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API is used to create a CLB instance. (This API only supports purchasing pay-as-you-go CLB instances. For monthly subscription CLB instances, purchase through the console.) To use the CLB service, you should purchase one or more CLB instances. After this API is successfully called, the unique ID of the CLB instance will be returned. The type of CLB instances is divided into public network and private network. For details, see the product type in the product description.
Note: (1) Apply for CLB instances in the specified AZ and adopt cross-zone disaster recovery. (2) The default purchase quota for an account in each region is: 100 for public network and 100 for private network.
This API is an asynchronous API. After the API returns a call success message, the DescribeLoadBalancers API can be used to query the status of the CLB instance (such as creating or normal) to determine whether the creation is successful.
Default interface request rate limit: 20 times per second.
Interface update time: 2024-02-22 11:26:37.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateLoadBalancer |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-03-17 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LoadBalancerType | Yes | No | String | CLB instance network type: OPEN: Public network; INTERNAL: Private network. Example: OPEN |
| Forward | No | No | Int64 | The type of CLB instance. 1: General CLB instance. Currently, only 1 is supported. Example: 1 |
| LoadBalancerName | No | No | String | CLB instance name, which takes effect only when one instance is to be created. Rule: 1-50 English letters, digits, dashes (-), or underscores (_).Note: If this name is the same as that of an existing CLB instance, the system will automatically generate a name for this newly created instance. Example: lb-1 |
| VpcId | No | No | String | ID of the network specified for the target backend load balancing device. For example, vpc-j9x73ko1. This ID can be obtained through the DescribeVpcEx API. If this parameter is not specified, the classic network ("0") is used by default. Example: vpc-30xqji93 |
| SubnetId | No | No | String | A subnet ID must be specified when you purchase a private network CLB instance in a VPC, and the VIP of this instance will be generated in this subnet. Example: subnet-dva8ji93 |
| ProjectId | No | No | Int64 | The ID of the project to which the CLB instance belongs. This parameter can be obtained through the DescribeProject API. If this parameter is not specified, the default project will be used. Example: 0 |
| AddressIPVersion | No | No | String | IP version, applicable only to public network CLB. Valid values: IPV4, IPV6, and IPv6FullChain. Default: IPV4. Example: IPV4 |
| Number | No | No | Uint64 | Number of CLB instances to create. Default: 1. Example: 1 |
| MasterZoneId | No | No | String | Primary AZ ID for cross-AZ disaster recovery settings. For example, 100001 or ap-region1-1. Note: The primary AZ loads traffic while the secondary AZ does not load traffic by default. The primary AZ is used only if the latter is unavailable. The list of primary AZs in a region can be queried through the DescribeMasterZones API. Example: ap-region1-1 |
| ZoneId | No | No | String | AZ ID. For example, ap-region1-1. Applicable only to public network CLB. It specifies an AZ for creating CLB instances. This parameter is not used on Private Cloud. Example: ap-region1-1 |
| AnycastZone | No | No | String | Anycast release domain, applicable only to public network CLB. Valid values: ZONE_A and ZONE_B. This parameter is supported only by non-migration bandwidth users. (Deprecated) Example: ZONE_A |
| InternetAccessible | No | No | InternetAccessible | CLB network billing mode, applicable only to public network CLB instances. Example:View |
| VipIsp | No | No | String | Applicable only to public network CLB. CMCC |
| Tags | No | No | Array of TagInfo | Tags the CLB instance when you purchase it. Example:View |
| ZhiTong | No | No | Bool | Whether passthrough is supported. This parameter is not supported on Private Cloud. Example: true |
| Vip | No | No | String | Apply for CLB instances for a specified VIP. The TgwGroupName parameter must also be specified. Example: 139.X.X.X |
| TgwGroupName | No | No | String | Name of the Tgw exclusive cluster Example: tg-1 |
| IsDDos | No | No | Bool | Whether anti-DDoS package binding is supported. This parameter is not supported on Private Cloud. Example: true |
| BandwidthPackageId | No | No | String | Bandwidth package ID, which is required when the network billing mode is Bandwidth Package Example: bwp-pnbeji93 |
| ExclusiveCluster | No | No | ExclusiveCluster | Exclusive cluster information Example:View |
| SlaveZoneId | No | No | String | Secondary AZ ID for cross-AZ disaster recovery settings. For example, 100001 or ap-region1-1. Note: The primary AZ loads traffic, while the secondary AZ does not load traffic by default. The latter is used only if the primary AZ is unavailable, and the switch is automatic. The list of primary and secondary AZs in a region can be queried through the DescribeMasterZones API. Example: ap-region1-1 |
| TgwSetLabels | No | No | Array of String | Parameter specific to Private Cloud. A layer-4 cluster tag can be entered for private network CLB application to specify a layer-4 exclusive cluster. Example: ["l4-label1"] |
| StgwSetLabels | No | No | Array of String | Parameter specific to Private Cloud. A layer-7 cluster tag can be entered for private network CLB application to specify a layer-7 exclusive cluster. Example: ["l7-label1"] |
| EipAddressId | No | No | String | Unique ID of an EIP, in the format of eip-11112222, which is applicable only for binding EIP to private network CLB. Example: eip-1111ji93 |
| ClusterIds | No | No | Array of String | ID of a local dedicated cluster Example: ["cluster-gbo2ji93"] |
| IPv6DecoupleVpc | No | No | Int64 | Whether to apply for an IPv6 address from the VPC side. 1 indicates decoupling from the VPC and not applying for an address from the VPC side. 0 indicates not decoupling from the VPC and applying for an address from the VPC side. Example: 0 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| LoadBalancerIds | Array of String | Array of unique CLB instance IDs. Example: ["lb-6efswuxa"] |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter | Wrong parameter. |
| InvalidParameterValue | Incorrect parameter value |
| InternalError | Internal Error |
| UnauthorizedOperation | Unauthorized operation |
| ResourceInsufficient | Insufficient resources |
| LimitExceeded | Quota limit reached |
| FailedOperation | Failed to operate. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |
| MissingParameter | Missing parameter error. |
| InvalidParameterValue.Range | Invalid parameter value range. |