## 4\. services *地址*：/services/{id} *說明*：Service 是某類 API 的抽象（也可以理解為一組 Route 的抽象）。它通常與上游服務抽象是一一對應的，Route 與 Service 之間，通常是 N:1 的關系。 ### 4.1 請求方法 | 序號 | NAME | 請求URI | 請求body | 說明 | | --- | --- | --- | --- | --- | | 1 | POST | /services | {...} | 新增services | | 2 | POST | /certificates/{certificate name or id}/services | {...} | 基于certificates新增services | | 3 | GET | /services | | 獲取services列表 | | 4 | GET | /certificates/{certificate name or id}/services | | 獲取services列表 | | 5 | GET | /services/{name or id} | | 根據name或ID獲取service信息 | | 6 | GET | /routes/{route name or id}/service | | 根據路由name或id，獲取servcie信息 | | 7 | GET | /plugins/{plugin id}/service | | 根據插件id，獲取service信息 | | 8 | PATCH | /services/{name or id} | {...} | 更新service信息 | | 9 | PATCH | /routes/{route name or id}/service | {...} | 更新service信息 | | 10 | PATCH | /plugins/{plugin id}/service | {...} | 更新servie信息 | | 11 | PUT | /services/{name or id} | {...} | 新建/更新service信息 | | 12 | PUT | /routes/{route name or id}/service | {...} | 新建/更新service | | 13 | PUT | /plugins/{plugin id}/service | {...} | 新建/更新service | | 14 | DELETE | /services/{name or id} | 服務name或ID | 刪除service | | 15 | DELETE | /routes/{route name or id}/service | 路由名稱或ID | 刪除service | ### 4.2 body 請求參數 | 序號 | 參數名 | 可選 | 默認值 | 說明 | 示例 | | --- | --- | --- | --- | --- | --- | | 1 | name | 可選 | | 標識服務名稱 | examples.v1.service | | 2 | retries | 可選 | 5 | 重試次數 | 5 | | 3 | protocol | 必選 | http | 請求協議,http,https | http | | 4 | host | 必選 | | 上游服務upstream，或者host | examples.v1.upstream 或192.168.66.1 | | 5 | port | 必選 | 80 | 上游服務端口號 | 默認值為80 | | 6 | path | 可選 | | | | | 7 | connect\_timeout | 可選 | 60000 | 連接超時，默認為60s | 60000 | | 8 | write\_timeout | 可選 | 60000 | 向上游服務器傳輸請求的兩個連續寫入操作之間的超時時長 | 60000 | | 9 | read\_timeout | 可選 | 60000 | 向上游服務器傳輸請求的兩個連續讀取操作之間的超時（毫秒 | 60000 | | 10 | tags | 可選 | | 標簽，用于分組或過濾 | | | 11 | client\_certificate | 可選 | | 參考：client\_certificate，1.3.x+版本 | | | 12 | url | 可選 | | 用于同時設置protocol,host,port 和path 的速記屬性 | [http://localhost:8090/example](http://localhost:8090/example) | ### 4.3 數據樣例 body 請求參數 ``` { "id": "9748f662-7711-4a90-8186-dc02f10eb0f5", "created_at": 1422386534, "updated_at": 1422386534, "name": "my-service", "retries": 5, "protocol": "http", "host": "example.com", "port": 80, "path": "/some_api", "connect_timeout": 60000, "write_timeout": 60000, "read_timeout": 60000, "tags": ["user-level", "low-priority"], "client_certificate": {"id":"4e3ad2e4-0bc4-4638-8e34-c84a417ba39b"} } ``` 服務列表 ``` { "data": [{ "id": "a5fb8d9b-a99d-40e9-9d35-72d42a62d83a", "created_at": 1422386534, "updated_at": 1422386534, "name": "my-service", "retries": 5, "protocol": "http", "host": "example.com", "port": 80, "path": "/some_api", "connect_timeout": 60000, "write_timeout": 60000, "read_timeout": 60000, "tags": ["user-level", "low-priority"], "client_certificate": {"id":"51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515"} }, { "id": "fc73f2af-890d-4f9b-8363-af8945001f7f", "created_at": 1422386534, "updated_at": 1422386534, "name": "my-service", "retries": 5, "protocol": "http", "host": "example.com", "port": 80, "path": "/another_api", "connect_timeout": 60000, "write_timeout": 60000, "read_timeout": 60000, "tags": ["admin", "high-priority", "critical"], "client_certificate": {"id":"4506673d-c825-444c-a25b-602e3c2ec16e"} }], "next": "http://localhost:8001/services?offset=6378122c-a0a1-438d-a5c6-efabae9fb969" } ```