文档

DescribeNamespaceScopeSidecarConfig - 查询Sidecar配置

更新时间:

调用DescribeNamespaceScopeSidecarConfig查询命名空间级别的Sidecar配置设置。

调试

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

授权信息

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

请求参数

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

ASM 实例 ID。

c7120e75a202d4fd8acb028a86b6a****
Namespacestring

命名空间。

default

返回参数

名称类型描述示例值
object

响应体。

RequestIdstring

请求 ID。

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

命名空间级别配置内容。

TerminationDrainDurationstring

Sidecar 代理终止等待时间。

6s
SidecarProxyInitResourceLimitobject

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

ResourceCPULimitstring

CPU 资源限制。

2000 m
ResourceMemoryLimitstring

内存资源限制。

50 Mi
SidecarProxyInitResourceRequestobject

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

ResourceCPURequeststring

CPU 资源最低要求。

60 m
ResourceMemoryRequeststring

内存资源最低要求。

30 Mi
SidecarProxyResourceLimitobject

Sidecar 代理容器资源限制。

ResourceCPULimitstring

CPU 资源限制。

2000 m
ResourceMemoryLimitstring

内存资源限制。

50 Mi
SidecarProxyResourceRequestobject

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

ResourceCPURequeststring

CPU 资源最低要求。

60 m
ResourceMemoryRequeststring

内存资源限制。

30 Mi
ExcludeOutboundPortsstring

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

81
ExcludeOutboundIPRangesstring

免于经过 Sidecar 代理的出口流量 IP 地址。

192.168.1.3/31
IncludeOutboundIPRangesstring

经过 Sidecar 代理的出口流量 IP 地址。

192.168.1.4/31
ExcludeInboundPortsstring

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

82
IncludeInboundPortsstring

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

83
IncludeOutboundPortsstring

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

84
IstioDNSProxyEnabledboolean

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

  • true:启用 DNS 代理功能。

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

true
LifecycleStrstring

Sidecar 代理生命周期 JSON 字符串。

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

istio-proxy 并发度设置。

2
LogLevelstring

日志等级,取值:infodebugtraceerror

info
HoldApplicationUntilProxyStartsboolean

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

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

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

true
ProxyStatsMatcherobject

用于 Envoy 监控统计的指标。

InclusionPrefixesarray

Envoy 监控统计的指标前缀列表。

string

Envoy 监控统计的指标前缀。

server
InclusionSuffixesarray

Envoy 监控统计的指标后缀列表。

string

Envoy 监控统计的指标后缀。

cluster.outbound
InclusionRegexpsarray

Envoy 监控统计的指标正则表达式列表。

string

Envoy 监控统计的指标正则表达式。

listener.*.downstream_cx_total
Tracingobject

自定义的链路追踪配置。

Samplingdouble

链路追踪的采样率。

99.8
CustomTagsobject

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

  • literal:链路追踪标签值将取固定值,JSON 对象类型,其中必须包含value字段,指定固定的字面量值,例如{"value":"test"}

  • header:链路追踪标签值将取指定的请求头,JSON 对象类型,其中必须包含name字段和defaultValue字段,指定请求头的名称和取不到时的默认值,例如{"name":"test","defaultValue":"test"}

  • environment:链路追踪标签值将取指定的环境变量,JSON 对象类型,其中必须包含name字段和defaultValue字段,指定环境变量的名称和取不到时的默认值,例如{"name":"test","defaultValue":"test"}

{"test":{"literal":{"value":"test"}}}
MaxPathTagLengthinteger

链路追踪标签最大长度限制。

10
InterceptionModestring

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

  • REDIRECT:默认的拦截策略,Sidecar 将使用重定向方式拦截入向流量。

  • TPROXY:透明代理拦截策略,Sidecar 将以透明代理的方式拦截入向流量。

TPROXY
ProxyMetadataobject

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

string

在 Sidecar 代理中额外添加的环境变量值。

"true"
SidecarProxyInitAckSloResourceobject

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

Requestsobject

Sidecar 代理初始化容器资源最低申请额度设置(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签 labelkoordinator.sh/qosClass 时,使用此值设定 Sidecar 代理初始化容器资源最低申请额度。 对象中可能包含两种键,对应两种类型的资源:

  1. kubernetes.io/batch-cpu:ACK 超卖类型 CPU 资源,单位为千分之一核。

  2. kubernetes.io/batch-memory:ACK 超卖类型内存资源。

string

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

128Mi
Limitsobject

Sidecar 代理初始化容器资源限制设置(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签 labelkoordinator.sh/qosClass 时,使用此值设定 Sidecar 代理初始化容器资源限制。 对象中可能包含两种键,对应两种类型的资源:

  1. kubernetes.io/batch-cpu:ACK 超卖类型 CPU 资源,单位为千分之一核。

  2. kubernetes.io/batch-memory:ACK 超卖类型内存资源。

string

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

2048Mi
SidecarProxyAckSloResourceobject

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

Requestsobject

Sidecar 代理容器资源最低申请额度设置(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签 labelkoordinator.sh/qosClass 时,使用此值设定 Sidecar 代理容器资源最低申请额度。 对象中可能包含两种键,对应两种类型的资源:

  1. kubernetes.io/batch-cpu:ACK 超卖类型 CPU 资源,单位为千分之一核。

  2. kubernetes.io/batch-memory:ACK 超卖类型内存资源。

string

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

128Mi
Limitsobject

Sidecar 代理容器资源限制设置(ACK 动态超卖资源形式),当 Pod 带有 ACK 动态资源超卖标签 labelkoordinator.sh/qosClass 时,使用此值设定 Sidecar 代理容器资源限制。 对象中可能包含两种键,对应两种类型的资源:

  1. kubernetes.io/batch-cpu:ACK 超卖类型 CPU 资源,单位为千分之一核。

  2. kubernetes.io/batch-memory:ACK 超卖类型内存资源。

string

Sidecar 代理容器资源限制值。

2048Mi
Privilegedboolean

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

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

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

false
EnableCoreDumpboolean

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

  • true:为 Sidecar 代理容器启用 core dump。

  • false:不为 Sidecar 代理容器启用 core dump。

false
ReadinessInitialDelaySecondsinteger

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

2
ReadinessPeriodSecondsinteger

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

3
ReadinessFailureThresholdinteger

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

5

示例

正常返回示例

JSON格式

{
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "ConfigPatches": {
    "TerminationDrainDuration": "6s",
    "SidecarProxyInitResourceLimit": {
      "ResourceCPULimit": "2000 m",
      "ResourceMemoryLimit": "50 Mi"
    },
    "SidecarProxyInitResourceRequest": {
      "ResourceCPURequest": "60 m",
      "ResourceMemoryRequest": "30 Mi"
    },
    "SidecarProxyResourceLimit": {
      "ResourceCPULimit": "2000 m",
      "ResourceMemoryLimit": "50 Mi"
    },
    "SidecarProxyResourceRequest": {
      "ResourceCPURequest": "60 m",
      "ResourceMemoryRequest": "30 Mi"
    },
    "ExcludeOutboundPorts": "81",
    "ExcludeOutboundIPRanges": "192.168.1.3/31",
    "IncludeOutboundIPRanges": "192.168.1.4/31",
    "ExcludeInboundPorts": "82",
    "IncludeInboundPorts": "83",
    "IncludeOutboundPorts": "84",
    "IstioDNSProxyEnabled": true,
    "LifecycleStr": "{\"postStart\":{\"exec\":{\"command\":[\"pilot-agent\",\"wait\"]}},\"preStop\":{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"sleep 15\"]}}}",
    "Concurrency": 2,
    "LogLevel": "info",
    "HoldApplicationUntilProxyStarts": true,
    "ProxyStatsMatcher": {
      "InclusionPrefixes": [
        "server"
      ],
      "InclusionSuffixes": [
        "cluster.outbound"
      ],
      "InclusionRegexps": [
        "listener.*.downstream_cx_total"
      ]
    },
    "Tracing": {
      "Sampling": 99.8,
      "CustomTags": {
        "test": {
          "literal": {
            "value": "test"
          }
        }
      },
      "MaxPathTagLength": 10
    },
    "InterceptionMode": "TPROXY",
    "ProxyMetadata": {
      "key": "\"true\""
    },
    "SidecarProxyInitAckSloResource": {
      "Requests": {
        "key": "128Mi"
      },
      "Limits": {
        "key": "2048Mi"
      }
    },
    "SidecarProxyAckSloResource": {
      "Requests": {
        "key": "128Mi"
      },
      "Limits": {
        "key": "2048Mi"
      }
    },
    "Privileged": false,
    "EnableCoreDump": false,
    "ReadinessInitialDelaySeconds": 2,
    "ReadinessPeriodSeconds": 3,
    "ReadinessFailureThreshold": 5
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-31OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈