Interface Option

interface Option {
    canary?: string;
    destinationEnvName?: string;
    enableFailOverDefaultMeta?: boolean;
    envKey?: string;
    failOverDefaultMeta?: FailOverDefaultMeta;
    flowID?: number;
    lbPolicy?: string;
    metadata?: Record<string, string>;
    replicateCount?: number;
    retryCount?: number;
    sourceService?: SourceService;
    timeoutMs?: number;
}

Properties

canary? destinationEnvName? enableFailOverDefaultMeta? envKey? failOverDefaultMeta? flowID? lbPolicy? metadata? replicateCount? retryCount? sourceService? timeoutMs?

Properties

Optionalcanary

canary?: string

canary 金丝雀

OptionaldestinationEnvName

destinationEnvName?: string

destinationEnvName 被调服务环境名

OptionalenableFailOverDefaultMeta

enableFailOverDefaultMeta?: boolean

enableFailOverDefaultMeta 是否开启元数据匹配不到时启用自定义匹配规则，仅用于dstMetadata路由插件

OptionalenvKey

envKey?: string

envKey 指定环境 key 路由

OptionalfailOverDefaultMeta

failOverDefaultMeta?: FailOverDefaultMeta

failOverDefaultMeta 自定义匹配规则，仅当EnableFailOverDefaultMeta为true时生效

OptionalflowID

flowID?: number

flowID 可选，流水号，用于跟踪用户的请求，默认0

OptionallbPolicy

lbPolicy?: string

lbPolicy 可选，负载均衡算法

Optionalmetadata

metadata?: Record<string, string>

metadata 可选，元数据信息，仅用于dstMetadata路由插件的过滤

OptionalreplicateCount

replicateCount?: number

replicateCount 对于一致性hash等有状态的负载均衡方式

OptionalretryCount

retryCount?: number

retryCount 可选，重试次数，默认直接获取全局的超时配置

OptionalsourceService

sourceService?: SourceService

sourceService 主调方服务信息

OptionaltimeoutMs

timeoutMs?: number

timeoutMs 用户总最大超时时间为(1+RetryCount) * Timeout，单位毫秒

Settings

Member Visibility

On This Page

Properties