Queries the information about Alibaba Cloud Service Mesh (ASM) instances.

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 DescribeServiceMeshes

The operation that you want to perform. Set the value to DescribeServiceMeshes.

Response parameters

Parameter Type Example Description
RequestId String BD65C0AD-D3C6-48D3-8D93-38D2015C****

The ID of the request.

ServiceMeshes Array of ServiceMesh

The information about the ASM instances.

Endpoints Object

All endpoints of the ASM instance.

IntranetPilotEndpoint String 192.168.xx.xx:15011

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

ReverseTunnelEndpoint String ...

The endpoint of the reverse tunnel.

PublicPilotEndpoint String 182.92.xx.xx:15011

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

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

The endpoint that is used to access the API server 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.

ServiceMeshInfo Object

The basic information about the ASM instance.

Profile String Pro

The edition of the ASM instance before ASM is available for commercial use. Valid values:

  • Pro: Professional Edition
  • Default: Standard Edition
CreationTime String 2020-04-21T09:42:20+08:00

The point in time when the ASM instance was created.

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

The point in time when the ASM instance was last modified.

ErrorMessage String error

The error message that is returned when the call failed.

Version String 1

The version number of the ASM instance.

State String success

The status of the ASM instance.

ServiceMeshId String cb8963379255149cb98c8686f274x****

The ID of the ASM instance.

Name String test

The name of the ASM instance.

RegionId String cn-beijing

The ID of the region in which the ASM instance resides.

Spec Object

The specifications of the ASM instance.

Network Object

The network configurations of the ASM instance.

VpcId String vpc-2zew0rajjkmxy2369****

The ID of the virtual private cloud (VPC).

SecurityGroupId String sg-2ze384sxttxbctnj****

The ID of the security group.

VSwitches Array of String ["1","2"]

The IDs of vSwitches.

LoadBalancer Object

The information about load balancing.

PilotPublicEip Boolean true

Indicates whether Istio Pilot is exposed to the Internet. Valid values:

  • true: Istio Pilot is exposed to the Internet.
  • false: Istio Pilot is not exposed to the Internet.
PilotPublicLoadbalancerId String lb-2zesa8qs8kbkj9jkl****

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

ApiServerLoadbalancerId String lb-2zekaak10uxds44vx****

The ID of the 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. Valid values:

  • true: The API server is exposed to the Internet.
  • false: The API server is not exposed to the Internet.
MeshConfig Object

The configurations of the ASM instance.

Telemetry Boolean true

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

  • true: Prometheus monitoring is enabled.
  • false: Prometheus monitoring is disabled.
OutboundTrafficPolicy String ALLOW_ANY

The outbound traffic policy. Valid values:

  • ALLOW_ANY: Outbound traffic to an external service is allowed.
  • REGISTRY_ONLY: Outbound traffic is allowed to only external services that are defined in the service registry of the ASM instance.
Tracing Boolean true

Indicates whether the tracing feature is enabled. This feature can be enabled only after Tracing Analysis is activated. Valid values:

  • true: The tracing feature is enabled.
  • false: The tracing feature is disabled.
StrictMtls Boolean true

Indicates whether mutual Transport Layer Security (mTLS) is strictly enforced.

Pilot Object

The configurations of the control plane.

Http10Enabled Boolean true

Indicates whether the support for HTTP 1.0 is enabled. Valid values:

  • true: The support for HTTP 1.0 is enabled.
  • false: The support for HTTP 1.0 is disabled.
TraceSampling Float 0.2

The sampling percentage of tracing.

Mtls Boolean true

Indicates whether the feature of routing traffic to the nearest instance is enabled. Valid values:

  • true: The feature is enabled.
  • false: The feature is disabled.
SidecarInjector Object

The configurations of sidecar injection.

EnableNamespacesByDefault Boolean false

Indicates whether automatic sidecar injection is enabled for all namespaces. Valid values:

  • true: Automatic sidecar injection is enabled for all namespaces.
  • false: Automatic sidecar injection is disabled for all namespaces.
AutoInjectionPolicyEnabled Boolean true

Indicates whether automatic sidecar injection is enabled by using annotations.

InitCNIConfiguration Object

The initial configurations of Container Network Interface (CNI).

ExcludeNamespaces String default,foo

The namespace for which sidecar injection is disabled.

Enabled Boolean true

Indicates whether elevated privileges are required for the istio-init container when you perform traffic redirection for the istio-proxy container. Valid values:

  • true: Elevated privileges are required for the istio-init container.
  • false: Elevated privileges are not required for the istio-init container.
Clusters Array of String ["caf089e56daba4c51a8906fe43ea1****","c80f45444b3da447da60a911390c2****"]

The information about the clusters.

ClusterSpec String standard

The edition of the ASM instance. Valid values:

  • standard: Standard Edition
  • enterprise: Enterprise Edition
  • ultimate: Ultimate Edition
OwnerType String ackone

The Alibaba Cloud service for which the ASM instance is created. Valid values:

  • ackone: The ASM instance is created for Alibaba Cloud Distributed Cloud Container Platform (ACK One).
  • An empty value indicates that the ASM instance is created by the user.
OwnerId String cc3e96f249d124eb38b72718ec5*****

The ID of the Alibaba Cloud service instance for which the ASM instance is created.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeServiceMeshes
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeServiceMeshesResponse>
    <RequestId>BD65C0AD-D3C6-48D3-8D93-38D2015C****</RequestId>
    <ServiceMeshes>
        <Endpoints>
            <IntranetPilotEndpoint>192.168.xx.xx:15011</IntranetPilotEndpoint>
            <ReverseTunnelEndpoint>...</ReverseTunnelEndpoint>
            <PublicPilotEndpoint>182.92.xx.xx:15011</PublicPilotEndpoint>
            <IntranetApiServerEndpoint>https://192.168.xx.xx:6443</IntranetApiServerEndpoint>
            <PublicApiServerEndpoint>https://123.56.xx.xx:6443</PublicApiServerEndpoint>
        </Endpoints>
        <ServiceMeshInfo>
            <Profile>Pro</Profile>
            <CreationTime>2020-04-21T09:42:20+08:00</CreationTime>
            <UpdateTime>2020-04-21T09:42:20+08:00</UpdateTime>
            <ErrorMessage>error</ErrorMessage>
            <Version>1</Version>
            <State>success</State>
            <ServiceMeshId>cb8963379255149cb98c8686f274x****</ServiceMeshId>
            <Name>test</Name>
            <RegionId>cn-beijing</RegionId>
        </ServiceMeshInfo>
        <Spec>
            <Network>
                <VpcId>vpc-2zew0rajjkmxy2369****</VpcId>
                <SecurityGroupId>sg-2ze384sxttxbctnj****</SecurityGroupId>
                <VSwitches>["1","2"]</VSwitches>
            </Network>
            <LoadBalancer>
                <PilotPublicEip>true</PilotPublicEip>
                <PilotPublicLoadbalancerId>lb-2zesa8qs8kbkj9jkl****</PilotPublicLoadbalancerId>
                <ApiServerLoadbalancerId>lb-2zekaak10uxds44vx****</ApiServerLoadbalancerId>
                <ApiServerPublicEip>true</ApiServerPublicEip>
            </LoadBalancer>
            <MeshConfig>
                <Telemetry>true</Telemetry>
                <OutboundTrafficPolicy>xxx</OutboundTrafficPolicy>
                <Tracing>true</Tracing>
                <StrictMtls>true</StrictMtls>
                <Pilot>
                    <Http10Enabled>true</Http10Enabled>
                    <TraceSampling>0.2</TraceSampling>
                </Pilot>
                <Mtls>true</Mtls>
                <SidecarInjector>
                    <EnableNamespacesByDefault>false</EnableNamespacesByDefault>
                    <AutoInjectionPolicyEnabled>true</AutoInjectionPolicyEnabled>
                    <InitCNIConfiguration>
                        <ExcludeNamespaces>default,foo</ExcludeNamespaces>
                        <Enabled>true</Enabled>
                    </InitCNIConfiguration>
                </SidecarInjector>
            </MeshConfig>
        </Spec>
        <Clusters>["caf089e56daba4c51a8906fe43ea1****","c80f45444b3da447da60a911390c2****"]</Clusters>
        <ClusterSpec>standard</ClusterSpec>
        <OwnerType>ackone</OwnerType>
        <OwnerId>cc3e96f249d124eb38b72718ec5*****</OwnerId>
    </ServiceMeshes>
</DescribeServiceMeshesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "ServiceMeshes" : {
    "Endpoints" : {
      "IntranetPilotEndpoint" : "192.168.xx.xx:15011",
      "ReverseTunnelEndpoint" : "...",
      "PublicPilotEndpoint" : "182.92.xx.xx:15011",
      "IntranetApiServerEndpoint" : "https://192.168.xx.xx:6443",
      "PublicApiServerEndpoint" : "https://123.56.xx.xx:6443"
    },
    "ServiceMeshInfo" : {
      "Profile" : "Pro",
      "CreationTime" : "2020-04-21T09:42:20+08:00",
      "UpdateTime" : "2020-04-21T09:42:20+08:00",
      "ErrorMessage" : "error",
      "Version" : 1,
      "State" : "success",
      "ServiceMeshId" : "cb8963379255149cb98c8686f274x****",
      "Name" : "test",
      "RegionId" : "cn-beijing"
    },
    "Spec" : {
      "Network" : {
        "VpcId" : "vpc-2zew0rajjkmxy2369****",
        "SecurityGroupId" : "sg-2ze384sxttxbctnj****",
        "VSwitches" : "[\"1\",\"2\"]"
      },
      "LoadBalancer" : {
        "PilotPublicEip" : true,
        "PilotPublicLoadbalancerId" : "lb-2zesa8qs8kbkj9jkl****",
        "ApiServerLoadbalancerId" : "lb-2zekaak10uxds44vx****",
        "ApiServerPublicEip" : true
      },
      "MeshConfig" : {
        "Telemetry" : true,
        "OutboundTrafficPolicy" : "xxx",
        "Tracing" : true,
        "StrictMtls" : true,
        "Pilot" : {
          "Http10Enabled" : true,
          "TraceSampling" : 0.2
        },
        "Mtls" : true,
        "SidecarInjector" : {
          "EnableNamespacesByDefault" : false,
          "AutoInjectionPolicyEnabled" : true,
          "InitCNIConfiguration" : {
            "ExcludeNamespaces" : "default,foo",
            "Enabled" : true
          }
        }
      }
    },
    "Clusters" : "[\"caf089e56daba4c51a8906fe43ea1****\",\"c80f45444b3da447da60a911390c2****\"]",
    "ClusterSpec" : "standard",
    "OwnerType" : "ackone",
    "OwnerId" : "cc3e96f249d124eb38b72718ec5*****"
  }
}

Error codes

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