普通型BLB后端服务器相关接口

AddBackendServers添加后端服务器

描述

  • 为指定LoadBalancer添加后端服务器,支持批量添加

请求结构

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

{
    "backendServerList":[
        {
            "instanceId":instanceId,
            "weight":weight
        },...
    ]
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
blbId String URL参数 所属LoadBalancer的标识符
backendServerList List<BackendServerModel> RequestBody参数 待添加的后端服务器列表

返回状态码

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

返回头域

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

返回参数

请求示例

POST /v1/blb/lb-j8UqijYf/backendserver?clientToken=clienttokentest
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "backendServerList":[
        {
            "instanceId":"i-YfAibl4A",
            "weight":"50"
        },
        {
            "instanceId":"i-jBXABQ8D",
            "weight":"60"
        }
    ]
}

响应示例

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

DescribeHealthStatus查询后端服务器健康状态

描述

  • 查询指定LoadBalancer下的后端服务器信息,需要指定监听端口,结果会返回后端服务器的健康状态
  • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

请求结构

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

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

参数名称 类型 描述
backendServerList List<BackendServerStatus> 后端服务器状态列表
type String 监听器类型,值为"TCP"/"HTTP"
listenerPort int 监听器的监听端口
backendPort int 后端服务器的监听端口
marker string 标记查询的起始位置,若结果列表为空,此项不存在
isTruncated boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
maxKeys int 每页包含的最大数量

请求示例

GET /v1/blb/lb-j8UqijY/backendserver?listenerPort=88 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 03:54:29 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "backendServerList": [
        {
            "instanceId": "i-YfAibl4A",
            "weight": 50,
            "status": "Alive"
        },
        {
            "instanceId": "i-jBXABQ8D",
            "weight": 60,
            "status": "Dead"
        }
    ],
    "type": "TCP",
    "listenerPort": 88,
    "backendPort": 88,
    "marker": "rs-0A6BE9BB",
    "nextMarker": null,
    "isTruncated": false,
    "maxKeys": 1000
}

DescribeBackendServers查询后端服务器列表

描述

  • 查询指定LoadBalancer下的后端服务器列表
  • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

请求结构

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

请求头域

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

请求参数

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

返回状态码

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

返回头域

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

返回参数

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

请求示例

GET /v1/blb/lb-j8UqijY/backendserver 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 03:54:29 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "backendServerList": [
        {
            "instanceId": "i-YfAibl4A",
            "weight": 50,
        }
    ],
    "marker": "rs-0A6BE9BB",
    "nextMarker": null,
    "isTruncated": false,
    "maxKeys": 1000
}

UpdateBackendServers更新后端服务器

描述

更新指定LoadBalancer下的后端服务器权重,支持批量修改。

请求结构

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

{
    "backendServerList":[
        {
            "instanceId":instanceId,
            "weight":weight
        },...
    ]
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
blbId String URL参数 所属LoadBalancer的标识符
action String Query参数 必须为update
backendServerList List<BackendServerModel> RequestBody参数 待更新的后端服务器列表

返回状态码

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

返回头域

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

返回参数

请求示例

PUT /v1/blb/lb-j8UqijYf/backendserver?update&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118

{
    "backendServerList":[
        {
            "instanceId":"i-YfAibl4A",
            "weight":"50"
        },
        {
            "instanceId":"i-jBXABQ8D",
            "weight":"60"
        }
    ]
}

响应示例

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

RemoveBackendServers释放后端服务器

描述

  • 释放指定LoadBalancer下的后端服务器,后端服务器通过其标识符指定
  • 支持批量释放

请求结构

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

{
    "backendServerList":[backendServer1,backendServer2,...]
}

请求头域

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

请求参数

参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
blbId String URL参数 所属LoadBalancer的标识符
clientToken String Query参数 幂等性Token,长度不超过64位
backendServerList List<String> RequestBody参数 所有待释放的后端服务器标识符,一起组成一个数组

返回状态码

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

返回头域

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

返回参数

请求示例

PUT /v1/blb/lb-j8UqijY/backendserver?clientToken=shfkjanajsabvhj HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "backendServerList":["i-jBXABQ8D"]
}

响应示例

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