保留参数

大约 2 分钟

保留参数

自第一代sekiro开源版开始,sekiro就存在一些特殊的保留参数,他们大多对sekiro的调用行为存在特殊影响。 所以一般情况下用户使用sekiro的时候,需要关注这些特殊参数的作用,以及自定义参数尽量不要和保留参数重复。

group

接口组概念,区分sekiro的业务类型。在之前章节有对group的解释

action

接口概念,区分统一个接口组下的具体接口,在注册sekiroHandler的时候,需要给每个handler指定一个action。在之前章节有对action的解释

sekiro_token

sekiro的API鉴权token,当您调用一个sekiro非匿名服务的时候,需要指定token。sekiro服务器根据token判定您是否有权限访问,以及最终时间流量的监控、记录、拦截等逻辑。 sekiro_token参数在sekiro网站后台查看。每个用户都是独立的sekiro_token

请注意,开源demo由于不存在权限系统,所以这个参数在开源demo版本中不存在,也不是保留字

bind_client

调用转发指定设备id,在sekiro的转发调度算法中,默认是使用one by one的方式,但是如果你希望多次调用在同一台设备下,那么通过这个参数指定clientId

invoke_timeout

指定整个调用过程的超时时间,单位为毫秒。如果不设定,默认为5s

consistent_key

一致性哈希调度关键key,支持一致性哈希调度,这样类似的请求可以聚拢在特定的设备下。请注意,如果您的设备数量很少(小于20),那么非常不建议您使用一致性哈希模式, 一致性哈希算法在节点过少的情况下,大概率会导致分布不均匀。

__invoke_trace_id

traceId,用于串联sekiro调用过程的任务日志,同时当传递了这个参数之后,sekiro系统将会尽可能的打印更加详细的日志。如此可以方便您排查特定case的调用问题。

__action_list

action=__action_list,查看当前group下注册的action 列表。

__sekiro_system_timeout

系统给客户端发送的一个特殊参数,本文档不详细讲述含义

__response_5xx_as_json

本参数当前废弃,但是用户也不要使用它。

__sekiro_seq__

调用流水号,主要用在jsRPC中,为jsRPC内部传输数据需要的一个字段,用户不要使用它

__NOT_COMPRESS_FOR_SEKIRO_SEKIRO

标记改调用请求来自invoker,拥有次标记的请求在sekiro服务器转发过程不会进行压缩和解压处理。用来减少sekiro服务器的CPU压力。

__status__

sekiroFastJson模块使用的一个保留参数,用户不能使用它。否则可能导致数据紊乱

上次编辑于:
贡献者: liguobao