
# x-apigateway-ratelimits.policy
**含义**：流控策略定义。
**作用域** ：[x-apigateway-ratelimits](https://support.huaweicloud.com/usermanual-apig/apig_03_0099.html)
**示例**：
```
x-apigateway-ratelimits:
  customRatelimitName:
    api-limit: 200
    app-limit: 200
    user-limit: 200
    ip-limit: 200
    interval: 1
    unit: MINUTE
    shared: false
    special: 
      - type: USER
        limit: 100
        instance: xxxxxxx
```
表1参数说明 
| 参数         | 是否必选 | 类型                                                                                                                                                                           | 说明                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| api-limit  | 是    | Number                                                                                                                                                                       | API访问次数限制。                                                                                                                                                                                                                                                                                    |
| user-limit | 否    | Number                                                                                                                                                                       | 用户访问次数限制。                                                                                                                                                                                                                                                                                     |
| app-limit  | 否    | Number                                                                                                                                                                       | 应用访问次数限制。                                                                                                                                                                                                                                                                                     |
| ip-limit   | 否    | Number                                                                                                                                                                       | 源IP访问次数限制。                                                                                                                                                                                                                                                                                    |
| interval   | 是    | Number                                                                                                                                                                       | 流控策略时间周期。                                                                                                                                                                                                                                                                                     |
| unit       | 是    | String                                                                                                                                                                       | 流控策略时间周期单位，支持SECOND、MINUTE、HOUR、DAY。                                                                                                                                                                                                                                                          |
| shared     | 否    | Boolean                                                                                                                                                                      | 是否共享流控策略。 - false：对单个API进行流量统计和控制。  - true：对绑定了该策略的所有API进行总流量统计和控制。   |
| special    | 否    | [x-apigateway-ratelimits.policy.special](https://support.huaweicloud.com/usermanual-apig/apig_03_0101.html) 对象数组 | 特殊流控策略。                                                                                                                                                                                                                                                                                       |
   
