Lattice.Hub

Circuit-breaker rules and releases.

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

Circuit breaker

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

GET/naming/v1/circuitbreakersAuth required

List circuit breaker

Paginated circuit breaker 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/circuitbreakers?limit=20' \
  -H "Authorization: $TOKEN"

Response example

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

GET/naming/v1/circuitbreakers/detailAuth required

Get circuit breaker 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/circuitbreakers/detail?id=<id>' \
  -H "Authorization: $TOKEN"

Response example

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

POST/naming/v1/circuitbreakersAuth required

Create circuit breaker

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

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · CircuitBreakerRule[]required
Request body is a JSON array of CircuitBreakerRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringrequired
rule name
enablebody · booloptional
enable this router
descriptionbody · stringoptional
description simple description rules
levelbody · enum(Level)optional
the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
rule_matcherbody · RuleMatcheroptional
match condition for this rule
- sourcebody · SourceServiceoptional
  source
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- destinationbody · DestinationServiceoptional
  destination
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
block_configsbody · CircuitBreakerPolicy[]optional
block_configs
- block_configbody · BlockConfigoptional
  blocking strategy
  - namebody · stringoptional
    name
  - 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
  - error_conditionsbody · ErrorCondition[]optional
    error_conditions
    - input_typebody · enum(InputType)optional
      input_type enum: UNKNOWN | RET_CODE | DELAY
    - conditionbody · MatchStringoptional
      condition
      - 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
  - trigger_conditionsbody · TriggerCondition[]optional
    trigger_conditions
    - trigger_typebody · enum(TriggerType)optional
      trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
    - error_countbody · uint32optional
      error_count
    - error_percentbody · uint32optional
      error_percent
    - intervalbody · uint32optional
      interval
    - minimum_requestbody · uint32optional
      minimum_request
  - regex_separatebody · booloptional
    whether regex API matches are counted separately
- max_ejection_percentbody · uint32optional
  the maximum % of an upstream cluster that can be ejected
- recoverConditionbody · RecoverConditionoptional
  recover condition to make resource open to close
  - sleep_windowbody · uint32optional
    seconds from open to half-open
  - consecutiveSuccessbody · uint32optional
    consecutive success request to recover
- faultDetectConfigbody · FaultDetectConfigoptional
  fault detection enable config
  - enablebody · booloptional
    enable
- fallbackConfigbody · FallbackConfigoptional
  fall back configuration
  - enablebody · booloptional
    enable
  - responsebody · FallbackResponseoptional
    response
    - codebody · stringoptional
      code
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
prioritybody · uint32optional
priority rules priority
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.
circuitBreakerRulebody · CircuitBreakerRuleoptional
CircuitBreakerRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- enablebody · booloptional
  enable this router
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- etimebody · stringoptional
  etime enable time of the rules
- descriptionbody · stringoptional
  description simple description rules
- levelbody · enum(Level)optional
  the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
- rule_matcherbody · RuleMatcheroptional
  match condition for this rule
  - sourcebody · SourceServiceoptional
    source
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
  - destinationbody · DestinationServiceoptional
    destination
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
- block_configsbody · CircuitBreakerPolicy[]optional
  block_configs
  - block_configbody · BlockConfigoptional
    blocking strategy
    - namebody · stringoptional
      name
    - 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
    - error_conditionsbody · ErrorCondition[]optional
      error_conditions
      - input_typebody · enum(InputType)optional
        input_type enum: UNKNOWN | RET_CODE | DELAY
      - conditionbody · MatchStringoptional
        condition
        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
    - trigger_conditionsbody · TriggerCondition[]optional
      trigger_conditions
      - trigger_typebody · enum(TriggerType)optional
        trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
      - error_countbody · uint32optional
        error_count
      - error_percentbody · uint32optional
        error_percent
      - intervalbody · uint32optional
        interval
      - minimum_requestbody · uint32optional
        minimum_request
    - regex_separatebody · booloptional
      whether regex API matches are counted separately
  - max_ejection_percentbody · uint32optional
    the maximum % of an upstream cluster that can be ejected
  - recoverConditionbody · RecoverConditionoptional
    recover condition to make resource open to close
    - sleep_windowbody · uint32optional
      seconds from open to half-open
    - consecutiveSuccessbody · uint32optional
      consecutive success request to recover
  - faultDetectConfigbody · FaultDetectConfigoptional
    fault detection enable config
    - enablebody · booloptional
      enable
  - fallbackConfigbody · FallbackConfigoptional
    fall back configuration
    - enablebody · booloptional
      enable
    - responsebody · FallbackResponseoptional
      response
      - codebody · stringoptional
        code
      - headersbody · MessageHeader[]optional
        headers
        keybody · stringoptional
        key
        valuebody · stringoptional
        value
      - bodybody · stringoptional
        body
- prioritybody · uint32optional
  priority rules priority
- 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/circuitbreakers' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"demo-cb","enable":true}]'

Response example

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

PUT/naming/v1/circuitbreakersAuth required

Update circuit breaker

Update rules; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · CircuitBreakerRule[]required
Request body is a JSON array of CircuitBreakerRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
rule name
enablebody · booloptional
enable this router
descriptionbody · stringoptional
description simple description rules
levelbody · enum(Level)optional
the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
rule_matcherbody · RuleMatcheroptional
match condition for this rule
- sourcebody · SourceServiceoptional
  source
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- destinationbody · DestinationServiceoptional
  destination
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
block_configsbody · CircuitBreakerPolicy[]optional
block_configs
- block_configbody · BlockConfigoptional
  blocking strategy
  - namebody · stringoptional
    name
  - 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
  - error_conditionsbody · ErrorCondition[]optional
    error_conditions
    - input_typebody · enum(InputType)optional
      input_type enum: UNKNOWN | RET_CODE | DELAY
    - conditionbody · MatchStringoptional
      condition
      - 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
  - trigger_conditionsbody · TriggerCondition[]optional
    trigger_conditions
    - trigger_typebody · enum(TriggerType)optional
      trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
    - error_countbody · uint32optional
      error_count
    - error_percentbody · uint32optional
      error_percent
    - intervalbody · uint32optional
      interval
    - minimum_requestbody · uint32optional
      minimum_request
  - regex_separatebody · booloptional
    whether regex API matches are counted separately
- max_ejection_percentbody · uint32optional
  the maximum % of an upstream cluster that can be ejected
- recoverConditionbody · RecoverConditionoptional
  recover condition to make resource open to close
  - sleep_windowbody · uint32optional
    seconds from open to half-open
  - consecutiveSuccessbody · uint32optional
    consecutive success request to recover
- faultDetectConfigbody · FaultDetectConfigoptional
  fault detection enable config
  - enablebody · booloptional
    enable
- fallbackConfigbody · FallbackConfigoptional
  fall back configuration
  - enablebody · booloptional
    enable
  - responsebody · FallbackResponseoptional
    response
    - codebody · stringoptional
      code
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
prioritybody · uint32optional
priority rules priority
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.
circuitBreakerRulebody · CircuitBreakerRuleoptional
CircuitBreakerRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- enablebody · booloptional
  enable this router
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- etimebody · stringoptional
  etime enable time of the rules
- descriptionbody · stringoptional
  description simple description rules
- levelbody · enum(Level)optional
  the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
- rule_matcherbody · RuleMatcheroptional
  match condition for this rule
  - sourcebody · SourceServiceoptional
    source
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
  - destinationbody · DestinationServiceoptional
    destination
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
- block_configsbody · CircuitBreakerPolicy[]optional
  block_configs
  - block_configbody · BlockConfigoptional
    blocking strategy
    - namebody · stringoptional
      name
    - 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
    - error_conditionsbody · ErrorCondition[]optional
      error_conditions
      - input_typebody · enum(InputType)optional
        input_type enum: UNKNOWN | RET_CODE | DELAY
      - conditionbody · MatchStringoptional
        condition
        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
    - trigger_conditionsbody · TriggerCondition[]optional
      trigger_conditions
      - trigger_typebody · enum(TriggerType)optional
        trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
      - error_countbody · uint32optional
        error_count
      - error_percentbody · uint32optional
        error_percent
      - intervalbody · uint32optional
        interval
      - minimum_requestbody · uint32optional
        minimum_request
    - regex_separatebody · booloptional
      whether regex API matches are counted separately
  - max_ejection_percentbody · uint32optional
    the maximum % of an upstream cluster that can be ejected
  - recoverConditionbody · RecoverConditionoptional
    recover condition to make resource open to close
    - sleep_windowbody · uint32optional
      seconds from open to half-open
    - consecutiveSuccessbody · uint32optional
      consecutive success request to recover
  - faultDetectConfigbody · FaultDetectConfigoptional
    fault detection enable config
    - enablebody · booloptional
      enable
  - fallbackConfigbody · FallbackConfigoptional
    fall back configuration
    - enablebody · booloptional
      enable
    - responsebody · FallbackResponseoptional
      response
      - codebody · stringoptional
        code
      - headersbody · MessageHeader[]optional
        headers
        keybody · stringoptional
        key
        valuebody · stringoptional
        value
      - bodybody · stringoptional
        body
- prioritybody · uint32optional
  priority rules priority
- 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/circuitbreakers' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[{"name":"demo-cb","enable":true}]'

Response example

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

POST/naming/v1/circuitbreakers/deleteAuth required

Delete circuit breaker

Delete rules; body is an array with ids.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · CircuitBreakerRule[]required
Request body is a JSON array of CircuitBreakerRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
rule name
enablebody · booloptional
enable this router
descriptionbody · stringoptional
description simple description rules
levelbody · enum(Level)optional
the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
rule_matcherbody · RuleMatcheroptional
match condition for this rule
- sourcebody · SourceServiceoptional
  source
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- destinationbody · DestinationServiceoptional
  destination
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
block_configsbody · CircuitBreakerPolicy[]optional
block_configs
- block_configbody · BlockConfigoptional
  blocking strategy
  - namebody · stringoptional
    name
  - 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
  - error_conditionsbody · ErrorCondition[]optional
    error_conditions
    - input_typebody · enum(InputType)optional
      input_type enum: UNKNOWN | RET_CODE | DELAY
    - conditionbody · MatchStringoptional
      condition
      - 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
  - trigger_conditionsbody · TriggerCondition[]optional
    trigger_conditions
    - trigger_typebody · enum(TriggerType)optional
      trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
    - error_countbody · uint32optional
      error_count
    - error_percentbody · uint32optional
      error_percent
    - intervalbody · uint32optional
      interval
    - minimum_requestbody · uint32optional
      minimum_request
  - regex_separatebody · booloptional
    whether regex API matches are counted separately
- max_ejection_percentbody · uint32optional
  the maximum % of an upstream cluster that can be ejected
- recoverConditionbody · RecoverConditionoptional
  recover condition to make resource open to close
  - sleep_windowbody · uint32optional
    seconds from open to half-open
  - consecutiveSuccessbody · uint32optional
    consecutive success request to recover
- faultDetectConfigbody · FaultDetectConfigoptional
  fault detection enable config
  - enablebody · booloptional
    enable
- fallbackConfigbody · FallbackConfigoptional
  fall back configuration
  - enablebody · booloptional
    enable
  - responsebody · FallbackResponseoptional
    response
    - codebody · stringoptional
      code
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
prioritybody · uint32optional
priority rules priority
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.
circuitBreakerRulebody · CircuitBreakerRuleoptional
CircuitBreakerRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- enablebody · booloptional
  enable this router
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- etimebody · stringoptional
  etime enable time of the rules
- descriptionbody · stringoptional
  description simple description rules
- levelbody · enum(Level)optional
  the circuitbreaking level enum: UNKNOWN | SERVICE | METHOD | GROUP | INSTANCE
- rule_matcherbody · RuleMatcheroptional
  match condition for this rule
  - sourcebody · SourceServiceoptional
    source
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
  - destinationbody · DestinationServiceoptional
    destination
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
- block_configsbody · CircuitBreakerPolicy[]optional
  block_configs
  - block_configbody · BlockConfigoptional
    blocking strategy
    - namebody · stringoptional
      name
    - 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
    - error_conditionsbody · ErrorCondition[]optional
      error_conditions
      - input_typebody · enum(InputType)optional
        input_type enum: UNKNOWN | RET_CODE | DELAY
      - conditionbody · MatchStringoptional
        condition
        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
    - trigger_conditionsbody · TriggerCondition[]optional
      trigger_conditions
      - trigger_typebody · enum(TriggerType)optional
        trigger_type enum: UNKNOWN | ERROR_RATE | CONSECUTIVE_ERROR
      - error_countbody · uint32optional
        error_count
      - error_percentbody · uint32optional
        error_percent
      - intervalbody · uint32optional
        interval
      - minimum_requestbody · uint32optional
        minimum_request
    - regex_separatebody · booloptional
      whether regex API matches are counted separately
  - max_ejection_percentbody · uint32optional
    the maximum % of an upstream cluster that can be ejected
  - recoverConditionbody · RecoverConditionoptional
    recover condition to make resource open to close
    - sleep_windowbody · uint32optional
      seconds from open to half-open
    - consecutiveSuccessbody · uint32optional
      consecutive success request to recover
  - faultDetectConfigbody · FaultDetectConfigoptional
    fault detection enable config
    - enablebody · booloptional
      enable
  - fallbackConfigbody · FallbackConfigoptional
    fall back configuration
    - enablebody · booloptional
      enable
    - responsebody · FallbackResponseoptional
      response
      - codebody · stringoptional
        code
      - headersbody · MessageHeader[]optional
        headers
        keybody · stringoptional
        key
        valuebody · stringoptional
        value
      - bodybody · stringoptional
        body
- prioritybody · uint32optional
  priority rules priority
- 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/circuitbreakers/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/circuitbreakers/releasesAuth required

Publish circuit breaker

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/circuitbreakers/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/circuitbreakers/releasesAuth required

List circuit breaker 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/circuitbreakers/releases?limit=20' \
  -H "Authorization: $TOKEN"

Response example

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

PUT/naming/v1/circuitbreakers/releases/rollbackAuth required

Rollback circuit breaker

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/circuitbreakers/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/circuitbreakers/releases/stopbetaAuth required

Stop circuit breaker 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/circuitbreakers/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/circuitbreakers/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/circuitbreakers/releases/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

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

Circuit breaker

List circuit breaker

Get circuit breaker detail

Create circuit breaker

Update circuit breaker

Delete circuit breaker

Publish circuit breaker

List circuit breaker releases

Rollback circuit breaker

Stop circuit breaker gray

Delete releases

On this page