Queries the information of an Alibaba Cloud Service Mesh (ASM) instance.

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
ServiceMeshId String Yes c08ba3fd1e6484b0f8cc1ad8fe10d****

The ID of the ASM instance.

Response parameters

Parameter Type Example Description
RequestId String 11fd0027-c27e-41bb-a565-75583054****

The ID of the request.

ServiceMesh Struct

The information of the ASM instance.

Clusters List ["caf089e56daba4c51a8906fe43ea1****","c80f45444b3da447da60a911390c2****"]

The clusters in the ASM instance.

Endpoints Struct

All endpoints of the ASM instance.

IntranetApiServerEndpoint String https://192.168.xx.xx:6443

The endpoint that is used to access the API server from the internal network.

IntranetPilotEndpoint String 192.168.xx.xx:15011

The endpoint that is used to access Istio Pilot from the internal network.

PublicApiServerEndpoint String https://123.56.xx.xx:6443

The endpoint that is used to expose the API server to the Internet.

PublicPilotEndpoint String 182.92.xx.xx:15011

The endpoint that is used to expose Istio Pilot to the Internet.

ServiceMeshInfo Struct

The basic information of the ASM instance.

CreationTime String 2020-04-21T09:42:20+08:00

The time when the ASM instance was created.

ErrorMessage String error

The error message that is returned when the call failed.

Name String mesh1

The name of the ASM instance.

RegionId String cn-beijing

The ID of the region where the ASM instance resides.

ServiceMeshId String c08ba3fd1e6484b0f8cc1ad8fe10d****

The ID of the ASM instance.

State String running

The status of the ASM instance.

UpdateTime String 2020-06-03T14:48:54+08:00

The time when the ASM instance was last modified.

Version String v1.7.4.0-gfb34ba99-aliyun

The version number of the ASM instance.

Spec Struct

The specifications of the ASM instance.

LoadBalancer Struct

The information about load balancing.

ApiServerLoadbalancerId String lb-2zekaak10uxds44vx****

The ID of the Server Load Balancer (SLB) instance that is used when the API server is exposed to the Internet.

ApiServerPublicEip Boolean true

Indicates whether the API Server is exposed to the Internet.

PilotPublicEip Boolean true

Indicates whether Istio Pilot is exposed to the Internet.

PilotPublicLoadbalancerId String lb-2zesa8qs8kbkj9jkl****

The ID of the SLB instance that is used when Istio Pilot is exposed to the Internet.

MeshConfig Struct

The configuration information of the ASM instance.

AccessLog Struct

The configurations of the collection of access logs.

Enabled Boolean true

Indicates whether access logs are collected.

Audit Struct

The information about mesh audit.

Enabled Boolean true

Indicates whether the mesh audit feature is enabled.

Project String audit-project

The name of the Log Service project that is used for mesh audit.

CustomizedZipkin Boolean false

Indicates whether a user-created Zipkin system is used.

Edition String default

The edition of the ASM instance, such as the Standard Edition or the Professional Edition.

EnableLocalityLB Boolean true

Indicates whether traffic is routed to the nearest instance.

IncludeIPRanges String *

The IP addresses.

Kiali Struct

The Kiali configurations.

Enabled Boolean false

Indicates whether Kiali is enabled. Kiali can be enabled only when Prometheus monitoring is enabled. If Prometheus monitoring is disabled, the value of this parameter is false.

Url String http://1.2.3.4:20001

The endpoint of Kiali.

OPA Struct

The information about the Open Policy Agent (OPA) plug-in.

Enabled Boolean true

Indicates whether the OPA plug-in is enabled.

LimitCPU String 1

The maximum number of CPU cores that are available to the OPA container.

LimitMemory String 512Mi

The maximum size of the memory that is available to the OPA container.

LogLevel String info

The log level of the OPA container.

RequestCPU String 2

The number of CPU cores that are requested by the OPA container.

RequestMemory String 1024Mi

The size of the memory that is requested by the OPA container.

OutboundTrafficPolicy String ALLOW_ANY

The outbound traffic policy.

Pilot Struct

The sampling information of tracing.

Http10Enabled Boolean false

Indicates whether HTTP 1.0 is supported.

TraceSampling Float 100

Indicates whether the tracing feature is enabled.

Prometheus Struct

The information about Prometheus monitoring.

ExternalUrl String http://prometheus:9090

The endpoint of Prometheus monitoring. If a custom Prometheus instance is used, the endpoint of Prometheus monitoring is set by the system.

UseExternal Boolean false

Indicates whether a custom Prometheus instance is used.

Proxy Struct

The proxy configurations.

ClusterDomain String cluster.domain

The trust domain.

LimitCPU String 2000m

The maximum number of CPU cores.

LimitMemory String 1024Mi

The maximum size of the memory.

RequestCPU String 100m

The number of CPU cores that are requested.

RequestMemory String 128Mi

The size of the memory that is requested.

SidecarInjector Struct

The configurations of the sidecar injector.

AutoInjectionPolicyEnabled Boolean true

Indicates whether automatic sidecar injection is enabled by using annotations.

EnableNamespacesByDefault Boolean false

Indicates whether automatic injection is enabled for all namespaces.

InitCNIConfiguration Struct

The Container Network Interface (CNI) configurations.

Enabled Boolean false

Indicates whether the CNI plug-in is enabled.

ExcludeNamespaces String kube-system,istio-system

The excluded namespaces.

LimitCPU String 4000m

The maximum number of CPU cores that are available to the sidecar injector pod.

LimitMemory String 2048Mi

The maximum size of the memory that is available to the sidecar injector pod.

RequestCPU String 1000m

The number of CPU cores that are requested by the sidecar injector pod.

RequestMemory String 512Mi

The size of the memory that is requested by the sidecar injector pod.

SidecarInjectorWebhookAsYaml String {"injectedAnnotations":{"test/istio-init":"runtime/default2","test/istio-proxy":"runtime/default"},"replicaCount":2,"nodeSelector":{"beta.kubernetes.io/os":"linux"}}

Other configurations of automatic sidecar injection, in the YAML format.

Telemetry Boolean true

Indicates whether Prometheus monitoring is enabled. We recommend that you use Prometheus Service of Application Real-Time Monitoring Service (ARMS).

Tracing Boolean true

Indicates whether the tracing feature is enabled. This feature can be enabled only when Tracing Analysis is activated.

Network Struct

The network configurations of the ASM instance.

SecurityGroupId String sg-2ze384sxttxbctnj****

The ID of the security group.

VSwitches List vsw-2ze66z3ntvsej0mdo****

The ID of the vSwitch.

VpcId String vpc-2zew0rajjkmxy2369****

The ID of the virtual private cloud (VPC).

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeServiceMeshDetail
&ServiceMeshId=c08ba3fd1e6484b0f8cc1ad8fe10d****
&<Common request parameters>

Sample success responses

XML format

<RequestId>11fd0027-c27e-41bb-a565-75583054****</RequestId>
<ServiceMesh>
    <Endpoints>
        <PublicPilotEndpoint>182.92.xx.xx:15011</PublicPilotEndpoint>
        <IntranetApiServerEndpoint>https://192.168.xx.xx:6443</IntranetApiServerEndpoint>
        <PublicApiServerEndpoint>https://123.56.xx.xx:6443</PublicApiServerEndpoint>
        <IntranetPilotEndpoint>192.168.xx.xx:15011</IntranetPilotEndpoint>
    </Endpoints>
    <Clusters>["caf089e56daba4c51a8906fe43ea1****","c80f45444b3da447da60a911390c2****"]</Clusters>
    <ServiceMeshInfo>
        <Version>v1.7.4.0-gfb34ba99-aliyun</Version>
        <ServiceMeshId>c08ba3fd1e6484b0f8cc1ad8fe10d****</ServiceMeshId>
        <State>running</State>
        <UpdateTime>2020-06-03T14:48:54+08:00</UpdateTime>
        <CreationTime>2020-04-21T09:42:20+08:00</CreationTime>
        <RegionId>cn-beijing</RegionId>
        <ErrorMessage> error</ErrorMessage>
        <Name>mesh1</Name>
    </ServiceMeshInfo>
    <Spec>
        <MeshConfig>
            <Pilot>
                <Http10Enabled>false</Http10Enabled>
                <TraceSampling>100</TraceSampling>
            </Pilot>
            <AccessLog>
                <Enabled>true</Enabled>
            </AccessLog>
            <OPA>
                <LimitMemory>512Mi</LimitMemory>
                <RequestMemory>1024Mi</RequestMemory>
                <LimitCPU>1</LimitCPU>
                <Enabled>true</Enabled>
                <RequestCPU>2</RequestCPU>
                <LogLevel>info</LogLevel>
            </OPA>
            <Prometheus>
                <UseExternal>false</UseExternal>
                <ExternalUrl>http://prometheus:9090</ExternalUrl>
            </Prometheus>
            <OutboundTrafficPolicy>ALLOW_ANY</OutboundTrafficPolicy>
            <Telemetry>true</Telemetry>
            <Edition>default</Edition>
            <SidecarInjector>
                <LimitMemory>2048Mi</LimitMemory>
                <AutoInjectionPolicyEnabled>true</AutoInjectionPolicyEnabled>
                <RequestMemory>512Mi</RequestMemory>
                <LimitCPU>4000m</LimitCPU>
                <EnableNamespacesByDefault>false</EnableNamespacesByDefault>
                <InitCNIConfiguration>
                    <Enabled>false</Enabled>
                    <ExcludeNamespaces>kube-system,istio-system</ExcludeNamespaces>
                </InitCNIConfiguration>
                <RequestCPU>1000m</RequestCPU>
                <SidecarInjectorWebhookAsYaml>{"injectedAnnotations":{"test/istio-init":"runtime/default2","test/istio-proxy":"runtime/default"},"replicaCount":2,"nodeSelector":{"beta.kubernetes.io/os":"linux"}}</SidecarInjectorWebhookAsYaml>
            </SidecarInjector>
            <Audit>
                <Project>audit-project</Project>
                <Enabled>true</Enabled>
            </Audit>
            <Proxy>
                <LimitMemory>1024Mi</LimitMemory>
                <RequestMemory>128Mi</RequestMemory>
                <ClusterDomain>cluster.domain</ClusterDomain>
                <LimitCPU>2000m</LimitCPU>
                <RequestCPU>100m</RequestCPU>
            </Proxy>
            <Kiali>
                <Enabled>false</Enabled>
                <Url>http://1.2.3.4:20001</Url>
            </Kiali>
            <IncludeIPRanges>*</IncludeIPRanges>
            <EnableLocalityLB>true</EnableLocalityLB>
            <Tracing>true</Tracing>
            <CustomizedZipkin>false</CustomizedZipkin>
        </MeshConfig>
        <Network>
            <VpcId>vpc-2zew0rajjkmxy2369****</VpcId>
            <SecurityGroupId>sg-2ze384sxttxbctnj****</SecurityGroupId>
            <VSwitches>vsw-2ze66z3ntvsej0mdo****</VSwitches>
        </Network>
        <LoadBalancer>
            <ApiServerLoadbalancerId>lb-2zekaak10uxds44vx****</ApiServerLoadbalancerId>
            <PilotPublicEip>true</PilotPublicEip>
            <PilotPublicLoadbalancerId>lb-2zesa8qs8kbkj9jkl****</PilotPublicLoadbalancerId>
            <ApiServerPublicEip>true</ApiServerPublicEip>
        </LoadBalancer>
    </Spec>
</ServiceMesh>

JSON format

{"RequestId":"11fd0027-c27e-41bb-a565-75583054****","ServiceMesh":{"Endpoints":{"PublicPilotEndpoint":"182.92.xx.xx:15011","IntranetApiServerEndpoint":"https://192.168.xx.xx:6443","PublicApiServerEndpoint":"https://123.56.xx.xx:6443","IntranetPilotEndpoint":"192.168.xx.xx:15011"},"Clusters":"[\"caf089e56daba4c51a8906fe43ea1****\",\"c80f45444b3da447da60a911390c2****\"]","ServiceMeshInfo":{"Version":"v1.7.4.0-gfb34ba99-aliyun","ServiceMeshId":"c08ba3fd1e6484b0f8cc1ad8fe10d****","State":"running","UpdateTime":"2020-06-03T14:48:54+08:00","CreationTime":"2020-04-21T09:42:20+08:00","RegionId":"cn-beijing","ErrorMessage":" error","Name":"mesh1"},"Spec":{"MeshConfig":{"Pilot":{"Http10Enabled":"false","TraceSampling":"100"},"AccessLog":{"Enabled":"true"},"OPA":{"LimitMemory":"512Mi","RequestMemory":"1024Mi","LimitCPU":"1","Enabled":"true","RequestCPU":"2","LogLevel":"info"},"Prometheus":{"UseExternal":"false","ExternalUrl":"http://prometheus:9090"},"OutboundTrafficPolicy":"ALLOW_ANY","Telemetry":"true","Edition":"default","SidecarInjector":{"LimitMemory":"2048Mi","AutoInjectionPolicyEnabled":"true","RequestMemory":"512Mi","LimitCPU":"4000m","EnableNamespacesByDefault":"false","InitCNIConfiguration":{"Enabled":"false","ExcludeNamespaces":"kube-system,istio-system"},"RequestCPU":"1000m","SidecarInjectorWebhookAsYaml":"{\"injectedAnnotations\":{\"test/istio-init\":\"runtime/default2\",\"test/istio-proxy\":\"runtime/default\"},\"replicaCount\":2,\"nodeSelector\":{\"beta.kubernetes.io/os\":\"linux\"}}"},"Audit":{"Project":"audit-project","Enabled":"true"},"Proxy":{"LimitMemory":"1024Mi","RequestMemory":"128Mi","ClusterDomain":"cluster.domain","LimitCPU":"2000m","RequestCPU":"100m"},"Kiali":{"Enabled":"false","Url":"http://1.2.3.4:20001"},"IncludeIPRanges":"*","EnableLocalityLB":"true","Tracing":"true","CustomizedZipkin":"false"},"Network":{"VpcId":"vpc-2zew0rajjkmxy2369****","SecurityGroupId":"sg-2ze384sxttxbctnj****","VSwitches":"vsw-2ze66z3ntvsej0mdo****"},"LoadBalancer":{"ApiServerLoadbalancerId":"lb-2zekaak10uxds44vx****","PilotPublicEip":"true","PilotPublicLoadbalancerId":"lb-2zesa8qs8kbkj9jkl****","ApiServerPublicEip":"true"}}}}

Error codes

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