Lattice.Hub

Fault-detect rules and releases.

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

Fault detect

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

GET/naming/v1/faultdetectorsAuth required

List fault detect

Paginated fault detect 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/faultdetectors?limit=20' \
  -H "Authorization: $TOKEN"

Response example

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

GET/naming/v1/faultdetectors/detailAuth required

Get fault detect 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/faultdetectors/detail?id=<id>' \
  -H "Authorization: $TOKEN"

Response example

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

POST/naming/v1/faultdetectorsAuth required

Create fault detect

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

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · FaultDetectRule[]required
Request body is a JSON array of FaultDetectRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringrequired
rule name
descriptionbody · stringoptional
description simple description rules
target_servicebody · DestinationServiceoptional
detect target
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
prioritybody · uint32optional
priority rules priority
metadatabody · map<string,string>optional
metadata
rulesbody · FaultDetectSubRule[]optional
rules
- intervalbody · uint32optional
  detect interval
- timeoutbody · uint32optional
  detect timeout
- portbody · uint32optional
  detect port
- protocolbody · FaultDetectRule.Protocoloptional
  detect protocol
- http_configbody · HttpProtocolConfigoptional
  http detect config
  - methodbody · stringoptional
    method
  - urlbody · stringoptional
    url
  - headersbody · MessageHeader[]optional
    headers
    - keybody · stringoptional
      key
    - valuebody · stringoptional
      value
  - bodybody · stringoptional
    body
- tcp_configbody · TcpProtocolConfigoptional
  tcp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- udp_configbody · UdpProtocolConfigoptional
  udp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- disablebody · booloptional
  sub rule disabled
namespacebody · stringrequired
namespace

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
faultDetectRulebody · FaultDetectRuleoptional
FaultDetectRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- descriptionbody · stringoptional
  description simple description rules
- target_servicebody · DestinationServiceoptional
  detect target
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- prioritybody · uint32optional
  priority rules priority
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- rulesbody · FaultDetectSubRule[]optional
  rules
  - intervalbody · uint32optional
    detect interval
  - timeoutbody · uint32optional
    detect timeout
  - portbody · uint32optional
    detect port
  - protocolbody · FaultDetectRule.Protocoloptional
    detect protocol
  - http_configbody · HttpProtocolConfigoptional
    http detect config
    - methodbody · stringoptional
      method
    - urlbody · stringoptional
      url
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
  - tcp_configbody · TcpProtocolConfigoptional
    tcp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - udp_configbody · UdpProtocolConfigoptional
    udp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - disablebody · booloptional
    sub rule disabled
- namespacebody · stringoptional
  namespace

Request

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

Response example

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

PUT/naming/v1/faultdetectorsAuth required

Update fault detect

Update rules; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · FaultDetectRule[]required
Request body is a JSON array of FaultDetectRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
rule name
descriptionbody · stringoptional
description simple description rules
target_servicebody · DestinationServiceoptional
detect target
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
prioritybody · uint32optional
priority rules priority
metadatabody · map<string,string>optional
metadata
rulesbody · FaultDetectSubRule[]optional
rules
- intervalbody · uint32optional
  detect interval
- timeoutbody · uint32optional
  detect timeout
- portbody · uint32optional
  detect port
- protocolbody · FaultDetectRule.Protocoloptional
  detect protocol
- http_configbody · HttpProtocolConfigoptional
  http detect config
  - methodbody · stringoptional
    method
  - urlbody · stringoptional
    url
  - headersbody · MessageHeader[]optional
    headers
    - keybody · stringoptional
      key
    - valuebody · stringoptional
      value
  - bodybody · stringoptional
    body
- tcp_configbody · TcpProtocolConfigoptional
  tcp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- udp_configbody · UdpProtocolConfigoptional
  udp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- disablebody · booloptional
  sub rule disabled
namespacebody · stringoptional
namespace

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
faultDetectRulebody · FaultDetectRuleoptional
FaultDetectRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- descriptionbody · stringoptional
  description simple description rules
- target_servicebody · DestinationServiceoptional
  detect target
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- prioritybody · uint32optional
  priority rules priority
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- rulesbody · FaultDetectSubRule[]optional
  rules
  - intervalbody · uint32optional
    detect interval
  - timeoutbody · uint32optional
    detect timeout
  - portbody · uint32optional
    detect port
  - protocolbody · FaultDetectRule.Protocoloptional
    detect protocol
  - http_configbody · HttpProtocolConfigoptional
    http detect config
    - methodbody · stringoptional
      method
    - urlbody · stringoptional
      url
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
  - tcp_configbody · TcpProtocolConfigoptional
    tcp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - udp_configbody · UdpProtocolConfigoptional
    udp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - disablebody · booloptional
    sub rule disabled
- namespacebody · stringoptional
  namespace

Request

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

Response example

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

POST/naming/v1/faultdetectors/deleteAuth required

Delete fault detect

Delete rules; body is an array with ids.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · FaultDetectRule[]required
Request body is a JSON array of FaultDetectRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
rule name
descriptionbody · stringoptional
description simple description rules
target_servicebody · DestinationServiceoptional
detect target
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
prioritybody · uint32optional
priority rules priority
metadatabody · map<string,string>optional
metadata
rulesbody · FaultDetectSubRule[]optional
rules
- intervalbody · uint32optional
  detect interval
- timeoutbody · uint32optional
  detect timeout
- portbody · uint32optional
  detect port
- protocolbody · FaultDetectRule.Protocoloptional
  detect protocol
- http_configbody · HttpProtocolConfigoptional
  http detect config
  - methodbody · stringoptional
    method
  - urlbody · stringoptional
    url
  - headersbody · MessageHeader[]optional
    headers
    - keybody · stringoptional
      key
    - valuebody · stringoptional
      value
  - bodybody · stringoptional
    body
- tcp_configbody · TcpProtocolConfigoptional
  tcp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- udp_configbody · UdpProtocolConfigoptional
  udp detect config
  - sendbody · stringoptional
    send
  - receivebody · string[]optional
    receive
- disablebody · booloptional
  sub rule disabled
namespacebody · stringoptional
namespace

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
faultDetectRulebody · FaultDetectRuleoptional
FaultDetectRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  rule name
- revisionbody · stringoptional
  revision routing version
- ctimebody · stringoptional
  ctime create time of the rules
- mtimebody · stringoptional
  mtime modify time of the rules
- descriptionbody · stringoptional
  description simple description rules
- target_servicebody · DestinationServiceoptional
  detect target
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- prioritybody · uint32optional
  priority rules priority
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- rulesbody · FaultDetectSubRule[]optional
  rules
  - intervalbody · uint32optional
    detect interval
  - timeoutbody · uint32optional
    detect timeout
  - portbody · uint32optional
    detect port
  - protocolbody · FaultDetectRule.Protocoloptional
    detect protocol
  - http_configbody · HttpProtocolConfigoptional
    http detect config
    - methodbody · stringoptional
      method
    - urlbody · stringoptional
      url
    - headersbody · MessageHeader[]optional
      headers
      - keybody · stringoptional
        key
      - valuebody · stringoptional
        value
    - bodybody · stringoptional
      body
  - tcp_configbody · TcpProtocolConfigoptional
    tcp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - udp_configbody · UdpProtocolConfigoptional
    udp detect config
    - sendbody · stringoptional
      send
    - receivebody · string[]optional
      receive
  - disablebody · booloptional
    sub rule disabled
- namespacebody · stringoptional
  namespace

Request

curl -sS -X POST 'http://127.0.0.1:8090/naming/v1/faultdetectors/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/faultdetectors/releasesAuth required

Publish fault detect

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

List fault detect 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/faultdetectors/releases?limit=20' \
  -H "Authorization: $TOKEN"

Response example

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

PUT/naming/v1/faultdetectors/releases/rollbackAuth required

Rollback fault detect

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

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

Response example

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

Fault detect

List fault detect

Get fault detect detail

Create fault detect

Update fault detect

Delete fault detect

Publish fault detect

List fault detect releases

Rollback fault detect

Stop fault detect gray

Delete releases

On this page