批量创建限流规则

请求参数

Header 参数

X-Polaris-Token

string

可选

鉴权凭据，当OpenAPI接口鉴权开启时必须开启

Body 参数application/json

array of:

name

string

规则名称

必需

service

string

规则所属服务名

必需

namespace

string

规则所属命名空间

必需

amounts

array [object {5}]

限流阈值

必需

可以有多个粒度的配置（比如同时针对秒级，分钟级，天级），匹配一个则进行限流，全局限流模式下，该值为服务配额总量；单机限流模式下，该值为单个节点能处理的配额量

maxAmount

integer

必需

时间周期内的最大配额数

precision

integer

请求统计精度

必需

validDuration

string

配额生效的时间周期

必需

格式为 {number}s，必须大于等于1s

startAmount

integer

可选

可选，起始限流阈值，爬坡起始值

minAmount

integer

可选

可选，最小限流阈值，降低时最小值

arguments

array [object {3}]

流量标签

可选

key

string

标签 Key

可选

type

string

标签类型

可选

HEADER：请求头/QUERY：请求参数/METHOD：方法（GET|POST等）/CUSTOM：用户自定义标签/CALLER_IP：主调IP/CALLER_SERVICE：主调服务

value

object (MatchString)

标签 Value

可选

disable

boolean

是否禁用

必需

failover

string

全局限流降级策略

必需

FAILOVER_LOCAL：降级为单机限流/FAILOVER_PASS：请求直接放通

max_queue_delay

integer

匀速排队最大排队时间

必需

method

object

限流接口

必需

type

string

匹配模式

必需

默认值填写为：EXACT

value

string

参数值

必需

默认值填写为：*

value_type

string

参数类型

必需

只能填写 TEXT

priority

integer

规则优先级

必需

regex_combine

boolean

通配符是否合并计算

必需

默认分开计数

revision

string

规则摘要

可选

type

string

限流类型

必需

GLOBAL：全局限流/LOCAL：单机限流

示例

[
  {
    "name": "string",
    "service": "string",
    "namespace": "string",
    "amounts": [
      {
        "maxAmount": 0,
        "precision": 0,
        "validDuration": "string",
        "startAmount": 0,
        "minAmount": 0
      }
    ],
    "arguments": [
      {
        "key": "string",
        "type": "string",
        "value": {
          "type": "string",
          "value": "string",
          "value_type": "string"
        }
      }
    ],
    "disable": true,
    "failover": "string",
    "max_queue_delay": 0,
    "method": {
      "type": "string",
      "value": "string",
      "value_type": "string"
    },
    "priority": 0,
    "regex_combine": true,
    "revision": "string",
    "type": "string"
  }
]

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://119.91.66.223:8090/naming/v1/ratelimits' \
--header 'X-Polaris-Token;' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

code

integer

状态码

可选

info

string

提示信息

可选

示例

{
  "code": 0,
  "info": "string"
}