普通型BLB实例相关接口

更新时间：2024-12-25

CreateLoadBalancer创建实例

描述

创建一个LoadBalancer，返回分配的服务地址及实例ID。
付费方式为后付费。
需要实名认证，若未通过实名认证可以前往百度智能云官网控制台中的安全认证下的实名认证中进行认证。

请求结构

POST /v{version}/blb?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "name": name,
	"desc": desc,
	"vpcId": vpcId,
	"subnetId": subnetId,
    "address": address,
    "type": type,
    "eip":eip,
    "tags":[
        {
            "tagKey": tagKey,
            "tagValue": tagValue
        }
    ]
}

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
name	String	否	RequestBody参数	LoadBalancer的名称，方便记忆。长度1~65个字节，字母开头，可包含字母数字-_/.字符。若不传该参数，会自动生成
desc	String	否	RequestBody参数	LoadBalancer实例的描述，便于用户添加更详细的描述信息。长度0~450个字节，支持中文，默认为空
vpcId	String	是	RequestBody参数	LoadBalancer实例所属VPC的ID
subnetId	String	是	RequestBody参数	LoadBalancer实例所属子网的ID
address	String	否	RequestBody参数	指定负载均衡实例的私网IP地址，该地址必须包含在子网网段下。
type	String	否	RequestBody参数	指定负载均衡实例的类型，不传默认为普通型，传"ipv6"代表创建ipv6类型的BLB。
eip	String	否	RequestBody参数	绑定已有的eip。取值为eip的IP地址。
tags	List<TagModel>	否	RequestBody参数	待创建的标签键值对列表
billing	BillingForCreate	否	RequestBody参数	订单相关信息，购买预付费blb的时候必填
performanceLevel	String	否	RequestBody参数	性能规格参数，默认为共享型。取值如下："small1"标准型1，"small2"标准型2，"medium1"增强型1，"medium2"增强型1，"large1"超大型1，"large2"超大型2，"large3"超大型3,如果是后付费按使用量计费的时候还可以传"unlimited"不限速
autoRenewLength	int	否	RequestBody参数	支持创建预付费BLB同时开通自动续费，根据autoRenewTimeUnit的取值有不同的范围，month 为1到9，year 为1到3
autoRenewTimeUnit	String	否	RequestBody参数	支持创建BLB同时开通自动续费，取值为 month 获 year （默认 month）
resourceGroupId	String	否	RequestBody参数	支持创建BLB同时绑定资源分组id
allowDelete	Boolean	否	RequestBody参数	是否允许删除。缺省值为true，代表允许删除
allocateIpv6	Boolean	否	RequestBody参数	是否分配ipv6地址。true代表分配ipv6地址，false代表不分配ipv6地址

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

参数名称	类型	描述
address	string	分配的内网服务地址IP，通过这个IP即能通过内网访问该实例
name	string	LoadBalancer的名称
blbId	string	LoadBalancer的ID。后续针对该实例的操作，均需要在请求中带上此ID
desc	string	LoadBalancer的描述

请求示例

POST /v1/blb?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST blb.bj.baidubce.com
Authorization: authorization string

创建后付费blb实例
{
    "name":"blb-for-test",
	"desc": "myblb",
	"vpcId": "vpc-fy6vdykpwkqb",
	"subnetId": "sbn-a34td0pxcucd",
    "address": "192.168.0.24",
    "eip": "100.88.8.139"
}

创建预付费blb实例
{
    "vpcId":"vpc-fbsxgfs9ty60",
    "subnetId":"sbn-3317rkjfq8j9",
    "name":"ccq20240223_ccq",
    "billing": {
        "paymentTiming":"Prepaid",
        "reservation": {
            "reservationLength":2
        }
    },
    "performanceLevel":"small1"
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "blbId": "lb-BLuOPSLZ",
    "name": "blb-for-test",
    "address": "192.168.0.24",
	 "desc": "myblb"
}

DescribeLoadBalancers查询已有的BLB实例

描述

查询用户账户下所有LoadBalancer的信息
支持按LoadBalancer的Name、Address进行模糊查询
支持按LoadBalancer的ID进行精确查询
支持按bccId进行查询，目前只支持单个bccId查询，并且仅支持精确查询。查询结果为包含该后端服务器的负载均衡实例。
返回结果是多重查询条件的交集
如果BLB实例开启了公网访问，返回结果将会带上公网IP
结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

请求结构

GET /v{version}/blb?address={address}&name={name}&blbId={blbId}&bccId={bccId}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
address	String	否	Query参数	要查询的LoadBalancer内网服务地址，格式为点分十进制
name	String	否	Query参数	要查询的LoadBalancer名称
blbId	String	否	Query参数	要查询的LoadBalancer ID（只支持精确查询）
bccId	String	否	Query参数	绑定该BCC的LoadBalancer（只支持精确查询）
exactlyMatch	Boolean	否	Query参数	为true表示查询条件为精准匹配，否则为模糊匹配。缺省值为false
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量不超过1000。缺省值为1000
type	String	否	Query参数	指定负载均衡实例的类型，不传默认为普通型，传"ipv6"代表查询ipv6类型的BLB。

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

参数名称	类型	描述
blbList	List<BLBModel>	包含查询结果的列表
marker	string	标记查询的起始位置，若结果列表为空，此项不存在
isTruncated	boolean	true表示后面还有数据，false表示已经是最后一页
nextMarker	String	获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
maxKeys	int	每页包含的最大数量

请求示例

GET /v1/blb?name=test&maxKeys=2 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "blbList": [
        {
            "blbId": "lb-a7e5zPPk",
            "status": available,
            "name": "test-blb",
			"desc": desc,
            "address": "192.168.0.23"
        },
        {
            "blbId": "lb-gj5gVpeq",
            "status": available,
            "name": "nametest",
			"desc": desc,
            "address": "192.168.0.24",
			"publicIp": "123.2.3.4"
        }
    ],
    "marker": "blb-0A20F971",
    "nextMarker": "blb-0A20FB09",
    "isTruncated": true,
    "maxKeys": 2
}

DescribeLoadBalancerDetail查询BLB实例详情

描述

按ID查询用户账户下所有LoadBalancer的详细信息
包含LoadBalancer所有的监听器端口信息

请求结构

GET /v{version}/blb/{blbId}?type={type} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	要查询的LoadBalancer的标识符
type	String	否	Query参数	指定查询负载均衡实例的类型，不传默认为普通型，传"ipv6"代表查询ipv6类型的BLB。

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

参数名称	类型	描述
blbId	String	LoadBalancer的标识符
status	blbStatus	BLB状态
name	String	LoadBalancer的名称
desc	String	LoadBalancer的描述
address	String	LoadBalancer的内网地址
publicIp	String	LoadBalancer的公网地址
cidr	String	LoadBalancer所在网络cidr
vpcName	String	LoadBalancer所属vpc名称
vpcId	String	LoadBalancer所属vpcId
createTime	String	LoadBalancer创建时间
releaseTime	String	LoadBalancer自动释放时间
listener	List<ListenerModel>	LoadBalancer下挂载监听器列表
tags	List<TagModel>	标签键值对列表
allowDelete	Boolean	是否允许删除
paymentTiming	String	付款时间，预支付（Prepaid）或后支付（Postpaid）
billingMethod	String	计费方式，"ByCapacityUnit" 按使用量 "BySpec" 按固定规格
performanceLevel	String	性能规格。"small1"标准型1，"small2"标准型2，"medium1"增强型1，"medium2"增强型1，"large1"超大型1，"large2"超大型2，"large3"超大型3
expireTime	String	预付费实例的过期时间
eipRouteType	String	EIP线路类型
publicIpv6	String	如果LoadBalancer绑定过EIPv6，则显示该项，否则不显示
eipV6RouteType	String	EIPV6线路类型

请求示例

GET /v1/blb/lb-7fb1e926 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "blbId":"lb-gj5gVpeq",
    "status":"available",
    "name":"nametest", 
    "desc":"",     
    "address":"192.168.0.2", 
    "publicIp":"123.2.3.4", 
    "cidr":"192.168.0.0/16", 
    "vpcName":"test",         
    "createTime":"2019-03-07T02:35:31Z",    
    "releaseTime":"2019-03-07T02:35:31Z",
    "paymentTiming":"Postpaid",   
    "billingMethod":"ByCapacityUnit",  
    "listener":[                            
    {
        "port":80,                      
        "backendPort":90,               
        "type": "TCP",                  
        "healthCheckType": "TCP",       
        "healthCheckstatus": "Alive"       
    }
    ]
}

UpdateLoadBalancer更新实例

描述

更新指定的单个LoadBalancer配置信息，包括LoadBalancer实例的名称和描述。

请求结构

PUT /v{version}/blb/{blbId}?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "name": name,
    "desc": desc
}

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	Query参数	待更新的LoadBalancer的ID
name	String	否	RequestBody参数	LoadBalancer的名称，方便记忆。长度1~65个字节，字母开头，可包含字母数字-_/.字符。若不传该参数，会自动生成
desc	String	否	RequestBody参数	LoadBalancer实例的描述，便于用户添加更详细的描述信息。长度0~450个字节，支持中文。默认为空
allowDelete	Boolean	否	RequestBody参数	是否允许删除。缺省值为true，代表允许删除
allocateIpv6	Boolean	否	RequestBody参数	是否分配ipv6地址。true代表分配ipv6地址，false代表不分配ipv6地址

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

无

请求示例

PUT /v1/blb/lb-j8UqijYf?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST blb.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
	"name":"blb-for-test",
	"desc":"用于测试"
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

DeleteLoadBalancer释放BLB实例

描述

释放指定LoadBalancer，被释放的LoadBalancer无法找回

请求结构

DELETE /v{version}/blb/{blbId}?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	待释放的LoadBalancer的ID
clientToken	String	是	Query参数	幂等性Token，长度不超过64位

返回状态码

成功返回200，失败返回见错误码

返回头域

除公共头域外，无其他特殊头域

返回参数

无

请求示例

DELETE /v1/blb/lb-j8UqijYf?clientToken=aabbccdd HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 03 Jun 2016 07:09:45 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

UpdateLoadBalancerAcl更新实例ACL功能

描述

更新指定的LoadBalancer是否支持ACL功能，支持更新类型（普通型、应用型、IPv6型）

请求结构

PUT /v{version}/blb/acl/{blbId}?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
    "supportAcl": supportAcl
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	Query参数	待更新的LoadBalancer的ID
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
supportAcl	Boolean	否	RequestBody参数	是否支持ACL，缺省值为true，代表支持

返回状态码

成功返回200，失败返回见错误码。

返回头域

除公共头域外，无其他特殊头域

返回参数

无

请求示例

PUT /v1/blb/acl/lb-9f59e197?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST blb.bj.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2021-09-10T10:00:00Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
	"supportAcl":true
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 10 Sep 2021 10:00:10 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

错误码

普通型BLB监听器相关接口

百度智能云

负载均衡 BLB

负载均衡 BLB

普通型BLB实例相关接口

CreateLoadBalancer创建实例

DescribeLoadBalancers查询已有的BLB实例

DescribeLoadBalancerDetail查询BLB实例详情

UpdateLoadBalancer更新实例

DeleteLoadBalancer释放BLB实例

UpdateLoadBalancerAcl更新实例ACL功能