服务发布点相关接口

更新时间：2023-11-24

创建服务发布点

描述

创建服务发布点

请求结构

POST /v{version}/service?clientToken={clientToken} HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: authorization string
 {
    "name": name,
    "description": description,
    "serviceName": serviceName,
    "instanceId": instanceId,
    "authList": [
        {
            "uid": uid,  
            "auth" : auth
        }
    ]
 }

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
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	服务发布点的域名，使用此域名绑定服务网卡

请求示例

POST /v1/service?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "name": "name",
    "description": "",
    "serviceName": "serviceName",
    "instanceId": "lb-d3e2cf75",
    "authList": [
        {
            "uid": "*",
            "auth" : "allow"
        }          
    ]
 }

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

 {
    "service": "xxx.baidubce.com"
 }

更新服务发布点

描述

更新服务发布点，name、description不能同时为空

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "name":name,
    "description":description
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
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字符

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?modifyAttribute&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "name":"name",
    "description":"description"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

服务发布点绑定实例

描述

服务发布点绑定服务

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "instanceId":instanceId
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名
action	String	是	Query参数	执行动作，当前取值为bind
instanceId	String	是	Request Body参数	绑定实例id

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?bind&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "instanceId":"lb-95d3c305"
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

服务发布点解绑实例

描述

服务发布点解绑服务

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名
action	String	是	Query参数	执行动作，当前取值为unbind

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?unbind&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

新增服务发布点鉴权信息

描述

新增服务发布点鉴权信息，如果用户授权已存在则覆盖之前的授权信息

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "authList": [
        {
            "uid": uid,  
            "auth" : auth
        }
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名
action	String	是	Query参数	执行动作，当前取值为addAuth
authList	List<Auth>	是	Request Body参数	用户授权列表

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?addAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "authList": [
        {
            "uid": "e8deba4d81d3435bb4591ce97288f296",
            "auth" : "deny"
        }          
    ]
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

修改服务发布点鉴权信息

描述

修改服务发布点鉴权信息

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "authList": [
        {
            "uid": uid,  
            "auth" : auth
        }
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名
action	String	是	Query参数	执行动作，当前取值为editAuth
authList	List<Auth>	是	Request Body参数	用户授权列表

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?editAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "authList": [
        {
            "uid": "e8deba4d81d3435bb4591ce97288f296",
            "auth" : "deny"
        }          
    ]
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

删除服务发布点鉴权信息

描述

新增服务发布点鉴权信息

请求结构

PUT /v{version}/service/{service}?{action}&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: authorization string

{
    "uidList": [
        "uid"
    ]
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名
action	String	是	Query参数	执行动作，当前取值为removeAuth
uidList	List<String>	是	Request Body参数	用户id列表，所有人使用"*"

返回头域

除公共头域，无其它特殊头域。

返回参数

无返回参数

请求示例

PUT /v1/service/xxx.baidubce.com?removeAuth&clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
    "uidList": [
        "e8deba4d81d3435bb4591ce97288f296",
        "f8deba4d81d8908bb4591ce97288f212",
    ]
}

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

查询服务发布点列表

描述

查询服务发布点列表。

请求结构

GET /v{version}/service?maxKeys=1   HTTP/1.1   
Host: blb.bj.baidubce.com      
Authorization: authorization string

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
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>	服务发布点列表

请求示例

GET /v{version}/service?marker=uservice-a223vc&maxKeys=1 HTTP/1.1   
Host: blb.bj.baidubce.com     
ContentType: application/json     
Authorization: bce auth v1/f81d3b34e48048fbb2634dc7882d7e21/2017 03 11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

 HTTP/1.1 200 OK     
 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
 Date: Thu, 16 Mar 2017 06:29:48 GMT    
 Content Type: application/json;charset=UTF 8     
 Server: BWS  
  
{
    "nextMarker": "uservice-a223vc",
    "marker": "uservice-a032va",
    "maxKeys": 1,
    "isTruncated": true,
    "services": [
        {
            "serviceId': "uservice-a223vc",
            "name": "name",
            "description": "",
            "serviceName": "serviceName",
            "bindType": "blb",
            "instanceId": "lb-d3e2cf75",
            "status": "inService",
            "service": "xxx.baidubce.com",
            "createTime": "2019-03-07T02:35:31Z",
            "endpointCount": 1,
            "endpointList": [
                {
                    "endpointId': "endpoint-a223vc",
                    "uid': "e8deba4d81d3435bb4591ce97288f296",
                    "attachTime': "2019-03-07T02:35:31Z",
                }
            ],
            "authList": [
                {
                    "uid": "*",
                    "auth" : "allow"
                }
            ]
            
        }
        ]
}

查询服务发布点详情

描述

查询服务发布点详情

请求结构

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

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
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>	授权列表

请求示例

 GET /v1/service/xxx.baidubce.com HTTP/1.1
 Host: blb.bj.baidubce.com
 Authorization: authorization string

返回示例

 HTTP/1.1 200 OK     
 x-bce-request-id: 1214cca7 4ad5 451d 9215 71cb844c0a50     
 Date: Thu, 16 Mar 2017 06:29:48 GMT       
 Content Type: application/json;charset=UTF 8     
 Server: BWS     
      
{
    "serviceId': "uservice-a223vc",
    "name": "name",
    "description": "",
    "serviceName": "serviceName",
    "bindType": "blb",
    "instanceId": "lb-d3e2cf75",
    "status": "inService",
    "service": "xxx.baidubce.com",
    "createTime": "2019-03-07T02:35:31Z",
    "endpointCount": 1,
    "endpointList": [
        {
            "endpointId': "endpoint-a223vc",
            "uid': "e8deba4d81d3435bb4591ce97288f296",
            "attachTime': "2019-03-07T02:35:31Z",
        }
    ],
    "authList": [
        {
            "uid": "*",
            "auth" : "allow"
        }
    ]
}

删除服务发布点

描述

删除服务发布点

请求结构

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

请求头域

除公共头域外，无其它特殊头域。

请求参数

参数名称	类型	是否必需	参数位置	描述
version	String	是	URL参数	API版本号
clientToken	String	否	Query参数	幂等性Token，是一个长度不超过64位的ASCII字符串
service	String	是	URL参数	服务发布点的域名

返回头域

除公共头域，无其它特殊头域。

返回参数 无返回参数

请求示例

DELETE /v1/service/xxx.baidubce.com?clientToken=1849ef6b-f73c-4f5d-b88b-259ca47af849 HTTP/1.1
Host: blb.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

返回示例

HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Thu, 16 Mar 2017 06:29:48 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

负载均衡专属集群LBDC接口

附录

百度智能云

负载均衡 BLB

负载均衡 BLB

服务发布点相关接口

创建服务发布点

更新服务发布点

服务发布点绑定实例

服务发布点解绑实例

新增服务发布点鉴权信息

修改服务发布点鉴权信息

删除服务发布点鉴权信息

查询服务发布点列表

查询服务发布点详情

删除服务发布点