接口URL:/csm/v1/open/Sidecar/config/get
Content-Type:text/plain
请求方式:GET
URI参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
service_mesh_id | e779bd8***** | String | 是 | 服务网格id |
namespace | default | String | 否 | 命名空间,不填则默认为istio-system |
请求体参数说明:
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
无请求参数KEY/VALUE类型 |
返回参数说明:
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
code | CSM_2000 | String | 错误码 |
message | SUCCESS | String | 错误提示信息 |
returnObj | Object | Object | API返回数据体,接口如果没有返回字段时也可能可能返回{}或[] |
statusCode | 2000 | Integer | 调用错误时返回的错误编码 |
表returnObj
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
customProxyConfig | Object | CustomProxyConfig | 命名空间级别配置内容 |
表customProxyConfig
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
concurrency | 2 | Integer | Istio-Proxy线程数 |
enableDnsCapture | false | Boolean | 是否开启istio内置dns |
excludeIPRanges | 127.0.0.1 | String | 不拦截对外访问的地址范围 |
excludeInboundPorts | 80,8080 | String | 设置端口使入口流量免于经过Sidecar代理 |
excludeOutboundPorts | 80,8080 | String | 设置端口使出口流量免于经过Sidecar代理 |
holdApplicationUntilProxyStarts | true | Boolean | 生命周期管理 |
includeIPRanges | 192.168.0.0/16 | String | 拦截对外访问的地址范围 |
includeInboundPorts | 443 | String | 设置端口使入口流量经过Sidecar代理 |
includeOutboundPorts | 443 | String | 设置端口使出口流量经过Sidecar代理 |
interceptionMode | REDIRECT | String | Sidecar对入向流量的拦截策略,取值为REDIRECT,TPROXY,NONE |
lifecycleStr | {"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}} | String | Sidecar代理生命周期JSON字符串 |
logLevel | info | String | 日志等级,取值范围为trace,debug,info,warning,error,critical,off |
outboundTrafficPolicy | ALLOW_ANY | String | 出向流量策略。取值:ALLOW_ANY:允许访问所有外部服务。REGISTRY_ONLY:只能访问注册到网格内的服务。 |
proxyMetadata | ISTIO_META_DNS_CAPTURE:true,ISTIO_META_DNS_AUTO_ALLOCATE:true | map[string]string | 环境变量 |
proxyStatsMatcher | Object | CustomProxyConfig_ProxyStatsMatcher | 统计相关指标 |
SidecarProxyInitResourceLimit | Object | ResourcesLimit | Sidecar代理初始化容器资源限制 |
SidecarProxyInitResourceRequest | Object | ResourcesRequest | Sidecar代理初始化容器资源最低申请额度 |
SidecarProxyResourceLimit | Object | ResourcesLimit | Sidecar代理容器资源限制 |
SidecarProxyResourceRequest | Object | ResourcesRequest | Sidecar代理容器资源最低申请额度 |
terminationDrainDuration | 5s | String | Istio Proxy终止等待时长 |
表CustomProxyConfig_ProxyStatsMatcher
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
inclusion_prefixes | Arrary | Arrary | Envoy监控统计的指标前缀 |
inclusion_regexps | Arrary | Arrary | Envoy监控统计的指标正则表达式 |
inclusion_suffixes | Arrary | Arrary | Envoy监控统计的指标后缀 |
表ResourcesLimit
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
resourceCPULimit | 100m | String | CPU资源限制 |
resourceMemoryLimit | 60Mi | String | 内存资源限制 |
表ResourcesRequest
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
resourceCPURequest | 60m | String | CPU资源最低要求 |
resourceMemoryRequest | 30Mi | String | 内存资源最低要求 |
返回示例:成功
{
"code": "CSM_2000",
"message": "SUCCESS",
"returnObj": {
"customProxyConfig": {
"concurrency": 2,
"enableDnsCapture": false,
"excludeIPRanges": "127.0.0.1",
"excludeInboundPorts": "80,8080",
"excludeOutboundPorts": "80,8080",
"holdApplicationUntilProxyStarts": true,
"includeIPRanges": "192.168.0.0/16",
"includeInboundPorts": "443",
"includeOutboundPorts": "443",
"interceptionMode": "REDIRECT",
"lifecycleStr": "{\"postStart\":{\"exec\":{\"command\":[\"pilot-agent\",\"wait\"]}},\"preStop\":{\"exec\":{\"command\":[\"/bin/sh\",\"-c\",\"sleep 15\"]}}}",
"logLevel": "trace",
"outboundTrafficPolicy": "ALLOW_ANY",
"proxyMetadata": {
"ISTIO_META_DNS_AUTO_ALLOCATE": "true",
"ISTIO_META_DNS_CAPTURE": "true"
},
"proxyStatsMatcher": {
"inclusion_prefixes": [
"string"
],
"inclusion_regexps": [
"string"
],
"inclusion_suffixes": [
"string"
]
},
"SidecarProxyInitResourceLimit": {
"resourceCPULimit": "100 m",
"resourceMemoryLimit": "60 Mi"
},
"SidecarProxyInitResourceRequest": {
"resourceCPURequest": "60 m",
"resourceMemoryRequest": "30 Mi"
},
"SidecarProxyResourceLimit": {
"resourceCPULimit": "100 m",
"resourceMemoryLimit": "60 Mi"
},
"SidecarProxyResourceRequest": {
"resourceCPURequest": "60 m",
"resourceMemoryRequest": "30 Mi"
},
"terminationDrainDuration": "5s"
}
},
"statusCode": 2000
}
返回示例:失败(详见接口失败示例章节)