Application BLB Server Group Related Interface
Last Updated：2020-07-20
CreateAppServerGroup
- Under the specified application BLB, create a server group to bind the backend server and open the corresponding port for the listener.
Request Structure
POST /v{version}/appblb/{blbId}/appservergroup?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"name":name,
"desc":desc,
"backendServerList": [
{
"instanceId": instanceId,
"weight": weight
},
{
"instanceId": instanceId,
"weight": weight
}
]
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| name | String | No | RequestBody parameter | The name of the server group is easy to remember. It is 1-65 bytes in length beginning with a letter. _can contain letters, numbers and characters of -,/, and . This parameter will be generated automatically if not loaded |
| desc | String | No | RequestBody parameter | The description of the server group, convenient for users to add more detailed description information. It is 0-450 bytes in length and supports Chinese. Empty by default. |
| backendServerList | List<AppBackendServer> | No | RequestBody parameter | List of backend servers bound to the server group |
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| id | String | Server group id |
| name | String | Server group name |
| desc | String | Server group description |
| status | String | For server group status, please see blbStatus |
Request Example
POST /v1/appblb/lb-j8UqijYf/appservergroup?clientToken=asdfg 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": "name1",
"desc": "aaa",
"backendServerList":[
{
"instanceId": "BCC_UUID",
"weight": 20
}
]
} Response Example
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
{
"id": "sg_short_id",
"name": "name",
"desc": "aaa",
"status": "available"
} UpdateAppServerGroup
- Update the TCP listener parameters under the specified LoadBalancer. All the domains specified in the request parameters will be updated. The unspecified domains remain unchanged, and the listener is specified by the port.
Request Structure
PUT /v{version}/appblb/{blbId}/appservergroup?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId":sgId,
"name":name,
"desc":desc
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | Id of the server group to update |
| name | String | No | RequestBody parameter | The name of the server group is easy to remember. It is 1-65 bytes in length beginning with a letter. It can contain letters, numbers and characters of -_/.. This parameter will be generated automatically if not loaded |
| desc | String | No | RequestBody parameter | The description of the server group, convenient for users to add more detailed description information. It is 0-450 bytes in length and supports Chinese. Empty by default |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/appservergroup?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
{
"sgId": "sgId",
"name": "name1",
"desc": "aaa"
} Response Example
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 DescribeAppServerGroup
- Query information about all server groups under a specified LoadBalancer.
- The result supports marker paging. The default paging size is 1,000, and can be specified by the maxKeys parameter.
Request Structure
GET /v{version}/appblb/{blbId}/appservergroup?name={name}&marker={marker}&maxKeys={maxKeys}&exactlyMatch={exactlyMatch} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| name | String | No | Query parameter | Server group name to query |
| exactlyMatch | boolean | No | Query parameter | Set whether name matches globally |
| marker | String | No | Query parameter | The starting location of query for batch acquisition of lists, and is one string generated by the system. |
| maxKeys | int | No | Query parameter | Maximum number contained in each page, generally not exceeding 1000. The default value is 1000. |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| appServerGroupList | List<AppServerGroup> | List containing query results |
| marker | String | Mark the starting position of the query. The item does not exist if the result list is empty |
| isTruncated | boolean | True means there are additional data in the following pages and false means the current page is the last page. |
| nextMarker | String | The marker value requiring to be passed in order to acquire the next page. The domain doesn't appear when isTruncated is false. |
| maxKeys | int | Maximum number contained in each page. |
Request Example
GET /v1/appblb/lb-j8UqijYf/appservergroup?maxKeys=2 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3 Response Example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 03 Jun 2016 06:42:44 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"appServerGroupList":[
{
"id": "sg_short_id",
"name": "name",
"desc": "bbb",
"status": "available"
"portList":
[{
"id": "port_id"
"port": BACKEND_PORT,
"type": "TCP",
"healthCheck": "TCP",
"healthCheckNormalStatus": "^[1-5][0-9]*$",
"healthCheckPort": 90,
"healthCheckTimeoutInSecond": 2,
"healthCheckDownRetry": 3,
"healthCheckUpRetry": 3,
"healthCheckIntervalInSecond": 1,
"healthCheckUrlPath": "HEALTH_CHECK_URL_PATH",
"healtchCheckHost": www.xxx,
"status": "available"
}]
}
],
"marker": "sg-012310",
"isTruncated": false,
"maxKeys": 1000,
"nextMarker": "sg-013214"
} DeleteAppServerGroup
- Delete server group, specified by server group id.
Request Structure
PUT /v{version}/appblb/{blbId}/appservergroup?{action}&clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId": sgId
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| action | String | Yes | Query parameter | Must be "delete" |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | Server group id to delete |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/appservergroup?delete&clientToken=be31b98c-5e41-4838-9830-9be700de5a20
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
{
"sgId":"abc"
} Response Example
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 CreateAppServerGroupPort
- Under the specified application BLB, create a server group backend port to distribute all traffic sented to the port by weighted round-robin to its bound servers in the corresponding server list.
Request Structure
POST /v{version}/appblb/{blbId}/appservergroupport?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId":sgId,
"port":port,
"type":type,
"healthCheck":healthCheck,
"healthCheckPort":healthCheckPort,
"healthCheckUrlPath":healthCheckUrlPath,
"healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
"healthCheckIntervalInSecond":healthCheckIntervalInSecond,
"healthCheckDownRetry":healthCheckDownRetry,
"healthCheckUpRetry":healthCheckUpRetry,
"healthCheckNormalStatus":healthCheckNormalStatus
"udpHealthCheckString":udpHealthCheckString
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | Identifier of server group to which the port belongs |
| port | int | Yes | RequestBody parameter | Port number which must be an integer from 1 to 65,535 |
| type | String | Yes | RequestBody parameter | Protocol types of the listening port: "TCP"/"UDP"/"HTTP" |
| healthCheck | String | No | RequestBody parameter | Health check protocols support "HTTP"/"TCP"/"UDP"; TCP for TCP protocols by default, UDP for UDP protocols by default, HTTP for HTTP protocols by default |
| healthCheckPort | int | No | RequestBody parameter | Health check port, value of port by default |
| healthCheckUrlPath | String | No | RequestBody parameter | Health check URI,/by default. Effective when the health check protocol is "HTTP" |
| healthCheckTimeoutInSecond | int | No | RequestBody parameter | Health check timeout (unit: second); 3 by default; it must be an integer between 1 and 60 |
| healthCheckIntervalInSecond | int | No | RequestBody parameter | Health check interval (unit: second); 3 by default; it must be an integer between 1 and 10 |
| healthCheckDownRetry | int | No | RequestBody parameter | Unhealthy threshold (the number of failed consecutive health check before the backend server is blocked). 3 by default, must be an integer between 2-5 |
| healthCheckUpRetry | int | No | RequestBody parameter | Healthy threshold (the number of successful consecutive health checks before the backend server is made available again). 3 by default, must be an integer between 2-5 |
| healthCheckNormalStatus | String | No | RequestBody parameter | The HTTP status code when the health check is normal. It supports 5 types of status code combinations like "http_1xx| http_2xx", and is "http_2xx| http_3xx" by default. Effective when the health check protocol is "HTTP" |
| udpHealthCheckString | String | No | RequestBody parameter | Health check field of the UDP service. Required if type is "UDP" |
"200" for return successful and Error Code for return failed
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| id | String | Server group port id |
| status | String | For server group port status, please see blbStatus |
Request Example
POST /v1/appblb/lb-j8UqijYf/appservergroupport?clientToken=asdfg HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
"sgId":"sgid",
"type":"TCP",
"port": 80,
"healthCheck":"TCP",
"healthCheckPort": 90,
"healthCheckTimeoutInSecond": 2,
"healthCheckDownRetry": 3,
"healthCheckUpRetry": 3,
"healthCheckIntervalInSecond":3
} Response Example
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
{
"id": "sg_port_id",
"status": "available"
} Update AppServerGroupPort
- Update the server group port based on the id.
Request Structure
PUT /v{version}/appblb/{blbId}/appservergroupport?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId":sgId,
"portId":portId,
"healthCheck":healthCheck,
"healthCheckPort":healthCheckPort,
"healthCheckUrlPath":healthCheckUrlPath,
"healthCheckTimeoutInSecond":healthCheckTimeoutInSecond,
"healthCheckIntervalInSecond":healthCheckIntervalInSecond,
"healthCheckDownRetry":healthCheckDownRetry,
"healthCheckUpRetry":healthCheckUpRetry,
"healthCheckNormalStatus":healthCheckNormalStatus,
"udpHealthCheckString":udpHealthCheckString
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | Identifier of server group to which the port belongs |
| portId | String | Yes | RequestBody parameter | The identifier of the server group port to update |
| healthCheck | String | No | RequestBody parameter | Health check protocols support "HTTP"/"TCP"/"UDP"; TCP for TCP protocols by default, UDP for UDP protocols by default, HTTP for HTTP protocols by default |
| healthCheckPort | int | No | RequestBody parameter | Health check port, value of port by default |
| healthCheckUrlPath | String | No | RequestBody parameter | Health check URI,/by default. Effective when the health check protocol is "HTTP" |
| healthCheckTimeoutInSecond | int | No | RequestBody parameter | Health check timeout (unit: second); 3 by default; it must be an integer between 1 and 60 |
| healthCheckIntervalInSecond | int | No | RequestBody parameter | Health check interval (unit: second); 3 by default; it must be an integer between 1 and 10 |
| healthCheckDownRetry | int | No | RequestBody parameter | Unhealthy threshold (the number of failed consecutive health check before the backend server is blocked). 3 by default, must be an integer between 2-5 |
| healthCheckUpRetry | int | No | RequestBody parameter | Healthy threshold (the number of successful consecutive health checks before the backend server is made available again). 3 by default, must be an integer between 2-5 |
| healthCheckNormalStatus | String | No | RequestBody parameter | The HTTP status code when the health check is normal. It supports 5 types of status code combinations like "http_1xx| http_2xx", and is "http_2xx| http_3xx" by default. Effective when the health check protocol is "HTTP" |
| udpHealthCheckString | String | No | RequestBody parameter | Health check field of the UDP service. Required if type is "UDP" |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/appservergroupport?clientToken=abc HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
"sgId": "abc",
"portId":"dbd",
"healthCheck":"TCP",
"healthCheckPort": 90,
"healthCheckTimeoutInSecond": 2,
"healthCheckDownRetry": 3,
"healthCheckUpRetry": 3,
"healthCheckIntervalInSecond": 1
} Response Example
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 DeleteAppServerGroupPort
- Delete server group port specified by server group id.
Request Structure
PUT /v{version}/appblb/{blbId}/appservergroupport?{action}&clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId": sgId,
"portIdList":[portid1,portid2]
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| action | String | Yes | Query parameter | Must be batchdelete |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | Server group id of the port to delete |
| portIdList | List\<String> | Yes | RequestBody parameter | All the port IDs to be released form an array together |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/appservergroupport?batchdelete&clientToken=asdfg
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
{
"sgId":"abc",
"portIdList":["a","b"]
} Response Example
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 CreateBlbRs
- Bind backend server RS under specified application BLB and server group.
Request Structure
POST /v{version}/appblb/{blbId}/blbrs?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId":sgId,
"backendServerList": [
{
"instanceId": instanceId,
"weight": weight
},
{
"instanceId": instanceId,
"weight": weight
}
]
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | ID of the server group to which the RS belongs |
| backendServerList | List<AppBackendServer> | Yes | RequestBody parameter | Backend server list |
"200" for return successful and Error Code for return failed.
Return Status Code
"200" for return successful and Error Code for return failed. Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
POST /v1/appblb/lb-j8UqijYf/blbrs?clientToken=asdfg HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
"sgId": "sg-db3975dc",
"backendServerList":[
{
"instanceId": "i-b3Dq3ea3",
"weight": 20
}
]
} Response Example
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 UpdateBlbRs
- Update RS information in the specified server group.
Request Structure
PUT /v{version}/appblb/{blbId}/blbrs?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId": sgId,
"backendServerList":[
{
"instanceId": instanceId,
"weight": weight
}
]
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | ID of the server group to which the RS belongs |
| backendServerList | List<AppBackendServer> | Yes | RequestBody parameter | Backend server list |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/blbrs?clientToken=asdfg HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02
{
"sgId": "sg-db3975dc",
"backendServerList":[
{
"instanceId": "i-b3Dq3ea3",
"weight": 20
}
]
} Response Example
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 DescribeBlbRs
- Query information about all server groups under a specified LoadBalancer.
- Support matching query by listener port.
- The result supports marker paging. The default paging size is 1,000, and can be specified by the maxKeys parameter.
Request Structure
GET /v{version}/appblb/{blbId}/blbrs?marker={marker}&maxKeys={maxKeys}&sgId={sgId} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| sgId | String | Yes | Query parameter | ID of the server group to which the RS belongs |
| marker | String | No | Query parameter | The starting location of query for batch acquisition of lists, and is one string generated by the system. |
| maxKeys | int | No | Query parameter | Maximum number contained in each page, generally not exceeding 1000. The default value is 1000. |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| backendServerList | List<AppBackendServer> | List containing query results |
| marker | String | Mark the starting position of the query. The item does not exist if the result list is empty |
| isTruncated | boolean | True means there are additional data in the following pages and false means the current page is the last page. |
| nextMarker | String | The marker value requiring to be passed in order to acquire the next page. The domain doesn't appear when isTruncated is false. |
| maxKeys | int | Maximum number contained in each page. |
Request Example
GET /v1/appblb/lb-j8UqijYf/blbrs?maxKeys=2&sgId=sg-db3975dc HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3 Response Example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 03 Jun 2016 06:42:44 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"marker": "rs-012310",
"isTruncated": false,
"maxKeys": 1000,
"nextMarker": "rs-013214",
"backendServerList": [
{
"instanceId": "BCC_UUID",
"privateIp": "192.168.0.1",
"weight": "WEIGHT",
"portList": [
{
"listenerPort": "LISTENER_PORT1",
"backendPort": "BACKEND_PORT1",
"portType": "HTTP",
"healthCheckPortType" "HTTP",
"portId": "port_xxx",
"policyId": "policy_xxx",
"status": "Alive"
},
{
"listenerPort": "LISTENER_PORT2",
"backendPort": "BACKEND_PORT2",
"portType": "HTTP",
"healthCheckPortType", "HTTP",
"portId": "port_xxx",
"policyId": "policy_xxx",
"staus": "Alive"
}
]
}
]
} DeleteBlbRs
- Delete server group, specified by server group id.
Request Structure
PUT /v{version}/appblb/{blbId}/blbrs?{action}&clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
{
"sgId": sgId,
backendServerIdList: ["Serverid1", "Serverid2", "Serverid3"]
} Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| action | String | Yes | Query parameter | Describe the operation to be performed, and this interface takes batchdelete |
| clientToken | String | Yes | Query parameter | Idempotent Token, no longer than 64 bits |
| sgId | String | Yes | RequestBody parameter | ID of the server group to which the RS belongs to be deleted |
| backendServerIdList | List\<String> | Yes | RequestBody parameter | All backend server identifiers to be released form an array together |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
None
Request Example
PUT /v1/appblb/lb-j8UqijYf/blbrs?batchdelete&clientToken=be31b98c-5e41-4838-9830-9be700de5a20
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T03:26:45Z/1800/host/c863c8b9f75ff307eb1a3c564307b0833acb9d857c65de108258c3edd4cd0118
{
"sgId":"abc",
"backendServerIdList": ["ab48bbe", "2520741", "a78e04"]
} Response Example
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 DescribeRsMount
- Query the server bound to the server group.
Request Structure
GET /v{version}/appblb/{blbId}/blbrsmount?sgId={sgId} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| sgId | String | Yes | Query parameter | ID of the server group to which the RS belongs |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| backendServerList | List<AppBackendServer> | List containing query results |
Request Example
GET /v1/appblb/lb-j8UqijYf/blbrsmount?sgId=abc HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3 Response Example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 03 Jun 2016 06:42:44 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"backendServerList": [
{
"instanceId": "BCC_UUID",
"privateIp": "192.168.0.1",
"weight": "WEIGHT",
"portList": [
{
"listenerPort": "LISTENER_PORT1",
"backendPort": "BACKEND_PORT1",
"portType": "HTTP",
"healthCheckPortType", "HTTP",
"portId": "port_xxx",
"policyId": "policy_xxx",
"status": "Alive"
},
{
"listenerPort": "LISTENER_PORT2",
"backendPort": "BACKEND_PORT2",
"portType": "HTTP",
"healthCheckPortType", "HTTP",
"portId": "port_xxx",
"policyId": "policy_xxx",
"staus": "Alive"
}
]
}
]
} DescribeRsUnMount
- Query the RS unbound to the server group.
Request Structure
GET /v{version}/appblb/{blbId}/blbrsunmount?sgId={sgId} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string Request Header
There are no other special headers except the public headers.
Request Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| blbId | String | Yes | URL parameter | The identifier of the own LoadBalancer |
| sgId | String | Yes | Query parameter | ID of the server group to which the RS belongs |
Return Status Code
"200" for return successful and Error Code for return failed.
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| backendServerList | List<AppBackendServer> | List containing query results |
Request Example
GET /v1/appblb/lb-j8UqijYf/blbrsunmount?sgId=abc HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/ae4780f344774daa832f34caadd4d7de/2016-06-03T06:42:31Z/1800/host/3f26e5a322d41fa0f3315e906342c2691fe5ee35d21c7e66e425b4ee0f67ced3 Response Example
HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Fri, 03 Jun 2016 06:42:44 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"backendServerList": [
{
"instanceId": "BCC_UUID",
"privateIp": null,
"weight": null,
"portList": []
}
]
}