调用DescribeNamespaceScopeSidecarConfig查询命名空间级别的Sidecar配置设置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeNamespaceScopeSidecarConfig |
系统规定参数。取值:DescribeNamespaceScopeSidecarConfig |
ServiceMeshId | String | 是 | c7120e75a202d4fd8acb028a86b6a**** |
ASM实例ID。 |
Namespace | String | 否 | default |
命名空间。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 31d3a0f0-07ed-4f6e-9004-1804498c**** |
请求ID。 |
ConfigPatches | Object |
命名空间级别配置内容。 |
|
TerminationDrainDuration | String | 6s |
Sidecar代理终止等待时间。 |
SidecarProxyInitResourceLimit | Object |
Sidecar代理初始化容器资源限制。 |
|
ResourceCPULimit | String | 2000 m |
CPU资源限制。 |
ResourceMemoryLimit | String | 50 Mi |
内存资源限制。 |
SidecarProxyInitResourceRequest | Object |
Sidecar代理初始化容器资源最低申请额度。 |
|
ResourceCPURequest | String | 60 m |
CPU资源最低要求。 |
ResourceMemoryRequest | String | 30 Mi |
内存资源最低要求。 |
SidecarProxyResourceLimit | Object |
Sidecar代理容器资源限制。 |
|
ResourceCPULimit | String | 2000 m |
CPU资源限制。 |
ResourceMemoryLimit | String | 50 Mi |
内存资源限制。 |
SidecarProxyResourceRequest | Object |
Sidecar代理容器资源最低申请额度。 |
|
ResourceCPURequest | String | 60 m |
CPU资源最低要求。 |
ResourceMemoryRequest | String | 30 Mi |
内存资源限制。 |
ExcludeOutboundPorts | String | 81 |
免于经过Sidecar代理的出口流量端口。 |
ExcludeOutboundIPRanges | String | 191.2.1.3/31 |
免于经过Sidecar代理的出口流量IP地址。 |
IncludeOutboundIPRanges | String | 191.2.1.4/31 |
经过Sidecar代理的出口流量IP地址。 |
ExcludeInboundPorts | String | 82 |
免于经过Sidecar代理的入口流量端口。 |
IncludeInboundPorts | String | 83 |
经过Sidecar代理的入口流量端口。 |
IncludeOutboundPorts | String | 84 |
经过Sidecar代理的出口流量端口。 |
IstioDNSProxyEnabled | Boolean | true |
是否启用DNS代理功能,取值:
|
LifecycleStr | String | {"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}} |
Sidecar代理生命周期JSON字符串。 |
Concurrency | Integer | 2 |
Istio-Proxy并发度设置。 |
LogLevel | String | info |
日志等级,取值: |
HoldApplicationUntilProxyStarts | Boolean | true |
应用程序启动前是否等待istio-proxy启动完成,取值:
|
ProxyStatsMatcher | Object |
用于Envoy监控统计的指标。 |
|
InclusionPrefixes | Array of String | server |
Envoy监控统计的指标前缀。 |
InclusionSuffixes | Array of String | cluster.outbound |
Envoy监控统计的指标后缀。 |
InclusionRegexps | Array of String | listener.*.downstream_cx_total |
Envoy监控统计的指标正则表达式。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeNamespaceScopeSidecarConfig
&ServiceMeshId=c7120e75a202d4fd8acb028a86b6a****
&Namespace=default
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeNamespaceScopeSidecarConfigResponse>
<RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
<ConfigPatches>
<TerminationDrainDuration>6s</TerminationDrainDuration>
<SidecarProxyInitResourceLimit>
<ResourceCPULimit>2000 m</ResourceCPULimit>
<ResourceMemoryLimit>50 Mi</ResourceMemoryLimit>
</SidecarProxyInitResourceLimit>
<SidecarProxyInitResourceRequest>
<ResourceCPURequest>60 m</ResourceCPURequest>
<ResourceMemoryRequest>30 Mi</ResourceMemoryRequest>
</SidecarProxyInitResourceRequest>
<SidecarProxyResourceLimit>
<ResourceCPULimit>2000 m</ResourceCPULimit>
<ResourceMemoryLimit>50 Mi</ResourceMemoryLimit>
</SidecarProxyResourceLimit>
<SidecarProxyResourceRequest>
<ResourceCPURequest>60 m</ResourceCPURequest>
<ResourceMemoryRequest>30 Mi</ResourceMemoryRequest>
</SidecarProxyResourceRequest>
<ExcludeOutboundPorts>81</ExcludeOutboundPorts>
<ExcludeOutboundIPRanges>191.2.1.3/31</ExcludeOutboundIPRanges>
<IncludeOutboundIPRanges>191.2.1.4/31</IncludeOutboundIPRanges>
<ExcludeInboundPorts>82</ExcludeInboundPorts>
<IncludeInboundPorts>83</IncludeInboundPorts>
<IncludeOutboundPorts>84</IncludeOutboundPorts>
<IstioDNSProxyEnabled>true</IstioDNSProxyEnabled>
<LifecycleStr>{"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}</LifecycleStr>
</ConfigPatches>
</DescribeNamespaceScopeSidecarConfigResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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" : "191.2.1.3/31",
"IncludeOutboundIPRanges" : "191.2.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\"]}}}"
}
}
错误码
访问错误中心查看更多错误码。