## 6\. Consumers
*地址*:/consumers
*說明*:Consumer 是某類服務的消費者,需與用戶認證體系配合才能使用。
### 6.1 請求方法
| 序號 | NAME | 請求URI | 請求body | 說明 |
| --- | --- | --- | --- | --- |
| 1 | POST | /consumers | {...} | 新增consumers |
| 2 | GET | /consumers | | 查詢consumers列表 |
| 3 | GET | /consumers/{username or id} | | 獲取consumers信息 |
| 4 | GET | /plugins/{plugin id}/consumer | | 同上 |
| 5 | PATCH | /consumers/{username or id} | {...} | 更新consumers信息 |
| 6 | PATCH | /plugins/{plugin id}/consumer | {...} | 同上 |
| 7 | PUT | /consumers/{username or id} | {...} | 新增/更新consumers |
| 8 | PUT | /plugins/{plugin id}/consumer | {...} | 同上 |
| 9 | DELETE | /consumers/{username or id} | | 刪除consumers |
### 6.2 body 請求參數
| 序號 | 參數名 | 可選 | 默認值 | 說明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| 1 | username | 半選 | | 用戶名,必須唯一,username和custom\_id兩者必須填寫一項 | zhangshan |
| 2 | custom\_id | 半選 | | 唯一標識,必須保證唯一,username和custom\_id兩者必須填寫一項 | |
| 3 | tags | 可選 | | | |
### 6.3 數據樣例
body 請求參數
```
{
"id": "ec1a1f6f-2aa4-4e58-93ff-b56368f19b27",
"created_at": 1422386534,
"username": "my-username",
"custom_id": "my-custom-id",
"tags": ["user-level", "low-priority"]
}
```
consumers列表
```
{
"data": [{
"id": "a4407883-c166-43fd-80ca-3ca035b0cdb7",
"created_at": 1422386534,
"username": "my-username",
"custom_id": "my-custom-id",
"tags": ["user-level", "low-priority"]
}, {
"id": "01c23299-839c-49a5-a6d5-8864c09184af",
"created_at": 1422386534,
"username": "my-username",
"custom_id": "my-custom-id",
"tags": ["admin", "high-priority", "critical"]
}],
"next": "http://localhost:8001/consumers?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模式