apisix/doc/admin-api-cn.md

目录

• Route

Route

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

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

请求方法：

名字	请求 uri	请求 body	说明
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}/{path}	{...}	修改已有 Route 的部分内容，其他不涉及部分会原样保留。

uri 请求参数：

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

body 请求参数：

名字	可选项	类型	说明	示例
uri	与 uris 二选一	匹配规则	除了如 /foo/bar、/foo/gloo 这种全量匹配外，使用不同 Router 还允许更高级匹配，更多见 Router。	"/hello"
uris	与 uri 二选一	匹配规则	数组形式，可以匹配多个 uri	["/hello", "/world"]
plugins	plugins、upstream/upstream_id、service_id至少选择一个	Plugin	详见 Plugin
upstream	plugins、upstream/upstream_id、service_id至少选择一个	Upstream	启用的 Upstream 配置，详见 Upstream
upstream_id	plugins、upstream/upstream_id、service_id至少选择一个	Upstream	启用的 upstream id，详见 Upstream
service_id	plugins、upstream/upstream_id、service_id至少选择一个	Service	绑定的 Service 配置，详见 Service
service_protocol	可选	上游协议类型	只可以是 "grpc", "http" 二选一。	默认 "http"，使用gRPC proxy 或gRPC transcode 时，必须用"grpc"
desc	可选	辅助	标识路由名称、使用场景等。	客户 xxxx
host	可选	匹配规则	当前请求域名，比如 foo.com；也支持泛域名，比如 *.foo.com。	"foo.com"
hosts	可选	匹配规则	列表形态的 host，表示允许有多个不同 host，匹配其中任意一个即可。	{"foo.com", "*.bar.com"}
remote_addr	可选	匹配规则	客户端请求 IP 地址: 192.168.1.101、192.168.1.102 以及 CIDR 格式的支持 192.168.1.0/24。特别的，APISIX 也完整支持 IPv6 地址匹配：::1，fe80::1, fe80::1/64 等。	"192.168.1.0/24"
remote_addrs	可选	匹配规则	列表形态的 remote_addr，表示允许有多个不同 IP 地址，符合其中任意一个即可。	{"127.0.0.1", "192.0.0.0/8", "::1"}
methods	可选	匹配规则	如果为空或没有该选项，代表没有任何 method 限制，也可以是一个或多个的组合：GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS，CONNECT，TRACE。	{"GET", "POST"}
priority	可选	匹配规则	如果不同路由包含相同 uri，根据属性 priority 确定哪个 route 被优先匹配，默认值为 0。	priority = 10
vars	可选	匹配规则	由一个或多个{var, operator, val}元素组成的列表，类似这样：{{var, operator, val}, {var, operator, val}, ...}。例如：{"arg_name", "==", "json"}，表示当前请求参数 name 是 json。这里的 var 与 Nginx 内部自身变量命名是保持一致，所以也可以使用 request_uri、host 等；对于 operator 部分，目前已支持的运算符有 ==、~=、>、< 和 ~~。对于>和<两个运算符，会把结果先转换成 number 然后再做比较。查看支持的运算符列表	{{"arg_name", "==", "json"}, {"arg_age", ">", 18}}
filter_func	可选	匹配规则	用户自定义的过滤函数。可以使用它来实现特殊场景的匹配要求实现。该函数默认接受一个名为 vars 的输入参数，可以用它来获取 Nginx 变量。	function(vars) return vars["arg_name"] == "json" end

有两点需要特别注意：

• 除了 uri/uris 是必选的之外，plugins、upstream/upstream_id、service_id 这三类必须选择其中至少一个。
• 对于同一类参数比如 uri与 uris，upstream 与 upstream_id，host 与 hosts，remote_addr 与 remote_addrs 等，是不能同时存在，二者只能选择其一。如果同时启用，接口会报错。

示例：

# 创建一个路由
$ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
    "uri": "/index.html",
    "hosts": ["foo.com", "*.bar.com"],
    "remote_addrs": ["127.0.0.0/8"],
    "methods": ["PUT", "GET"],
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "39.97.63.215:80": 1
        }
    }
}'

HTTP/1.1 201 Created
Date: Sat, 31 Aug 2019 01:17:15 GMT
...

# 创建一个有效期为 60 秒的路由，过期后自动删除
$ curl http://127.0.0.1:9080/apisix/admin/routes/2?ttl=60 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
    "uri": "/aa/index.html",
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "39.97.63.215:80": 1
        }
    }
}'

HTTP/1.1 201 Created
Date: Sat, 31 Aug 2019 01:17:15 GMT
...

应答参数

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

运算符列表

运算符	描述	例子
==	相等	{"arg_name", "==", "json"}
~=	不等于	{"arg_name", "~=", "json"}
>	大于	{"arg_age", ">", 24}
<	小于	{"arg_age", "<", 24}
~~	正则匹配	{"arg_name", "~~", "[a-z]+"}

请看下面例子，匹配请求参数 name 等于 json ，age 大于 18 且 address 开头是 China 的请求：

curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
{
    "uri": "/index.html",
    "vars": [
        ["arg_name", "==", "json"],
        ["arg_age", ">", "18"],
        ["arg_address", "~~", "^China.*"]
    ],
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "39.97.63.215:80": 1
        }
    }
}'

Back to TOC