## 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"
}
```
- 1. 概述
- 2. 快速安装
- 2.1 环境准备
- 2.2 开始安装
- 2.3 启动/关闭kongx
- 2.4 使用kongx
- 3. 使用指南
- 3.0 mockbin配置示例
- 3.0.1 不含upstream的配置
- 3.0.2 含upstream的配置
- 3.1 Gateway
- 3.1.1 Upstreams
- 3.1.1.1 新增/修改upstreams
- 3.1.1.2 管理targets
- 3.1.1.3 设置健康检查
- 3.1.1.4 upstream视图
- 3.1.2 Services
- 3.1.2.1 新建/修改service
- 3.1.2.2 添加服务路由
- 3.1.2.3 添加服务插件
- 3.1.2.4 同步services
- 3.1.2.5 services视图
- 3.1.3 Routes
- 3.1.3.1 路由列表
- 3.1.3.2 修改路由
- 3.1.3.3 批量修改HOSTS
- 3.1.4 Plugins
- 3.1.4.1 新增插件
- 3.1.4.2 插件列表
- 3.1.5 Consumers
- 3.1.5.1 新建/修改consumers
- 3.1.6 Kong Shell
- 3.1.6.1 shell安装
- 3.1.6.2 使用Shell
- 3.2 系统管理
- 3.2.1 用户管理
- 3.2.2 角色管理
- 3.2.3 用户组管理
- 3.2.4 菜单管理
- 3.3 参数管理
- 3.3.1 环境管理
- 3.3.2 系统参数
- 3.3.3 如何增加多个环境?
- 3.4 日志管理
- 3.4.1 操作日志
- 3.4.2 同步日志
- 3.5 工具箱
- 3.5.1 Kong Shell
- 3.5.2 切换工作台
- 3.6 网关流水线
- 3.6.1 Pipeline
- 4. 最佳实践
- 4.1 灰度插件canary使用
- 4.2 kong与consul集成
- 4.2.1 使用kong提供dns服务
- 4.2.2 使用dnsmasq提供dns服务
- 4.2.3 使用consul自主发现服务
- 4.3 kong健康检查
- 4.3.1 简介
- 4.3.2 健康检查(主动检查)
- 4.3.3 断路器(被动检查)
- 4.3.4 总结
- 4.4 认证插件之key-auth
- 4.5 认证插件之basic-auth
- 4.6 认证插件之oauth2-auth
- 4.7 认证插件之jwt
- 4.8 kong自定义access_log格式
- 4.8.1 前言
- 4.8.2 配置文本格式
- 4.8.3 配置JSON格式
- 4.9 kong的访问监控
- 4.9.1 解决方案
- 4.9.2 方案实施
- 4.9.3 接入grafana报表
- 5. 常见问题
- 5.1 默认账号及密码
- 5.2 新增用户默认密码为123456
- 5.3 如何设置超级管理员
- 5.4 密码忘记了咋办
- 6. Kong
- 6.1 Kong简介
- 6.2 kong安装指南
- 6.2.1 kong安装-RPM
- 6.2.2 kong安装-源码
- 6.2.3 kong基于yum源安装
- 6.3 Admin API
- 6.3.1 API支持两种内容类型
- 6.3.2 声明式配置(Declarative Configuration)
- 6.3.3 获取实体schema
- 6.3.4 services
- 6.3.5 Routes
- 6.3.6 Consumers
- 6.3.7 Plugins
- 6.3.8 Certficate
- 6.3.9 CA certficate(1.3.x+以上版本)
- 6.3.10 SNI
- 6.3.11 Upstreams
- 6.3.12 Targets
- 6.4 Kong使用
- 6.4.1 DB-LESS模式
- 6.4.2 DB模式