更新Sidecar配置
更新时间 2026-02-27 11:40:43
最近更新时间: 2026-02-27 11:40:43
接口功能介绍
本接口更新命名空间级别的Sidecar配置设置。如果指定命名空间为istio-system则表示对所有命名空间生效。
接口约束
无
URI
POST /v1/open/sidecar/config/update
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池 ID | bb9fdb42056xxxeda1610242ac1xxxxx |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| customProxyConfig | 是 | Object | sidecar配置 | CustomProxyConfigReq | |
| name | 否 | String | 配置名称 | test-sidecar | |
| namespace | 否 | String | 服务网格命名空间,当scale为NAMESPACE 、WORKLOAD时必填 | default | |
| scale | 是 | String | sidecar配置作用范围，选择GLOBAL 、NAMESPACE、WORKLOAD | GLOBAL,NAMESPACE,WORKLOAD | |
| serviceMeshId | 是 | String | 服务网格id | e779bd8***** |
表 CustomProxyConfigReq
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| concurrency | 否 | Integer | Istio-Proxy线程数 | 2 | |
| enableCoreDump | 否 | Boolean | 核心转存 | false | |
| enableDnsCapture | 否 | Boolean | 是否开启istio内置dns | false | |
| enableElegantTermination | 否 | Boolean | 是否开启优雅终止 | false | |
| excludeIPRanges | 否 | String | 不拦截对外访问的地址范围 | 127.0.0.1 | |
| excludeInboundPorts | 否 | String | 设置端口使入口流量免于经过Sidecar代理 | 80,8080 | |
| excludeOutboundPorts | 否 | String | 设置端口使出口流量免于经过Sidecar代理 | 80,8080 | |
| holdApplicationUntilProxyStarts | 否 | Boolean | 生命周期管理 | true | |
| includeIPRanges | 否 | String | 拦截对外访问的地址范围 | 192.168.0.0/16 | |
| includeInboundPorts | 否 | String | 设置端口使入口流量经过Sidecar代理 | 443 | |
| includeOutboundPorts | 否 | String | 设置端口使出口流量经过Sidecar代理 | 443 | |
| interceptionMode | 否 | String | Sidecar对入向流量的拦截策略，REDIRECT：默认的拦截策略，Sidecar将使用重定向方式拦截入向流量。TPROXY：透明代理拦截策略，Sidecar将以透明代理的方式拦截入向流量。NONE:不拦截流量 | REDIRECT | |
| lifecycleStr | 否 | String | Sidecar代理生命周期JSON字符串 | ||
| logLevel | 否 | String | 日志等级，如果不设置则为warning | info | |
| outboundTrafficPolicy | 否 | String | 出向流量策略。取值：ALLOW_ANY：允许访问所有外部服务。REGISTRY_ONLY：只能访问注册到网格内的服务。 | ALLOW_ANY | |
| proxyMetadata | 否 | Map of String | 环境变量 | ||
| proxyStatsMatcher | 否 | Object | 统计相关指标 | CustomProxyConfig_ProxyStatsMatcher | |
| selector | 否 | Map of String | workload的标签选择器 | ||
| sidecarProxyInitResourceLimit | 否 | Object | Sidecar代理初始化容器资源限制 | ResourcesLimitReq | |
| sidecarProxyInitResourceRequest | 否 | Object | Sidecar代理初始化容器资源最低申请额度 | ResourcesRequestReq | |
| sidecarProxyResourceLimit | 否 | Object | Sidecar代理容器资源限制 | ResourcesLimitReq | |
| sidecarProxyResourceRequest | 否 | Object | Sidecar代理容器资源最低申请额度 | ResourcesRequestReq | |
| terminationDrainDuration | 否 | String | Istio Proxy终止等待时长 | 5s |
表 CustomProxyConfig_ProxyStatsMatcher
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| inclusion_prefixes | 否 | Array of Strings | Envoy监控统计的指标前缀 | ||
| inclusion_regexps | 否 | Array of Strings | Envoy监控统计的指标正则表达式 | ||
| inclusion_suffixes | 否 | Array of Strings | Envoy监控统计的指标后缀 |
表 ResourcesLimitReq
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceCPULimit | 否 | String | CPU资源限制 | 1000m | |
| resourceMemoryLimit | 否 | String | 内存资源限制 | 1024Mi |
表 ResourcesRequestReq
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourceCPURequest | 否 | String | CPU资源最低要求 | 1000m | |
| resourceMemoryRequest | 否 | String | 内存资源最低要求 | 1024Mi |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 错误码 | CSM_2000 | |
| returnObj | Object | API返回数据体,接口如果没有返回字段时也可能可能返回{}或[] | ||
| statusCode | Integer | 返回码状态 | 2000 | |
| message | String | 错误提示信息 | SUCCESS |
枚举参数
无
请求示例
请求url
POST /v1/cae/v1/open/sidecar/config/update
请求头header
regionId:20000000***1852
请求体body
{
"customProxyConfig": {
"concurrency": 2,
"enableCoreDump": false,
"enableDnsCapture": true,
"enableElegantTermination": true,
"excludeIPRanges": "169.254.7.127/32",
"excludeInboundPorts": "15020,15021,15090",
"excludeOutboundPorts": "53",
"holdApplicationUntilProxyStarts": true,
"includeIPRanges": "*",
"includeInboundPorts": "*",
"includeOutboundPorts": "80,443",
"interceptionMode": "REDIRECT",
"lifecycleStr": "{\"preStop\":{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"sleep 10\"]}}}",
"logLevel": "info",
"outboundTrafficPolicy": "ALLOW_ANY",
"proxyMetadata": {
"ISTIO_META_DNS_AUTO_ALLOCATE": "true",
"ISTIO_META_DNS_CAPTURE": "true"
},
"proxyStatsMatcher": {
"inclusion_prefixes": [
"cluster.outbound",
"listener"
],
"inclusion_regexps": [
".*upstream_rq.*"
],
"inclusion_suffixes": [
"cx_total"
]
},
"selector": {},
"sidecarProxyInitResourceLimit": {
"resourceCPULimit": "200m",
"resourceMemoryLimit": "256Mi"
},
"sidecarProxyInitResourceRequest": {
"resourceCPURequest": "50m",
"resourceMemoryRequest": "64Mi"
},
"sidecarProxyResourceLimit": {
"resourceCPULimit": "1000m",
"resourceMemoryLimit": "1024Mi"
},
"sidecarProxyResourceRequest": {
"resourceCPURequest": "200m",
"resourceMemoryRequest": "256Mi"
},
"terminationDrainDuration": "30s"
},
"name": "namespace-sidecar-default",
"namespace": "default",
"scale": "NAMESPACE",
"serviceMeshId": "e779bd8*****"
}
响应示例
{
"error": "CSM_2000",
"returnObj": {},
"statusCode": 2000,
"message": "SUCCESS"
}
状态码
请参考 状态码
错误码
请参考 错误码
