Queries the configurations of sidecar proxies at the namespace level.

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 Alibaba Cloud Service Mesh (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 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 maximum size of the memory.

ExcludeOutboundPorts String 81

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

ExcludeOutboundIPRanges String 191.2.1.3/31

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

IncludeOutboundIPRanges String 191.2.1.4/31

The IP address that the outbound traffic of the sidecar proxy passes through.

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 DNS proxy feature is enabled.

  • true: the DNS proxy feature is enabled.
  • false: the DNS proxy feature in disabled.
LifecycleStr String null

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

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>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 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" : "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\"]}}}"
  }
}

Error codes

For a list of error codes, visit the API Error Center.