DescribeServiceMeshes - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries a list of 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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tag	object []	No	The tags.
Key	string	No	The tag key.	test
Value	string	No	The tag value.	yahaha

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
ServiceMeshes	object []	The information about the ASM instances.
Endpoints	object	The information about all endpoints of the ASM instances.
IntranetPilotEndpoint	string	The endpoint that is used to access Istio Pilot from the internal network.	192.168.xx.xx:15011
IntranetApiServerEndpoint	string	The endpoint that is used to access the API server over the internal network.	https://192.168.xx.xx:6443
PublicApiServerEndpoint	string	The endpoint that is used to access the API server over the Internet.	https://123.56.xx.xx:6443
ServiceMeshInfo	object	The basic information about the ASM instances.
Profile	string	The edition of the ASM instance before ASM is available for commercial use. Valid values: `Pro`: Professional Edition `Default`: Standard Edition	Pro
CreationTime	string	The time when the ASM instance was created.	2020-04-21T09:42:20+08:00
UpdateTime	string	The time when the ASM instance was last modified.	2020-04-21T09:42:20+08:00
ErrorMessage	string	The returned error message.	error
Version	string	The version number of the ASM instance.	1
State	string	The state of the ASM instance.	success
ServiceMeshId	string	The ID of the ASM instance.	cb8963379255149cb98c8686f274x****
Name	string	The name of the ASM instance.	test
RegionId	string	The region ID of the ASM instance.	cn-beijing
Spec	object	The specifications of the ASM instance.
Network	object	The network configurations of the ASM instance.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2zew0rajjkmxy2369****
SecurityGroupId	string	The ID of the security group.	sg-2ze384sxttxbctnj****
VSwitches	array	The IDs of the vSwitches.
	string	The ID of the vSwitch.	["1","2"]
LoadBalancer	object	The information about load balancing.
PilotPublicEip	boolean	Indicates whether Istio Pilot is exposed to the Internet. Valid values: `true` `false`	true
PilotPublicLoadbalancerId	string	The ID of the Classic Load Balancer (CLB) instance that is used when Istio Pilot is exposed to the Internet.	lb-2zesa8qs8kbkj9jkl****
ApiServerLoadbalancerId	string	The ID of the CLB instance that is used when the API server is exposed to the Internet.	lb-2zekaak10uxds44vx****
ApiServerPublicEip	boolean	Indicates whether the API server is exposed to the Internet. Valid values: `true` `false`	true
MeshConfig	object	The configurations of the ASM instance.
Telemetry	boolean	Indicates whether Prometheus monitoring is enabled. We recommend that you use Managed Service for Prometheus. Valid values: `true` `false`	true
OutboundTrafficPolicy	string	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.	ALLOW_ANY
Tracing	boolean	Indicates whether the tracing feature is enabled. This feature can be enabled only after Managed Service for OpenTelemetry is activated. Valid values: `true` `false`	true
StrictMtls	boolean	Indicates whether mutual Transport Layer Security (mTLS) is strictly enforced.	true
Pilot	object	The configurations of the control plane.
Http10Enabled	boolean	Indicates whether the support for HTTP 1.0 is enabled. Valid values: `true` `false`	true
TraceSampling	float	The sampling rate when Managed Service for OpenTelemetry is enabled.	0.2
Mtls	boolean	Indicates whether nearby access is enabled. Valid values: `true` `false`	true
SidecarInjector	object	The configurations of sidecar proxy injection.
EnableNamespacesByDefault	boolean	Indicates whether automatic sidecar proxy injection is enabled for all namespaces. Valid values: `true` `false`	false
AutoInjectionPolicyEnabled	boolean	Indicates whether automatic sidecar proxy injection is enabled by using annotations.	true
InitCNIConfiguration	object	The initial configurations of Container Network Interface (CNI).
ExcludeNamespaces	string	The namespaces in which the CNI plug-in does not check the pods.	default,foo
Enabled	boolean	Indicates whether elevated privileges are required for the istio-init container when you perform traffic redirection for the istio-proxy container. Valid values: `true` `false`	true
Clusters	array	The clusters.
	string	The cluster.	["caf089e56daba4c51a8906fe43ea1**","c80f45444b3da447da60a911390c2**"]
ClusterSpec	string	The edition of the ASM instance. Valid values: `standard`: Standard Edition `enterprise`: Enterprise Edition `ultimate`: Ultimate Edition	standard
OwnerType	string	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.	ackone
OwnerId	string	The ID of the Alibaba Cloud service instance for which the ASM instance is created.	cc3e96f249d124eb38b72718ec5*****
Tag	object []	The details about the tags.
Key	string	The tag key.	test
Value	string	The tag value.	yahaha
Upgradable	boolean	Indicates whether the ASM instance can be upgraded.	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "ServiceMeshes": [
    {
      "Endpoints": {
        "IntranetPilotEndpoint": "192.168.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": "ALLOW_ANY",
          "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*****",
      "Tag": [
        {
          "Key": "test",
          "Value": "yahaha"
        }
      ],
      "Upgradable": false
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-12-14

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-10-09

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-15

The request parameters of the API has changed. The response structure of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: Tag
Output Parameters	The response structure of the API has changed.