apisix/docs/en/latest/architecture-design/global-rule.md

52 lines
1.6 KiB
Markdown
Raw Normal View History

---
title: Global rule
---
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-->
[Plugin](plugin.md) just can be binded to [Service](service.md) or [Route](route.md), if we want a [Plugin](plugin.md) work on all requests, how to do it?
We can register a global [Plugin](plugin.md) with `GlobalRule`:
```shell
curl -X PUT \
https://{apisix_listen_address}/apisix/admin/global_rules/1 \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' \
-d '{
"plugins": {
"limit-count": {
"time_window": 60,
"policy": "local",
"count": 2,
"key": "remote_addr",
"rejected_code": 503
}
}
}'
```
Now, the `limit-count` plugin will work on all requests
we can list all `GlobalRule` via admin api as below:
```shell
curl https://{apisix_listen_address}/apisix/admin/global_rules
```