服务发布点相关接口
更新时间：2023-11-24
创建服务发布点
描述
创建服务发布点
请求结构
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 } 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| name | String | 是 | Request Body参数 | 服务发布点的名称，大小写字母、数字以及-_/.特殊字符，必须以字母开头，长度1-65 |
| description | String | 否 | Request Body参数 | 服务发布点的描述，最大支持200字符 |
| serviceName | String | 是 | Request Body参数 | 对应服务名称,大小写字母、数字长度1-65 |
| instanceId | String | 是 | Request Body参数 | 绑定实例id，当前只支持绑定blb |
| authList | List<Auth> | 否 | Request Body参数 | 用户授权列表，默认拒绝所有 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| service | String | 服务发布点的域名，使用此域名绑定服务网卡 |
请求示例
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 } 返回示例
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 } 更新服务发布点
描述
更新服务发布点，name、description不能同时为空
请求结构
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}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为modifyAttribute |
| name | String | 否 | RequestBody参数 | 服务发布点名称,大小写字母、数字以及-_/.特殊字符，必须以字母开头，长度1-65 |
| description | String | 否 | RequestBody参数 | 服务发布点描述，不超过200字符 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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}返回示例
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服务发布点绑定实例
描述
服务发布点绑定服务
请求结构
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}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为bind |
| instanceId | String | 是 | Request Body参数 | 绑定实例id |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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}返回示例
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服务发布点解绑实例
描述
服务发布点解绑服务
请求结构
Plain Text
1PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
2Host: blb.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为unbind |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
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 新增服务发布点鉴权信息
描述
新增服务发布点鉴权信息，如果用户授权已存在则覆盖之前的授权信息
请求结构
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}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为addAuth |
| authList | List<Auth> | 是 | Request Body参数 | 用户授权列表 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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}返回示例
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修改服务发布点鉴权信息
描述
修改服务发布点鉴权信息
请求结构
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}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为editAuth |
| authList | List<Auth> | 是 | Request Body参数 | 用户授权列表 |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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}返回示例
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删除服务发布点鉴权信息
描述
新增服务发布点鉴权信息
请求结构
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}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
| action | String | 是 | Query参数 | 执行动作，当前取值为removeAuth |
| uidList | List<String> | 是 | Request Body参数 | 用户id列表，所有人使用"*" |
返回头域
除公共头域，无其它特殊头域。
返回参数
无返回参数
请求示例
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}返回示例
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查询服务发布点列表
描述
查询服务发布点列表。
请求结构
Plain Text
1GET /v{version}/service?maxKeys=1 HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string
4 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | Integer | 否 | Query参数 | 每页包含的最大数量，最大数量通常不超过1000，缺省值为1000 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| marker | String | 标记查询的起始位置 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
| services | List<Service> | 服务发布点列表 |
请求示例
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
5 返回示例
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}
41 查询服务发布点详情
描述
查询服务发布点详情
请求结构
Plain Text
1 GET /v{version}/service/{service} HTTP/1.1
2 Host: blb.bj.baidubce.com
3 Authorization: authorization string
4 请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
返回头域
除公共头域，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| serviceId | String | 服务发布点的id |
| name | String | 服务发布点的名称 |
| description | String | 描述 |
| serviceName | String | 服务名称 |
| bindType | String | 绑定服务类型，目前仅支持绑定BLB实例 |
| instanceId | String | 绑定实例ID |
| status | String | 发布点状态，取值范围inService/available/unavailable/dead/free，分别表示：服务中/可用/不可用/故障/未绑定 |
| service | String | 服务发布点唯一对应域名 |
| createTime | String | 创建时间 |
| endpointCount | int | 关联的服务网卡数量 |
| endpointList | List<RelatedEndpoint> | 关联的服务网卡列表 |
| authList | List<Auth> | 授权列表 |
请求示例
Plain Text
1 GET /v1/service/xxx.baidubce.com HTTP/1.1
2 Host: blb.bj.baidubce.com
3 Authorization: authorization string
4 返回示例
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}
32
33 删除服务发布点
描述
删除服务发布点
请求结构
Plain Text
1DELETE /v{version}/service/{service}?clientToken={clientToken} HTTP/1.1
2Host: blb.bj.baidubce.com
3Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| clientToken | String | 否 | Query参数 | 幂等性Token，是一个长度不超过64位的ASCII字符串 |
| service | String | 是 | URL参数 | 服务发布点的域名 |
返回头域
除公共头域，无其它特殊头域。
返回参数 无返回参数
请求示例
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/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de返回示例
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