欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页

Kong API Gateway 管理API详解

程序员文章站 2022-06-03 21:15:34
...

Kong API Gateway 管理API详解

一、前言

安装好了Kong，那么如何使用和管理它呢？Kong附带了一个管理的API接口，我们通过这个API接口来管理所有的API以及其他的资源，这个接口具有最高的权限，所以在生产环境中我们要特别注意这个接口的权限，通常我们不会将这个接口暴露在外网中。

如果Kong是以集群的状态的运行的，那么你只需要将管理API的请求发送到其中的一个节点中，Kong会自动同步信息到其他的节点。Kong默认监听8001和8444两个端口用接受管理API的请求，8001为http端口，8444为https端口

Kong支持application/x-www-form-urlencoded和application/json两种类型，POST的数据我们需要以json的格式发送。

Kong大概有以下几个管理对象：

  • 节点信息
  • 服务
  • 路由
  • 用户
  • 插件
  • 证书
  • SNI
  • 上游信息
  • 目标

在Kong0.13.0版本以前，有API对象，但是从0.13.0之后开始逐步抛弃API对象，使用路由和服务组合来取代API对象，这提高了Kong的灵活性。基于此本文也将不介绍有关API对象的操作

本文约定：

  • 我使用的是Kong_0.14.1版本
  • 节点管理地址为 http://192.168.0.184:8001
  • 使用curl请求接口，并且将得到的结果通过管道送给python进行格式化

例如：

[email protected]:~$curl -s http://192.168.0.184:8001/status | python -m json.tool
{
    "database": {
        "reachable": true
    },
    "server": {
        "connections_accepted": 112,
        "connections_active": 1,
        "connections_handled": 112,
        "connections_reading": 0,
        "connections_waiting": 0,
        "connections_writing": 1,
        "total_requests": 65
    }
}

在以上的示例中，-s参数表示静默模式，curl将不输入信息，这样我们就可以不打印我们不需要关注的信息。

然后将得到的结果通过管道送给python进行格式化，这样打印出来的就是格式化的json，方便我们查看。

下面我们一起看一下每一种对象的操作

二、节点信息

1、查看节点信息

接口信息：

接口名称 查看节点详细信息
请求端点 /
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001 | python -m json.tool

返回值：

查询节点详细信息返回的信息非常多，这里就显示了。

2、查看节点状态

这个接口查询节点的状态，主要是显示nginx进程处理连接的情况，以及数据库连接的情况。

如果Kong是以集群的方式运行，那么如果要查看其他节点的情况，必须要要一个一个访问节点的此接口。

因为Kong是基于nginx的，你也可以直接使用Nginx的监控工具。

接口信息：

接口名称 查看节点状态
请求端点 /status
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/status | python -m json.tool

返回值：

{
    "database": {
        "reachable": true
    },
    "server": {
        "connections_accepted": 111,
        "connections_active": 1,
        "connections_handled": 111,
        "connections_reading": 0,
        "connections_waiting": 0,
        "connections_writing": 1,
        "total_requests": 64
    }
}

在返回的数据中，各个值的含义如下：：

  • total_requests：客户端请求的总数。
  • connections_active：当前活动客户端连接数，包括等待连接。
  • connections_accepted：已接受的客户端连接总数。
  • connections_handled：已处理连接的总数。通常，参数值与accept相同，除非已达到某些资源限制。
  • connections_reading：Kong正在读取请求标头的当前连接数。
  • connections_writing：nginx将响应写回客户端的当前连接数。
  • connections_waiting：等待请求的当前空闲客户端连接数。

三、服务

服务是每一个后端真实接口的抽象，它与路由关联，客户端发起请求，如果路由匹配到了，那么会将这个请求代理到与匹配路由相关联的服务中。

1、添加服务

接口信息：

接口名称 添加服务
请求端点 /services/
请求方法 POST
返回状态 HTTP 201 Created

请求参数:

参数名 类型 默认值 是否必须 说明
name string 否 服务名称，全局唯一
protocol string http 是 和上游通讯的协议取值http或https
host string 是 上游服务器的主机
port int 80 是 上游服务器的端口
path string 否 上游服务器请求中的路径，必须以/开头
retries int 5 否 代理失败时要执行的重试次数
connect_timeout int 60000 否 与上游连接的超时时间，单位毫秒
write_timeout int 60000 否 向上游发送请求两次连续写操作的超时时间 ，单位毫秒
read_timeout int 60000 否 用于向上游服务器发送请求的两次连续读取操作之间的超时 ，单位毫秒

请求示例：

curl -s -X POST --url http://192.168.0.184:8001/services/ \
-d 'name=linuxops_server' \
-d 'protocol=http' \
-d 'host=www.baidu.com'\
| python -m json.tool

返回值：

{
    "connect_timeout": 60000,
    "created_at": 1537924532,
    "host": "www.baidu.com",
    "id": "27f30248-fef1-4ddc-9fdc-4ca73f354c64",
    "name": "linuxops_server",
    "path": null,
    "port": 80,
    "protocol": "http",
    "read_timeout": 60000,
    "retries": 5,
    "updated_at": 1537924532,
    "write_timeout": 60000
}

如果在创建服务的时候没有指定name，那么Kong并不会自动创建name，但是会创建UUID形式的ID，Kong在调用、匹配等等的操作都是可以基于这个ID，所以这个ID绝对是全局唯一的。

在其他的对象管理中，name字段可能是必须的，通常这个name资源也是全局唯一的，即便如此，Kong也会创建ID字段，也可以通过这个ID字段来匹配。

在服务对象中，能组合起来成为上游服务也是唯一的，也就是说，在一个服务中无法同时存在 http和https，如果上游提供http和https服务，同时也需要Kong代理它们的话，那必须要设置两个服务。

2、查询服务

接口信息：

接口名称 查询服务
请求端点 /services/{name or id}
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s --url http://192.168.0.184:8001/services/27f30248-fef1-4ddc-9fdc-4ca73f354c64 | python -m json.tool

返回值：

{
    "connect_timeout": 60000,
    "created_at": 1537986798,
    "host": "www.baidu.com",
    "id": "27f30248-fef1-4ddc-9fdc-4ca73f354c64",
    "name": "linuxops_server",
    "port": 80,
    "protocol": "http",
    "read_timeout": 60000,
    "retries": 5,
    "updated_at": 1537986798,
    "write_timeout": 60000
}

查询服务的接口我们可以通过id来查询，也可以通过name来查询，在创建服务的时候可以不指定name字段，在系统中显示为null，这种服务就无法通过指定name来查询了，必须要使用id来查询，所以，强烈建议在创建服务的时候指定name，这是一个好习惯。

3、查询所有服务

接口信息：

接口名称 查询所有服务
请求端点 /services/
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
offset string 否 分页偏移，用于定义列表中的唯一
size int 100 否 每页返回的对象的数量

请求示例：

curl -s --url http://192.168.0.184:8001/services/?size=1 | python -m json.tool

返回值：

{
    "data": [
        {
            "connect_timeout": 60000,
            "created_at": 1537986798,
            "host": "www.baidu.com",
            "id": "27f30248-fef1-4ddc-9fdc-4ca73f354c64",
            "name": "linuxops_server",
            "path": null,
            "port": 80,
            "protocol": "http",
            "read_timeout": 60000,
            "retries": 5,
            "updated_at": 1537986798,
            "write_timeout": 60000
        }
    ],
    "next": "/services?offset=WyIyN2YzMDI0OC1mZWYxLTRkZGMtOWZkYy00Y2E3M2YzNTRjNjQiXQ",
    "offset": "WyIyN2YzMDI0OC1mZWYxLTRkZGMtOWZkYy00Y2E3M2YzNTRjNjQiXQ"
}

在上面的请求示例中，我们带了一个size的参数来限定每一页的数量，在返回的结果中有两个字段，next表示下一页的端点，offset是本页的偏移。

当然，如果你在读取下一页的时候还需要限定返回的数据，还是依然要使用size的参数

4、更新服务

接口信息：

接口名称 查询所有服务
请求端点 /services/{name or id}
请求方法 PATCH
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
name string 否 服务名称，全局唯一
protocol string http 是 和上游通讯的协议取值http或https
host string 是 上游服务器的主机
port int 80 是 上游服务器的端口
path string 否 上游服务器请求中的路径，必须以/开头
retries int 5 否 代理失败时要执行的重试次数
connect_timeout int 60000 否 与上游连接的超时时间，单位毫秒
write_timeout int 60000 否 向上游发送请求两次连续写操作的超时时间 ，单位毫秒
read_timeout int 60000 否 用于向上游服务器发送请求的两次连续读取操作之间的超时 ，单位毫秒

请求示例：

curl -s -X PATCH --url http://192.168.0.184:8001/services/linuxops_server \
-d 'name=linuxops_server_patch' \
-d 'protocol=http' \
-d 'host=www.baidu.com' \
 | python -m json.tool

返回值：

{
    "connect_timeout": 60000,
    "created_at": 1537986798,
    "host": "www.baidu.com",
    "id": "27f30248-fef1-4ddc-9fdc-4ca73f354c64",
    "name": "linuxops_server_patch",
    "path": null,
    "port": 80,
    "protocol": "http",
    "read_timeout": 60000,
    "retries": 5,
    "updated_at": 1537989418,
    "write_timeout": 60000
}

和查看服务的接口一样，接入点是需要带上id或者name的，只不过方法变成了PATCH，参数和添加的参数一样。

在上面的示例中，我修改了一个服务的name，从返回值中可以可能出来id是不会变化的。

5、更新或者创建服务

接口信息：

接口名称 更新或者创建服务
请求端点 /services/{name or id}
请求方法 PUT
返回状态 HTTP 201 Created or HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
name string 否 服务名称，全局唯一
protocol string http 是 和上游通讯的协议取值http或https
host string 是 上游服务器的主机
port int 80 是 上游服务器的端口
path string 否 上游服务器请求中的路径，必须以/开头
retries int 5 否 代理失败时要执行的重试次数
connect_timeout int 60000 否 与上游连接的超时时间，单位毫秒
write_timeout int 60000 否 向上游发送请求两次连续写操作的超时时间 ，单位毫秒
read_timeout int 60000 否 用于向上游服务器发送请求的两次连续读取操作之间的超时 ，单位毫秒

请求示例：

curl -s -X PUT --url http://192.168.0.184:8001/services/linuxops_server_put \
-d 'name=linuxops_server_patch' \
-d 'protocol=http' \
-d 'host=www.baidu.com' \
 | python -m json.tool

返回值：

{
    "connect_timeout": 60000,
    "created_at": 1537991524,
    "host": "www.baidu.com",
    "id": "7242306f-3a55-46b5-9cda-cfb6c25a421c",
    "name": "linuxops_server_put",
    "path": null,
    "port": 80,
    "protocol": "http",
    "read_timeout": 60000,
    "retries": 5,
    "updated_at": 1537991524,
    "write_timeout": 60000
}

这个接口是更新或者创建一个服务，接入点和查询、更新是一样的，不一样的是用了PUT的方法。

此接口带了{name or id}，Kong会根据{name or id}的信息查询数据库，如果对应的数据存在，那么更新，如果对于的数据不存在，那么就新增。

在更新服务的接口中，我们也是可以带{name or id}，无论是带了id还是name，服务中的name字段都是能被更新到的，但是这个接口就有点不一样了。

有以下几种情况：

1.如果这个接口带的是name，例如/services/linuxops_server Kong会判断name为”linuxops_server“的服务存不存在，如果存在，则更新，这个时候POST到Kong的数据中name字段无效，Kong并不会修改。 如果不存在”linuxops_server“这个服务存，那么会创建name为"linuxops_server"的服务，并且Kong会生成UUID形式的id，此时POST上来的数据中的name字段依然无效。

2.如果这个接口带的是id，例如/services/ca4f16bc-1562-4ab8-b201-131c7ac393f0 Kong会判断id为"ca4f16bc-1562-4ab8-b201-131c7ac393f0"的服务是否存在，如果存在，那么更新它，这个时候如果POST上来的数据中有name字段，那么Kong会更新name。 如果id为"ca4f16bc-1562-4ab8-b201-131c7ac393f0"的服务不存在，那么Kong会创建name为"ca4f16bc-1562-4ab8-b201-131c7ac393f0"的服务，并且Kong会生成UUID形式的id，这个时候POST上来的数据中如果有name字段，那么这个字段无效。

6、删除服务

接口信息：

接口名称 删除服务
请求端点 /services/{name or id}
请求方法 DELETE
返回状态 HTTP 204 No Content

请求参数:

无

请求示例：

curl -i  -X DELETE --url http://192.168.0.184:8001/services/b6094754-07da-4c31-bb95-0a7caf5e6c0b

返回值：

无

此接口没有返回值

四、路由

路由用来匹配客户端请求的规则，每一个路由都要与一个服务相关联，当一个请求到达Kong的时候，会先给路由匹配，如果匹配成功，那么会将请求转发给服务，服务再去后端请求数据。所以路由是Kong的入口。

在Kong0.13.0之前的版本有API实体，因为API实体使用用起来并不方便，所以将API实体拆分成路由和服务，这样提供了最大的*度。

Kong的一个API实体必须是路由和服务的组合。

1、添加路由

接口信息：

接口名称 添加路由
请求端点 /routes/
请求方法 POST
返回状态 HTTP 201 Created

请求参数:

参数名 类型 默认值 是否必须 说明
protocols string or list ["http", "https"] 否 此路由允许的协议，取值http或https
methods string or list null *否 此路由允许的方法
hosts string or list null *否 此路由允许的域名
paths string or list null *否 此路由匹配的path
strip_path bool true 否 匹配到path时，是否删除匹配到的前缀
preserve_host bool false 否 匹配到hosts时，使用请求头部的值为域名向后端发起请求，请求的头部为"host",例如"host:api.abc.com"
service string 是 关联的服务id。
这里需要特别注意，如果是以表达的形式发送的，需要以 service.id=<service_id>形式发送，如果是json，需要以"service":{"id":"<service_id>"}形式发送

请求示例：

curl -s -X POST --url http://192.168.0.184:8001/routes \
-d 'protocols=http' \
-d 'methods=GET'  \
-d 'paths=/weather' \
-d 'service.id=43921b23-65fc-4722-a4e0-99bf84e26593' \
| python -m json.tool

返回值：

{
    "created_at": 1538089234,
    "hosts": null,
    "id": "cce1a279-d05a-4faa-8c10-1f9d27b881c9",
    "methods": [
        "GET"
    ],
    "paths": [
        "/weather"
    ],
    "preserve_host": false,
    "protocols": [
        "http"
    ],
    "regex_priority": 0,
    "service": {
        "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
    },
    "strip_path": true,
    "updated_at": 1538089234
}

在上面的示例中，我们创建了一个路由并且关联了一个服务，在创建路由的时候并没有指定hosts，路由匹配到host的时候会允许所有，因为默认值为null。当然如果不指定其他的也是一样的。

值得注意的是，methods，hosts，paths这三个参数必须要指定一个，否则无法创建路由。

路由和服务组合的规则相对比较复杂，我们将会重新开一篇文章来专门讲解这个，本文仅仅关注管理API的使用。

2、查看路由

接口信息：

接口名称 查看路由
请求端点 /routes/{id}
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/routes/6c6b7863-9a05-4d51-bf7e-8e4e5866a131 | python -m json.tool

返回值：

{
    "created_at": 1538089668,
    "id": "6c6b7863-9a05-4d51-bf7e-8e4e5866a131",
    "paths": [
        "/weather"
    ],
    "preserve_host": false,
    "protocols": [
        "http",
        "https"
    ],
    "regex_priority": 0,
    "service": {
        "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
    },
    "strip_path": true,
    "updated_at": 1538089668
}

路由中没有name字段，所以只能通过ID来查看。

3、查询所有路由

接口信息：

接口名称 查询所有路由
请求端点 /routes
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
offset string 否 分页偏移，用于定义列表中的唯一
size int 100 否 每页返回的对象的数量

请求示例：

curl -s --url http://192.168.0.184:8001/routes/?size=1 | python -m json.tool

返回值：

{
    "data": [
        {
            "created_at": 1538004899,
            "hosts": [],
            "id": "19377681-ba1c-43dc-9eb6-ff117467ce96",
            "methods": [
                "GET",
                "POST"
            ],
            "paths": [],
            "preserve_host": false,
            "protocols": [
                "http",
                "https"
            ],
            "regex_priority": 0,
            "service": {
                "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
            },
            "strip_path": true,
            "updated_at": 1538071225
        }
    ],
    "next": "/routes?offset=WyIxOTM3NzY4MS1iYTFjLTQzZGMtOWViNi1mZjExNzQ2N2NlOTYiXQ",
    "offset": "WyIxOTM3NzY4MS1iYTFjLTQzZGMtOWViNi1mZjExNzQ2N2NlOTYiXQ"
}

在上面的请求示例中，我们带了一个size的参数来限定每一页的数量，在返回的结果中有两个字段，next表示下一页的端点，offset是本页的偏移。

当然，如果你在读取下一页的时候还需要限定返回的数据，还是依然要使用size的参数

4、更新路由

接口信息：

接口名称 更新路由
请求端点 /routes/{id}
请求方法 PATCH
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
protocols string or list ["http", "https"] 否 此路由允许的协议，取值http或https
methods string or list null *否 此路由允许的方法
hosts string or list null *否 此路由允许的域名
paths string or list null *否 此路由匹配的path
strip_path bool true 否 匹配到path时，是否删除匹配到的前缀
preserve_host bool false 否 匹配到hosts时，使用请求头部的值为域名向后端发起请求，请求的头部为"host",例如"host:api.abc.com"
service string 是 关联的服务id。
这里需要特别注意，如果是以表达的形式发送的，需要以 service.id=<service_id>形式发送，如果是json，需要以"service":{"id":"<service_id>"}形式发送

请求示例：

curl -s -X PATCH --url http://192.168.0.184:8001/routes/6c6b7863-9a05-4d51-bf7e-8e4e5866a131 \
-d 'protocols=http' \
-d 'methods=GET'  \
-d 'paths=/weather' \
-d 'service.id=43921b23-65fc-4722-a4e0-99bf84e26593' \
| python -m json.tool

返回值：

{
    "created_at": 1538089668,
    "hosts": null,
    "id": "6c6b7863-9a05-4d51-bf7e-8e4e5866a131",
    "methods": [
        "GET"
    ],
    "paths": [
        "/weather"
    ],
    "preserve_host": false,
    "protocols": [
        "http"
    ],
    "regex_priority": 0,
    "service": {
        "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
    },
    "strip_path": true,
    "updated_at": 1538090658
}

此接口的参数和添加路由的参数一样，接入点带了路由的id，路由没有name字段，所有的匹配都是以ID匹配的。

5、更新或者添加路由

接口信息：

接口名称 更新或者添加路由
请求端点 /routes/{id}
请求方法 PUT
返回状态 HTTP 201 Created or HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
protocols string or list ["http", "https"] 否 此路由允许的协议，取值http或https
methods string or list null *否 此路由允许的方法
hosts string or list null *否 此路由允许的域名
paths string or list null *否 此路由匹配的path
strip_path bool true 否 匹配到path时，是否删除匹配到的前缀
preserve_host bool false 否 匹配到hosts时，使用请求头部的值为域名向后端发起请求，请求的头部为"host",例如"host:api.abc.com"
service string 是 关联的服务id。
这里需要特别注意，如果是以表达的形式发送的，需要以 service.id=<service_id>形式发送，如果是json，需要以"service":{"id":"<service_id>"}形式发送

请求示例：

curl -s -X PUT --url http://192.168.0.184:8001/routes/6c6b7863-9a05-4d51-bf7e-2962c1d6b0e6 \
-d 'protocols=http' \
-d 'methods=GET'  \
-d 'paths=/weather' \
-d 'service.id=43921b23-65fc-4722-a4e0-99bf84e26593' \
| python -m json.tool

返回值：

{
    "created_at": 1538091038,
    "hosts": null,
    "id": "6c6b7863-9a05-4d51-bf7e-2962c1d6b0e6",
    "methods": [
        "GET"
    ],
    "paths": [
        "/weather"
    ],
    "preserve_host": false,
    "protocols": [
        "http"
    ],
    "regex_priority": 0,
    "service": {
        "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
    },
    "strip_path": true,
    "updated_at": 1538091038
}

此接口的参数和添加路由的参数一样，接入点带了路由的id，路由没有name字段，所有的匹配都是以ID匹配的。

和服务的更新创建接口差不多，只不过路由没有name的字段，所以匹配均是按照id来匹配，所以规则比较简单：如果id存在则更新，如果id不存在则添加。

但是，此处的ID必须是UUID形式的ID，否则添加不成功。

6、查看和服务关联的路由

接口信息：

接口名称 查看和服务关联的路由
请求端点 /services/{service name or id}/routes
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/services/wechat/routes | python -m json.tool

返回值：

{
    "data": [
        {
            "created_at": 1538089623,
            "id": "cdfee2bc-a5eb-4f80-96f5-64bfe3b85507",
            "methods": [
                "GET"
            ],
            "preserve_host": false,
            "protocols": [
                "http",
                "https"
            ],
            "regex_priority": 0,
            "service": {
                "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
            },
            "strip_path": true,
            "updated_at": 1538089623
        },
        {
            "created_at": 1538089397,
            "id": "f8ef8876-9681-4629-a2ee-d7fac8a8094a",
            "methods": [
                "GET"
            ],
            "paths": [
                "/weather"
            ],
            "preserve_host": false,
            "protocols": [
                "http",
                "https"
            ],
            "regex_priority": 0,
            "service": {
                "id": "43921b23-65fc-4722-a4e0-99bf84e26593"
            },
            "strip_path": true,
            "updated_at": 1538089397
        }
    ],
    "next": null
}

7、查看和路由关联的服务

接口信息：

接口名称 查看和路由关联的服务
请求端点 /routes/{route id}/service
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/routes/f8ef8876-9681-4629-a2ee-d7fac8a8094a/service | python -m json.tool

返回值：

{
    "connect_timeout": 60000,
    "created_at": 1538000258,
    "host": "t.weather.sojson.com",
    "id": "43921b23-65fc-4722-a4e0-99bf84e26593",
    "name": "wechat",
    "path": "/api/weather/city/",
    "port": 80,
    "protocol": "http",
    "read_timeout": 60000,
    "retries": 5,
    "updated_at": 1538005796,
    "write_timeout": 60000
}

8、删除路由

接口信息：

接口名称 删除路由
请求端点 /routes/{id}
请求方法 DELETE
返回状态 HTTP 204 No Content

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/routes/f8ef8876-9681-4629-a2ee-d7fac8a8094a/service | python -m json.tool

返回值：

此接口没有返回值

五、用户

1、添加用户

接口信息：

接口名称 添加用户
请求端点 /consumers/
请求方法 POST
返回状态 HTTP 201 Created

请求参数:

参数名 类型 默认值 是否必须 说明
username string null *否 全局唯一的用户名
custom_id string null *否 全局唯一的用户ID

请求示例：

curl -s -X POST --url http://192.168.0.184:8001/consumers  -d 'username=linuxops' | python -m json.tool

返回值：

{
    "created_at": 1538126090,
    "custom_id": null,
    "id": "376a9ccf-7d10-45a7-a956-77eb129d8ff0",
    "username": "linuxops"
}

在上面示例中，我们指定了一个username来创建一个用户，从返回值看出，如果没有指定参数，那么默认值为空。

在调用这个接口，必须要指定username 和 custom_id其中一个参数，不能同时不指定。

在创建用户的时候，系统都将会生成一个UUID的形式的唯一ID。

2、查询用户

接口信息：

接口名称 查询用户
请求端点 /consumers/{username or id}
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s http://192.168.0.184:8001/consumers/linuxops | python -m json.tool

返回值：

{
    "created_at": 1538126090,
    "id": "376a9ccf-7d10-45a7-a956-77eb129d8ff0",
    "username": "linuxops"
}

查询用户只能通过系统ID和username来查询，无法通过custom_id查询

3、查询所有用户

接口信息：

接口名称 查询所有用户
请求端点 /consumers
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
offset string 否 分页偏移，用于定义列表中的唯一
size int 100 否 每页返回的对象的数量

请求示例：

curl -s http://192.168.0.184:8001/consumers?size=1 | python -m json.tool

返回值：

{
    "data": [
        {
            "created_at": 1538126090,
            "custom_id": null,
            "id": "376a9ccf-7d10-45a7-a956-77eb129d8ff0",
            "username": "linuxops"
        }
    ],
    "next": "/consumers?offset=WyIzNzZhOWNjZi03ZDEwLTQ1YTctYTk1Ni03N2ViMTI5ZDhmZjAiXQ",
    "offset": "WyIzNzZhOWNjZi03ZDEwLTQ1YTctYTk1Ni03N2ViMTI5ZDhmZjAiXQ"
}

在上面的请求示例中，我们带了一个size的参数来限定每一页的数量，在返回的结果中有两个字段，next表示下一页的端点，offset是本页的偏移。

当然，如果你在读取下一页的时候还需要限定返回的数据，还是依然要使用size的参数

4、更新用户

接口信息：

接口名称 更新用户
请求端点 /consumers/{username or id}
请求方法 PATCH
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
username string null *否 全局唯一的用户名
custom_id string null *否 全局唯一的用户ID

请求示例：

curl -s -X PATCH --url http://192.168.0.184:8001/consumers/376a9ccf-7d10-45a7-a956-77eb129d8ff0 -d "custom_id=linuxops123456789" | python -m json.tool

返回值：

{
    "created_at": 1538126090,
    "custom_id": "linuxops123456789",
    "id": "376a9ccf-7d10-45a7-a956-77eb129d8ff0",
    "username": "linuxops"
}

5、更新或者添加用户

接口信息：

接口名称 更新或者添加用户
请求端点 /consumers/{username or id}
请求方法 PUT
返回状态 HTTP 201 Created or HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
username string null *否 全局唯一的用户名
custom_id string null *否 全局唯一的用户ID

请求示例：

curl -s -X PUT --url http://192.168.0.184:8001/consumers/376a9ccf-7d10-45a7-a956-77eb129d8ff0 -d "custom_id=linuxops123456789" | python -m json.tool

返回值：

{
    "created_at": 1538127246,
    "custom_id": "linuxops123456789",
    "id": "376a9ccf-7d10-45a7-a956-77eb129d8ff0",
    "username": null
}

这个接口和更新添加服务的接口类似，当{username or id}属性具有UUID的结构时，插入/更新的Consumer将由其标识id。否则它将由它识别username。

6、删除用户

接口信息：

接口名称 删除用户
请求端点 /consumers/{username or id}
请求方法 DELETE
返回状态 HTTP 204 No Content

请求参数:

无

请求示例：

curl -i -X DELETE --url http://192.168.0.184:8001/consumers/376a9ccf-7d10-45a7-a956-77eb129d8ff0

返回值：

此操作没有返回值

六、插件

Kong提供了一个插件的功能，你可以通过配置指定某个服务或者路由或者用户启用某个插，插件始终只运行一次，所以对于不同的实体配置相同插件时就有优先级的概念。

多次配置插件的优先级如下：

  • 在以下组合上配置的插件：路由，服务和使用者。 （消费者意味着必须对请求进行身份验证）。
  • 在Route和Consumer的组合上配置的插件。 （消费者意味着必须对请求进行身份验证）。
  • 在服务和使用者的组合上配置的插件。 （消费者意味着必须对请求进行身份验证）。
  • 在路由和服务的组合上配置的插件。
  • 在Consumer上配置的插件。 （消费者意味着必须对请求进行身份验证）。
  • 在路由上配置的插件。
  • 在服务上配置的插件。
  • 配置为全局运行的插件。

从以上的优先级可以看出全局配置的插件优先级最小，而越具体的组合优先级越高。

1、添加插件

可以通过以下几种不同的方式添加插件：

  • 对于每个Service/Route和consumer。不要设置consumer_id和设置service_id或route_id。
  • 适用于每个Service/Route和特定consumer。只有设定consumer_id。
  • 适用于每个consumer和特定Service。仅设置service_id（警告：某些插件只允许设置route_id）
  • 对于每个consumer和特定的Route。仅设置route_id（警告：某些插件只允许设置service_id）
  • 对于特定的Service/Route和consumer。设置两个service_id/ route_id和consumer_id。

并非所有插件都允许指定consumer_id。检查插件文档。

接口信息：

接口名称 添加插件
请求端点 /plugins/
请求方法 POST
返回状态 HTTP 201 Created

请求参数:

参数名 类型 默认值 是否必须 说明
name string 是 要添加的插件的名称。目前，插件必须分别安装在每个Kong实例中。
consumer_id string null 否 使用者的唯一标识符，用于覆盖传入请求中此特定使用者的现有设置。
service_id string null 否 服务的唯一标识符，用于覆盖传入请求中此特定服务的现有设置。
route_id string null 否 路由的唯一标识符，它覆盖传入请求中此特定路由的现有设置。
config.{property} string null 否 插件的配置属性，可以在Kong Hub的插件文档页面找到。
enabled bool true 否 是否应用插件。默认值：true。

请求示例：

curl -s -X POST --url http://192.168.0.184:8001/plugins/ \
-d 'name=basic-auth' \
-d 'route_id=d1a10507-ea15-4c61-9d8c-7f10ebc79ecb' \
| python -m json.tool

返回值：

{
    "config": {
        "anonymous": "",
        "hide_credentials": false
    },
    "created_at": 1540102452000,
    "enabled": true,
    "id": "900aeaa3-0a47-49a1-9fea-649e6c90ab7f",
    "name": "basic-auth",
    "route_id": "d1a10507-ea15-4c61-9d8c-7f10ebc79ecb"
}

在上面的请求示例中，我们在route上添加了basic-auth插件，这个插件用于认证，通过http的头部带入用户名和密码信息进行认证。

当然，启用插件后，我们要对user设置好basic-auth的凭证,否则访问不了，并且返回如下信息：

{
"message": "Unauthorized"
}

2、查询插件

接口信息：

接口名称 查询插件
请求端点 /plugins/{id}
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
id string 是 要检索的插件的唯一标识符

请求示例：

curl -s  --url http://192.168.0.184:8001/plugins/900aeaa3-0a47-49a1-9fea-649e6c90ab7f  | python -m json.tool

返回值：

{
    "config": {
        "anonymous": "",
        "hide_credentials": false
    },
    "created_at": 1540102452000,
    "enabled": true,
    "id": "900aeaa3-0a47-49a1-9fea-649e6c90ab7f",
    "name": "basic-auth",
    "route_id": "d1a10507-ea15-4c61-9d8c-7f10ebc79ecb"
}

3、查询所有插件

接口信息：

接口名称 查询所有插件
请求端点 /plugins/
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
id string 否 通过id查询
name string 否 通过name查
service_id string 否 通过service_id查
route_id string 否 通过iroute_id查
consumer_id string 否 通过consumer_id查
offset string 否 分页偏移，用于定义列表中的唯一
size int 100 否 每页返回的对象的数量

请求示例：

curl -s --url http://192.168.0.184:8001/plugins/?size=1 | python -m json.tool

返回值：

{
    "data": [
        {
            "config": {
                "anonymous": "",
                "hide_credentials": false
            },
            "created_at": 1540102452000,
            "enabled": true,
            "id": "900aeaa3-0a47-49a1-9fea-649e6c90ab7f",
            "name": "basic-auth",
            "route_id": "d1a10507-ea15-4c61-9d8c-7f10ebc79ecb"
        }
    ],
    "total": 1
}

在上面的请求示例中，我们带了一个size的参数来限定每一页的数量，在返回的结果中有两个字段，next表示下一页的端点，offset是本页的偏移。

当然，如果你在读取下一页的时候还需要限定返回的数据，还是依然要使用size的参数

4、更新插件

接口信息：

接口名称 更新插件
请求端点 /plugins/{plugin id}
请求方法 PATCH
返回状态 HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
plugin id string 是 要更新的插件配置的唯一标识符
name string null 否 要添加的插件的名称要添加的插件的名称
consumer_id string null 否 使用者的唯一标识符，用于覆盖传入请求中此特定使用者的现有设置。
service_id string null 否 服务的唯一标识符，用于覆盖传入请求中此特定服务的现有设置。
route_id string null 否 路由的唯一标识符，它覆盖传入请求中此特定路由的现有设置。
config.{property} string null 否 插件的配置属性，可以在Kong Hub的插件文档页面找到。
enabled bool true 否 是否应用插件。

请求示例：

curl -s -X PATCH --url http://192.168.0.184:8001/plugins/900aeaa3-0a47-49a1-9fea-649e6c90ab7f -d "service_id=da4dce88-4df3-4723-b544-b11b27184e97" | python -m json.tool

返回值：

{
    "config": {
        "anonymous": "",
        "hide_credentials": false
    },
    "created_at": 1540102452000,
    "enabled": true,
    "id": "900aeaa3-0a47-49a1-9fea-649e6c90ab7f",
    "name": "basic-auth",
    "route_id": "d1a10507-ea15-4c61-9d8c-7f10ebc79ecb",
    "service_id": "da4dce88-4df3-4723-b544-b11b27184e97"
}

在上面的请求示例中，我更新了这个插件，原本只针对route启用的，现在又增加了对service生效，由此看出，一个插件是可以对多个实体生效的（前提是插件本身要支持此实体生效），因为插件只会在请求的生命周期中运行一次，所以对多个实体启用同一个插件会受到优先级的限制。

5、更新或添加插件

接口信息：

接口名称 更新或添加插件
请求端点 /plugins/
请求方法 PUT
返回状态 HTTP 201 Created or HTTP 200 OK

请求参数:

参数名 类型 默认值 是否必须 说明
name string null 否 要添加的插件的名称要添加的插件的名称
consumer_id string null 否 使用者的唯一标识符，用于覆盖传入请求中此特定使用者的现有设置。
service_id string null 否 服务的唯一标识符，用于覆盖传入请求中此特定服务的现有设置。
route_id string null 否 路由的唯一标识符，它覆盖传入请求中此特定路由的现有设置。
config.{property} string null 否 插件的配置属性，可以在Kong Hub的插件文档页面找到。
enabled bool true 否 是否应用插件。

请求示例：

curl -s -X PUT --url http://192.168.0.184:8001/plugins/900aeaa3-0a47-49a1-9fea-649e6c90ab7f -d "service_id=da4dce88-4df3-4723-b544-b11b27184e97" | python -m json.tool

返回值：

{
    "config": {
        "anonymous": "",
        "hide_credentials": false
    },
    "created_at": 1540102452000,
    "enabled": true,
    "id": "900aeaa3-0a47-49a1-9fea-649e6c90ab7f",
    "name": "basic-auth",
    "route_id": "d1a10507-ea15-4c61-9d8c-7f10ebc79ecb",
    "service_id": "da4dce88-4df3-4723-b544-b11b27184e97"
}

这个接口是更新或者创建一个插件。

如果传入的参数name已经存在，那么以传入的参数修改此插件，如果name不存在，则以传入的参数创建此插件。

6、删除插件

接口信息：

接口名称 删除插件
请求端点 /plugins/{plugin id}
请求方法 DELETE
返回状态 HTTP 204 No Content

请求参数:

参数名 类型 默认值 是否必须 说明
plugin id string 是 要删除的插件配置的唯一标识符

请求示例：

curl -s -X DELETE --url http://192.168.0.184:8001/plugins/900aeaa3-0a47-49a1-9fea-649e6c90ab7f | python -m json.tool

返回值：

此操作没有返回值

7、查询已启用的插件

接口信息：

接口名称 查询已启用的插件
请求端点 /plugins/enabled
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s -X GET --url http://192.168.0.184:8001/plugins/enabled | python -m json.tool

返回值：

{
    "enabled_plugins": [
        "response-transformer",
        "oauth2",
        "acl",
        "correlation-id",
        "pre-function",
        "jwt",
        "cors",
        "ip-restriction",
        "basic-auth",
        "key-auth",
        "rate-limiting",
        "request-transformer",
        "http-log",
        "file-log",
        "hmac-auth",
        "ldap-auth",
        "datadog",
        "tcp-log",
        "zipkin",
        "post-function",
        "request-size-limiting",
        "bot-detection",
        "syslog",
        "loggly",
        "azure-functions",
        "udp-log",
        "response-ratelimiting",
        "aws-lambda",
        "statsd",
        "prometheus",
        "request-termination"
    ]
}

返回Kong示例启用了那些插件，只有已经启用的插件才能被应用在实体上，需要说明的是，在kong集群中，插件启用的情况要一致。

8、检索插件架构

接口信息：

接口名称 检索插件架构
请求端点 /plugins/schema/{plugin name}
请求方法 GET
返回状态 HTTP 200 OK

请求参数:

无

请求示例：

curl -s -X GET --url http://192.168.0.184:8001/plugins/schema/basic-auth | python -m json.tool

返回值：

{
    "fields": {
        "anonymous": {
            "default": "",
            "func": "function",
            "type": "string"
        },
        "hide_credentials": {
            "default": false,
            "type": "boolean"
        }
    },
    "no_consumer": true
}

可以通过此接口了解插件接受哪些字段。

七、证书

八、SNI

九、上游信息

十、目标

本文转载自：https://linuxops.org/blog/kong/admin.html

相关标签： Kong

上一篇： 程序设计基石与实践系列之编写高效的C程序与C代码优化

下一篇： kong使用入门

推荐阅读