三、注册中心API服务(RESTFUL 格式)

服务注册中心为支持服务注册与发现功能,提供的 RESTFUL 格式API接口如下:

3.1、服务注册 & 续约 API

说明:新服务注册上线1s内广播通知接入方;需要接入方循环续约,否则服务将会过期(三倍于注册中心心跳时间)下线;

  1. 地址格式:{服务注册中心跟地址}/registry
  2. 请求参数说明:
  3. 1accessToken:请求令牌;
  4. 2biz:业务标识
  5. 2env:环境标识
  6. 3registryDataList:服务注册信息
  7. 请求数据格式如下,放置在 RequestBody 中,JSON格式:
  8. {
  9. "accessToken" : "xx",
  10. "biz" : "xx",
  11. "env" : "xx",
  12. "registryDataList" : [{
  13. "key" : "service01",
  14. "value" : "address01"
  15. }]
  16. }

3.2、服务摘除 API

说明:新服务摘除下线1s内广播通知接入方;

  1. 地址格式:{服务注册中心跟地址}/remove
  2. 请求参数说明:
  3. 1accessToken:请求令牌;
  4. 2biz:业务标识
  5. 2env:环境标识
  6. 3registryDataList:服务注册信息
  7. 请求数据格式如下,放置在 RequestBody 中,JSON格式:
  8. {
  9. "accessToken" : "xx",
  10. "biz" : "xx",
  11. "env" : "xx",
  12. "registryDataList" : [{
  13. "key" : "service01",
  14. "value" : "address01"
  15. }]
  16. }

3.3、服务发现 API

说明:查询在线服务地址列表;

  1. 地址格式:{服务注册中心跟地址}/discovery
  2. 请求参数说明:
  3. 1accessToken:请求令牌;
  4. 2biz:业务标识
  5. 2env:环境标识
  6. 3keys:服务注册Key列表
  7. 请求数据格式如下,放置在 RequestBody 中,JSON格式:
  8. {
  9. "accessToken" : "xx",
  10. "biz" : "xx",
  11. "env" : "xx",
  12. "keys" : [
  13. "service01",
  14. "service02"
  15. ]
  16. }

3.4、服务监控 API

说明:long-polling 接口,主动阻塞一段时间(三倍于注册中心心跳时间);直至阻塞超时或服务注册信息变动时响应;

  1. 地址格式:{服务注册中心跟地址}/monitor
  2. 请求参数说明:
  3. 1accessToken:请求令牌;
  4. 2biz:业务标识
  5. 2env:环境标识
  6. 3keys:服务注册Key列表
  7. 请求数据格式如下,放置在 RequestBody 中,JSON格式:
  8. {
  9. "accessToken" : "xx",
  10. "biz" : "xx",
  11. "env" : "xx",
  12. "keys" : [
  13. "service01",
  14. "service02"
  15. ]
  16. }