Lattice.Hub

限流规则与 release。

默认 Base URL：http://127.0.0.1:8090。管理面接口需 Authorization（登录返回的 token）。

限流

限流：查询、创建/更新、删除与 releases（发布 / 回滚 / 停灰度）。body 为规则数组；字段以 specification 为准。

GET/naming/v1/ratelimits需要鉴权

查询限流

分页查询限流。

参数

Authorizationheader · string必填
登录返回的 token。
idquery · string可选
按 ID。
namequery · string可选
按名称。
namespacequery · string可选
按命名空间。
servicequery · string可选
按服务。
enablequery · bool可选
是否启用。
offsetquery · integer可选
偏移，默认 0。
limitquery · integer可选
分页大小，常见上限 100。

请求示例

curl -sS 'http://127.0.0.1:8090/naming/v1/ratelimits?limit=20' \
  -H "Authorization: $TOKEN"

响应示例

{
  "code": 200000,
  "info": "execute success",
  "data": [{ "id": "...", "name": "demo", "enable": true }]
}

GET/naming/v1/ratelimits/detail需要鉴权

查询限流详情

按 id 等条件查单条详情。

参数

Authorizationheader · string必填
登录返回的 token。
idquery · string可选
按 ID。
namequery · string可选
按名称。
namespacequery · string可选
按命名空间。
servicequery · string可选
按服务。
enablequery · bool可选
是否启用。
offsetquery · integer可选
偏移，默认 0。
limitquery · integer可选
分页大小，常见上限 100。

请求示例

curl -sS 'http://127.0.0.1:8090/naming/v1/ratelimits/detail?id=<id>' \
  -H "Authorization: $TOKEN"

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/ratelimits需要鉴权

创建限流

写接口 body 多为 protobuf 消息数组；下列为单条对象字段（见 specification）。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RateLimit[]必填
请求体为 RateLimit 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
限流规则唯一标识
namebody · string必填
限流规则名称
prioritybody · uint32可选
限流规则优先级，0值最高
typebody · enum(Type)可选
type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]可选
rules
- namebody · string可选
  限流规则名
- apisbody · API[]可选
  apis
  - protocolbody · string可选
    API的协议，*或者为空代表全部
  - methodbody · string可选
    API的方法，*或者为空代表全部
  - pathbody · MatchString可选
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- resourcebody · enum(Resource)可选
  resource 枚举：QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]可选
  arguments
  - typebody · enum(Type)可选
    type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · string可选
    header key or query key
  - valuebody · MatchString可选
    header value or query value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- amountsbody · Amount[]可选
  amounts
  - maxAmountbody · uint32可选
    时间周期内的最大配额数
  - validDurationbody · duration可选
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32可选
    请求统计精度
  - startAmountbody · uint32可选
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32可选
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32可选
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmount可选
  amount for concurrency rate-limit
  - max_amountbody · uint32可选
    max_amount
- custom_responsebody · CustomResponse可选
  fallback configuration
  - codebody · string可选
    code
  - headersbody · map<string,string>可选
    headers
  - bodybody · string可选
    body
- regex_combinebody · bool可选
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)可选
  failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · string可选
  限流动作，和 resource 配合决定插件名称
- disablebody · bool可选
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)可选
  amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · bool可选
是否停用该限流规则，默认启用
reportbody · Report可选
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · duration可选
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32可选
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitCluster可选
分布式限流服务集群
- servicebody · string可选
  service
- namespacebody · string可选
  限流规则所属命名空间
metadatabody · map<string,string>可选
metadata
namespacebody · string必填
namespace identifies the environment that owns this rule.

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
rateLimitbody · RateLimit可选
返回中的 RateLimit 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  限流规则唯一标识
- namebody · string可选
  限流规则名称
- prioritybody · uint32可选
  限流规则优先级，0值最高
- typebody · enum(Type)可选
  type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
- rulesbody · LimitTrigger[]可选
  rules
  - namebody · string可选
    限流规则名
  - apisbody · API[]可选
    apis
    - protocolbody · string可选
      API的协议，*或者为空代表全部
    - methodbody · string可选
      API的方法，*或者为空代表全部
    - pathbody · MatchString可选
      API的路径，支持多种匹配方式
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - resourcebody · enum(Resource)可选
    resource 枚举：QPS | CONCURRENCY | SYSTEM
  - argumentsbody · MatchArgument[]可选
    arguments
    - typebody · enum(Type)可选
      type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - keybody · string可选
      header key or query key
    - valuebody · MatchString可选
      header value or query value
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - amountsbody · Amount[]可选
    amounts
    - maxAmountbody · uint32可选
      时间周期内的最大配额数
    - validDurationbody · duration可选
      配额生效的时间周期，必须大于等于1s
    - precisionbody · uint32可选
      请求统计精度
    - startAmountbody · uint32可选
      可选，起始限流阈值，爬坡起始值
    - minAmountbody · uint32可选
      可选，最小限流阈值，降低时最小值
  - max_queue_delaybody · uint32可选
    最大排队时长，单位秒
  - concurrency_amountbody · ConcurrencyAmount可选
    amount for concurrency rate-limit
    - max_amountbody · uint32可选
      max_amount
  - custom_responsebody · CustomResponse可选
    fallback configuration
    - codebody · string可选
      code
    - headersbody · map<string,string>可选
      headers
    - bodybody · string可选
      body
  - regex_combinebody · bool可选
    通配符是否合并计算，默认分开计数
  - failoverbody · enum(FailoverType)可选
    failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
  - actionbody · string可选
    限流动作，和 resource 配合决定插件名称
  - disablebody · bool可选
    是否停用该限流规则，默认启用
  - amount_modebody · enum(AmountMode)可选
    amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
- revisionbody · string可选
  限流规则汇总的revision信息
- disablebody · bool可选
  是否停用该限流规则，默认启用
- reportbody · Report可选
  限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
  - intervalbody · duration可选
    配额固定上报周期，单位毫秒
  - amountPercentbody · uint32可选
    使用了百分之多少配额后启动一次实时上报，值范围(0,100]
- clusterbody · RateLimitCluster可选
  分布式限流服务集群
  - servicebody · string可选
    service
  - namespacebody · string可选
    限流规则所属命名空间
- ctimebody · string可选
  限流规则创建时间
- mtimebody · string可选
  限流规则修改时间
- metadatabody · map<string,string>可选
  metadata
- editablebody · bool可选
  操作标志位
- deleteablebody · bool可选
  deleteable
- namespacebody · string可选
  namespace identifies the environment that owns this rule.

请求示例

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/ratelimits' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"demo-limit","enable":true}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

PUT/naming/v1/ratelimits需要鉴权

更新限流

更新规则；body 为数组。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RateLimit[]必填
请求体为 RateLimit 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
限流规则唯一标识
namebody · string可选
限流规则名称
prioritybody · uint32可选
限流规则优先级，0值最高
typebody · enum(Type)可选
type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]可选
rules
- namebody · string可选
  限流规则名
- apisbody · API[]可选
  apis
  - protocolbody · string可选
    API的协议，*或者为空代表全部
  - methodbody · string可选
    API的方法，*或者为空代表全部
  - pathbody · MatchString可选
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- resourcebody · enum(Resource)可选
  resource 枚举：QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]可选
  arguments
  - typebody · enum(Type)可选
    type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · string可选
    header key or query key
  - valuebody · MatchString可选
    header value or query value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- amountsbody · Amount[]可选
  amounts
  - maxAmountbody · uint32可选
    时间周期内的最大配额数
  - validDurationbody · duration可选
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32可选
    请求统计精度
  - startAmountbody · uint32可选
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32可选
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32可选
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmount可选
  amount for concurrency rate-limit
  - max_amountbody · uint32可选
    max_amount
- custom_responsebody · CustomResponse可选
  fallback configuration
  - codebody · string可选
    code
  - headersbody · map<string,string>可选
    headers
  - bodybody · string可选
    body
- regex_combinebody · bool可选
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)可选
  failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · string可选
  限流动作，和 resource 配合决定插件名称
- disablebody · bool可选
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)可选
  amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · bool可选
是否停用该限流规则，默认启用
reportbody · Report可选
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · duration可选
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32可选
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitCluster可选
分布式限流服务集群
- servicebody · string可选
  service
- namespacebody · string可选
  限流规则所属命名空间
metadatabody · map<string,string>可选
metadata
namespacebody · string可选
namespace identifies the environment that owns this rule.

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
rateLimitbody · RateLimit可选
返回中的 RateLimit 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  限流规则唯一标识
- namebody · string可选
  限流规则名称
- prioritybody · uint32可选
  限流规则优先级，0值最高
- typebody · enum(Type)可选
  type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
- rulesbody · LimitTrigger[]可选
  rules
  - namebody · string可选
    限流规则名
  - apisbody · API[]可选
    apis
    - protocolbody · string可选
      API的协议，*或者为空代表全部
    - methodbody · string可选
      API的方法，*或者为空代表全部
    - pathbody · MatchString可选
      API的路径，支持多种匹配方式
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - resourcebody · enum(Resource)可选
    resource 枚举：QPS | CONCURRENCY | SYSTEM
  - argumentsbody · MatchArgument[]可选
    arguments
    - typebody · enum(Type)可选
      type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - keybody · string可选
      header key or query key
    - valuebody · MatchString可选
      header value or query value
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - amountsbody · Amount[]可选
    amounts
    - maxAmountbody · uint32可选
      时间周期内的最大配额数
    - validDurationbody · duration可选
      配额生效的时间周期，必须大于等于1s
    - precisionbody · uint32可选
      请求统计精度
    - startAmountbody · uint32可选
      可选，起始限流阈值，爬坡起始值
    - minAmountbody · uint32可选
      可选，最小限流阈值，降低时最小值
  - max_queue_delaybody · uint32可选
    最大排队时长，单位秒
  - concurrency_amountbody · ConcurrencyAmount可选
    amount for concurrency rate-limit
    - max_amountbody · uint32可选
      max_amount
  - custom_responsebody · CustomResponse可选
    fallback configuration
    - codebody · string可选
      code
    - headersbody · map<string,string>可选
      headers
    - bodybody · string可选
      body
  - regex_combinebody · bool可选
    通配符是否合并计算，默认分开计数
  - failoverbody · enum(FailoverType)可选
    failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
  - actionbody · string可选
    限流动作，和 resource 配合决定插件名称
  - disablebody · bool可选
    是否停用该限流规则，默认启用
  - amount_modebody · enum(AmountMode)可选
    amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
- revisionbody · string可选
  限流规则汇总的revision信息
- disablebody · bool可选
  是否停用该限流规则，默认启用
- reportbody · Report可选
  限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
  - intervalbody · duration可选
    配额固定上报周期，单位毫秒
  - amountPercentbody · uint32可选
    使用了百分之多少配额后启动一次实时上报，值范围(0,100]
- clusterbody · RateLimitCluster可选
  分布式限流服务集群
  - servicebody · string可选
    service
  - namespacebody · string可选
    限流规则所属命名空间
- ctimebody · string可选
  限流规则创建时间
- mtimebody · string可选
  限流规则修改时间
- metadatabody · map<string,string>可选
  metadata
- editablebody · bool可选
  操作标志位
- deleteablebody · bool可选
  deleteable
- namespacebody · string可选
  namespace identifies the environment that owns this rule.

请求示例

curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/ratelimits' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"demo-limit","enable":true}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/ratelimits/delete需要鉴权

删除限流

删除规则；body 为含 id 的数组。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RateLimit[]必填
请求体为 RateLimit 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
限流规则唯一标识
namebody · string可选
限流规则名称
prioritybody · uint32可选
限流规则优先级，0值最高
typebody · enum(Type)可选
type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]可选
rules
- namebody · string可选
  限流规则名
- apisbody · API[]可选
  apis
  - protocolbody · string可选
    API的协议，*或者为空代表全部
  - methodbody · string可选
    API的方法，*或者为空代表全部
  - pathbody · MatchString可选
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- resourcebody · enum(Resource)可选
  resource 枚举：QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]可选
  arguments
  - typebody · enum(Type)可选
    type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · string可选
    header key or query key
  - valuebody · MatchString可选
    header value or query value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- amountsbody · Amount[]可选
  amounts
  - maxAmountbody · uint32可选
    时间周期内的最大配额数
  - validDurationbody · duration可选
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32可选
    请求统计精度
  - startAmountbody · uint32可选
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32可选
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32可选
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmount可选
  amount for concurrency rate-limit
  - max_amountbody · uint32可选
    max_amount
- custom_responsebody · CustomResponse可选
  fallback configuration
  - codebody · string可选
    code
  - headersbody · map<string,string>可选
    headers
  - bodybody · string可选
    body
- regex_combinebody · bool可选
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)可选
  failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · string可选
  限流动作，和 resource 配合决定插件名称
- disablebody · bool可选
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)可选
  amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · bool可选
是否停用该限流规则，默认启用
reportbody · Report可选
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · duration可选
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32可选
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitCluster可选
分布式限流服务集群
- servicebody · string可选
  service
- namespacebody · string可选
  限流规则所属命名空间
metadatabody · map<string,string>可选
metadata
namespacebody · string可选
namespace identifies the environment that owns this rule.

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
rateLimitbody · RateLimit可选
返回中的 RateLimit 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  限流规则唯一标识
- namebody · string可选
  限流规则名称
- prioritybody · uint32可选
  限流规则优先级，0值最高
- typebody · enum(Type)可选
  type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
- rulesbody · LimitTrigger[]可选
  rules
  - namebody · string可选
    限流规则名
  - apisbody · API[]可选
    apis
    - protocolbody · string可选
      API的协议，*或者为空代表全部
    - methodbody · string可选
      API的方法，*或者为空代表全部
    - pathbody · MatchString可选
      API的路径，支持多种匹配方式
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - resourcebody · enum(Resource)可选
    resource 枚举：QPS | CONCURRENCY | SYSTEM
  - argumentsbody · MatchArgument[]可选
    arguments
    - typebody · enum(Type)可选
      type 枚举：CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - keybody · string可选
      header key or query key
    - valuebody · MatchString可选
      header value or query value
      - typebody · enum(MatchStringType)可选
        type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
      - valuebody · string可选
        value
      - value_typebody · enum(ValueType)可选
        value_type 枚举：TEXT | PARAMETER
  - amountsbody · Amount[]可选
    amounts
    - maxAmountbody · uint32可选
      时间周期内的最大配额数
    - validDurationbody · duration可选
      配额生效的时间周期，必须大于等于1s
    - precisionbody · uint32可选
      请求统计精度
    - startAmountbody · uint32可选
      可选，起始限流阈值，爬坡起始值
    - minAmountbody · uint32可选
      可选，最小限流阈值，降低时最小值
  - max_queue_delaybody · uint32可选
    最大排队时长，单位秒
  - concurrency_amountbody · ConcurrencyAmount可选
    amount for concurrency rate-limit
    - max_amountbody · uint32可选
      max_amount
  - custom_responsebody · CustomResponse可选
    fallback configuration
    - codebody · string可选
      code
    - headersbody · map<string,string>可选
      headers
    - bodybody · string可选
      body
  - regex_combinebody · bool可选
    通配符是否合并计算，默认分开计数
  - failoverbody · enum(FailoverType)可选
    failover 枚举：FAILOVER_LOCAL | FAILOVER_PASS
  - actionbody · string可选
    限流动作，和 resource 配合决定插件名称
  - disablebody · bool可选
    是否停用该限流规则，默认启用
  - amount_modebody · enum(AmountMode)可选
    amount_mode 枚举：GLOBAL_TOTAL | SHARE_EQUALLY
- revisionbody · string可选
  限流规则汇总的revision信息
- disablebody · bool可选
  是否停用该限流规则，默认启用
- reportbody · Report可选
  限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
  - intervalbody · duration可选
    配额固定上报周期，单位毫秒
  - amountPercentbody · uint32可选
    使用了百分之多少配额后启动一次实时上报，值范围(0,100]
- clusterbody · RateLimitCluster可选
  分布式限流服务集群
  - servicebody · string可选
    service
  - namespacebody · string可选
    限流规则所属命名空间
- ctimebody · string可选
  限流规则创建时间
- mtimebody · string可选
  限流规则修改时间
- metadatabody · map<string,string>可选
  metadata
- editablebody · bool可选
  操作标志位
- deleteablebody · bool可选
  deleteable
- namespacebody · string可选
  namespace identifies the environment that owns this rule.

请求示例

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/ratelimits/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"id":"<rule-id>"}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/ratelimits/releases需要鉴权

发布限流

发布 release，使客户端读到 active 视图。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RuleRelease[]必填
请求体为 RuleRelease 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
id
rule_idbody · string可选
rule_id
rule_namebody · string可选
rule_name
release_namebody · string可选
release_name
descriptionbody · string可选
description
release_typebody · string可选
release_type
client_labelsbody · ClientLabel[]可选
client_labels
- keybody · string可选
  key
- valuebody · MatchString可选
  value
  - typebody · enum(MatchStringType)可选
    type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · string可选
    value
  - value_typebody · enum(ValueType)可选
    value_type 枚举：TEXT | PARAMETER
versionbody · uint64可选
version
resourcebody · enum(RuleType)可选
resource 枚举：

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
ruleReleasebody · RuleRelease可选
返回中的 RuleRelease 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  id
- rule_idbody · string可选
  rule_id
- rule_namebody · string可选
  rule_name
- release_namebody · string可选
  release_name
- descriptionbody · string可选
  description
- release_typebody · string可选
  release_type
- client_labelsbody · ClientLabel[]可选
  client_labels
  - keybody · string可选
    key
  - valuebody · MatchString可选
    value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- versionbody · uint64可选
  version
- resourcebody · enum(RuleType)可选
  resource 枚举：
- activebody · bool可选
  active
- ctimebody · string可选
  ctime
- mtimebody · string可选
  mtime

请求示例

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/ratelimits/releases' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"id":"<rule-id>","release_type":"normal"}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

GET/naming/v1/ratelimits/releases需要鉴权

查询限流发布

查询已发布版本。

参数

Authorizationheader · string必填
登录返回的 token。
idquery · string可选
规则 ID。
limitquery · integer可选
分页大小。

请求示例

curl -sS 'http://127.0.0.1:8090/naming/v1/ratelimits/releases?limit=20' \
  -H "Authorization: $TOKEN"

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

PUT/naming/v1/ratelimits/releases/rollback需要鉴权

回滚限流

回滚到指定 release。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RuleRelease[]必填
请求体为 RuleRelease 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
id
rule_idbody · string可选
rule_id
rule_namebody · string可选
rule_name
release_namebody · string可选
release_name
descriptionbody · string可选
description
release_typebody · string可选
release_type
client_labelsbody · ClientLabel[]可选
client_labels
- keybody · string可选
  key
- valuebody · MatchString可选
  value
  - typebody · enum(MatchStringType)可选
    type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · string可选
    value
  - value_typebody · enum(ValueType)可选
    value_type 枚举：TEXT | PARAMETER
versionbody · uint64可选
version
resourcebody · enum(RuleType)可选
resource 枚举：

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
ruleReleasebody · RuleRelease可选
返回中的 RuleRelease 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  id
- rule_idbody · string可选
  rule_id
- rule_namebody · string可选
  rule_name
- release_namebody · string可选
  release_name
- descriptionbody · string可选
  description
- release_typebody · string可选
  release_type
- client_labelsbody · ClientLabel[]可选
  client_labels
  - keybody · string可选
    key
  - valuebody · MatchString可选
    value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- versionbody · uint64可选
  version
- resourcebody · enum(RuleType)可选
  resource 枚举：
- activebody · bool可选
  active
- ctimebody · string可选
  ctime
- mtimebody · string可选
  mtime

请求示例

curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/ratelimits/releases/rollback' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"id":"<rule-id>"}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

PUT/naming/v1/ratelimits/releases/stopbeta需要鉴权

停止限流灰度

停止灰度 release。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RuleRelease[]必填
请求体为 RuleRelease 的 JSON 数组：[{...}, ...]。下列字段为数组中单条对象的完整字段（含嵌套）。
idbody · string可选
id
rule_idbody · string可选
rule_id
rule_namebody · string可选
rule_name
release_namebody · string可选
release_name
descriptionbody · string可选
description
release_typebody · string可选
release_type
client_labelsbody · ClientLabel[]可选
client_labels
- keybody · string可选
  key
- valuebody · MatchString可选
  value
  - typebody · enum(MatchStringType)可选
    type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · string可选
    value
  - value_typebody · enum(ValueType)可选
    value_type 枚举：TEXT | PARAMETER
versionbody · uint64可选
version
resourcebody · enum(RuleType)可选
resource 枚举：

响应字段

codebody · uint32必填
业务码，成功多为 200000。
infobody · string可选
提示信息。
ruleReleasebody · RuleRelease可选
返回中的 RuleRelease 实体字段（批量接口在 responses[] 内）。
- idbody · string可选
  id
- rule_idbody · string可选
  rule_id
- rule_namebody · string可选
  rule_name
- release_namebody · string可选
  release_name
- descriptionbody · string可选
  description
- release_typebody · string可选
  release_type
- client_labelsbody · ClientLabel[]可选
  client_labels
  - keybody · string可选
    key
  - valuebody · MatchString可选
    value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- versionbody · uint64可选
  version
- resourcebody · enum(RuleType)可选
  resource 枚举：
- activebody · bool可选
  active
- ctimebody · string可选
  ctime
- mtimebody · string可选
  mtime

请求示例

curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/ratelimits/releases/stopbeta' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"id":"<rule-id>"}]'

响应示例

{
  "code": 200000,
  "info": "execute success",
  "amount": 1
}

POST/naming/v1/ratelimits/releases/delete需要鉴权

删除发布

删除发布。

参数

Authorizationheader · string必填
登录返回的 token。
(body)body · RuleRelease[]必填
请求体为 RuleRelease 的 JSON 数组；下列为单条字段。
idbody · string可选
id
rule_idbody · string可选
rule_id
rule_namebody · string可选
rule_name
release_namebody · string可选
release_name
descriptionbody · string可选
description
release_typebody · string可选
release_type
client_labelsbody · ClientLabel[]可选
client_labels
- keybody · string可选
  key
- valuebody · MatchString可选
  value
  - typebody · enum(MatchStringType)可选
    type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · string可选
    value
  - value_typebody · enum(ValueType)可选
    value_type 枚举：TEXT | PARAMETER
versionbody · uint64可选
version
resourcebody · enum(RuleType)可选
resource 枚举：

响应字段

codebody · uint32必填
业务码。
infobody · string可选
提示信息。
RuleReleasebody · RuleRelease可选
实体字段。
- idbody · string可选
  id
- rule_idbody · string可选
  rule_id
- rule_namebody · string可选
  rule_name
- release_namebody · string可选
  release_name
- descriptionbody · string可选
  description
- release_typebody · string可选
  release_type
- client_labelsbody · ClientLabel[]可选
  client_labels
  - keybody · string可选
    key
  - valuebody · MatchString可选
    value
    - typebody · enum(MatchStringType)可选
      type 枚举：EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · string可选
      value
    - value_typebody · enum(ValueType)可选
      value_type 枚举：TEXT | PARAMETER
- versionbody · uint64可选
  version
- resourcebody · enum(RuleType)可选
  resource 枚举：
- activebody · bool可选
  active
- ctimebody · string可选
  ctime
- mtimebody · string可选
  mtime

请求示例

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/ratelimits/releases/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

响应示例

{
  "code": 200000,
  "info": "execute success"
}

限流

查询限流

查询限流详情

创建限流

更新限流

删除限流

发布限流

查询限流发布

回滚限流

停止限流灰度

删除发布

On this page