源码地址:https://github.com/Netflix/eureka/wiki
数据来源:https://github.com/Netflix/eureka/wiki/Eureka-REST-operations
Eureka作为Spring Cloud常用的注册中心,其开放了以下接口:
注:
接口仅支持xml/json两种数据格式,请求时需设定Context-Type为application/xml 或者 application/json
VIP(虚拟IP地址)默认为实例的应用名
API文档
| 操作类型 | API | 描述 |
| 注册新的应用程序实例 | POST /eureka/v2/apps/appID |
请求内容: JSON/XML 成功【HTTP Code: 204 】 |
| 注销应用程序实例 | DELETE /eureka/v2/apps/appID/instanceID | HTTP Code: 200 on success |
| 发送应用实例心跳 | PUT /eureka/v2/apps/appID/instanceID |
成功【HTTP Code: 204 】 instanceID不存在【HTTP Code: 404 】 |
| 查询所有实例 | GET /eureka/v2/apps |
响应内容格式: JSON/XML 成功【HTTP Code: 200 】 |
| 查询所有appID实例 | GET /eureka/v2/apps/appID |
响应内容: JSON/XML 成功【HTTP Code: 200 】 |
| 查询特定的appID / instanceID | GET /eureka/v2/apps/appID/instanceID |
响应内容: JSON/XML 成功【HTTP Code: 200 】 |
| 查询特定的instanceID | GET /eureka/v2/instances/instanceID |
响应内容: JSON/XML 成功【HTTP Code: 200 】 |
| 使实例停止服务 | PUT /eureka/v2/apps/appID/instanceID/status?value=OUT_OF_SERVICE |
成功【HTTP Code: 200 】 失败【HTTP Code: 500 】 |
| 将实例移回服务中(删除替代) | DELETE /eureka/v2/apps/appID/instanceID/status?value=UP (UP:可选) |
成功【HTTP Code: 200 】 失败【HTTP Code: 500 】 |
| 更新元数据 | PUT /eureka/v2/apps/appID/instanceID/metadata?key=value |
成功【HTTP Code: 200 】 失败【HTTP Code: 500 】 |
| 查询特定VIP下的所有实例 | GET /eureka/v2/vips/vipAddress |
成功【HTTP Code: 204 ,响应内容格式:JSON/XML 】 vipAddress不存【HTTP Code: 404 】 |
| 查询特定SVIP下的所有实例 | GET /eureka/v2/svips/svipAddress |
成功【HTTP Code: 204 ,响应内容格式:JSON/XML 】 svipAddress不存【HTTP Code: 404 】 |
以下为实际请求内容实例:
context-path: /eureka
GET /eureka/v2/apps
Accept:application/json 时响应json数据
PUT /eureka/v2/apps/appID/instanceID/status?value=OUT_OF_SERVICE