Lattice.Hub

Rate-limit rules and releases.

Default Base URL: http://127.0.0.1:8090. Management APIs require Authorization (token from login).

Rate limit

Rate limit: list, create/update, delete, and releases (publish / rollback / stopbeta). Bodies are rule arrays; fields follow specification.

GET/naming/v1/ratelimitsAuth required

List rate limit

Paginated rate limit list.

Parameters

Authorizationheader · stringrequired
Token from login.
idquery · stringoptional
Filter by ID.
namequery · stringoptional
Filter by name.
namespacequery · stringoptional
Filter by namespace.
servicequery · stringoptional
Filter by service.
enablequery · booloptional
Enabled filter.
offsetquery · integeroptional
Offset, default 0.
limitquery · integeroptional
Page size, often max 100.

Request

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

Response example

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

GET/naming/v1/ratelimits/detailAuth required

Get rate limit detail

Fetch one rule by id / filters.

Parameters

Authorizationheader · stringrequired
Token from login.
idquery · stringoptional
Filter by ID.
namequery · stringoptional
Filter by name.
namespacequery · stringoptional
Filter by namespace.
servicequery · stringoptional
Filter by service.
enablequery · booloptional
Enabled filter.
offsetquery · integeroptional
Offset, default 0.
limitquery · integeroptional
Page size, often max 100.

Request

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

Response example

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

POST/naming/v1/ratelimitsAuth required

Create rate limit

Write bodies are usually protobuf message arrays; fields below are per-object (see specification).

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RateLimit[]required
Request body is a JSON array of RateLimit: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
限流规则唯一标识
namebody · stringrequired
限流规则名称
prioritybody · uint32optional
限流规则优先级，0值最高
typebody · enum(Type)optional
type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]optional
rules
- namebody · stringoptional
  限流规则名
- apisbody · API[]optional
  apis
  - protocolbody · stringoptional
    API的协议，*或者为空代表全部
  - methodbody · stringoptional
    API的方法，*或者为空代表全部
  - pathbody · MatchStringoptional
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- resourcebody · enum(Resource)optional
  resource enum: QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · stringoptional
    header key or query key
  - valuebody · MatchStringoptional
    header value or query value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- amountsbody · Amount[]optional
  amounts
  - maxAmountbody · uint32optional
    时间周期内的最大配额数
  - validDurationbody · durationoptional
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32optional
    请求统计精度
  - startAmountbody · uint32optional
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32optional
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32optional
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmountoptional
  amount for concurrency rate-limit
  - max_amountbody · uint32optional
    max_amount
- custom_responsebody · CustomResponseoptional
  fallback configuration
  - codebody · stringoptional
    code
  - headersbody · map<string,string>optional
    headers
  - bodybody · stringoptional
    body
- regex_combinebody · booloptional
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)optional
  failover enum: FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · stringoptional
  限流动作，和 resource 配合决定插件名称
- disablebody · booloptional
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)optional
  amount_mode enum: GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · booloptional
是否停用该限流规则，默认启用
reportbody · Reportoptional
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · durationoptional
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32optional
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitClusteroptional
分布式限流服务集群
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  限流规则所属命名空间
metadatabody · map<string,string>optional
metadata
namespacebody · stringrequired
namespace identifies the environment that owns this rule.

Response fields

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

Request

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}]'

Response example

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

PUT/naming/v1/ratelimitsAuth required

Update rate limit

Update rules; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RateLimit[]required
Request body is a JSON array of RateLimit: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
限流规则唯一标识
namebody · stringoptional
限流规则名称
prioritybody · uint32optional
限流规则优先级，0值最高
typebody · enum(Type)optional
type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]optional
rules
- namebody · stringoptional
  限流规则名
- apisbody · API[]optional
  apis
  - protocolbody · stringoptional
    API的协议，*或者为空代表全部
  - methodbody · stringoptional
    API的方法，*或者为空代表全部
  - pathbody · MatchStringoptional
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- resourcebody · enum(Resource)optional
  resource enum: QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · stringoptional
    header key or query key
  - valuebody · MatchStringoptional
    header value or query value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- amountsbody · Amount[]optional
  amounts
  - maxAmountbody · uint32optional
    时间周期内的最大配额数
  - validDurationbody · durationoptional
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32optional
    请求统计精度
  - startAmountbody · uint32optional
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32optional
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32optional
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmountoptional
  amount for concurrency rate-limit
  - max_amountbody · uint32optional
    max_amount
- custom_responsebody · CustomResponseoptional
  fallback configuration
  - codebody · stringoptional
    code
  - headersbody · map<string,string>optional
    headers
  - bodybody · stringoptional
    body
- regex_combinebody · booloptional
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)optional
  failover enum: FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · stringoptional
  限流动作，和 resource 配合决定插件名称
- disablebody · booloptional
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)optional
  amount_mode enum: GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · booloptional
是否停用该限流规则，默认启用
reportbody · Reportoptional
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · durationoptional
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32optional
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitClusteroptional
分布式限流服务集群
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  限流规则所属命名空间
metadatabody · map<string,string>optional
metadata
namespacebody · stringoptional
namespace identifies the environment that owns this rule.

Response fields

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

Request

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}]'

Response example

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

POST/naming/v1/ratelimits/deleteAuth required

Delete rate limit

Delete rules; body is an array with ids.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RateLimit[]required
Request body is a JSON array of RateLimit: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
限流规则唯一标识
namebody · stringoptional
限流规则名称
prioritybody · uint32optional
限流规则优先级，0值最高
typebody · enum(Type)optional
type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
rulesbody · LimitTrigger[]optional
rules
- namebody · stringoptional
  限流规则名
- apisbody · API[]optional
  apis
  - protocolbody · stringoptional
    API的协议，*或者为空代表全部
  - methodbody · stringoptional
    API的方法，*或者为空代表全部
  - pathbody · MatchStringoptional
    API的路径，支持多种匹配方式
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- resourcebody · enum(Resource)optional
  resource enum: QPS | CONCURRENCY | SYSTEM
- argumentsbody · MatchArgument[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - keybody · stringoptional
    header key or query key
  - valuebody · MatchStringoptional
    header value or query value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- amountsbody · Amount[]optional
  amounts
  - maxAmountbody · uint32optional
    时间周期内的最大配额数
  - validDurationbody · durationoptional
    配额生效的时间周期，必须大于等于1s
  - precisionbody · uint32optional
    请求统计精度
  - startAmountbody · uint32optional
    可选，起始限流阈值，爬坡起始值
  - minAmountbody · uint32optional
    可选，最小限流阈值，降低时最小值
- max_queue_delaybody · uint32optional
  最大排队时长，单位秒
- concurrency_amountbody · ConcurrencyAmountoptional
  amount for concurrency rate-limit
  - max_amountbody · uint32optional
    max_amount
- custom_responsebody · CustomResponseoptional
  fallback configuration
  - codebody · stringoptional
    code
  - headersbody · map<string,string>optional
    headers
  - bodybody · stringoptional
    body
- regex_combinebody · booloptional
  通配符是否合并计算，默认分开计数
- failoverbody · enum(FailoverType)optional
  failover enum: FAILOVER_LOCAL | FAILOVER_PASS
- actionbody · stringoptional
  限流动作，和 resource 配合决定插件名称
- disablebody · booloptional
  是否停用该限流规则，默认启用
- amount_modebody · enum(AmountMode)optional
  amount_mode enum: GLOBAL_TOTAL | SHARE_EQUALLY
disablebody · booloptional
是否停用该限流规则，默认启用
reportbody · Reportoptional
限流上报方式，同时支持按固定周期上报，以及达到配额百分比后上报
- intervalbody · durationoptional
  配额固定上报周期，单位毫秒
- amountPercentbody · uint32optional
  使用了百分之多少配额后启动一次实时上报，值范围(0,100]
clusterbody · RateLimitClusteroptional
分布式限流服务集群
- servicebody · stringoptional
  service
- namespacebody · stringoptional
  限流规则所属命名空间
metadatabody · map<string,string>optional
metadata
namespacebody · stringoptional
namespace identifies the environment that owns this rule.

Response fields

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

Request

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>"}]'

Response example

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

POST/naming/v1/ratelimits/releasesAuth required

Publish rate limit

Publish a release so clients observe the active view.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RuleRelease[]required
Request body is a JSON array of RuleRelease: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
rule_idbody · stringoptional
rule_id
rule_namebody · stringoptional
rule_name
release_namebody · stringoptional
release_name
descriptionbody · stringoptional
description
release_typebody · stringoptional
release_type
client_labelsbody · ClientLabel[]optional
client_labels
- keybody · stringoptional
  key
- valuebody · MatchStringoptional
  value
  - typebody · enum(MatchStringType)optional
    type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · stringoptional
    value
  - value_typebody · enum(ValueType)optional
    value_type enum: TEXT | PARAMETER
versionbody · uint64optional
version
resourcebody · enum(RuleType)optional
resource enum:

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
ruleReleasebody · RuleReleaseoptional
RuleRelease entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- rule_idbody · stringoptional
  rule_id
- rule_namebody · stringoptional
  rule_name
- release_namebody · stringoptional
  release_name
- descriptionbody · stringoptional
  description
- release_typebody · stringoptional
  release_type
- client_labelsbody · ClientLabel[]optional
  client_labels
  - keybody · stringoptional
    key
  - valuebody · MatchStringoptional
    value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- versionbody · uint64optional
  version
- resourcebody · enum(RuleType)optional
  resource enum:
- activebody · booloptional
  active
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime

Request

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"}]'

Response example

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

GET/naming/v1/ratelimits/releasesAuth required

List rate limit releases

List published releases.

Parameters

Authorizationheader · stringrequired
Token from login.
idquery · stringoptional
Rule ID.
limitquery · integeroptional
Page size.

Request

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

Response example

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

PUT/naming/v1/ratelimits/releases/rollbackAuth required

Rollback rate limit

Roll back to a release.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RuleRelease[]required
Request body is a JSON array of RuleRelease: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
rule_idbody · stringoptional
rule_id
rule_namebody · stringoptional
rule_name
release_namebody · stringoptional
release_name
descriptionbody · stringoptional
description
release_typebody · stringoptional
release_type
client_labelsbody · ClientLabel[]optional
client_labels
- keybody · stringoptional
  key
- valuebody · MatchStringoptional
  value
  - typebody · enum(MatchStringType)optional
    type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · stringoptional
    value
  - value_typebody · enum(ValueType)optional
    value_type enum: TEXT | PARAMETER
versionbody · uint64optional
version
resourcebody · enum(RuleType)optional
resource enum:

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
ruleReleasebody · RuleReleaseoptional
RuleRelease entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- rule_idbody · stringoptional
  rule_id
- rule_namebody · stringoptional
  rule_name
- release_namebody · stringoptional
  release_name
- descriptionbody · stringoptional
  description
- release_typebody · stringoptional
  release_type
- client_labelsbody · ClientLabel[]optional
  client_labels
  - keybody · stringoptional
    key
  - valuebody · MatchStringoptional
    value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- versionbody · uint64optional
  version
- resourcebody · enum(RuleType)optional
  resource enum:
- activebody · booloptional
  active
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime

Request

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>"}]'

Response example

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

PUT/naming/v1/ratelimits/releases/stopbetaAuth required

Stop rate limit gray

Stop a gray release.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RuleRelease[]required
Request body is a JSON array of RuleRelease: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
rule_idbody · stringoptional
rule_id
rule_namebody · stringoptional
rule_name
release_namebody · stringoptional
release_name
descriptionbody · stringoptional
description
release_typebody · stringoptional
release_type
client_labelsbody · ClientLabel[]optional
client_labels
- keybody · stringoptional
  key
- valuebody · MatchStringoptional
  value
  - typebody · enum(MatchStringType)optional
    type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · stringoptional
    value
  - value_typebody · enum(ValueType)optional
    value_type enum: TEXT | PARAMETER
versionbody · uint64optional
version
resourcebody · enum(RuleType)optional
resource enum:

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
ruleReleasebody · RuleReleaseoptional
RuleRelease entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- rule_idbody · stringoptional
  rule_id
- rule_namebody · stringoptional
  rule_name
- release_namebody · stringoptional
  release_name
- descriptionbody · stringoptional
  description
- release_typebody · stringoptional
  release_type
- client_labelsbody · ClientLabel[]optional
  client_labels
  - keybody · stringoptional
    key
  - valuebody · MatchStringoptional
    value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- versionbody · uint64optional
  version
- resourcebody · enum(RuleType)optional
  resource enum:
- activebody · booloptional
  active
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime

Request

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>"}]'

Response example

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

POST/naming/v1/ratelimits/releases/deleteAuth required

Delete releases

Delete releases.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · RuleRelease[]required
JSON array of RuleRelease; fields below are per-item.
idbody · stringoptional
id
rule_idbody · stringoptional
rule_id
rule_namebody · stringoptional
rule_name
release_namebody · stringoptional
release_name
descriptionbody · stringoptional
description
release_typebody · stringoptional
release_type
client_labelsbody · ClientLabel[]optional
client_labels
- keybody · stringoptional
  key
- valuebody · MatchStringoptional
  value
  - typebody · enum(MatchStringType)optional
    type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
  - valuebody · stringoptional
    value
  - value_typebody · enum(ValueType)optional
    value_type enum: TEXT | PARAMETER
versionbody · uint64optional
version
resourcebody · enum(RuleType)optional
resource enum:

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
RuleReleasebody · RuleReleaseoptional
Entity fields.
- idbody · stringoptional
  id
- rule_idbody · stringoptional
  rule_id
- rule_namebody · stringoptional
  rule_name
- release_namebody · stringoptional
  release_name
- descriptionbody · stringoptional
  description
- release_typebody · stringoptional
  release_type
- client_labelsbody · ClientLabel[]optional
  client_labels
  - keybody · stringoptional
    key
  - valuebody · MatchStringoptional
    value
    - typebody · enum(MatchStringType)optional
      type enum: EXACT | REGEX | NOT_EQUALS | IN | NOT_IN | RANGE
    - valuebody · stringoptional
      value
    - value_typebody · enum(ValueType)optional
      value_type enum: TEXT | PARAMETER
- versionbody · uint64optional
  version
- resourcebody · enum(RuleType)optional
  resource enum:
- activebody · booloptional
  active
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime

Request

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

Response example

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

Rate limit

List rate limit

Get rate limit detail

Create rate limit

Update rate limit

Delete rate limit

Publish rate limit

List rate limit releases

Rollback rate limit

Stop rate limit gray

Delete releases

On this page