kong插件之Rate Limiting

文章来源：http://blog.csdn.net/qq_26656329/article/details/78842005

关于Response Rate Limiting插件

说明

插件实现是在每个代理upstream API之前添加header信息，以便正确的拒绝处理该请求;
插件启用的时候,响应时会告诉客户端可以请求多少次、有多少次请求可以用;
比如:

X-RateLimit-Limit-Videos-Minute: 10
X-RateLimit-Remaining-Videos-Minute: 9

如果有多种限制组合，则返回更多的限制组合

Rate Limiting插件常用参数

尽量把每个参数都测试一遍

name:插件名称,必选参数,每月默认值;
consumer_id:消费者id,可选参数,没有默认值,如果留空,该插件将适用于所有消费者;
config.second:每秒请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.minute:每分钟请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.hour:每小时请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.day:每天请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.month:每月请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.year:每年请求限制(int),半可选参数(限制必须存在一项),没有默认值;
config.limit_by:可以使consumer、credential或ip,默认是消费者,如果consumer或credential没有设置时,根据ip来限制,可选参数;

# 小时天和年的太久了就没测试

config.hide_client_headers:是否隐藏头信息,可选参数,默认False;

添加API

function add_api($data=[])
{
    if (empty($data)){
        $data = [
            'name' => 'ip_api',
            'upstream_url' => 'http://ip.taobao.com/service/getIpInfo.php?ip=14.215.177.39',
            'methods' => 'GET',
            'uris' => '/ip/query'
        ];
    }
    $curl = curl_init('http://localhost:8001/apis/');
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
    $output = curl_exec($curl);
    curl_close($curl);
    return $output;
}
print_r(add_api());exit;

返回值

{
    "created_at":1513673389000,
    "strip_uri":true,
    "id":"bbe7aaae-ea06-43ad-a69c-43b0889faf26",
    "name":"ip_api",
    "methods":[
        "GET"
    ],
    "http_if_terminated":false,
    "preserve_host":false,
    "upstream_url":"http://ip.taobao.com/service/getIpInfo.php?ip=14.215.177.39",
    "uris":[
        "/ip/query"
    ],
    "upstream_send_timeout":60000,
    "upstream_connect_timeout":60000,
    "upstream_read_timeout":60000,
    "retries":5,
    "https_only":false
}

关联插件

function rate_limiting($api_name = '', $data = [])
{
    if(empty($data)){
        $data = [
            'name' => 'rate-limiting',
            'config.minute' => 5,
        ];
    }
    $curl = curl_init(sprintf('http://localhost:8001/apis/%s/plugins', $api_name));
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
    $output = curl_exec($curl);
    curl_close($curl);
    return $output;
}
print_r(rate_limiting('ip_api'));exit;

返回值

{
    "created_at":1513673424000,
    "config":{
        "hide_client_headers":false,
        "minute":5,
        "policy":"cluster",
        "redis_database":0,
        "redis_timeout":2000,
        "redis_port":6379,
        "limit_by":"consumer",
        "fault_tolerant":true
    },
    "id":"85d76dae-b50e-4e25-9f6b-1032a7e92a6f",
    "name":"rate-limiting",
    "api_id":"bbe7aaae-ea06-43ad-a69c-43b0889faf26",
    "enabled":true
}

通过http://localhost:8001端口来看看这个API的信息

// http://localhost:8001/apis/ip_api
{
    "created_at":1513673389000,
    "strip_uri":true,
    "id":"bbe7aaae-ea06-43ad-a69c-43b0889faf26",
    "name":"ip_api",
    "methods":[
        "GET"
    ],
    "http_if_terminated":false,
    "https_only":false,
    "upstream_url":"http://ip.taobao.com/service/getIpInfo.php?ip=14.215.177.39",
    "uris":[
        "/ip/query"
    ],
    "preserve_host":false,
    "upstream_connect_timeout":60000,
    "upstream_read_timeout":60000,
    "upstream_send_timeout":60000,
    "retries":5
}

// http://localhost:8001/apis/ip_api/plugins
{
    "total":1,
    "data":[
        {
            "created_at":1513673424000,
            "config":{
                "hide_client_headers":false,
                "minute":5,
                "policy":"cluster",
                "redis_database":0,
                "redis_timeout":2000,
                "redis_port":6379,
                "limit_by":"consumer",
                "fault_tolerant":true
            },
            "id":"85d76dae-b50e-4e25-9f6b-1032a7e92a6f",
            "enabled":true,
            "api_id":"bbe7aaae-ea06-43ad-a69c-43b0889faf26",
            "name":"rate-limiting"
        }
    ]
}

添加限制组合

function add_limiting($api_name = '', $plugin_id = '', $data = [])
{
    if(empty($data)){
        $data = [
            'name' => 'rate-limiting',
            'config.second' => 1,
        ];
    }
    $curl = curl_init("http://localhost:8001/apis/{$api_name}/plugins/{$plugin_id}");
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
    curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
    $output = curl_exec($curl);
    curl_close($curl);
    return $output;
}
print_r(add_limiting('ip_api', '85d76dae-b50e-4e25-9f6b-1032a7e92a6f'));exit;

返回值

{
    "created_at":1513673424000,
    "config":{
        "minute":5,
        "policy":"cluster",
        "redis_timeout":2000,
        "hide_client_headers":false,
        "second":1,
        "limit_by":"consumer",
        "redis_port":6379,
        "redis_database":0,
        "fault_tolerant":true
    },
    "id":"85d76dae-b50e-4e25-9f6b-1032a7e92a6f",
    "name":"rate-limiting",
    "api_id":"bbe7aaae-ea06-43ad-a69c-43b0889faf26",
    "enabled":true
}

测试

头信息

curl -I -X GET http://localhost:8000/ip/query

HTTP/1.1 200 OK
Content-Type: text/html; charset=UTF-8
Transfer-Encoding: chunked
Connection: keep-alive
X-RateLimit-Limit-minute: 5
X-RateLimit-Remaining-minute: 4
Server: Tengine
Date: Tue, 19 Dec 2017 08:57:18 GMT
Vary: Accept-Encoding
X-Powered-By: PHP/5.3.6
X-Kong-Upstream-Latency: 59
X-Kong-Proxy-Latency: 23
Via: kong/0.11.0

访问测试

for ($i = 0; $i < 10; $i++){
    $curl = curl_init('http://localhost:8000/ip/query');
    curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
    $output = curl_exec($curl);
    curl_close($curl);
    print_r($output);
}
exit();

{
    "code":1,
    "data":"no ip param."
}
{
    "message":"API rate limit exceeded"
}