Service Publishing Point Related Interfaces
Updated at：2025-10-16
Create a service distribution point
Description
Create a service distribution point
Request structure
Plain Text
1POST /v{version}/service?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 {
5 "name": name,
6 "description": description,
7 "serviceName": serviceName,
8 "instanceId": instanceId,
9 "authList": [
10 {
11 "uid": uid,
12 "auth" : auth
13 }
14 ]
15 }Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| name | String | Yes | Request Body parameters | Name of service distribution point, which supports uppercase and lowercase letters, numbers, and special characters such as -, / and ., starting with a letter and a length of 1-65. |
| description | String | No | Request Body parameters | Description of the service distribution point, supporting up to 200 characters |
| serviceName | String | Yes | Request Body parameters | Corresponding service name, supporting 1-65 characters consisting of uppercase and lowercase letters and numbers |
| instanceId | String | Yes | Request Body parameters | Bound instance ID; currently only supporting binding BLB |
| authList | List<[Auth](BLB/API Reference/Appendix.md#Auth)> | No | Request Body parameters | User authorization list. All are denied by default. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| service | String | The domain name of the service distribution point. This domain name is used to bind the Service Network Interface Card (SNIC). |
Request example
Plain Text
1POST /v1/service?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "name": "name",
7 "description": "",
8 "serviceName": "serviceName",
9 "instanceId": "lb-d3e2cf75",
10 "authList": [
11 {
12 "uid": "*",
13 "auth" : "allow"
14 }
15 ]
16 } Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7 {
8 "service": "xxx.baidubce.com"
9 }Update service distribution point
Description
Update service distribution point. The name and description shall not be empty at the same time.
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name":name,
7 "description":description
8}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action performed, current value: modifyAttribute. |
| name | String | No | RequestBody | Name of service distribution point, which supports uppercase and lowercase letters, numbers, and special characters such as -, / and ., starting with a letter and a length of 1-65. |
| description | String | No | RequestBody | Service distribution point description, no more than 200 characters |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?modifyAttribute&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "name":"name",
7 "description":"description"
8}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSBind service distribution point to instance
Description
Bind service distribution point to service
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "instanceId":instanceId
7}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action performed, current value: bind |
| instanceId | String | Yes | Request Body parameters | Bound instance ID |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?bind&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "instanceId":"lb-95d3c305"
7}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSUnbind service distribution point from instance
Description
Unbind service distribution point from service
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization stringRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action performed, current value: unbind |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?unbind&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSAdd authentication information of service distribution point
Description
Add authentication information of service distribution point. If the user authorization is available, overwrite previous authorization.
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "authList": [
7 {
8 "uid": uid,
9 "auth" : auth
10 }
11 ]
12}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action executed, current value: addAuth |
| authList | List<[Auth](BLB/API Reference/Appendix.md#Auth)> | Yes | Request Body parameters | User authorization list |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?addAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "authList": [
7 {
8 "uid": "e8deba4d81d3435bb4591ce97288f296",
9 "auth" : "deny"
10 }
11 ]
12}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSModify authentication information of service distribution point
Description
Modify authentication information of service distribution point
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "authList": [
7 {
8 "uid": uid,
9 "auth" : auth
10 }
11 ]
12}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action executed, current value: editAuth |
| authList | List<[Auth](BLB/API Reference/Appendix.md#Auth)> | Yes | Request Body parameters | User authorization list |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?editAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "authList": [
7 {
8 "uid": "e8deba4d81d3435bb4591ce97288f296",
9 "auth" : "deny"
10 }
11 ]
12}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSDelete authentication information of service distribution point
Description
Add authentication information of service distribution point
Request structure
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "uidList": [
7 "uid"
8 ]
9}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
| action | String | Yes | Query | Action executed, current value: removeAuth |
| uidList | List<String> | Yes | Request Body parameters | User ID list, with "*" for all users. |
Response headers
No special headers are required beyond the standard ones.
Response parameters
No response parameters
Request example
Plain Text
1PUT /v1/service/xxx.baidubce.com?removeAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "uidList": [
7 "e8deba4d81d3435bb4591ce97288f296",
8 "f8deba4d81d8908bb4591ce97288f212",
9 ]
10}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWSQuery service distribution point list
Description
Query the service distribution point list.
Request structure
Plain Text
1GET /v{version}/service?maxKeys=1 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items included per page, maximum: 1,000, default: 1,000 |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | int | Maximum number of items included per page |
| services | List<[Service](BLB/API Reference/Appendix.md#Service)> | Service distribution point list |
Request example
Plain Text
1GET /v{version}/service?marker=uservice-a223vc&maxKeys=1 HTTP/1.1
2Host: blb.bj.baidubce.com
3ContentType: application/json
4Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "nextMarker": "uservice-a223vc",
9 "marker": "uservice-a032va",
10 "maxKeys": 1,
11 "isTruncated": true,
12 "services": [
13 {
14 "serviceId': "uservice-a223vc",
15 "name": "name",
16 "description": "",
17 "serviceName": "serviceName",
18 "bindType": "blb",
19 "instanceId": "lb-d3e2cf75",
20 "status": "inService",
21 "service": "xxx.baidubce.com",
22 "createTime": "2019-03-07T02:35:31Z",
23 "endpointCount": 1,
24 "endpointList": [
25 {
26 "endpointId': "endpoint-a223vc",
27 "uid': "e8deba4d81d3435bb4591ce97288f296",
28 "attachTime': "2019-03-07T02:35:31Z",
29 }
30 ],
31 "authList": [
32 {
33 "uid": "*",
34 "auth" : "allow"
35 }
36 ]
37
38 }
39 ]
40} Query service distribution point details
Description
Query service distribution point details
Request structure
Plain Text
1 GET /v{version}/service/{service} HTTP/1.1
2 Host: blb.bj.baidubce.com
3 Authorization: authorization string Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| serviceId | String | Service distribution point ID |
| name | String | Service distribution point name |
| description | String | Description |
| serviceName | String | Service name |
| bindType | String | Bound service type. Currently, binding BLB instances is supported only. |
| instanceId | String | Bound instance ID |
| status | String | Distribution point status, with values of inService/available/unavailable/dead/free, representing, indicating it is in service/available/unavailable/faulty/unbound. |
| service | String | Unique corresponding domain name of the service distribution point |
| createTime | String | Creation time |
| endpointCount | int | Count of associated service network interface card |
| endpointList | List<[RelatedEndpoint](BLB/API Reference/Appendix.md#RelatedEndpoint)> | List of associated service network interface card |
| authList | List<[Auth](BLB/API Reference/Appendix.md#Auth)> | Authorization list |
Request example
Plain Text
1 GET /v1/service/xxx.baidubce.com HTTP/1.1
2 Host: blb.bj.baidubce.com
3 Authorization: authorization string Response example
Plain Text
1 HTTP/1.1 200 OK
2 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50
3 Date: Thu, 16 Mar 2017 06:29:48 GMT
4 Content Type: application/json;charset=UTF 8
5 Server: BWS
6
7{
8 "serviceId': "uservice-a223vc",
9 "name": "name",
10 "description": "",
11 "serviceName": "serviceName",
12 "bindType": "blb",
13 "instanceId": "lb-d3e2cf75",
14 "status": "inService",
15 "service": "xxx.baidubce.com",
16 "createTime": "2019-03-07T02:35:31Z",
17 "endpointCount": 1,
18 "endpointList": [
19 {
20 "endpointId': "endpoint-a223vc",
21 "uid': "e8deba4d81d3435bb4591ce97288f296",
22 "attachTime': "2019-03-07T02:35:31Z",
23 }
24 ],
25 "authList": [
26 {
27 "uid": "*",
28 "auth" : "allow"
29 }
30 ]
31} Delete service distribution point
Description
Delete service distribution point
Request structure
Plain Text
1DELETE /v{version}/service/{service}?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization stringRequest headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| clientToken | String | No | Query | Idempotence Token, an ASCII string with a length not exceeding 64 bits. |
| service | String | Yes | URL parameter | Domain name of the service distribution point |
Response headers
No special headers are required beyond the standard ones.
Response parameters No response parameters
Request example
Plain Text
1DELETE /v1/service/xxx.baidubce.com?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1deResponse example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS