Lattice.Hub

Traffic security rules and releases.

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

Traffic security

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

GET/naming/v1/traffic/securityAuth required

List traffic security

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

Response example

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

GET/naming/v1/traffic/security/detailAuth required

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

Response example

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

POST/naming/v1/traffic/securityAuth required

Create traffic security

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

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · TrafficSecurityRule[]required
Request body is a JSON array of TrafficSecurityRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringrequired
规则名称
descriptionbody · stringoptional
规则描述
prioritybody · uint32optional
规则优先级
enablebody · booloptional
是否启用
target_servicebody · DestinationServiceoptional
被调服务，规则只绑定到该服务
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
policiesbody · TrafficSecurityPolicy[]optional
policies
- 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
- traffic_match_rulebody · TrafficMatchRuleoptional
  主调、请求头、查询参数、路径、Cookie 等流量匹配条件
  - 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
- actionbody · enum(TrafficSecurityAction)optional
  命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
- reject_effectbody · TrafficSecurityRejectEffectoptional
  拒绝调用时的响应效果，仅 action=DENY 时生效
  - codebody · stringoptional
    业务错误码
  - messagebody · stringoptional
    拒绝原因
- managed_callerbody · ManagedCallerSelectoroptional
  托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
  - any_authenticatedbody · booloptional
    接受任意已通过托管身份认证的服务。
  - callersbody · SourceService[]optional
    callers
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
metadatabody · map<string,string>optional
metadata
authenticationbody · TrafficSecurityAuthenticationoptional
规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
- modebody · enum(TrafficSecurityAuthMode)optional
  mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
- managed_identitybody · ManagedIdentityAuthenticationoptional
  managed_identity
- custom_headerbody · CustomHeaderAuthenticationoptional
  custom_header
  - header_namebody · stringoptional
    header_name
  - valuebody · stringoptional
    仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
  - value_sha256body · stringoptional
    control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
namespacebody · stringrequired
namespace identifies the environment that owns this rule.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
trafficSecurityRulebody · TrafficSecurityRuleoptional
TrafficSecurityRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  规则名称
- descriptionbody · stringoptional
  规则描述
- prioritybody · uint32optional
  规则优先级
- enablebody · booloptional
  是否启用
- target_servicebody · DestinationServiceoptional
  被调服务，规则只绑定到该服务
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- policiesbody · TrafficSecurityPolicy[]optional
  policies
  - 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
  - traffic_match_rulebody · TrafficMatchRuleoptional
    主调、请求头、查询参数、路径、Cookie 等流量匹配条件
    - 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
  - actionbody · enum(TrafficSecurityAction)optional
    命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
  - reject_effectbody · TrafficSecurityRejectEffectoptional
    拒绝调用时的响应效果，仅 action=DENY 时生效
    - codebody · stringoptional
      业务错误码
    - messagebody · stringoptional
      拒绝原因
  - managed_callerbody · ManagedCallerSelectoroptional
    托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
    - any_authenticatedbody · booloptional
      接受任意已通过托管身份认证的服务。
    - callersbody · SourceService[]optional
      callers
      - servicebody · stringoptional
        Main tuning service and namespace
      - namespacebody · stringoptional
        namespace
- ctimebody · stringoptional
  创建时间
- mtimebody · stringoptional
  修改时间
- metadatabody · map<string,string>optional
  metadata
- revisionbody · stringoptional
  规则 revision
- editablebody · booloptional
  规则的权限操作状态
- deleteablebody · booloptional
  deleteable
- authenticationbody · TrafficSecurityAuthenticationoptional
  规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
  - modebody · enum(TrafficSecurityAuthMode)optional
    mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
  - managed_identitybody · ManagedIdentityAuthenticationoptional
    managed_identity
  - custom_headerbody · CustomHeaderAuthenticationoptional
    custom_header
    - header_namebody · stringoptional
      header_name
    - valuebody · stringoptional
      仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
    - value_sha256body · stringoptional
      control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
- namespacebody · stringoptional
  namespace identifies the environment that owns this rule.

Request

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

Response example

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

PUT/naming/v1/traffic/securityAuth required

Update traffic security

Update rules; body is an array.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · TrafficSecurityRule[]required
Request body is a JSON array of TrafficSecurityRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
规则名称
descriptionbody · stringoptional
规则描述
prioritybody · uint32optional
规则优先级
enablebody · booloptional
是否启用
target_servicebody · DestinationServiceoptional
被调服务，规则只绑定到该服务
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
policiesbody · TrafficSecurityPolicy[]optional
policies
- 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
- traffic_match_rulebody · TrafficMatchRuleoptional
  主调、请求头、查询参数、路径、Cookie 等流量匹配条件
  - 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
- actionbody · enum(TrafficSecurityAction)optional
  命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
- reject_effectbody · TrafficSecurityRejectEffectoptional
  拒绝调用时的响应效果，仅 action=DENY 时生效
  - codebody · stringoptional
    业务错误码
  - messagebody · stringoptional
    拒绝原因
- managed_callerbody · ManagedCallerSelectoroptional
  托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
  - any_authenticatedbody · booloptional
    接受任意已通过托管身份认证的服务。
  - callersbody · SourceService[]optional
    callers
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
metadatabody · map<string,string>optional
metadata
authenticationbody · TrafficSecurityAuthenticationoptional
规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
- modebody · enum(TrafficSecurityAuthMode)optional
  mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
- managed_identitybody · ManagedIdentityAuthenticationoptional
  managed_identity
- custom_headerbody · CustomHeaderAuthenticationoptional
  custom_header
  - header_namebody · stringoptional
    header_name
  - valuebody · stringoptional
    仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
  - value_sha256body · stringoptional
    control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
namespacebody · stringoptional
namespace identifies the environment that owns this rule.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
trafficSecurityRulebody · TrafficSecurityRuleoptional
TrafficSecurityRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  规则名称
- descriptionbody · stringoptional
  规则描述
- prioritybody · uint32optional
  规则优先级
- enablebody · booloptional
  是否启用
- target_servicebody · DestinationServiceoptional
  被调服务，规则只绑定到该服务
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- policiesbody · TrafficSecurityPolicy[]optional
  policies
  - 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
  - traffic_match_rulebody · TrafficMatchRuleoptional
    主调、请求头、查询参数、路径、Cookie 等流量匹配条件
    - 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
  - actionbody · enum(TrafficSecurityAction)optional
    命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
  - reject_effectbody · TrafficSecurityRejectEffectoptional
    拒绝调用时的响应效果，仅 action=DENY 时生效
    - codebody · stringoptional
      业务错误码
    - messagebody · stringoptional
      拒绝原因
  - managed_callerbody · ManagedCallerSelectoroptional
    托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
    - any_authenticatedbody · booloptional
      接受任意已通过托管身份认证的服务。
    - callersbody · SourceService[]optional
      callers
      - servicebody · stringoptional
        Main tuning service and namespace
      - namespacebody · stringoptional
        namespace
- ctimebody · stringoptional
  创建时间
- mtimebody · stringoptional
  修改时间
- metadatabody · map<string,string>optional
  metadata
- revisionbody · stringoptional
  规则 revision
- editablebody · booloptional
  规则的权限操作状态
- deleteablebody · booloptional
  deleteable
- authenticationbody · TrafficSecurityAuthenticationoptional
  规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
  - modebody · enum(TrafficSecurityAuthMode)optional
    mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
  - managed_identitybody · ManagedIdentityAuthenticationoptional
    managed_identity
  - custom_headerbody · CustomHeaderAuthenticationoptional
    custom_header
    - header_namebody · stringoptional
      header_name
    - valuebody · stringoptional
      仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
    - value_sha256body · stringoptional
      control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
- namespacebody · stringoptional
  namespace identifies the environment that owns this rule.

Request

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

Response example

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

POST/naming/v1/traffic/security/deleteAuth required

Delete traffic security

Delete rules; body is an array with ids.

Parameters

Authorizationheader · stringrequired
Token from login.
(body)body · TrafficSecurityRule[]required
Request body is a JSON array of TrafficSecurityRule: [{...}, ...]. Fields below are the full per-item schema (including nested).
idbody · stringoptional
id
namebody · stringoptional
规则名称
descriptionbody · stringoptional
规则描述
prioritybody · uint32optional
规则优先级
enablebody · booloptional
是否启用
target_servicebody · DestinationServiceoptional
被调服务，规则只绑定到该服务
- servicebody · stringoptional
  Main tuning service and namespace
- namespacebody · stringoptional
  namespace
policiesbody · TrafficSecurityPolicy[]optional
policies
- 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
- traffic_match_rulebody · TrafficMatchRuleoptional
  主调、请求头、查询参数、路径、Cookie 等流量匹配条件
  - 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
- actionbody · enum(TrafficSecurityAction)optional
  命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
- reject_effectbody · TrafficSecurityRejectEffectoptional
  拒绝调用时的响应效果，仅 action=DENY 时生效
  - codebody · stringoptional
    业务错误码
  - messagebody · stringoptional
    拒绝原因
- managed_callerbody · ManagedCallerSelectoroptional
  托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
  - any_authenticatedbody · booloptional
    接受任意已通过托管身份认证的服务。
  - callersbody · SourceService[]optional
    callers
    - servicebody · stringoptional
      Main tuning service and namespace
    - namespacebody · stringoptional
      namespace
metadatabody · map<string,string>optional
metadata
authenticationbody · TrafficSecurityAuthenticationoptional
规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
- modebody · enum(TrafficSecurityAuthMode)optional
  mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
- managed_identitybody · ManagedIdentityAuthenticationoptional
  managed_identity
- custom_headerbody · CustomHeaderAuthenticationoptional
  custom_header
  - header_namebody · stringoptional
    header_name
  - valuebody · stringoptional
    仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
  - value_sha256body · stringoptional
    control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
namespacebody · stringoptional
namespace identifies the environment that owns this rule.

Response fields

codebody · uint32required
Business code; success is usually 200000.
infobody · stringoptional
Info message.
trafficSecurityRulebody · TrafficSecurityRuleoptional
TrafficSecurityRule entity fields (batch APIs nest under responses[]).
- idbody · stringoptional
  id
- namebody · stringoptional
  规则名称
- descriptionbody · stringoptional
  规则描述
- prioritybody · uint32optional
  规则优先级
- enablebody · booloptional
  是否启用
- target_servicebody · DestinationServiceoptional
  被调服务，规则只绑定到该服务
  - servicebody · stringoptional
    Main tuning service and namespace
  - namespacebody · stringoptional
    namespace
- policiesbody · TrafficSecurityPolicy[]optional
  policies
  - 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
  - traffic_match_rulebody · TrafficMatchRuleoptional
    主调、请求头、查询参数、路径、Cookie 等流量匹配条件
    - 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
  - actionbody · enum(TrafficSecurityAction)optional
    命中该策略后的动作 enum: TRAFFIC_SECURITY_ALLOW | TRAFFIC_SECURITY_DENY
  - reject_effectbody · TrafficSecurityRejectEffectoptional
    拒绝调用时的响应效果，仅 action=DENY 时生效
    - codebody · stringoptional
      业务错误码
    - messagebody · stringoptional
      拒绝原因
  - managed_callerbody · ManagedCallerSelectoroptional
    托管身份模式下，从已认证主体中匹配可信来源服务。不得从调用方自行填写的普通 Header 或 metadata 中取值。
    - any_authenticatedbody · booloptional
      接受任意已通过托管身份认证的服务。
    - callersbody · SourceService[]optional
      callers
      - servicebody · stringoptional
        Main tuning service and namespace
      - namespacebody · stringoptional
        namespace
- ctimebody · stringoptional
  创建时间
- mtimebody · stringoptional
  修改时间
- metadatabody · map<string,string>optional
  metadata
- revisionbody · stringoptional
  规则 revision
- editablebody · booloptional
  规则的权限操作状态
- deleteablebody · booloptional
  deleteable
- authenticationbody · TrafficSecurityAuthenticationoptional
  规则级认证配置。历史规则缺少该字段时继续按旧请求匹配语义执行。
  - modebody · enum(TrafficSecurityAuthMode)optional
    mode enum: LEGACY_REQUEST_MATCH | MANAGED_IDENTITY | CUSTOM_HEADER
  - managed_identitybody · ManagedIdentityAuthenticationoptional
    managed_identity
  - custom_headerbody · CustomHeaderAuthenticationoptional
    custom_header
    - header_namebody · stringoptional
      header_name
    - valuebody · stringoptional
      仅由管理面创建/更新请求写入；control-plane 持久化前必须清空。
    - value_sha256body · stringoptional
      control-plane 生成的数据面精确验证摘要；管理面不得接受调用方写入。
- namespacebody · stringoptional
  namespace identifies the environment that owns this rule.

Request

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

Publish traffic security

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/traffic/security/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/traffic/security/releasesAuth required

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

Response example

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

PUT/naming/v1/traffic/security/releases/stopbetaAuth required

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

Response example

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

Traffic security

List traffic security

Get traffic security detail

Create traffic security

Update traffic security

Delete traffic security

Publish traffic security

List traffic security releases

Stop traffic security gray

Delete releases

On this page