全部产品
云市场

服务注册

更新时间:2019-09-20 20:47:33

查询服务信息

功能描述

查询服务元数据,支持分页查询。

接口定义

接口
/sofa/ms/services
Method
GET
参数
字段
类型
必填
描述
instance_id
String
Y
租户
app_name
String
Y
应用名字
page_num
Integer
Y
当前页数
page_size
Integer
Y
每页显示条数
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
services
List<ServiceRecord>
Y
对应的查询结果
page_num
Integer
Y
当前页数
page_size
Integer
Y
每页显示条数
total_count
Integer
Y
总条数

请求示例

  1. GET /sofa/ms/services?
  2. instance_id=abcd1234
  3. &app_name=xxx
  4. &page_num=1
  5. &page_size=10

响应示例

请求成功响应数据示例:

  1. {
  2. "services":
  3. "[
  4. {
  5. "data_id": "com.alipay.antcloud.drmdata.facade.DrmDataClusterFacade:1.0@DEFAULT"
  6. }
  7. ]",
  8. "page_num": 1,
  9. "page_size": 10,
  10. "total_count": 29,
  11. "req_msg_id":"1234abcd",
  12. "result_code":"OK",
  13. "result_msg":"Success",
  14. }

请求失败响应数据示例:

  1. {
  2. "result_code":"API_NOT_EXISTS", // API 不存在
  3. "result_msg":"the API (method=sofa.ms.service) does not exist",
  4. "req_msg_id":"1234abcd"
  5. }

查询服务提供者信息

功能描述

查询服务提供者动态数据,支持分页查询。服务提供者会根据客户端状态动态上下线。

接口定义

接口
/sofa/ms/services/publishers
Method
GET
参数
字段
类型
必填
描述
instance_id
String​
​Y
租户
data_id
​String
​Y
dataId
page_num
Integer
​Y
当前页数
page_size
Integer
​Y
每页显示条数
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
publishers
List<ServicePublisher>
Y
发布者列表
page_num
Integer
Y
当前页数
page_size
Integer
Y
每页显示条数
total_count
Integer
Y
总条数

请求示例

  1. GET /sofa/ms/services/publishers?
  2. instance_id=abcd1234
  3. &data_id=xxx
  4. &page_num=1
  5. &page_size=10

响应示例

请求成功响应数据示例:

  1. {
  2. "publishers":
  3. "[
  4. {
  5. "app_name": "drmdata",
  6. "data_id": "com.alipay.antcloud.drmdata.facade.DrmDataClusterFacade:1.0@DEFAULT",
  7. "host_ip": "11.165.199.49",
  8. "instance_id": "000001",
  9. "serviceIp": "11.165.199.49",
  10. "servicePort": 12200,
  11. "weight": 100,
  12. "zone": "DEFAULT_ZONE"
  13. }
  14. ]",
  15. "page_num": 1,
  16. "page_size": 10,
  17. "total_count": 29,
  18. "req_msg_id":"1234abcd",
  19. "result_code":"OK",
  20. "result_msg":"Success",
  21. }

请求失败响应数据示例:

  1. {
  2. "result_code":"API_NOT_EXISTS", // API 不存在
  3. "result_msg":"the API (method=sofa.ms.service.publisher) does not exist",
  4. "req_msg_id":"1234abcd"
  5. }

查询服务消费者信息

功能描述

查询服务消费者动态数据,支持分页查询。服务提供者会根据客户端状态动态上下线。

接口定义

接口
/sofa/ms/services/subscribers
Method
GET
参数
字段
类型
必填
描述
instance_id
String​
​Y
租户
data_id
​String
​Y
dataId
page_num
Integer
​Y
当前页数
page_size
Integer
​Y
每页显示条数
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪ID
subscribers
List<ServiceSubscriber>
订阅者列表

请求示例

  1. GET /sofa/ms/services/subscribers?
  2. instance_id=abcd1234
  3. &data_id=xxx
  4. &page_num=1
  5. &page_size=10

响应示例

请求成功响应数据示例:

  1. {
  2. "subscribers":
  3. "[
  4. {
  5. "appName": "dsrconsole",
  6. "dataId": "com.alipay.antcloud.drmdata.facade.DrmDataClusterFacade:1.0@DEFAULT",
  7. "hostIp": "11.165.199.26",
  8. "instanceId": "000001",
  9. "scope": "zone",
  10. "zone": "DEFAULT_ZONE"
  11. },
  12. ]",
  13. "page_num": 1,
  14. "page_size": 10,
  15. "total_count": 29,
  16. "req_msg_id":"1234abcd",
  17. "result_code":"OK",
  18. "result_msg":"Success",
  19. }

请求失败响应数据示例:

  1. {
  2. "result_code":"API_NOT_EXISTS", // API 不存在
  3. "result_msg":"the API (method=sofa.ms.service.subscriber) does not exist",
  4. "req_msg_id":"1234abcd"
  5. }

下线指定客户端提供的所有服务

功能描述

下线指定客户端提供的所有服务,主要用于发布平台切流发布。

接口定义

接口
/sofa/ms/services/client
Method
POST
type
json
参数
字段
类型
必须
描述
instance_id
String
Y
租户
example:
abcdEFGH1234
server_ips
String
Y
服务IP 列表
example:
11.165.199.169, 11.165.199.170
operation_type
String
操作类型如 logout

请求示例

  1. POST /sofa/ms/services/client
  2. {
  3. "instance_id": "abcd1234",
  4. "server_ips": ["1.1.1.1", "2.2.2.2"],
  5. "operation_type":"logout"
  6. }

响应示例

请求成功响应数据示例:

  1. {
  2. "result_code":"OK", // 请求成功
  3. "result_msg":"Service logout success",
  4. "req_msg_id":"1234abcd"
  5. }

请求失败响应数据示例:

  1. {
  2. "result_code":"API_NOT_EXISTS", // API 不存在
  3. "result_msg":"the API (method=sofa.ms.service.logout) does not exist",
  4. "req_msg_id":"1234abcd"
  5. }