Lattice.Hub

Lane groups and rule releases.

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

Lane

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

GET/naming/v1/lane/groupsAuth required

List lane

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

Response example

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

GET/naming/v1/lane/groups/detailAuth required

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

Response example

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

POST/naming/v1/lane/groupsAuth required

Create lane

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

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneGroup[]required
Request body is a JSON array of LaneGroup: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
泳道组 ID
namebody · stringrequired
泳道组名称
entriesbody · TrafficEntry[]optional
entries
- typebody · stringoptional
  标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
- selectorbody · anyoptional
  selector (google.protobuf.Any; unpack by policy).
destinationsbody · DestinationGroup[]optional
destinations
- servicebody · stringoptional
  Templated service and namespace
- namespacebody · stringoptional
  namespace
- labelsbody · map<string,MatchString>optional
  labels
  - 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
- prioritybody · uint32optional
  According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
- weightbody · uint32optional
  weight
- transferbody · stringoptional
  Forward requests to proxy service
- isolatebody · booloptional
  Whether to isolate the SET, after isolation, no traffic will be allocated
- namebody · stringoptional
  name desition name
descriptionbody · stringoptional
泳道组描述信息
rulesbody · LaneRule[]optional
rules
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  所属泳道组的名称
- traffic_match_rulebody · TrafficMatchRuleoptional
  流量匹配规则
  - argumentsbody · SourceMatch[]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
  - random_percentbody · uint32optional
    随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  保存这个泳道的默认实例标签
- enablebody · booloptional
  泳道规则是否启用
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- prioritybody · uint32optional
  priority rules priority
- descriptionbody · stringoptional
  description simple description rules
- label_keybody · stringoptional
  属于该泳道的实例标签KEY，不填默认为lane
metadatabody · map<string,string>optional
metadata
namespacebody · stringrequired
namespace identifies the environment that owns this lane group.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
laneGroupbody · LaneGroupoptional
LaneGroup entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  泳道组 ID
- namebody · stringoptional
  泳道组名称
- entriesbody · TrafficEntry[]optional
  entries
  - typebody · stringoptional
    标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
  - selectorbody · anyoptional
    selector (google.protobuf.Any; unpack by policy).
- destinationsbody · DestinationGroup[]optional
  destinations
  - servicebody · stringoptional
    Templated service and namespace
  - namespacebody · stringoptional
    namespace
  - labelsbody · map<string,MatchString>optional
    labels
    - 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
  - prioritybody · uint32optional
    According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
  - weightbody · uint32optional
    weight
  - transferbody · stringoptional
    Forward requests to proxy service
  - isolatebody · booloptional
    Whether to isolate the SET, after isolation, no traffic will be allocated
  - namebody · stringoptional
    name desition name
- revisionbody · stringoptional
  泳道组描述信息
- descriptionbody · stringoptional
  泳道组描述信息
- ctimebody · stringoptional
  泳道组的创建时间
- mtimebody · stringoptional
  泳道组的更新时间
- rulesbody · LaneRule[]optional
  rules
  - idbody · stringoptional
    id
  - namebody · stringoptional
    name
  - group_namebody · stringoptional
    所属泳道组的名称
  - traffic_match_rulebody · TrafficMatchRuleoptional
    流量匹配规则
    - argumentsbody · SourceMatch[]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
    - random_percentbody · uint32optional
      随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
    - matchModebody · enum(TrafficMatchMode)optional
      matchMode enum: AND | OR
  - default_label_valuebody · stringoptional
    保存这个泳道的默认实例标签
  - enablebody · booloptional
    泳道规则是否启用
  - match_modebody · enum(LaneMatchMode)optional
    match_mode enum: STRICT | PERMISSIVE
  - 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
  - prioritybody · uint32optional
    priority rules priority
  - descriptionbody · stringoptional
    description simple description rules
  - label_keybody · stringoptional
    属于该泳道的实例标签KEY，不填默认为lane
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- namespacebody · stringoptional
  namespace identifies the environment that owns this lane group.

Request

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

Response example

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

PUT/naming/v1/lane/groupsAuth required

Update lane

Update rules; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneGroup[]required
Request body is a JSON array of LaneGroup: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
泳道组 ID
namebody · stringoptional
泳道组名称
entriesbody · TrafficEntry[]optional
entries
- typebody · stringoptional
  标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
- selectorbody · anyoptional
  selector (google.protobuf.Any; unpack by policy).
destinationsbody · DestinationGroup[]optional
destinations
- servicebody · stringoptional
  Templated service and namespace
- namespacebody · stringoptional
  namespace
- labelsbody · map<string,MatchString>optional
  labels
  - 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
- prioritybody · uint32optional
  According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
- weightbody · uint32optional
  weight
- transferbody · stringoptional
  Forward requests to proxy service
- isolatebody · booloptional
  Whether to isolate the SET, after isolation, no traffic will be allocated
- namebody · stringoptional
  name desition name
descriptionbody · stringoptional
泳道组描述信息
rulesbody · LaneRule[]optional
rules
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  所属泳道组的名称
- traffic_match_rulebody · TrafficMatchRuleoptional
  流量匹配规则
  - argumentsbody · SourceMatch[]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
  - random_percentbody · uint32optional
    随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  保存这个泳道的默认实例标签
- enablebody · booloptional
  泳道规则是否启用
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- prioritybody · uint32optional
  priority rules priority
- descriptionbody · stringoptional
  description simple description rules
- label_keybody · stringoptional
  属于该泳道的实例标签KEY，不填默认为lane
metadatabody · map<string,string>optional
metadata
namespacebody · stringoptional
namespace identifies the environment that owns this lane group.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
laneGroupbody · LaneGroupoptional
LaneGroup entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  泳道组 ID
- namebody · stringoptional
  泳道组名称
- entriesbody · TrafficEntry[]optional
  entries
  - typebody · stringoptional
    标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
  - selectorbody · anyoptional
    selector (google.protobuf.Any; unpack by policy).
- destinationsbody · DestinationGroup[]optional
  destinations
  - servicebody · stringoptional
    Templated service and namespace
  - namespacebody · stringoptional
    namespace
  - labelsbody · map<string,MatchString>optional
    labels
    - 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
  - prioritybody · uint32optional
    According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
  - weightbody · uint32optional
    weight
  - transferbody · stringoptional
    Forward requests to proxy service
  - isolatebody · booloptional
    Whether to isolate the SET, after isolation, no traffic will be allocated
  - namebody · stringoptional
    name desition name
- revisionbody · stringoptional
  泳道组描述信息
- descriptionbody · stringoptional
  泳道组描述信息
- ctimebody · stringoptional
  泳道组的创建时间
- mtimebody · stringoptional
  泳道组的更新时间
- rulesbody · LaneRule[]optional
  rules
  - idbody · stringoptional
    id
  - namebody · stringoptional
    name
  - group_namebody · stringoptional
    所属泳道组的名称
  - traffic_match_rulebody · TrafficMatchRuleoptional
    流量匹配规则
    - argumentsbody · SourceMatch[]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
    - random_percentbody · uint32optional
      随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
    - matchModebody · enum(TrafficMatchMode)optional
      matchMode enum: AND | OR
  - default_label_valuebody · stringoptional
    保存这个泳道的默认实例标签
  - enablebody · booloptional
    泳道规则是否启用
  - match_modebody · enum(LaneMatchMode)optional
    match_mode enum: STRICT | PERMISSIVE
  - 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
  - prioritybody · uint32optional
    priority rules priority
  - descriptionbody · stringoptional
    description simple description rules
  - label_keybody · stringoptional
    属于该泳道的实例标签KEY，不填默认为lane
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- namespacebody · stringoptional
  namespace identifies the environment that owns this lane group.

Request

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

Response example

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

POST/naming/v1/lane/groups/deleteAuth required

Delete lane

Delete rules; body is an array with ids.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneGroup[]required
Request body is a JSON array of LaneGroup: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
泳道组 ID
namebody · stringoptional
泳道组名称
entriesbody · TrafficEntry[]optional
entries
- typebody · stringoptional
  标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
- selectorbody · anyoptional
  selector (google.protobuf.Any; unpack by policy).
destinationsbody · DestinationGroup[]optional
destinations
- servicebody · stringoptional
  Templated service and namespace
- namespacebody · stringoptional
  namespace
- labelsbody · map<string,MatchString>optional
  labels
  - 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
- prioritybody · uint32optional
  According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
- weightbody · uint32optional
  weight
- transferbody · stringoptional
  Forward requests to proxy service
- isolatebody · booloptional
  Whether to isolate the SET, after isolation, no traffic will be allocated
- namebody · stringoptional
  name desition name
descriptionbody · stringoptional
泳道组描述信息
rulesbody · LaneRule[]optional
rules
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  所属泳道组的名称
- traffic_match_rulebody · TrafficMatchRuleoptional
  流量匹配规则
  - argumentsbody · SourceMatch[]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
  - random_percentbody · uint32optional
    随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  保存这个泳道的默认实例标签
- enablebody · booloptional
  泳道规则是否启用
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- prioritybody · uint32optional
  priority rules priority
- descriptionbody · stringoptional
  description simple description rules
- label_keybody · stringoptional
  属于该泳道的实例标签KEY，不填默认为lane
metadatabody · map<string,string>optional
metadata
namespacebody · stringoptional
namespace identifies the environment that owns this lane group.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
laneGroupbody · LaneGroupoptional
LaneGroup entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  泳道组 ID
- namebody · stringoptional
  泳道组名称
- entriesbody · TrafficEntry[]optional
  entries
  - typebody · stringoptional
    标记流量入口类型 type == "pole.io/gateway/spring-cloud-gateway", 则 selector 为 ServiceGatewaySelector type == "pole.io/service, 则 selector 为 ServiceSelector
  - selectorbody · anyoptional
    selector (google.protobuf.Any; unpack by policy).
- destinationsbody · DestinationGroup[]optional
  destinations
  - servicebody · stringoptional
    Templated service and namespace
  - namespacebody · stringoptional
    namespace
  - labelsbody · map<string,MatchString>optional
    labels
    - 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
  - prioritybody · uint32optional
    According to the service name and service instance Metadata Filter the qualified service instance subset Service instance subset can set priority and weight Priority: integer, range [0, 9], the highest priority is 0 Weight: Integer Press priority routing, if there is high priority, low priority will not use If there is a subset of the same priority, then assign by weight Priority and weight can be not set / set up one / set two If the section is set priority, some are not set, it is considered that the priority is not set. If the part is set, some is not set, it is considered that the weight is not set to 0 If you have no weight, you think the weight is the same
  - weightbody · uint32optional
    weight
  - transferbody · stringoptional
    Forward requests to proxy service
  - isolatebody · booloptional
    Whether to isolate the SET, after isolation, no traffic will be allocated
  - namebody · stringoptional
    name desition name
- revisionbody · stringoptional
  泳道组描述信息
- descriptionbody · stringoptional
  泳道组描述信息
- ctimebody · stringoptional
  泳道组的创建时间
- mtimebody · stringoptional
  泳道组的更新时间
- rulesbody · LaneRule[]optional
  rules
  - idbody · stringoptional
    id
  - namebody · stringoptional
    name
  - group_namebody · stringoptional
    所属泳道组的名称
  - traffic_match_rulebody · TrafficMatchRuleoptional
    流量匹配规则
    - argumentsbody · SourceMatch[]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
    - random_percentbody · uint32optional
      随机百分比流量匹配, 1-100, 表示百分之几的流量会被匹配到, 默认值为 100
    - matchModebody · enum(TrafficMatchMode)optional
      matchMode enum: AND | OR
  - default_label_valuebody · stringoptional
    保存这个泳道的默认实例标签
  - enablebody · booloptional
    泳道规则是否启用
  - match_modebody · enum(LaneMatchMode)optional
    match_mode enum: STRICT | PERMISSIVE
  - 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
  - prioritybody · uint32optional
    priority rules priority
  - descriptionbody · stringoptional
    description simple description rules
  - label_keybody · stringoptional
    属于该泳道的实例标签KEY，不填默认为lane
- metadatabody · map<string,string>optional
  metadata
- editablebody · booloptional
  操作标志位
- deleteablebody · booloptional
  deleteable
- namespacebody · stringoptional
  namespace identifies the environment that owns this lane group.

Request

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

Publish lane

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/lane/groups/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/lane/groups/releasesAuth required

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

Response example

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

PUT/naming/v1/lane/groups/releases/rollbackAuth required

Rollback lane

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

Stop lane 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/lane/groups/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/lane/groups/rulesAuth required

Create lane rules

Create lane rules.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneRule[]required
JSON array of LaneRule; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
group_namebody · stringoptional
group_name
traffic_match_rulebody · TrafficMatchRuleoptional
traffic_match_rule
- argumentsbody · SourceMatch[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - 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
- random_percentbody · uint32optional
  random_percent
- matchModebody · enum(TrafficMatchMode)optional
  matchMode enum: AND | OR
default_label_valuebody · stringoptional
default_label_value
enablebody · booloptional
enable
match_modebody · enum(LaneMatchMode)optional
match_mode enum: STRICT | PERMISSIVE
prioritybody · uint32optional
priority
descriptionbody · stringoptional
description
label_keybody · stringoptional
label_key

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
LaneRulebody · LaneRuleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  group_name
- traffic_match_rulebody · TrafficMatchRuleoptional
  traffic_match_rule
  - argumentsbody · SourceMatch[]optional
    arguments
    - typebody · enum(Type)optional
      type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - 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
  - random_percentbody · uint32optional
    random_percent
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  default_label_value
- enablebody · booloptional
  enable
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- revisionbody · stringoptional
  revision
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- etimebody · stringoptional
  etime
- prioritybody · uint32optional
  priority
- descriptionbody · stringoptional
  description
- label_keybody · stringoptional
  label_key

Request

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

Response example

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

PUT/naming/v1/lane/groups/rulesAuth required

Update lane rules

Update lane rules.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneRule[]required
JSON array of LaneRule; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
group_namebody · stringoptional
group_name
traffic_match_rulebody · TrafficMatchRuleoptional
traffic_match_rule
- argumentsbody · SourceMatch[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - 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
- random_percentbody · uint32optional
  random_percent
- matchModebody · enum(TrafficMatchMode)optional
  matchMode enum: AND | OR
default_label_valuebody · stringoptional
default_label_value
enablebody · booloptional
enable
match_modebody · enum(LaneMatchMode)optional
match_mode enum: STRICT | PERMISSIVE
prioritybody · uint32optional
priority
descriptionbody · stringoptional
description
label_keybody · stringoptional
label_key

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
LaneRulebody · LaneRuleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  group_name
- traffic_match_rulebody · TrafficMatchRuleoptional
  traffic_match_rule
  - argumentsbody · SourceMatch[]optional
    arguments
    - typebody · enum(Type)optional
      type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - 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
  - random_percentbody · uint32optional
    random_percent
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  default_label_value
- enablebody · booloptional
  enable
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- revisionbody · stringoptional
  revision
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- etimebody · stringoptional
  etime
- prioritybody · uint32optional
  priority
- descriptionbody · stringoptional
  description
- label_keybody · stringoptional
  label_key

Request

curl -sS -X PUT 'http://127.0.0.1:8090/naming/v1/lane/groups/rules' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

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

POST/naming/v1/lane/groups/rules/deleteAuth required

Delete lane rules

Delete lane rules.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · LaneRule[]required
JSON array of LaneRule; fields below are per-item.
idbody · stringoptional
id
namebody · stringoptional
name
group_namebody · stringoptional
group_name
traffic_match_rulebody · TrafficMatchRuleoptional
traffic_match_rule
- argumentsbody · SourceMatch[]optional
  arguments
  - typebody · enum(Type)optional
    type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
  - 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
- random_percentbody · uint32optional
  random_percent
- matchModebody · enum(TrafficMatchMode)optional
  matchMode enum: AND | OR
default_label_valuebody · stringoptional
default_label_value
enablebody · booloptional
enable
match_modebody · enum(LaneMatchMode)optional
match_mode enum: STRICT | PERMISSIVE
prioritybody · uint32optional
priority
descriptionbody · stringoptional
description
label_keybody · stringoptional
label_key

Response fields

codebody · uint32required
Business code.
infobody · stringoptional
Info.
LaneRulebody · LaneRuleoptional
Entity fields.
- idbody · stringoptional
  id
- namebody · stringoptional
  name
- group_namebody · stringoptional
  group_name
- traffic_match_rulebody · TrafficMatchRuleoptional
  traffic_match_rule
  - argumentsbody · SourceMatch[]optional
    arguments
    - typebody · enum(Type)optional
      type enum: CUSTOM | METHOD | HEADER | QUERY | CALLER_IP | PATH | COOKIE | CALLER_METADATA | CALLER_SERVICE
    - 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
  - random_percentbody · uint32optional
    random_percent
  - matchModebody · enum(TrafficMatchMode)optional
    matchMode enum: AND | OR
- default_label_valuebody · stringoptional
  default_label_value
- enablebody · booloptional
  enable
- match_modebody · enum(LaneMatchMode)optional
  match_mode enum: STRICT | PERMISSIVE
- revisionbody · stringoptional
  revision
- ctimebody · stringoptional
  ctime
- mtimebody · stringoptional
  mtime
- etimebody · stringoptional
  etime
- prioritybody · uint32optional
  priority
- descriptionbody · stringoptional
  description
- label_keybody · stringoptional
  label_key

Request

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

Response example

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

POST/naming/v1/lane/groups/releases/deleteAuth required

Delete lane releases

Delete lane 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/lane/groups/releases/delete' \
  -H "Authorization: $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response example

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

Lane

List lane

Get lane detail

Create lane

Update lane

Delete lane

Publish lane

List lane releases

Rollback lane

Stop lane gray

Create lane rules

Update lane rules

Delete lane rules

Delete lane releases

On this page