[Eureka]REST操作接口清单

我就是我 2023-07-12 03:44 56阅读 0赞

**源码地址**：[https://github.com/Netflix/eureka/wiki][https_github.com_Netflix_eureka_wiki]

**数据来源**：[https://github.com/Netflix/eureka/wiki/Eureka-REST-operations][https_github.com_Netflix_eureka_wiki_Eureka-REST-operations]

Eureka作为Spring Cloud常用的注册中心，其开放了以下接口：

注：

接口仅支持xml/json两种数据格式，请求时需设定Context-Type为**application/xml** 或者 **application/json**

VIP（虚拟IP地址）默认为实例的应用名

### API文档 ###

<table> 
 <tbody> 
 <tr> 
 <td>操作类型</td> 
 <td>API</td> 
 <td>描述</td> 
 </tr> 
 <tr> 
 <td>注册新的应用程序实例</td> 
 <td>POST&nbsp;/eureka/v2/apps/appID</td> 
 <td> 请求内容:&nbsp;JSON/XML&nbsp; 成功【HTTP&nbsp;Code: 204 】 </td> 
 </tr> 
 <tr> 
 <td>注销应用程序实例</td> 
 <td>DELETE&nbsp;/eureka/v2/apps/appID/instanceID</td> 
 <td>HTTP&nbsp;Code: 200 on success</td> 
 </tr> 
 <tr> 
 <td>发送应用实例心跳</td> 
 <td>PUT&nbsp;/eureka/v2/apps/appID/instanceID</td> 
 <td> 成功【HTTP&nbsp;Code: 204 】 instanceID不存在【HTTP&nbsp;Code: 404 】 </td> 
 </tr> 
 <tr> 
 <td>查询所有实例</td> 
 <td>GET&nbsp;/eureka/v2/apps</td> 
 <td> 响应内容格式:&nbsp;JSON/XML&nbsp; 成功【HTTP&nbsp;Code: 200 】 </td> 
 </tr> 
 <tr> 
 <td>查询所有appID实例</td> 
 <td>GET&nbsp;/eureka/v2/apps/appID</td> 
 <td> 响应内容:&nbsp;JSON/XML&nbsp; 成功【HTTP&nbsp;Code: 200 】 </td> 
 </tr> 
 <tr> 
 <td>查询特定的appID&nbsp;/&nbsp;instanceID</td> 
 <td>GET&nbsp;/eureka/v2/apps/appID/instanceID</td> 
 <td> 响应内容:&nbsp;JSON/XML&nbsp; 成功【HTTP&nbsp;Code: 200 】 </td> 
 </tr> 
 <tr> 
 <td>查询特定的instanceID</td> 
 <td>GET&nbsp;/eureka/v2/instances/instanceID</td> 
 <td> 响应内容:&nbsp;JSON/XML&nbsp; 成功【HTTP&nbsp;Code: 200 】 </td> 
 </tr> 
 <tr> 
 <td>使实例停止服务</td> 
 <td>PUT&nbsp;/eureka/v2/apps/appID/instanceID/status?value=OUT_OF_SERVICE</td> 
 <td> 成功【HTTP&nbsp;Code: 200 】 失败【HTTP&nbsp;Code: 500 】 </td> 
 </tr> 
 <tr> 
 <td>将实例移回服务中（删除替代）</td> 
 <td>DELETE&nbsp;/eureka/v2/apps/appID/instanceID/status?value=UP (UP:可选)</td> 
 <td> 成功【HTTP&nbsp;Code: 200 】 失败【HTTP&nbsp;Code: 500 】 </td> 
 </tr> 
 <tr> 
 <td>更新元数据</td> 
 <td>PUT&nbsp;/eureka/v2/apps/appID/instanceID/metadata?key=value</td> 
 <td> 成功【HTTP&nbsp;Code: 200 】 失败【HTTP&nbsp;Code: 500 】 </td> 
 </tr> 
 <tr> 
 <td>查询特定VIP下的所有实例</td> 
 <td>GET&nbsp;/eureka/v2/vips/vipAddress</td> 
 <td> 成功【HTTP&nbsp;Code: 204 ，响应内容格式：JSON/XML&nbsp;】 vipAddress不存【HTTP&nbsp;Code: 404 】 </td> 
 </tr> 
 <tr> 
 <td>查询特定SVIP下的所有实例</td> 
 <td>GET&nbsp;/eureka/v2/svips/svipAddress</td> 
 <td> 成功【HTTP&nbsp;Code: 204 ，响应内容格式：JSON/XML&nbsp;】 svipAddress不存【HTTP&nbsp;Code: 404 】 </td> 
 </tr> 
 </tbody> 
</table>

### 以下为实际请求内容实例： ###

context-path: /eureka

### GET /eureka/v2/apps ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 1][]

Accept:application/json 时响应json数据

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 2][]

### PUT /eureka/v2/apps/**appID**/**instanceID**/status?value=OUT\_OF\_SERVICE ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 3][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 4][]

**补充一个常见的手动服务下线接口**

**DELETE**  /eureka/v2/apps/appID/instanceID/status?value=UP(UP:可选)

请求地址示例：http://localhost:8080/eureka***/eureka/apps/APOLLO-ADMINSERVICE/bogon:apollo-adminservice:8090***

使用**HTTP.Method=Delete** 方式请求后，**APOLLO-ADMINSERVICE**服务***bogon:apollo-adminservice:8090实例***下线，从eureka的服务实例列表中摘除。

[https_github.com_Netflix_eureka_wiki]: https://github.com/Netflix/eureka/wiki
[https_github.com_Netflix_eureka_wiki_Eureka-REST-operations]: https://github.com/Netflix/eureka/wiki/Eureka-REST-operations
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200306195409725.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200306195441447.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200306195746495.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200306200342978.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200306201833997.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L21hc3RlcjMzNg==,size_16,color_FFFFFF,t_70