应用型BLB服务器组相关接口

更新时间：2025-08-21

CreateAppServerGroup创建应用型服务器组

在指定应用型BLB下，创建一个服务器组，用来绑定后端服务器，以及为监听器开放相应的端口

请求结构

Plain Text

1POST /v{version}/appblb/{blbId}/appservergroup?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "name":name,
7    "desc":desc,
8    "backendServerList": [
9        {
10            "instanceId": instanceId,
11            "weight": weight
12        },
13        {
14            "instanceId": instanceId,
15            "weight": weight
16        }
17    ]
18}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
name	String	否	RequestBody参数	服务器组的名称，方便记忆。长度1~65个字节，字母开头，_可包含字母数字-/.字符。若不传该参数，会自动生成
desc	String	否	RequestBody参数	服务器组的描述，便于用户添加更详细的描述信息。长度0~450个字节，支持中文。默认为空。
backendServerList	List<AppBackendServer>	否	RequestBody参数	服务器组绑定的后端服务器列表

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

返回头域

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

返回参数

参数名称	类型	描述
id	String	服务器组id
name	String	服务器组的名称
desc	String	服务器组的描述
status	String	服务器组状态，详见blbStatus

请求示例

Plain Text

1POST /v1/appblb/lb-j8UqijYf/appservergroup?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "name": "name1",
7    "desc": "aaa",                         
8    "backendServerList":[                    
9        {
10            "instanceId": "BCC_UUID",       
11            "weight": 20
12        }
13    ]
14}

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7{
8    "id": "sg_short_id",
9    "name": "name",
10    "desc": "aaa",
11    "status": "available"                 
12}

UpdateAppServerGroup更新服务器组

更新指定LoadBalancer下的TCP监听器参数，所有请求参数中指定的域都会被更新，未指定的域保持不变，监听器通过端口指定。

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/appservergroup?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId":sgId,
7    "name":name,
8    "desc":desc
9}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	要更新的服务器组的id
name	String	否	RequestBody参数	服务器组的名称，方便记忆。长度1~65个字节，字母开头，可包含字母数字-_/.字符。若不传该参数，会自动生成
desc	String	否	RequestBody参数	服务器组的描述，便于用户添加更详细的描述信息。长度0~450个字节，支持中文。默认为空

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/appservergroup?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "sgId": "sgId",
7    "name": "name1",
8    "desc": "aaa"
9}

响应示例

Plain Text

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

DescribeAppServerGroup查询服务器组

查询指定LoadBalancer下所有服务器组的信息
结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

请求结构

Plain Text

1GET /v{version}/appblb/{blbId}/appservergroup?name={name}&marker={marker}&maxKeys={maxKeys}&exactlyMatch={exactlyMatch} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
name	String	否	Query参数	要查询的服务器组名称
exactlyMatch	boolean	否	Query参数	设置name是否全局匹配
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量不超过1000。缺省值为1000

返回状态码

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

返回头域

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

返回参数

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

请求示例

Plain Text

1GET /v1/appblb/lb-j8UqijYf/appservergroup?maxKeys=2 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 06:42:44 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9    "appServerGroupList":[
10    {
11        "id": "sg_short_id",
12        "name": "name",
13        "desc": "bbb",
14        "status": "available"，
15        "portList":
16        [{
17            "id": "port_id"
18            "port": BACKEND_PORT,
19            "type": "TCP",
20            "healthCheck": "TCP",
21            "healthCheckNormalStatus": "^[1-5][0-9]*$",
22            "healthCheckPort": 90,
23            "healthCheckTimeoutInSecond": 2,
24            "healthCheckDownRetry": 3,
25            "healthCheckUpRetry": 3,
26            "healthCheckIntervalInSecond": 1,
27            "healthCheckUrlPath": "HEALTH_CHECK_URL_PATH",
28            "healtchCheckHost": www.xxx,                         
29            "status": "available"                   
30        }]
31    }
32         ],
33    "marker": "sg-012310",         
34    "isTruncated": false,
35    "maxKeys": 1000,
36    "nextMarker": "sg-013214"      
37}

DeleteAppServerGroup删除服务器组

删除服务器组，通过服务器组id指定

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/appservergroup?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId": sgId 
7}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
action	String	是	Query参数	必须为delete
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	要删除的服务器组id

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/appservergroup?delete&clientToken=be31b98c-5e41-4838-9830-9be700de5a20
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
4
5{
6    "sgId":"abc"
7}

响应示例

Plain Text

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

CreateAppServerGroupPort创建应用型服务器组端口

在指定应用型BLB下，创建一个服务器组后端端口，将发往该端口的所有流量按权重轮询分发到其绑定的对应服务器列表中的服务器

请求结构

Plain Text

1POST /v{version}/appblb/{blbId}/appservergroupport?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId":sgId,
7    "port":port,
8    "type":type,
9    "enableHealthCheck":enableHealthCheck,
10    "healthCheck":healthCheck,
11    "healthCheckPort":healthCheckPort,
12    "healthCheckUrlPath":healthCheckUrlPath,
13    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
14    "healthCheckIntervalInSecond":healthCheckIntervalInSecond,
15    "healthCheckDownRetry":healthCheckDownRetry,
16    "healthCheckUpRetry":healthCheckUpRetry,
17    "healthCheckNormalStatus":healthCheckNormalStatus,
18    "healthCheckHost":healthCheckHost,
19    "udpHealthCheckString":udpHealthCheckString
20}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	端口所属服务器组标识符
port	int	是	RequestBody参数	端口号，需为1-65535间的整数
type	String	是	RequestBody参数	监听端口的协议类型，"TCP"/"UDP"/"HTTP"
enableHealthCheck	Boolean	否	RequestBody参数	是否开启健康检查，默认true
healthCheck	String	否	RequestBody参数	健康检查协议，支持"HTTP"/"TCP"/"UDP"/"ICMP"， TCP默认TCP，UDP默认UDP，HTTP默认HTTP
healthCheckPort	int	否	RequestBody参数	健康检查端口，允许范围为1-65535，默认为port的取值，当健康检查协议为"HTTP"时生效
healthCheckUrlPath	String	否	RequestBody参数	健康检查URI，默认/。当健康检查协议为"HTTP"时生效
healthCheckTimeoutInSecond	int	否	RequestBody参数	健康检查超时（单位：秒），默认为3，需为1-60间的整数
healthCheckIntervalInSecond	int	否	RequestBody参数	健康检查间隔（单位：秒），默认为3，需为1-10间的整数
healthCheckDownRetry	int	否	RequestBody参数	不健康阈值，即连续多少次健康检查失败后，屏蔽该后端服务器。默认为3，需为2-5间的整数
healthCheckUpRetry	int	否	RequestBody参数	健康阈值，即连续多少次健康检查成功后，重新将该后端服务器置为可用。默认为3，需为2-5间的整数
healthCheckNormalStatus	String	否	RequestBody参数	健康检查正常时的HTTP状态码，支持5类状态码的组合，例如"http_1xx\|http_2xx"，默认"http_2xx\|http_3xx"。当健康检查协议为"HTTP"时生效
healthCheckHost	String	否	RequestBody参数	7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效
udpHealthCheckString	String	否	RequestBody参数	UDP服务的健康检查字段。当健康检查协议为"UDP"时，则必传

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

返回头域

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

返回参数

参数名称	类型	描述
id	String	服务器组端口id
status	String	服务器组端口状态，详见blbStatus

请求示例

Plain Text

1POST /v1/appblb/lb-j8UqijYf/appservergroupport?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "sgId":"sgid",
7    "type":"TCP",
8    "port": 80,
9    "enableHealthCheck":true,
10    "healthCheck":"TCP",                     
11    "healthCheckTimeoutInSecond": 2,                    
12    "healthCheckDownRetry": 3,                          
13    "healthCheckUpRetry": 3,                            
14    "healthCheckIntervalInSecond":3                   
15}

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Wed, 10 Apr 2016 08:26:52 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7{
8    "id": "sg_port_id",
9    "status": "available"                 
10}

UpdateAppServerGroupPort更新服务器组端口

根据id更新服务器组端口。

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/appservergroupport?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId":sgId,
7    "portId":portId,
8    "enableHealthCheck":enableHealthCheck,
9    "healthCheck":healthCheck,
10    "healthCheckPort":healthCheckPort,
11    "healthCheckUrlPath":healthCheckUrlPath,
12    "healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
13    "healthCheckIntervalInSecond":healthCheckIntervalInSecond,
14    "healthCheckDownRetry":healthCheckDownRetry,
15    "healthCheckUpRetry":healthCheckUpRetry,
16    "healthCheckNormalStatus":healthCheckNormalStatus,
17    "healthCheckHost":healthCheckHost,
18    "udpHealthCheckString":udpHealthCheckString
19}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	端口所属服务器组标识符
portId	String	是	RequestBody参数	要更新的服务器组端口的标识符
enableHealthCheck	Boolean	否	RequestBody参数	是否开启健康检查，默认true
healthCheck	String	否	RequestBody参数	健康检查协议，支持"HTTP"/"TCP"/"UDP"/"ICMP"， TCP默认TCP，UDP默认UDP，HTTP默认HTTP
healthCheckPort	int	否	RequestBody参数	健康检查端口，默认为port的取值，当健康检查协议为"HTTP"时生效
healthCheckUrlPath	String	否	RequestBody参数	健康检查URI，默认/。当健康检查协议为"HTTP"时生效
healthCheckTimeoutInSecond	int	否	RequestBody参数	健康检查超时（单位：秒），默认为3，需为1-60间的整数
healthCheckIntervalInSecond	int	否	RequestBody参数	健康检查间隔（单位：秒），默认为3，需为1-10间的整数
healthCheckDownRetry	int	否	RequestBody参数	不健康阈值，即连续多少次健康检查失败后，屏蔽该后端服务器。默认为3，需为2-5间的整数
healthCheckUpRetry	int	否	RequestBody参数	健康阈值，即连续多少次健康检查成功后，重新将该后端服务器置为可用。默认为3，需为2-5间的整数
healthCheckNormalStatus	String	否	RequestBody参数	健康检查正常时的HTTP状态码，支持5类状态码的组合，例如"http_1xx\|http_2xx"，默认"http_2xx\|http_3xx"。当健康检查协议为"HTTP"时生效
healthCheckHost	String	否	RequestBody参数	7层健康检查请求的头部域会带指定的host字段，例如"localhost"，默认""。当健康检查协议为"HTTP"时生效
udpHealthCheckString	String	否	RequestBody参数	UDP服务的健康检查字段。当健康检查协议为"UDP"时，则必传

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/appservergroupport?clientToken=abc HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "sgId":“abc”,
7    "portId":"dbd",
8    "enableHealthCheck":true,
9    "healthCheck":"TCP",                     
10    "healthCheckTimeoutInSecond": 2,
11    "healthCheckDownRetry": 3,
12    "healthCheckUpRetry": 3,
13    "healthCheckIntervalInSecond": 1 
14}

响应示例

Plain Text

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

DeleteAppServerGroupPort删除服务器组端口

删除服务器组端口，通过服务器组id指定

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/appservergroupport?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId": sgId,
7    "portIdList":[portid1,portid2] 
8}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
action	String	是	Query参数	必须为batchdelete
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	要删除的端口所在服务器组id
portIdList	List\<String>	是	RequestBody参数	所有待释放的端口id，一起组成一个数组

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/appservergroupport?batchdelete&clientToken=asdfg
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
4
5{
6    "sgId":"abc",
7    "portIdList":["a","b"]
8}

响应示例

Plain Text

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

CreateBlbRs添加应用型BLB后端RS

在指定应用型BLB和服务器组下绑定后端服务器RS

请求结构

Plain Text

1POST /v{version}/appblb/{blbId}/blbrs?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId":sgId,
7    "backendServerList": [
8        {
9            "instanceId": instanceId,
10            "weight": weight
11        },
12        {
13            "instanceId": instanceId,
14            "weight": weight
15        }
16        
17    ]
18}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	RS所属服务器组id
backendServerList	List<AppBackendServer>	是	RequestBody参数	后端服务器列表

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

返回状态码

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

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

返回参数

无

请求示例

Plain Text

1POST /v1/appblb/lb-j8UqijYf/blbrs?clientToken=asdfg HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "sgId": "sg-db3975dc",                          
7    "backendServerList":[                    
8        {
9            "instanceId": "i-b3Dq3ea3",       
10            "weight": 20
11        }
12    ]
13}

响应示例

Plain Text

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

UpdateBlbRs更新服务器组下挂载的RS权重

更新指定服务器组下的RS信息

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/blbrs?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId": sgId,                          
7    "backendServerList":[                    
8        {
9            "instanceId": instanceId,     
10            "weight": weight
11        }
12    ]
13}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	RS所属服务器组id
backendServerList	List<AppBackendServer>	是	RequestBody参数	后端服务器列表

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/blbrs?clientToken=asdfg  HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
4
5{
6    "sgId": "sg-db3975dc",                          
7    "backendServerList":[                    
8        {
9            "instanceId": "i-b3Dq3ea3",       
10            "weight": 20
11        }
12    ]
13}

响应示例

Plain Text

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

DescribeBlbRs查询服务器组下的RS列表信息

查询指定LoadBalancer下所有服务器组的信息
支持按监听器端口进行匹配查询
结果支持marker分页，分页大小默认为1000，可通过maxKeys参数指定

请求结构

Plain Text

1GET /v{version}/appblb/{blbId}/blbrs?marker={marker}&maxKeys={maxKeys}&sgId={sgId} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
sgId	String	是	Query参数	RS所属服务器组id
marker	String	否	Query参数	批量获取列表的查询的起始位置，是一个由系统生成的字符串
maxKeys	int	否	Query参数	每页包含的最大数量，最大数量不超过1000。缺省值为1000

返回状态码

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

返回头域

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

返回参数

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

请求示例

Plain Text

1GET /v1/appblb/lb-j8UqijYf/blbrs?maxKeys=2&sgId=sg-db3975dc HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 06:42:44 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{
9    "marker": "rs-012310",          
10    "isTruncated": false,
11    "maxKeys": 1000,
12    "nextMarker": "rs-013214",      
13    "backendServerList": [
14    {
15        "instanceId": "BCC_UUID",
16        "privateIp": "192.168.0.1",              
17        "weight": "WEIGHT",
18        "portList": [                            
19        {
20            "listenerPort": "LISTENER_PORT1",
21            "backendPort": "BACKEND_PORT1",
22            "portType": "HTTP",
23            “healthCheckPortType”： "HTTP",
24            "portId": "port_xxx",             
25            "policyId": "policy_xxx",             
26            "status": "Alive"
27        },
28        {
29            "listenerPort": "LISTENER_PORT2",
30            "backendPort": "BACKEND_PORT2",
31            "portType": "HTTP",
32            “healthCheckPortType”： "HTTP",
33            "portId": "port_xxx",             
34            "policyId": "policy_xxx",             
35            "staus": "Alive"
36        }
37        ]
38    }
39    ]
40}

DeleteBlbRs删除服务器组下挂载的rs

删除服务器组，通过服务器组id指定

请求结构

Plain Text

1PUT /v{version}/appblb/{blbId}/blbrs?{action}&clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6    "sgId": sgId,
7     backendServerIdList: ["Serverid1", "Serverid2", "Serverid3"]
8}

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
action	String	是	Query参数	描述要进行的操作，本接口取batchdelete
clientToken	String	是	Query参数	幂等性Token，长度不超过64位
sgId	String	是	RequestBody参数	要删除的RS所属服务器组id
backendServerIdList	List\<String>	是	RequestBody参数	所有待释放的后端服务器标识符，一起组成一个数组

返回状态码

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

返回头域

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

返回参数

无

请求示例

Plain Text

1PUT /v1/appblb/lb-j8UqijYf/blbrs?batchdelete&clientToken=be31b98c-5e41-4838-9830-9be700de5a20
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
4
5{
6    "sgId":"abc",
7    "backendServerIdList": ["ab48bbe", "2520741", "a78e04"]
8}

响应示例

Plain Text

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

DescribeRsMount查询服务器组下绑定的server

查询服务器组下绑定的server

请求结构

Plain Text

1GET /v{version}/appblb/{blbId}/blbrsmount?sgId={sgId} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
sgId	String	是	Query参数	RS所属服务器组id

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
backendServerList	List<AppBackendServer>	包含查询结果的列表

请求示例

Plain Text

1GET /v1/appblb/lb-j8UqijYf/blbrsmount?sgId=abc HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 06:42:44 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{     
9    "backendServerList": [
10    {
11        "instanceId": "BCC_UUID",
12        "privateIp": "192.168.0.1",              
13        "weight": "WEIGHT",
14        "portList": [                            
15        {
16            "listenerPort": "LISTENER_PORT1",
17            "backendPort": "BACKEND_PORT1",
18            "portType": "HTTP",
19            “healthCheckPortType”： "HTTP",
20            "portId": "port_xxx",             
21            "policyId": "policy_xxx",             
22            "status": "Alive"
23        },
24        {
25            "listenerPort": "LISTENER_PORT2",
26            "backendPort": "BACKEND_PORT2",
27            "portType": "HTTP",
28            “healthCheckPortType”： "HTTP",
29            "portId": "port_xxx",             
30            "policyId": "policy_xxx",             
31            "staus": "Alive"
32        }
33        ]
34    }
35    ]
36}

DescribeRsUnMount查询服务器组下未绑定的RS

查询服务器组下未绑定的RS

请求结构

Plain Text

1GET /v{version}/appblb/{blbId}/blbrsunmount?sgId={sgId} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string

请求头域

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

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号，当前取值1
blbId	String	是	URL参数	所属LoadBalancer的标识符
sgId	String	是	Query参数	RS所属服务器组id

返回状态码

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

返回头域

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

返回参数

参数名称	类型	描述
backendServerList	List<AppBackendServer>	包含查询结果的列表

请求示例

Plain Text

1GET /v1/appblb/lb-j8UqijYf/blbrsunmount?sgId=abc HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3

响应示例

Plain Text

1HTTP/1.1 200 OK
2x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
3Date: Fri, 03 Jun 2016 06:42:44 GMT
4Transfer-Encoding: chunked
5Content-Type: application/json;charset=UTF-8
6Server: BWS
7
8{     
9    "backendServerList": [
10    {
11        "instanceId": "BCC_UUID",
12        "privateIp": null,              
13        "weight": null,
14        "portList": []
15    }
16    ]
17}

BLB订单相关接口

应用型BLB实例相关接口

负载均衡 BLB

负载均衡 BLB

应用型BLB服务器组相关接口

CreateAppServerGroup创建应用型服务器组

UpdateAppServerGroup更新服务器组

DescribeAppServerGroup查询服务器组

DeleteAppServerGroup删除服务器组

CreateAppServerGroupPort创建应用型服务器组端口

UpdateAppServerGroupPort更新服务器组端口

DeleteAppServerGroupPort删除服务器组端口

CreateBlbRs添加应用型BLB后端RS

UpdateBlbRs更新服务器组下挂载的RS权重

DescribeBlbRs查询服务器组下的RS列表信息

DeleteBlbRs删除服务器组下挂载的rs

DescribeRsMount查询服务器组下绑定的server

DescribeRsUnMount查询服务器组下未绑定的RS