tencent cloud

负载均衡

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
使用场景
技术原理
产品对比
使用约束
Service Regions and Service Providers
购买指南
计费概述
计费项
CLB 资源包
购买方式
欠费说明
产品属性选择
快速入门
域名化负载均衡快速入门
负载均衡快速入门
IPv6 负载均衡快速入门
CentOS 下部署 Nginx
CentOS 下部署 Java Web
操作指南
负载均衡实例
负载均衡监听器
后端服务器
健康检查
证书管理
日志管理
监控告警
访问管理
传统型负载均衡
实践教程
部署证书到负载均衡(双向认证)
负载均衡开启 Gzip 配置及检测方法说明
HTTPS 转发配置入门指南
如何获取客户端真实 IP
负载均衡配置监控告警最佳实践
产品高可用说明
均衡算法选择与权重配置示例
配置 WAF 对负载均衡的监听域名进行 Web 安全防护
配置 IAP 对负载均衡的域名和路径的web访问进行身份验证
配置 IAP 对负载均衡的域名和路径的程序化访问进行身份验证
运维指南
客户端 timewait 过多解决方案
负载均衡HTTPS服务性能测试
压力测试常见问题
CLB 证书操作权限问题
故障处理
UDP 健康检查出现异常
API 文档
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
常见问题
计费相关
负载均衡配置相关
健康检查异常排查
HTTPS 相关
WS/WSS 协议支持相关
HTTP/2 协议支持相关
默认域名阻断提示
服务等级协议
联系我们
词汇表

CreateLoadBalancer

PDF
聚焦模式
字号
最后更新时间: 2025-11-20 15:22:17

API Description

This API is used to create a CLB instance. To use the CLB service, you first need to purchase one or more instances. After this API call succeeds, a unique instance ID will be returned. There are two types of instances: public network and private network instances. For more information, see the “network types” in CLB Attributes Selection.
Domain name for API calls: lb.api.qcloud.com

Request Parameters

The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is CreateLoadBalancer.
Parameter
Required
Type
Description
loadBalancerType
No
Int
Network type of the CLB instance.
2: public network; 3: private network.
forward
No
Int
CLB instance type. 1: CLB; 0: Cassic CLB. Default value: 0.
loadBalancerName
No
String
CLB instance name, which takes effect only when an instance is created. Rule: 1-50 letters, Chinese, 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.
domainPrefix
No
String
Domain name prefix. The domain name of the CLB instance consists of the user-defined domain prefix and the domain suffix automatically generated by Tencent Cloud to ensure the uniqueness. This field is only applicable to Classic CLB instances.
Rule: 1-20 lowercase letters, digits or dashes (-). This field is inapplicable to private network CLB.
Note: if this domain name prefix is the same as that of an existing CLB instance, the system will automatically generate a domain name prefix for this newly created instance. For example, you only need to enter the prefix "xxxxx" for xxxxx.region.appId.clb.myqcloud.com.
vpcId
No
String
Network ID of the CLB instance, which can be obtained via the DescribeVpcEx API. If no value or “0” is passed in, the network is Classic Network.
subnetId
No
Int
A subnet ID specified when you purchase a private network CLB instance in a VPC. The VIP of this instance will be generated in the subnet. This parameter can be left empty in other cases.
projectId
No
Int
ID of the project to which a CLB instance belongs, which can be obtained via the DescribeProjects API. If this parameter is not passed in, the default project will be used.
number
No
Int
Number of CLB instances to be created. Default value: 1.

Response Parameters

Parameter
Type
Description
code
Int
Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
message
String
API-related module error message description.
codeDesc
String
Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
unLoadBalancerIds
Array
Array of unique CLB instance IDs.
requestId
Int
Task ID.
dealIds
Array
Reserved field.

Example

Purchasing three public network CLB instances with static IPs
https://lb.api.qcloud.com/v2/index.php?Action=CreateLoadBalancer
&<Common request parameters>
&loadBalancerType=2
&number=3
Response
{
"code": 0,
"message": "",
"codeDesc": "Success",
"requestId": 3901942,
"dealIds": [
"3901942"
],
"unLoadBalancerIds": {
"3901942": [
"lb-cjcymkw9",
"lb-fpk0oxhp",
"lb-ikpzv02x"
]
}
}
Where, lb-cjcymkw9 is the unique ID of the CLB instance you just purchased. Next, use the DescribeLoadBalancers API to query whether the CLB instance has been successfully created.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈