Version: 2.11

Admin API

目录

Description

Admin API 是为 Apache APISIX 服务的一组 API,我们可以将参数传递给 Admin API 以控制 APISIX 节点。更好地了解其工作原理,请参阅 architecture-design 中的文档。

启动 Apache APISIX 时,默认情况下 Admin API 将监听 9080 端口(HTTPS 的 9443 端口)。您可以通过修改 conf/config.yaml 文件来改变默认监听的端口。

在下面出现的 X-API-KEY 指的是 conf/config.yaml 文件中的 apisix.admin_key.key,它是 Admin API 的访问 token。

Route

地址:/apisix/admin/routes/{id}?ttl=0

说明:Route 字面意思就是路由,通过定义一些规则来匹配客户端的请求,然后根据匹配结果加载并执行相应的 插件,并把请求转发给到指定 Upstream。

注意:在启用 Admin API 时,它会占用前缀为 /apisix/admin 的 API。因此,为了避免您设计 API 与 /apisix/admin 冲突,建议为 Admin API 使用其他端口,您可以在 conf/config.yaml 中通过 port_admin 进行自定义 Admin API 端口。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/routes获取资源列表
GET/apisix/admin/routes/{id}获取资源
PUT/apisix/admin/routes/{id}{…}根据 id 创建资源
POST/apisix/admin/routes{…}创建资源,id 由后台服务自动生成
DELETE/apisix/admin/routes/{id}删除资源
PATCH/apisix/admin/routes/{id}{…}标准 PATCH ,修改已有 Route 的部分属性,其他不涉及的属性会原样保留;如果你要删除某个属性,将该属性的值设置为 null 即可删除;特别地,当需要修改属性的值为数组时,该属性将全量更新
PATCH/apisix/admin/routes/{id}/{path}{…}SubPath PATCH,通过 {path} 指定 Route 要更新的属性,全量更新该属性的数据,其他不涉及的属性会原样保留。两种 PATCH 的区别可以参考后面的示例

URL 请求参数

名字可选项类型说明示例
ttl可选辅助超过这个时间会被自动删除,单位:秒ttl=1

body 请求参数

名字可选项类型说明示例
uri必选,不能与 uris 一起使用匹配规则除了如 /foo/bar/foo/gloo 这种全量匹配外,使用不同 Router 还允许更高级匹配,更多见 Router“/hello”
uris必选,不能与 uri 一起使用匹配规则非空数组形式,可以匹配多个 uri[“/hello”, “/world”]
plugins可选Plugin详见 Plugin
script可选Script详见 Script
upstream可选Upstream启用的 Upstream 配置,详见 Upstream
upstream_id可选Upstream启用的 upstream id,详见 Upstream
service_id可选Service绑定的 Service 配置,详见 Service
plugin_config_id可选,无法跟 script 一起配置Plugin绑定的 Plugin config 配置,详见 Plugin config
name可选辅助标识路由名称route-xxxx
desc可选辅助标识描述、使用场景等。路由 xxxx
host可选,不能与 hosts 一起使用匹配规则当前请求域名,比如 foo.com;也支持泛域名,比如 .foo.com“foo.com”
hosts可选,不能与 host 一起使用匹配规则非空列表形态的 host,表示允许有多个不同 host,匹配其中任意一个即可。[“foo.com”, “.bar.com”]
remote_addr可选,不能与 remote_addrs 一起使用匹配规则客户端请求 IP 地址: 192.168.1.101192.168.1.102 以及 CIDR 格式的支持 192.168.1.0/24。特别的,APISIX 也完整支持 IPv6 地址匹配:::1fe80::1, fe80::1/64 等。“192.168.1.0/24”
remote_addrs可选,不能与 remote_addr 一起使用匹配规则非空列表形态的 remote_addr,表示允许有多个不同 IP 地址,符合其中任意一个即可。[“127.0.0.1”, “192.0.0.0/8”, “::1”]
methods可选匹配规则如果为空或没有该选项,代表没有任何 method 限制,也可以是一个或多个的组合:GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONSCONNECTTRACE[“GET”, “POST”]
priority可选匹配规则如果不同路由包含相同 uri,根据属性 priority 确定哪个 route 被优先匹配,值越大优先级越高,默认值为 0。priority = 10
vars可选匹配规则由一个或多个[var, operator, val]元素组成的列表,类似这样:[[var, operator, val], [var, operator, val], …]]。例如:[“arg_name”, “==”, “json”],表示当前请求参数 namejson。这里的 var 与 Nginx 内部自身变量命名是保持一致,所以也可以使用 request_urihost 等。更多细节请参考lua-resty-expr[[“arg_name”, “==”, “json”], [“arg_age”, “>”, 18]]
filter_func可选匹配规则用户自定义的过滤函数。可以使用它来实现特殊场景的匹配要求实现。该函数默认接受一个名为 vars 的输入参数,可以用它来获取 Nginx 变量。function(vars) return vars[“arg_name”] == “json” end
labels可选匹配规则标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
timeout可选辅助为 route 设置 upstream 的连接、发送消息、接收消息的超时时间。这个配置将会覆盖在 upstream 中 配置的 timeout 选项{“connect”: 3, “send”: 3, “read”: 3}
enable_websocket可选辅助是否启用 websocket(boolean), 缺省 false.
status可选辅助是否启用此路由, 缺省 11 表示启用,0 表示禁用
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670

有两点需要特别注意:

  • 对于同一类参数比如 uriurisupstreamupstream_idhosthostsremote_addrremote_addrs 等,是不能同时存在,二者只能选择其一。如果同时启用,接口会报错。
  • vars 中,当获取 cookie 的值时,cookie name 是区分大小写字母的。例如:var 等于 “cookie_x_foo” 与 var 等于 “cookie_X_Foo” 表示不同的 cookie

route 对象 json 配置内容:

  1. {
  2. "id": "1", # id,非必填
  3. "uris": ["/a","/b"], # 一组 URL 路径
  4. "methods": ["GET","POST"], # 可以填多个方法
  5. "hosts": ["a.com","b.com"], # 一组 host 域名
  6. "plugins": {}, # 指定 route 绑定的插件
  7. "priority": 0, # apisix 支持多种匹配方式,可能会在一次匹配中同时匹配到多条路由,此时优先级高的优先匹配中
  8. "name": "路由xxx",
  9. "desc": "hello world",
  10. "remote_addrs": ["127.0.0.1"], # 一组客户端请求 IP 地址
  11. "vars": [["http_user", "==", "ios"]], # 由一个或多个 [var, operator, val] 元素组成的列表
  12. "upstream_id": "1", # upstream 对象在 etcd 中的 id ,建议使用此值
  13. "upstream": {}, # upstream 信息对象,建议尽量不要使用
  14. "timeout": { # 为 route 设置 upstream 的连接、发送消息、接收消息的超时时间。
  15. "connect": 3,
  16. "send": 3,
  17. "read": 3
  18. },
  19. "filter_func": "", # 用户自定义的过滤函数,非必填
  20. }

具体示例:

  1. # 创建一个路由
  2. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  3. {
  4. "uri": "/index.html",
  5. "hosts": ["foo.com", "*.bar.com"],
  6. "remote_addrs": ["127.0.0.0/8"],
  7. "methods": ["PUT", "GET"],
  8. "enable_websocket": true,
  9. "upstream": {
  10. "type": "roundrobin",
  11. "nodes": {
  12. "39.97.63.215:80": 1
  13. }
  14. }
  15. }'
  16. HTTP/1.1 201 Created
  17. Date: Sat, 31 Aug 2019 01:17:15 GMT
  18. ...
  19. # 创建一个有效期为 60 秒的路由,过期后自动删除
  20. $ curl http://127.0.0.1:9080/apisix/admin/routes/2?ttl=60 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  21. {
  22. "uri": "/aa/index.html",
  23. "upstream": {
  24. "type": "roundrobin",
  25. "nodes": {
  26. "39.97.63.215:80": 1
  27. }
  28. }
  29. }'
  30. HTTP/1.1 201 Created
  31. Date: Sat, 31 Aug 2019 01:17:15 GMT
  32. ...
  33. # 给路由增加一个 upstream node
  34. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  35. {
  36. "upstream": {
  37. "nodes": {
  38. "39.97.63.216:80": 1
  39. }
  40. }
  41. }'
  42. HTTP/1.1 200 OK
  43. ...
  44. 执行成功后,upstream nodes 将更新为:
  45. {
  46. "39.97.63.215:80": 1,
  47. "39.97.63.216:80": 1
  48. }
  49. # 给路由更新一个 upstream node 的权重
  50. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  51. {
  52. "upstream": {
  53. "nodes": {
  54. "39.97.63.216:80": 10
  55. }
  56. }
  57. }'
  58. HTTP/1.1 200 OK
  59. ...
  60. 执行成功后,upstream nodes 将更新为:
  61. {
  62. "39.97.63.215:80": 1,
  63. "39.97.63.216:80": 10
  64. }
  65. # 给路由删除一个 upstream node
  66. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  67. {
  68. "upstream": {
  69. "nodes": {
  70. "39.97.63.215:80": null
  71. }
  72. }
  73. }'
  74. HTTP/1.1 200 OK
  75. ...
  76. 执行成功后,upstream nodes 将更新为:
  77. {
  78. "39.97.63.216:80": 10
  79. }
  80. # 替换路由的 methods -- 数组
  81. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '{
  82. "methods": ["GET", "POST"]
  83. }'
  84. HTTP/1.1 200 OK
  85. ...
  86. 执行成功后,methods 将不保留原来的数据,整个更新为:
  87. ["GET", "POST"]
  88. # 替换路由的 upstream nodes -- sub path
  89. $ curl http://127.0.0.1:9080/apisix/admin/routes/1/upstream/nodes -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  90. {
  91. "39.97.63.200:80": 1
  92. }'
  93. HTTP/1.1 200 OK
  94. ...
  95. 执行成功后,nodes 将不保留原来的数据,整个更新为:
  96. {
  97. "39.97.63.200:80": 1
  98. }
  99. # 替换路由的 methods -- sub path
  100. $ curl http://127.0.0.1:9080/apisix/admin/routes/1/methods -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '["POST", "DELETE", "PATCH"]'
  101. HTTP/1.1 200 OK
  102. ...
  103. 执行成功后,methods 将不保留原来的数据,整个更新为:
  104. ["POST", "DELETE", "PATCH"]
  105. # 禁用路由
  106. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  107. {
  108. "status": 0
  109. }'
  110. HTTP/1.1 200 OK
  111. ...
  112. 执行成功后,status 将更新为:
  113. {
  114. "status": 0
  115. }
  116. # 启用路由
  117. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  118. {
  119. "status": 1
  120. }'
  121. HTTP/1.1 200 OK
  122. ...
  123. 执行成功后,status 将更新为:
  124. {
  125. "status": 1
  126. }

应答参数

目前是直接返回与 etcd 交互后的结果。

Back to TOC

Service

地址:/apisix/admin/services/{id}

说明Service 是某类 API 的抽象(也可以理解为一组 Route 的抽象)。它通常与上游服务抽象是一一对应的,RouteService 之间,通常是 N:1 的关系。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/services获取资源列表
GET/apisix/admin/services/{id}获取资源
PUT/apisix/admin/services/{id}{…}根据 id 创建资源
POST/apisix/admin/services{…}创建资源,id 由后台服务自动生成
DELETE/apisix/admin/services/{id}删除资源
PATCH/apisix/admin/services/{id}{…}标准 PATCH ,修改已有 Service 的部分属性,其他不涉及的属性会原样保留;如果你要删除某个属性,将该属性的值设置为 null 即可删除;特别地,当需要修改属性的值为数组时,该属性将全量更新
PATCH/apisix/admin/services/{id}/{path}{…}SubPath PATCH,通过 {path} 指定 Service 需要更新的属性,全量更新该属性的数据,其他不涉及的属性会原样保留

body 请求参数

名字可选项类型说明示例
plugins可选Plugin详见 Plugin
upstreamupstream 或 upstream_id 两个选一个Upstream启用的 Upstream 配置,详见 Upstream
upstream_idupstream 或 upstream_id 两个选一个Upstream启用的 upstream id,详见 Upstream
name可选辅助标识服务名称。
desc可选辅助服务描述、使用场景等。
labels可选匹配规则标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
enable_websocket可选辅助是否启用 websocket(boolean), 缺省 false.
hosts可选匹配规则非空列表形态的 host,表示允许有多个不同 host,匹配其中任意一个即可。[“foo.com”, “*.bar.com”]
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670

service 对象 json 配置内容:

  1. {
  2. "id": "1", # id
  3. "plugins": {}, # 指定 service 绑定的插件
  4. "upstream_id": "1", # upstream 对象在 etcd 中的 id ,建议使用此值
  5. "upstream": {}, # upstream 信息对象,不建议使用
  6. "name": "测试svc", # service 名称
  7. "desc": "hello world", # service 描述
  8. "enable_websocket": true, #启动 websocket 功能
  9. "hosts": ["foo.com"]
  10. }

具体示例:

  1. # 创建一个Service
  2. $ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  3. {
  4. "plugins": {
  5. "limit-count": {
  6. "count": 2,
  7. "time_window": 60,
  8. "rejected_code": 503,
  9. "key": "remote_addr"
  10. }
  11. },
  12. "enable_websocket": true,
  13. "upstream": {
  14. "type": "roundrobin",
  15. "nodes": {
  16. "39.97.63.215:80": 1
  17. }
  18. }
  19. }'
  20. # 返回结果
  21. HTTP/1.1 201 Created
  22. ...
  23. # 给 Service 增加一个 upstream node
  24. $ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  25. {
  26. "upstream": {
  27. "nodes": {
  28. "39.97.63.216:80": 1
  29. }
  30. }
  31. }'
  32. HTTP/1.1 200 OK
  33. ...
  34. 执行成功后,upstream nodes 将更新为:
  35. {
  36. "39.97.63.215:80": 1,
  37. "39.97.63.216:80": 1
  38. }
  39. # 给 Service 更新一个 upstream node 的权重
  40. $ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  41. {
  42. "upstream": {
  43. "nodes": {
  44. "39.97.63.216:80": 10
  45. }
  46. }
  47. }'
  48. HTTP/1.1 200 OK
  49. ...
  50. 执行成功后,upstream nodes 将更新为:
  51. {
  52. "39.97.63.215:80": 1,
  53. "39.97.63.216:80": 10
  54. }
  55. # 给 Service 删除一个 upstream node
  56. $ curl http://127.0.0.1:9080/apisix/admin/services/201 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  57. {
  58. "upstream": {
  59. "nodes": {
  60. "39.97.63.215:80": null
  61. }
  62. }
  63. }'
  64. HTTP/1.1 200 OK
  65. ...
  66. 执行成功后,upstream nodes 将更新为:
  67. {
  68. "39.97.63.216:80": 10
  69. }
  70. # 替换 Service 的 upstream nodes
  71. $ curl http://127.0.0.1:9080/apisix/admin/services/201/upstream/nodes -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  72. {
  73. "39.97.63.200:80": 1
  74. }'
  75. HTTP/1.1 200 OK
  76. ...
  77. 执行成功后,upstream nodes 将不保留原来的数据,整个更新为:
  78. {
  79. "39.97.63.200:80": 1
  80. }

应答参数

目前是直接返回与 etcd 交互后的结果。

Back to TOC

Consumer

地址:/apisix/admin/consumers/{username}

说明:Consumer 是某类服务的消费者,需与用户认证体系配合才能使用。Consumer 使用 username 作为唯一标识,只支持使用 HTTP PUT 方法创建 Consumer。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/consumers获取资源列表
GET/apisix/admin/consumers/{id}获取资源
PUT/apisix/admin/consumers{…}创建资源
DELETE/apisix/admin/consumers/{id}删除资源

body 请求参数

名字可选项类型说明示例
username必需辅助Consumer 名称。
plugins可选Plugin该 Consumer 对应的插件配置,它的优先级是最高的:Consumer > Route > Service。对于具体插件配置,可以参考 Plugins 章节。
desc可选辅助consumer 描述
labels可选匹配规则标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670

consumer 对象 json 配置内容:

  1. {
  2. "plugins": {}, # 指定 consumer 绑定的插件
  3. "username": "name", # 必填
  4. "desc": "hello world", # consumer 描述
  5. }

绑定认证插件有些特别,当它需要与 consumer 联合使用时,需要提供用户名、密码等信息;另一方面,当它与 route/service 绑定时,是不需要任何参数的。因为这时候是根据用户请求数据来反向推出用户对应的是哪个 consumer

示例:

  1. # 创建 Consumer ,指定认证插件 key-auth ,并开启特定插件 limit-count
  2. $ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
  3. {
  4. "username": "jack",
  5. "plugins": {
  6. "key-auth": {
  7. "key": "auth-one"
  8. },
  9. "limit-count": {
  10. "count": 2,
  11. "time_window": 60,
  12. "rejected_code": 503,
  13. "key": "remote_addr"
  14. }
  15. }
  16. }'
  17. HTTP/1.1 200 OK
  18. Date: Thu, 26 Dec 2019 08:17:49 GMT
  19. ...
  20. {"node":{"value":{"username":"jack","plugins":{"key-auth":{"key":"auth-one"},"limit-count":{"time_window":60,"count":2,"rejected_code":503,"key":"remote_addr","policy":"local"}}},"createdIndex":64,"key":"\/apisix\/consumers\/jack","modifiedIndex":64},"prevNode":{"value":"{\"username\":\"jack\",\"plugins\":{\"key-auth\":{\"key\":\"auth-one\"},\"limit-count\":{\"time_window\":60,\"count\":2,\"rejected_code\":503,\"key\":\"remote_addr\",\"policy\":\"local\"}}}","createdIndex":63,"key":"\/apisix\/consumers\/jack","modifiedIndex":63},"action":"set"}

v2.2 版本之后,同一个 consumer 可以绑定多个认证插件。

应答参数

目前是直接返回与 etcd 交互后的结果。

Back to TOC

Upstream

地址:/apisix/admin/upstreams/{id}

说明:Upstream 是虚拟主机抽象,对给定的多个服务节点按照配置规则进行负载均衡。Upstream 的地址信息可以直接配置到 Route(或 Service) 上,当 Upstream 有重复时,就需要用“引用”方式避免重复了。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/upstreams获取资源列表
GET/apisix/admin/upstreams/{id}获取资源
PUT/apisix/admin/upstreams/{id}{…}根据 id 创建资源
POST/apisix/admin/upstreams{…}创建资源,id 由后台服务自动生成
DELETE/apisix/admin/upstreams/{id}删除资源
PATCH/apisix/admin/upstreams/{id}{…}标准 PATCH ,修改已有 Upstream 的部分属性,其他不涉及的属性会原样保留;如果你要删除某个属性,将该属性的值设置为 null 即可删除;特别地,当需要修改属性的值为数组时,该属性将全量更新
PATCH/apisix/admin/upstreams/{id}/{path}{…}SubPath PATCH,通过 {path} 指定 Upstream 需要更新的属性,全量更新该属性的数据,其他不涉及的属性会原样保留。

body 请求参数

APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上游做主被动健康检查、重试等逻辑,具体看下面表格。

名字可选项类型说明示例
type必需枚举负载均衡算法
nodes必需,不能和 servicename 一起用Node哈希表或数组。当它是哈希表时,内部元素的 key 是上游机器地址列表,格式为地址 + (可选的)端口,其中地址部分可以是 IP 也可以是域名,比如 192.168.1.100:80foo.com:80等。value 则是节点的权重。当它是数组时,数组中每个元素都是一个哈希表,其中包含 hostweight 以及可选的 portprioritynodes 可以为空,这通常用作占位符。客户端命中这样的上游会返回 502。192.168.1.100:80
service_name必需,不能和 nodes 一起用string服务发现时使用的服务名,见集成服务发现注册中心a-bootiful-client
discovery_type必需,如果设置了 service_namestring服务发现类型,见集成服务发现注册中心eureka
key条件必需匹配类型该选项只有类型是 chash 才有效。根据 key 来查找对应的 node id,相同的 key 在同一个对象中,永远返回相同 id,目前支持的 Nginx 内置变量有 uri, server_name, server_addr, request_uri, remote_port, remote_addr, query_string, host, hostname, arg,其中 arg_ 是来自 URL 的请求参数,Nginx 变量列表
checks可选health_checker配置健康检查的参数,详细可参考health-check
retries可选整型使用底层的 Nginx 重试机制将请求传递给下一个上游,默认启用重试且次数为后端可用的 node 数量。如果指定了具体重试次数,它将覆盖默认值。0 代表不启用重试机制。
retry_timeout可选number限制是否继续重试的时间,若之前的请求和重试请求花费太多时间就不再继续重试。0 代表不启用重试超时机制。
timeout可选超时时间对象设置连接、发送消息、接收消息的超时时间
hash_on可选辅助hash_on 支持的类型有 vars(Nginx 内置变量),header(自定义 header),cookieconsumer,默认值为 vars
name可选辅助标识上游服务名称、使用场景等。
desc可选辅助上游服务描述、使用场景等。
pass_host可选枚举请求发给上游时的 host 设置选型。 [passnoderewrite] 之一,默认是passpass: 将客户端的 host 透传给上游; node: 使用 upstream node 中配置的 host; rewrite: 使用配置项 upstream_host 的值。
upstream_host可选辅助指定上游请求的 host,只在 pass_host 配置为 rewrite 时有效。
scheme可选辅助跟上游通信时使用的 scheme。需要是 [‘http’, ‘https’, ‘grpc’, ‘grpcs’] 其中的一个,默认是 ‘http’。
labels可选匹配规则标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
tls.client_cert可选https 证书设置跟上游通信时的客户端证书,细节见下文
tls.client_key可选https 证书私钥设置跟上游通信时的客户端私钥,细节见下文
keepalive_pool.size可选辅助动态设置 keepalive 指令,细节见下文
keepalive_pool.idle_timeout可选辅助动态设置 keepalive_timeout 指令,细节见下文
keepalive_pool.requests可选辅助动态设置 keepalive_requests 指令,细节见下文

type 可以是以下的一种:

  • roundrobin: 带权重的 roundrobin
  • chash: 一致性哈希
  • ewma: 选择延迟最小的节点,计算细节参考 https://en.wikipedia.org/wiki/EWMA_chart
  • least_conn: 选择 (active_conn + 1) / weight 最小的节点。注意这里的 active connection 概念跟 Nginx 的相同:它是当前正在被请求使用的连接。
  • 用户自定义的 balancer,需要可以通过 require("apisix.balancer.your_balancer") 来加载。

hash_on 比较复杂,这里专门说明下:

  1. 设为 vars 时,key 为必传参数,目前支持的 Nginx 内置变量有 uri, server_name, server_addr, request_uri, remote_port, remote_addr, query_string, host, hostname, arg_***,其中 arg_*** 是来自 URL 的请求参数,Nginx 变量列表
  2. 设为 header 时, key 为必传参数,其值为自定义的 header name, 即 “http_key
  3. 设为 cookie 时, key 为必传参数,其值为自定义的 cookie name,即 “cookie_key“。请注意 cookie name 是区分大小写字母的。例如:”cookie_x_foo” 与 “cookie_X_Foo” 表示不同的 cookie
  4. 设为 consumer 时,key 不需要设置。此时哈希算法采用的 key 为认证通过的 consumer_name
  5. 如果指定的 hash_onkey 获取不到值时,就是用默认值:remote_addr

tls.client_cert/key 可以用来跟上游进行 mTLS 通信。 他们的格式和 SSL 对象的 certkey 一样。 这个特性需要 APISIX 运行于 APISIX-OpenResty

keepalive_pool 允许 upstream 对象有自己单独的连接池。 它下属的字段,比如 requests,可以用了配置上游连接保持的参数。 这个特性需要 APISIX 运行于 APISIX-OpenResty

upstream 对象 json 配置内容:

  1. {
  2. "id": "1", # id
  3. "retries": 1, # 请求重试次数
  4. "timeout": { # 设置连接、发送消息、接收消息的超时时间
  5. "connect":15,
  6. "send":15,
  7. "read":15,
  8. },
  9. "nodes": {"host:80": 100}, # 上游机器地址列表,格式为`地址 + 端口`
  10. # 等价于 "nodes": [ {"host":"host", "port":80, "weight": 100} ],
  11. "type":"roundrobin",
  12. "checks": {}, # 配置健康检查的参数
  13. "hash_on": "",
  14. "key": "",
  15. "name": "upstream-xxx", # upstream 名称
  16. "desc": "hello world", # upstream 描述
  17. "scheme": "http" # 跟上游通信时使用的 scheme,默认是 `http`
  18. }

具体示例:

示例一:创建一个 upstream 并对 nodes 的数据做修改

  1. # 创建一个 upstream
  2. $ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d '
  3. {
  4. "type":"roundrobin",
  5. "nodes":{
  6. "39.97.63.215:80": 1
  7. }
  8. }'
  9. HTTP/1.1 201 Created
  10. ...
  11. # 给 Upstream 增加一个 node
  12. $ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  13. {
  14. "nodes": {
  15. "39.97.63.216:80": 1
  16. }
  17. }'
  18. HTTP/1.1 200 OK
  19. ...
  20. 执行成功后,nodes 将更新为:
  21. {
  22. "39.97.63.215:80": 1,
  23. "39.97.63.216:80": 1
  24. }
  25. # 给 Upstream 更新一个 node 的权重
  26. $ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  27. {
  28. "nodes": {
  29. "39.97.63.216:80": 10
  30. }
  31. }'
  32. HTTP/1.1 200 OK
  33. ...
  34. 执行成功后,nodes 将更新为:
  35. {
  36. "39.97.63.215:80": 1,
  37. "39.97.63.216:80": 10
  38. }
  39. # 给 Upstream 删除一个 node
  40. $ curl http://127.0.0.1:9080/apisix/admin/upstreams/100 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  41. {
  42. "nodes": {
  43. "39.97.63.215:80": null
  44. }
  45. }'
  46. HTTP/1.1 200 OK
  47. ...
  48. 执行成功后,nodes 将更新为:
  49. {
  50. "39.97.63.216:80": 10
  51. }
  52. # 替换 Upstream 的 nodes
  53. $ curl http://127.0.0.1:9080/apisix/admin/upstreams/100/nodes -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -i -d '
  54. {
  55. "39.97.63.200:80": 1
  56. }'
  57. HTTP/1.1 200 OK
  58. ...
  59. 执行成功后,nodes 将不保留原来的数据,整个更新为:
  60. {
  61. "39.97.63.200:80": 1
  62. }

示例二:将客户端请求代理到上游 https 服务

1、创建 route 并配置 upstream 的 scheme 为 https

  1. $ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3. "uri": "/get",
  4. "upstream": {
  5. "type": "roundrobin",
  6. "scheme": "https",
  7. "nodes": {
  8. "httpbin.org:443": 1
  9. }
  10. }
  11. }'

执行成功后,请求与上游通信时的 scheme 将为 https

2、 发送请求进行测试。

  1. $ curl http://127.0.0.1:9080/get
  2. {
  3. "args": {},
  4. "headers": {
  5. "Accept": "*/*",
  6. "Host": "127.0.0.1",
  7. "User-Agent": "curl/7.29.0",
  8. "X-Amzn-Trace-Id": "Root=1-6058324a-0e898a7f04a5e95b526bb183",
  9. "X-Forwarded-Host": "127.0.0.1"
  10. },
  11. "origin": "127.0.0.1",
  12. "url": "https://127.0.0.1/get"
  13. }

请求成功,表示代理上游 https 生效了。

注意:

节点可以配置自己的优先级。只有在高优先级的节点不可用或者尝试过,才会访问一个低优先级的节点。

由于默认的优先级是 0,我们可以给一些节点配置负数的优先级来作为备份。 举个例子:

  1. {
  2. "uri": "/hello",
  3. "upstream": {
  4. "type": "roundrobin",
  5. "nodes": [
  6. {"host": "127.0.0.1", "port": 1980, "weight": 2000},
  7. {"host": "127.0.0.2", "port": 1980, "weight": 1, "priority": -1}
  8. ],
  9. "checks": {
  10. "active": {
  11. "http_path": "/status",
  12. "healthy": {
  13. "interval": 1,
  14. "successes": 1
  15. },
  16. "unhealthy": {
  17. "interval": 1,
  18. "http_failures": 1
  19. }
  20. }
  21. }
  22. }
  23. }

节点 127.0.0.2 只有在 127.0.0.1 不可用或者尝试过之后才会被访问。 所以它是 127.0.0.1 的备份。

应答参数

目前是直接返回与 etcd 交互后的结果。

Back to TOC

SSL

地址:/apisix/admin/ssl/{id}

说明:SSL.

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/ssl获取资源列表
GET/apisix/admin/ssl/{id}获取资源
PUT/apisix/admin/ssl/{id}{…}根据 id 创建资源
POST/apisix/admin/ssl{…}创建资源,id 由后台服务自动生成
DELETE/apisix/admin/ssl/{id}删除资源

body 请求参数

名字可选项类型说明示例
cert必需证书https 证书
key必需私钥https 证书私钥
certs可选证书字符串数组当你想给同一个域名配置多个证书时,除了第一个证书需要通过 cert 传递外,剩下的证书可以通过该参数传递上来
keys可选私钥字符串数组certs 对应的证书私钥,注意要跟 certs 一一对应
client.ca可选证书设置将用于客户端证书校验的 CA 证书。该特性需要 OpenResty 1.19+
client.depth可选辅助设置客户端证书校验的深度,默认为 1。该特性需要 OpenResty 1.19+
snis必需匹配规则非空数组形式,可以匹配多个 SNI
labels可选匹配规则标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
status可选辅助是否启用此 SSL, 缺省 11 表示启用,0 表示禁用

ssl 对象 json 配置内容:

  1. {
  2. "id": "1", # id
  3. "cert": "cert", # 证书
  4. "key": "key", # 私钥
  5. "snis": ["t.com"] # HTTPS 握手时客户端发送的 SNI
  6. }

更多的配置示例见 证书

Back to TOC

Global Rule

地址:/apisix/admin/global_rules/{id}

说明:设置全局运行的插件。这一类插件在所有路由级别的插件之前优先运行。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/global_rules获取资源列表
GET/apisix/admin/global_rules/{id}获取资源
PUT/apisix/admin/global_rules/{id}{…}根据 id 创建资源
DELETE/apisix/admin/global_rules/{id}删除资源
PATCH/apisix/admin/global_rules/{id}{…}标准 PATCH ,修改已有 Global Rule 的部分属性,其他不涉及的属性会原样保留;如果你要删除某个属性,将该属性的值设置为 null 即可删除;特别地,当需要修改属性的值为数组时,该属性将全量更新
PATCH/apisix/admin/global_rules/{id}/{path}{…}SubPath PATCH,通过 {path} 指定 Global Rule 要更新的属性,全量更新该属性的数据,其他不涉及的属性会原样保留。

body 请求参数

名字可选项类型说明示例
plugins必需Plugin详见 Plugin
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670

Back to TOC

Plugin Config

地址:/apisix/admin/plugin_configs/{id}

说明:配置一组可以在路由间复用的插件。

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/plugin_configs获取资源列表
GET/apisix/admin/plugin_configs/{id}获取资源
PUT/apisix/admin/plugin_configs/{id}{…}根据 id 创建资源
DELETE/apisix/admin/plugin_configs/{id}删除资源
PATCH/apisix/admin/plugin_configs/{id}{…}标准 PATCH ,修改已有 Plugin Config 的部分属性,其他不涉及的属性会原样保留;如果你要删除某个属性,将该属性的值设置为 null 即可删除;特别地,当需要修改属性的值为数组时,该属性将全量更新
PATCH/apisix/admin/plugin_configs/{id}/{path}{…}SubPath PATCH,通过 {path} 指定 Plugin Config 要更新的属性,全量更新该属性的数据,其他不涉及的属性会原样保留。

body 请求参数

名字可选项类型说明示例
plugins必需Plugin详见 Plugin
desc可选辅助标识描述、使用场景等customer xxxx
labels可选辅助标识附加属性的键值对{“version”:”v2”,”build”:”16”,”env”:”production”}
create_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670
update_time可选辅助单位为秒的 epoch 时间戳,如果不指定则自动创建1602883670

Back to TOC

Plugin Metadata

地址:/apisix/admin/plugin_metadata/{plugin_name}

说明: 插件元数据。

请求方法

Method请求 URI请求 body说明
GET/apisix/admin/plugin_metadata/{plugin_name}获取资源
PUT/apisix/admin/plugin_metadata/{plugin_name}{…}根据 plugin name 创建资源
DELETE/apisix/admin/plugin_metadata/{plugin_name}删除资源

body 请求参数

一个根据插件 ({plugin_name}) 的 metadata_schema 定义的数据结构的 json object 。

例子:

  1. $ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/example-plugin -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -i -X PUT -d '
  2. {
  3. "skey": "val",
  4. "ikey": 1
  5. }'
  6. HTTP/1.1 201 Created
  7. Date: Thu, 26 Dec 2019 04:19:34 GMT
  8. Content-Type: text/plain

Back to TOC

Plugin

地址:/apisix/admin/plugins/{plugin_name}

说明: 插件

请求方法

名字       请求  uri请求  body说明         
GET      /apisix/admin/plugins/list获取资源列表
GET      /apisix/admin/plugins/{plugin_name}获取资源
GET/apisix/admin/plugins?all=true获取所有插件的所有属性

body 请求参数

获取插件 ({plugin_name}) 数据结构的 json object 。

例子:

  1. $ curl "http://127.0.0.1:9080/apisix/admin/plugins/list" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
  2. ["zipkin","request-id",...]
  3. $ curl "http://127.0.0.1:9080/apisix/admin/plugins/key-auth" -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'
  4. {"properties":{"disable":{"type":"boolean"}},"additionalProperties":false,"type":"object"}

地址:/apisix/admin/plugins?all=true

说明: 所有插件的所有属性,每个插件包括 name, priority, type, schema, consumer_schemaversion

默认情况下,这个接口只返回 http 插件。如果你需要 stream 插件,需要用 /apisix/admin/plugins?all=true&subsystem=stream

请求方法

Method请求 URI请求 body说明
GET/apisix/admin/plugins?all=true获取资源

请求参数

名称说明默认
subsystem插件所属的子系统http

Back to TOC

Stream Route

API:/apisix/admin/stream_routes/{id}

Description:Stream Route 是用于 TCP/UDP 动态代理的路由。参见 TCP/UDP 动态代理 一节.

请求方法

名字请求 uri请求 body说明
GET/apisix/admin/stream_routes获取资源列表
GET/apisix/admin/stream_routes/{id}获取资源
PUT/apisix/admin/stream_routes/{id}{…}根据 id 创建资源
POST/apisix/admin/stream_routes{…}创建资源,id 由后台服务自动生成
DELETE/apisix/admin/stream_routes/{id}删除资源

body 请求参数

名字可选项类型说明示例
remote_addr可选IP/CIDR客户端 IP 地址“127.0.0.1/32” 或 “127.0.0.1”
server_addr可选IP/CIDR服务端 IP 地址“127.0.0.1/32” 或 “127.0.0.1”
server_port可选整数服务端端口9090
sni可选Host服务器名称指示“test.com”
upstream可选Upstream启用的 Upstream 配置,详见 Upstream
upstream_id可选Upstream启用的 upstream id,详见 Upstream

Back to TOC