Queries the sidecar proxy configurations of a namespace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeNamespaceScopeSidecarConfig

The operation that you want to perform. Set the value to DescribeNamespaceScopeSidecarConfig.
ServiceMeshId String Yes c7120e75a202d4fd8acb028a86b6a****

The ID of the ASM instance.

Namespace String No default

The name of the namespace.

Response parameters

Parameter Type Example Description
RequestId String 31d3a0f0-07ed-4f6e-9004-1804498c****

The ID of the request.

ConfigPatches Object

The namespace-level sidecar configurations.

TerminationDrainDuration String 6s

The maximum period of time that the sidecar proxy waits for a request to end.

SidecarProxyInitResourceLimit Object

The maximum size of resources that are available to the sidecar proxy init container.

ResourceCPULimit String 2000 m

The maximum number of CPU cores.

ResourceMemoryLimit String 50 Mi

The maximum size of the memory.

SidecarProxyInitResourceRequest Object

The minimum size of resources that are requested by the sidecar proxy init container.

ResourceCPURequest String 60 m

The minimum number of CPU cores.

ResourceMemoryRequest String 30 Mi

The minimum size of the memory.

SidecarProxyResourceLimit Object

The maximum size of resources that are available to the sidecar proxy container.

ResourceCPULimit String 2000 m

The maximum number of CPU cores.

ResourceMemoryLimit String 50 Mi

The maximum size of the memory.

SidecarProxyResourceRequest Object

The minimum size of resources that are requested by the sidecar proxy container.

ResourceCPURequest String 60 m

The minimum number of CPU cores.

ResourceMemoryRequest String 30 Mi

The minimum size of the memory.

ExcludeOutboundPorts String 81

The port that the outbound traffic of the sidecar proxy does not pass through.

ExcludeOutboundIPRanges String 192.168.1.3/31

The IP address from which the outbound traffic does not pass through the sidecar proxy.

IncludeOutboundIPRanges String 192.168.1.4/31

The IP address from which the outbound traffic passes through the sidecar proxy.

ExcludeInboundPorts String 82

The port that the inbound traffic of the sidecar proxy does not pass through.

IncludeInboundPorts String 83

The port that the inbound traffic of the sidecar proxy passes through.

IncludeOutboundPorts String 84

The port that the outbound traffic of the sidecar proxy passes through.

IstioDNSProxyEnabled Boolean true

Indicates whether the Domain Name System (DNS) proxy feature is enabled. Valid values:

  • true: The DNS proxy feature is enabled.
  • false: The DNS proxy feature is disabled.
LifecycleStr String {"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}

The JSON string that describes the lifecycle of the sidecar proxy.

Concurrency Integer 2

The number of worker threads running in the sidecar proxy.

LogLevel String info

The log level. Valid values: info, debug, trace, and error.

HoldApplicationUntilProxyStarts Boolean true

Indicates whether applications can be started only after Istio Proxy starts. Valid values:

  • true: Applications can be started only after Istio Proxy starts.
  • false: Applications can be started before Istio Proxy starts.
ProxyStatsMatcher Object

The monitoring metrics for data collected by Envoy proxies.

InclusionPrefixes Array of String server

The prefix of the monitoring metrics for data collected by Envoy proxies.

InclusionSuffixes Array of String cluster.outbound

The suffix of the monitoring metrics for data collected by Envoy proxies.

InclusionRegexps Array of String listener.*.downstream_cx_total

The regular expression of the monitoring metrics for data collected by Envoy proxies.

Tracing Object

The custom configurations of Tracing Analysis.

Sampling double 99.8

The sampling rate.

CustomTags Map

The custom tags added to reported spans. The key of a tag is of the string type. The value of a tag is in the JSON format. A custom tag can belong to one of the following types:

  • literal: The tag value is a fixed value in the JSON format. This tag must contain the value field that specifies a literal. Example: {"value":"test"}.
  • header: The tag value is a request header in the JSON format. This tag must contain the name field and defaultValue field.The name field indicates the name of the request header. The defaultValue field indicates the default value that is used when no request header is available. Example: {"name":"test","defaultValue":"test"}.
  • environment: The tag value is an environment variable in the JSON format. This tag must contain the name field and defaultValue field. The name field indicates the name of the environment variable. The defaultValue field indicates the environment variable that is used when no environment variable is available. Example: {"name":"test","defaultValue":"test"}.
MaxPathTagLength Integer 10

The maximum tag length.

InterceptionMode String TPROXY

The mode in which the sidecar proxy intercepts inbound traffic. Valid values:

  • REDIRECT: The sidecar proxy intercepts inbound traffic in the REDIRECT mode.
  • TPROXY: The sidecar proxy intercepts inbound traffic in the TPROXY mode.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeNamespaceScopeSidecarConfig
&ServiceMeshId=c7120e75a202d4fd8acb028a86b6a****
&Namespace=default
&<Common request parameters>

Sample success responses

XML format

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>192.168.1.3/31</ExcludeOutboundIPRanges>
        <IncludeOutboundIPRanges>192.168.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>
        <Concurrency>2</Concurrency>
        <LogLevel>info</LogLevel>
        <HoldApplicationUntilProxyStarts>true</HoldApplicationUntilProxyStarts>
        <ProxyStatsMatcher>
            <InclusionPrefixes>server</InclusionPrefixes>
            <InclusionSuffixes>cluster.outbound</InclusionSuffixes>
            <InclusionRegexps>listener.*.downstream_cx_total</InclusionRegexps>
        </ProxyStatsMatcher>
        <Tracing>
            <Sampling>99.8</Sampling>
            <MaxPathTagLength>10</MaxPathTagLength>
        </Tracing>
        <InterceptionMode>TPROXY</InterceptionMode>
    </ConfigPatches>
</DescribeNamespaceScopeSidecarConfigResponse>

JSON format

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" : "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,
      "MaxPathTagLength" : 10
    },
    "InterceptionMode" : "TPROXY"
  }
}

Error codes

For a list of error codes, see Service error codes.