全部产品
Search
文档中心

服务网格 ASM:UpdateNamespaceScopeSidecarConfig - 更新Sidecar配置

更新时间:Mar 21, 2024

调用UpdateNamespaceScopeSidecarConfig更新命名空间级别的Sidecar配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

ASM 实例 ID。

ca04bc38979214bf2882be79d39b4****
Namespacestring

命名空间。

default
IncludeIPRangesstring

拦截对外访问的地址范围global.proxy.includelPRanges

*
ExcludeIPRangesstring

不拦截对外访问的地址范围global.proxy.excludelPRanges

172.16.0.0/12
IncludeInboundPortsstring

经过 Sidecar 代理的入口流量端口。

83
ExcludeOutboundPortsstring

免于经过 Sidecar 代理的出口流量端口。

81
ExcludeInboundPortsstring

免于经过 Sidecar 代理的入口流量端口。

82
IncludeOutboundPortsstring

经过 Sidecar 代理的出口流量端口。

84
TerminationDrainDurationstring

Sidecar 代理终止等待时间。

6s
ProxyInitCPUResourceLimitstring

Sidecar 代理初始化容器 CPU 资源限制。

2000 m
ProxyInitMemoryResourceLimitstring

Sidecar 代理初始化容器内存资源限制。

50 Mi
ProxyInitCPUResourceRequeststring

Sidecar 代理初始化容器 CPU 资源最低申请额度。

60 m
ProxyInitMemoryResourceRequeststring

Sidecar 代理初始化容器内存资源最低申请额度。

30 Mi
SidecarProxyCPUResourceLimitstring

Sidecar 代理容器 CPU 资源限制。

2000 m
SidecarProxyMemoryResourceLimitstring

Sidecar 代理容器内存资源限制。

50 Mi
SidecarProxyCPUResourceRequeststring

Sidecar 代理容器 CPU 资源最低申请额度。

60 m
SidecarProxyMemoryResourceRequeststring

Sidecar 代理容器内存资源最低申请额度。

30 Mi
Lifecyclestring

Sidecar Proxy 生命周期设置。

{"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}
IstioDNSProxyEnabledboolean

是否启用 DNS 代理功能,取值:

  • true:启用 DNS 代理功能。

  • false:不启用 DNS 代理功能。

true
PostStartstring

istio-proxy 启动后执行参数。

{"exec":{"command":["pilot-agent","wait"]}}
PreStopstring

istio-proxy 终止前执行参数。

{"exec":{"command":["/bin/sh","-c","sleep 15"]}}
Concurrencyinteger

istio-proxy 并发度设置。

2
ProxyStatsMatcherstring

用于 Envoy 监控统计的指标,使用 JSON 格式表示。

{ "inclusionPrefixes": [ "cluster.outbound", "cluster_manager", "listener_manager", "server", "cluster.xds-grpc" ], "inclusionRegexps": [ "listener.*.downstream_cx_total", "listener.*.downstream_cx_active" ] }
HoldApplicationUntilProxyStartsboolean

应用程序启动前是否等待 istio-proxy 启动完成,取值:

  • true:应用程序启动前等待 istio-proxy 启动完成。

  • false:应用程序启动前不等待 istio-proxy 启动完成。

true
LogLevelstring

日志等级,取值:infodebugtracingerror

info
Tracingstring

自定义的链路追踪配置,需要将链路追踪配置序列化为 JSON 字符串后传入。链路追踪配置中包含以下字段:

  • sampling:Double 类型,链路追踪的采样率。

  • custom_tags:Map 类型,其中键为自定义链路追踪标签的键,String 类型;值为自定义链路追踪标签的取值,JSON 对象类型,可以选择填入以下字段之一。

    • literal:链路追踪标签值将取固定值,JSON 对象类型,其中必须包含value字段,指定固定的字面量值,例如{"value":"test"}
    • header:链路追踪标签值将取指定的请求头,JSON 对象类型,其中必须包含name字段和defaultValue字段,指定请求头的名称和取不到时的默认值,例如{"name":"test","defaultValue":"test"}
    • environment:链路追踪标签值将取指定的环境变量,JSON 对象类型,其中必须包含name字段和defaultValue字段,指定环境变量的名称和取不到时的默认值,例如{"name":"test","defaultValue":"test"}
{"sampling":99.8,"custom_tags":{"test":{"literal":{"value":"testnamespace"}}}}
InterceptionModestring

Sidecar 对入向流量的拦截策略,取值如下:

  • REDIRECT:默认的拦截策略,Sidecar 将使用重定向方式拦截入向流量。
  • TPROXY:透明代理拦截策略,Sidecar 将以透明代理的方式拦截入向流量。
TPROXY
ProxyMetadatastring

在 Sidecar 代理中额外添加的环境变量,以 JSON 对象的形式表示。JSON 对象中的键和值分别代表添加至 Sidecar 代理环境变量的键和值。

{"EXIT_ON_ZERO_ACTIVE_CONNECTIONS":"true"}
ProxyInitAckSloCPUResourceLimitstring

Sidecar 代理初始化容器 CPU 资源限制(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理初始化容器 CPU 资源限制。单位为千分之一核。

2000
ProxyInitAckSloMemoryResourceLimitstring

Sidecar 代理初始化容器内存资源限制(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理初始化容器内存资源限制。

2048Mi
ProxyInitAckSloCPUResourceRequeststring

Sidecar 代理初始化容器 CPU 资源最低申请额度(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理初始化容器 CPU 资源最低申请额度。单位为千分之一核。

100
ProxyInitAckSloMemoryResourceRequeststring

Sidecar 代理初始化容器内存资源最低申请额度(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理初始化容器内存资源最低申请额度。

128Mi
SidecarProxyAckSloCPUResourceLimitstring

Sidecar 代理容器 CPU 资源限制(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理容器 CPU 资源限制。单位为千分之一核。

2000
SidecarProxyAckSloMemoryResourceLimitstring

Sidecar 代理容器内存资源限制(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理容器内存资源限制。

2048Mi
SidecarProxyAckSloCPUResourceRequeststring

Sidecar 代理容器 CPU 资源最低申请额度(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理容器 CPU 资源最低申请额度。单位为千分之一核。

100
SidecarProxyAckSloMemoryResourceRequeststring

Sidecar 代理容器内存资源最低申请额度(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签labelkoordinator.sh/qosClass时,使用此值设定 Sidecar 代理容器内存资源最低申请额度。

128Mi
Privilegedboolean

是否在 Sidecar 代理容器的安全上下文中为 Sidecar 代理容器设定为特权,取值:

  • true:Sidecar 代理容器具有特权。

  • false:Sidecar 代理容器没有特权。

false
EnableCoreDumpboolean

是否为 Sidecar 代理容器启用 Core Dump(程序崩溃时转储内存状态),取值:

  • true:为 Sidecar 代理容器启用 Core Dump。

  • false:不为 Sidecar 代理容器启用 Core Dump。

false
ReadinessInitialDelaySecondsinteger

在开始进行 Sidecar 代理容器的就绪性检查前等待的时间(单位:秒)。

1
ReadinessPeriodSecondsinteger

对 Sidecar 代理容器进行就绪性检查时,两次检查之间的时间间隔(单位:秒)。

2
ReadinessFailureThresholdinteger

判断 Sidecar 代理容器不就绪时所需的就绪性检查失败次数阈值。

5

返回参数

名称类型描述示例值
object

响应体。

RequestIdstring

请求 ID。

31d3a0f0-07ed-4f6e-9004-1804498c****

示例

正常返回示例

JSON格式

{
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-31OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Privileged
    新增入参:EnableCoreDump
    新增入参:ReadinessInitialDelaySeconds
    新增入参:ReadinessPeriodSeconds
    新增入参:ReadinessFailureThreshold
2023-03-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ProxyInitAckSloCPUResourceLimit
    新增入参:ProxyInitAckSloMemoryResourceLimit
    新增入参:ProxyInitAckSloCPUResourceRequest
    新增入参:ProxyInitAckSloMemoryResourceRequest
    新增入参:SidecarProxyAckSloCPUResourceLimit
    新增入参:SidecarProxyAckSloMemoryResourceLimit
    新增入参:SidecarProxyAckSloCPUResourceRequest
    新增入参:SidecarProxyAckSloMemoryResourceRequest