Spring Cloud Eureka Server REST接口

╰半夏微凉° 2022-10-15 10:00 36阅读 0赞

Eureka由Netflix公司实现并开源，Negflix Eureka的原始REST API接口可以参考：[https://github.com/Netflix/eureka/wiki/Eureka-REST-operations][https_github.com_Netflix_eureka_wiki_Eureka-REST-operations]

Spring Cloud集成Netflix Eureka之后，其对外提供的REST API与原始Neflix对外提供的API有一点点差别，即将请求路径中的\{version\}值去掉。

例如：

注册某个实例到eureka server：原始Netflix Eureka提供的接口为： /eureka/v2/apps/\{appID\}

Spring Cloud Eureka对外提供的接口为： /eureka/apps/\{appID\}

Spring Cloud Eureka Server Rest API如下：

<table> 
 <thead> 
  <tr> 
   <th>操作</th> 
   <th>Method</th> 
   <th>描述</th> 
   <th>Path</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>注册新的应用实例</td> 
   <td>Post</td> 
   <td>成功返回HTTP Code：204</td> 
   <td>/eureka/apps/{appId}</td> 
  </tr> 
  <tr> 
   <td>注销某个实例</td> 
   <td>DELETE</td> 
   <td>成功返回HTTP Code: 200</td> 
   <td>/eureka/apps/{appId}/{instanceId}</td> 
  </tr> 
  <tr> 
   <td>应用实例发送心跳</td> 
   <td>PUT</td> 
   <td>成功返回： 200 ，如果实例不存在返回：404</td> 
   <td>/eureka/apps/{appId}/{instanceId}</td> 
  </tr> 
  <tr> 
   <td>查询所有实例</td> 
   <td>GET</td> 
   <td>成功返回： 200</td> 
   <td>/eureka/apps</td> 
  </tr> 
  <tr> 
   <td>查询指定appId的实例</td> 
   <td>GET</td> 
   <td>成功返回：200</td> 
   <td>/eureka/apps/{appId}</td> 
  </tr> 
  <tr> 
   <td>查询某个appId和instanceId</td> 
   <td>GET</td> 
   <td>成功返回： 200</td> 
   <td>/eureka/apps/{appId}/{instanceId}</td> 
  </tr> 
  <tr> 
   <td>根据指定instanceId查询</td> 
   <td>GET</td> 
   <td>成功返回：200</td> 
   <td>/eureka/instanceId/{instanceId}</td> 
  </tr> 
  <tr> 
   <td>暂停应用实例</td> 
   <td>PUT</td> 
   <td>成功：200，失败：500</td> 
   <td>/eureka/apps/{appId}/{instanceId}/status?value=OUT_OF_SERVICE</td> 
  </tr> 
  <tr> 
   <td>恢复应用实例</td> 
   <td>DELETE</td> 
   <td>成功：200，失败：500</td> 
   <td>/eureka/apps/{appId}/{instanceId}/status?value=UP</td> 
  </tr> 
  <tr> 
   <td>更新元数据</td> 
   <td>PUT</td> 
   <td>成功：200，失败：500</td> 
   <td>/eureka/apps/{appId}/{instanceId}/metadata?key=value</td> 
  </tr> 
  <tr> 
   <td>根据vip地址查询</td> 
   <td>GET</td> 
   <td>成功：200，该vipAddress不存在则返回：404</td> 
   <td>/eureka/v2/vips/{vipAddress}</td> 
  </tr> 
  <tr> 
   <td>根据svip地址查询</td> 
   <td>GET</td> 
   <td>成功：200，不存在返回：404</td> 
   <td>/eureka/v2/vips/{svipAddress}</td> 
  </tr> 
 </tbody> 
</table>

以上接口中如果请求体需要参数，则需要设置请求头Content-Type的值为application/json 或者 application/xml

注册新的应用实例请求参数(参考示例)：

{
        "instance": {
            "instanceId": "test-instance-1",
            "hostName": "localhost",
            "app": "test",
            "ipAddr": "127.0.0.1",
            "status": "UP",
            "port": {
                "$": 28000,
                "@enabled": true
            },
            "dataCenterInfo": {
                "@class": "com.netflix.appinfo.InstanceInfo$DefaultDataCenterInfo",
                "name": "MyOwn"
            },
            "leaseInfo": {
                "renewalIntervalInSecs": 30,
                "durationInSecs": 90
            },
            "metadata": {
                "management.port": "28000"
            },
            "vipAddress": "test",
            "secureVipAddress": "test",
            "lastUpdatedTimestamp": "1621849488060",
            "lastDirtyTimestamp": "1621849488060"
        }
    }

[https_github.com_Netflix_eureka_wiki_Eureka-REST-operations]: https://github.com/Netflix/eureka/wiki/Eureka-REST-operations