Service API详解
1. 添加服务
请求地址:/service/
请求方法:POST
请求主体:
2. 列出service列表
请求地址:/service/
请求方法:GET
3. 查找service
按条件查找service
请求地址:/services/{name or id}
请求方法:GET
属性 | 描述 |
---|---|
name or id (必填) |
要检索的服务的唯一标识符或名称。 |
查找与指定route关联的service
请求地址:/routes/{route name or id}/service
请求方法:GET
属性 | 描述 |
---|---|
route name or id (必填) |
与要检索的服务关联的唯一标识符或路由的名称。 |
查找与指定Plugin
关联的service
请求地址:/services/{name or id}
请求方法:GET
属性 | 描述 |
---|---|
plugin id required (必填) |
与要检索的服务关联的插件的唯一标识符。 |
4. 更新service
更新service
请求地址:/services/{name or id}
请求方法:PATCH
属性 | 描述 |
---|---|
name or id (必填) |
要更新的服务的唯一标识符或名称。 |
更新与特定路由关联的服务
请求地址:/routes/{route name or id}/service
请求方法:PATCH
属性 | 描述 |
---|---|
route name or id (必填) |
与要更新的服务关联的唯一标识符或路由名称。 |
更新与特定插件关联的服务
请求地址:/plugins/{plugin id}/service
请求方法:PATCH
属性 | 描述 |
---|---|
plugin id (必填) |
与要检索的服务关联的插件的唯一标识符。 |
请求主体
5. 更新或创建service
Create Or Update Service
请求地址:/services/{name or id}
请求方法:PUT
属性 | 描述 |
---|---|
name or id (必填) |
要创建或更新的服务的唯一标识符或名称。 |
创建或更新与特定route关联的服务
请求地址:/routes/{route name or id}/service
请求方法:PUT
属性 | 描述 |
---|---|
route name or id (必填) |
与要创建或更新的服务关联的唯一标识符或路由名称。 |
创建或更新与特定插件关联的服务
请求地址:/plugins/{plugin id}/service
请求方法:PUT
属性 | 描述 |
---|---|
plugin id (必填) |
与要创建或更新的服务关联的插件的唯一标识符。 |
请求主体
使用主体中指定的定义在请求的资源下插入(或替换)服务。服务将通过name or id
属性进行标识。
当name or id
属性具有UUID的结构时,将通过其标识要插入/替换的Service id
。否则将通过标识name
。
当创建新服务而未指定id
时(无论是在URL中还是在正文中),它将自动生成。
注意,不允许在URL中指定一个名称,而在请求体中指定另一个名称。
6. 删除服务
删除服务
请求地址:/services/{name or id}
请求方法:DELETE
属性 | 描述 |
---|---|
name or id (必填) |
要删除的服务的唯一标识符或名称。 |
删除与特定路由关联的服务
请求地址:/routes/{route name or id}/service
请求方法:DELETE
属性 | 描述 |
---|---|
route name or id (必填) |
唯一标识符或路径相关联的服务的名称被删除。 |
KONG 的其他对象
由于整理起来很费时间且意义不大,留下了一些LINK备用。
核心对象:
service对象
route对象
upstream对象
target(目标主机)
其他相关对象: