获取负载均衡列表
更新时间:2024-03-20
接口描述
本接口用于获取负载均衡列表。
请求结构
GET /v1/blb HTTP/1.1
Host: bec.baidubce.com
Content-Type: application/json; charset=utf-8
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
lbType | String | 否 | Query参数 | 负载均衡类型,取值为container、vm,分别对应容器和虚机。缺省为“container”。 |
pageNo | Integer | 否 | Query参数 | 页数。缺省值为1。 |
pageSize | Integer | 否 | Query参数 | 每页负载均衡个数。取值范围是1~1000,缺省值1000。 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | List<BlbInstanceVo> | 负载均衡列表 |
pageNo | Integer | 页码 |
pageSize | Integer | 当前页的结果数 |
totalCount | Integer | 结果总数 |
错误码
请参照错误返回章节的内容。
请求示例
GET /v1/blb?lbType=container HTTP/1.1
Host: bec.baidubce.com
Content-Type: application/json; charset=utf-8
Authorization: bce-auth-v1/318857a8f08b11e9845ca7e54775a0c2/2019-10-17T03:07:21Z/1800/host/212eef8cfe1ac94be56c4afedb9360bba621ef646c3c8288971d36801d70501a
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2020 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
X-Bce-Gateway-Region: BJ
{
"result": [
{
"blbId": "lb-3zsthi8p",
"blbName": "test-001",
"status": "RUNNING",
"lbType": "container",
"region": "NORTH_WEST",
"serviceProvider": "CHINA_TELECOM",
"city": "XIAN",
"publicIp": null,
"internalIp": null,
"ports": [],
"podCount": 0,
"bandwidthInMbpsLimit": 100,
"createTime": "2020-04-28T06:31:12Z"
}
],
"orders": null,
"orderBy": null,
"order": null,
"pageNo": 1,
"pageSize": 1000,
"totalCount": 1
}
Model对象定义
BlbInstanceVo
参数名称 | 类型 | 描述 |
---|---|---|
blbId | String | 负载均衡ID |
blbName | String | 负载均衡名称 |
status | ResourceStatus | 负载均衡状态 |
lbType | String | 负载均衡类型 |
region | Region | 负载均衡所在地域 |
serviceProvider | ServiceProvider | 负载均衡所属运营商 |
city | String | 负载均衡所在城市 |
publicIp | String | 负载均衡公网IP |
cmPublicIP | String | 中国移动公网IP |
ctPublicIP | String | 中国电信公网IP |
unPublicIP | String | 中国联通公网IP |
internalIp | String | 负载均衡内网IP |
ports | List<Listeners> | 负载均衡端口 |
podCount | Integer | 负载均衡绑定后端服务器数量 |
bandwidthInMbpsLimit | Integer | 负载均衡最大带宽限制 |
createTime | DateTime | 负载均衡创建时间 |
Listeners
参数名称 | 类型 | 描述 |
---|---|---|
protocol | Protocol | 负载均衡协议 |
port | Integer | 负载均衡端口 |
backendPort | Integer | 后端端口 |
scheduler | LbMode | 转发规则 |
healthCheckInterval | Integer | 健康检查间隔时间 |
healthCheckRetry | Integer | 健康检查阈值 |
healthCheckTimeout | Integer | 健康检查超时时间 |
Protocol
枚举名称 | 描述 |
---|---|
TCP | TCP协议 |
UDP | UDP协议 |
HTTP | HTTP协议 |
HTTPS | HTTPS协议 |
SSL | SSL协议 |
LbMode
枚举名称 | 描述 |
---|---|
wrr | 加权轮询 |
minconn | 最小连接数 |
srch | 源IP |
ResourceStatus
枚举名称 | 描述 |
---|---|
PENDING | 调度中 |
RUNNING | 运行中 |
DELETING | 删除中 |
Region
枚举名称 | 描述 |
---|---|
CENTRAL_CHINA | 华中 |
EAST_CHINA | 华东 |
NORTH_CHINA | 华北 |
SOUTH_CHINA | 华南 |
NORTH_EAST | 东北 |
NORTH_WEST | 西北 |
SOUTH_WEST | 西南 |
ServiceProvider
枚举名称 | 描述 |
---|---|
CHINA_UNICOM | 中国联通 |
CHINA_MOBILE | 中国移动 |
CHINA_TELECOM | 中国电信 |