应用型BLB实例相关接口
所有文档

          负载均衡 BLB

          应用型BLB实例相关接口

          CreateLoadBalancer创建实例

          描述

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

          请求结构

          POST /v{version}/appblb?clientToken={clientToken} HTTP/1.1
          Host: blb.bj.baidubce.com
          Authorization: authorization string
          
          {
              "name": name,
              "desc": desc,
              "subnetId": subnetShortId,
              "vpcId": vpcShortId,
              "address": address,
               "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个字节,支持中文。默认为空
          subnetId String RequestBody参数 LoadBalancer实例所属子网
          vpcId String RequestBody参数 LoadBalancer实例vip所属VPC的vpcShortId
          address String RequestBody参数 指定负载均衡实例的私网IP地址,该地址必须包含在子网网段下。
          tags List<TagModel> RequestBody参数 待创建的标签键值对列表

          返回状态码

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

          返回头域

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

          返回参数

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

          请求示例

          POST /v1/appblb?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",
              "subnetId":"sbn-hj9k8v413tqm",
              "vpcId": "vpc-tuf4sqw82i5m",
              "address": "192.168.0.24"
          }

          响应示例

          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",
              "desc": "",
              "address": "192.168.0.24"
          }

          UpdateLoadBalancer更新实例

          描述

          • 更新一个LoadBalancer的配置信息。

          请求结构

          PUT /v{version}/appblb/{blb_id}?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
          clientToken String Query参数 幂等性Token,长度不超过64位
          name String RequestBody参数 LoadBalancer的名称,方便记忆。长度1~65个字节,字母开头,可包含字母数字-_/.字符。若不传该参数,会自动生成
          desc String RequestBody参数 LoadBalancer实例的描述,便于用户添加更详细的描述信息。长度0~450个字节,支持中文。默认为空
          allowDelete Boolean RequestBody参数 是否允许删除。缺省值为true,代表允许删除

          返回状态码

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

          返回头域

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

          返回参数

          请求示例

          PUT /v1/appblb/lb-9f59e197?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

          DescribeLoadBalancers查询已有的BLB实例

          描述

          • 查询用户账户下所有LoadBalancer的信息
          • 支持按LoadBalancer的id、name、address进行查询,匹配规则支持部分包含(不支持正则)
          • 支持查找绑定指定BCC的LoadBalancer,通过bccId参数指定
          • 返回结果是多重查询条件的交集
          • 结果支持marker分页,分页大小默认为1000,可通过maxKeys参数指定

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          address String Query参数 要查询的LoadBalancer地址,格式为点分十进制的IP
          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

          返回状态码

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

          返回头域

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

          返回参数

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

          请求示例

          GET /v1/appblb?name=test&maxKeys=2 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
          
          {
              "blbList": [
                  {
                      "blbId": "lb-a7e5zPPk",
                      "status": available,
                      "name": "test-blb",
                      "desc": "用于生产环境",
                      "vpcId":"vpc-fy6vdykpwkqb",
                      "address": "192.168.0.24"
                  },
                  {
                      "blbId": "lb-gj5gVpeq",
                      "status": available,
                      "name": "nametest",
                      "desc": "用于测试环境",
                      "vpcId":"vpc-a8n5p6kybbx4",
                      "address": "192.168.0.25"
                  }
              ],
              "marker": "blb-0A20F971",
              "nextMarker": "blb-0A20FB09",
              "isTruncated": true,
              "maxKeys": 2
          }

          DescribeLoadBalancerDetail查询BLB实例详情

          描述

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

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          blbId String URL参数 要查询的LoadBalancer的标识符

          返回状态码

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

          返回头域

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

          返回参数

          参数名称 类型 描述
          blbId String LoadBalancer的标识符
          status blbStatus BLB状态
          desc String LoadBalancer的描述
          address String LoadBalancer的内网地址
          publicIp String LoadBalancer的公网地址
          cidr String LoadBalancer所在网络cidr
          vpcName String LoadBalancer所属vpc名称
          subnetCider String LoadBalancer所属子网cidr
          subnetName String LoadBalancer所属子网名称
          createTime String LoadBalancer创建时间
          releaseTime String LoadBalancer自动释放时间
          listener List<ListenerModel> LoadBalancer下挂载监听器列表
          tags List<TagModel> 标签键值对列表
          allowDelete Boolean 是否允许删除

          请求示例

          GET /v1/appblb/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",               
              "subnetName": "系统预定义子网",    
              "subnetCider": "192.168.0.0/20",    
              "createTime":"2019-03-07T02:35:31Z",    
              "releaseTime":"2019-03-07T02:35:31Z",   
              "listener":[                            
              {
                  "port":80,                      
                  "type": "TCP"                   
              }
              ]
          }

          DeleteLoadBalancer释放BLB实例

          描述

          • 释放指定LoadBalancer,被释放的LoadBalancer无法找回

          请求结构

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

          请求头域

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

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String URL参数 API版本号,当前取值1
          blbId String URL参数 待释放的LoadBalancer的ID

          返回状态码

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

          返回头域

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

          返回参数

          请求示例

          DELETE /v1/appblb/lb-j8UqijYf HTTP/1.1
          Host: blb.bj.baidubce.com
          Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T07:09:25Z/1800/host/fa13c6057d34b0152a0959541f49bea9ae4eeece2317ac3e371dda33c27f5f76

          响应示例

          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
          上一篇
          普通型BLB接口
          下一篇
          应用型BLB监听器相关接口