获取限流规则列表

请求参数

Query 参数

id

string

规则ID

可选

name

string

规则名称

可选

service

string

服务名称

可选

namespace

string

命名空间

可选

method

string

限流接口名称

可选

disable

string

可选

规则是否启用，true为不启用，false为启用

brief

string

可选

是否只显示概要信息，brief=true时，只返回规则列表概要信息，默认为false

limt

integer

可选

分页偏移量，默认为0

offset

integer

可选

分页条数，最大为 100

Header 参数

X-Polaris-Token

string

可选

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

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://119.91.66.223:8090/naming/v1/ratelimits?id=&name=&service=&namespace=&method=&disable=&brief=&limt=&offset=' \
--header 'X-Polaris-Token;'

返回响应

🟢200成功

application/json

Body

amount

integer

总数

必需

code

integer

响应码

必需

info

string

提示信息

必需

size

integer

当前返回数据条数

必需

rateLimits

array[object (限流规则) {17}]

限流规则列表

必需

id

string

规则ID

必需

更新/删除/启用/禁用规则时必须填写

name

string

规则名称

必需

service

string

规则所属服务名

必需

namespace

string

规则所属命名空间

必需

amounts

array [object {5}]

限流阈值

必需

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

arguments

array [object {3}]

流量标签

可选

disable

boolean

是否禁用

必需

failover

string

全局限流降级策略

必需

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

max_queue_delay

integer

匀速排队最大排队时间

必需

method

object

限流接口

必需

priority

integer

规则优先级

必需

regex_combine

boolean

通配符是否合并计算

必需

默认分开计数

revision

string

规则摘要

可选

type

string

限流类型

必需

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

ctime

string

创建时间

可选

格式：2006-01-02 15:04:05

mtime

string

修改时间

可选

格式：2006-01-02 15:04:05

etime

string

启用时间

可选

格式：2006-01-02 15:04:05

示例

{
  "amount": 0,
  "code": 0,
  "info": "string",
  "size": 0,
  "rateLimits": [
    {
      "id": "string",
      "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",
      "ctime": "string",
      "mtime": "string",
      "etime": "string"
    }
  ]
}