DescribeServiceMeshes - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries a list of service meshes.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeServiceMeshes

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tag	array<object>	No	The list of tags.
	object	No	The tag of the resource.
Key	string	No	The tag key.	test
Value	string	No	The tag value.	yahaha

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
ServiceMeshes	array<object>	The details of the service meshes.
	object
Endpoints	object	The endpoint details.
IntranetPilotEndpoint	string	The internal endpoint of Istio Pilot.	192.168.xx.xx:15011
IntranetApiServerEndpoint	string	The internal endpoint of the API server.	https://192.168.xx.xx:6443
PublicApiServerEndpoint	string	The public endpoint of the API server.	https://123.56.xx.xx:6443
ReverseTunnelEndpoint	string	The endpoint of the reverse tunnel. This parameter is deprecated.	none
PublicPilotEndpoint	string	The public endpoint of the Istio Pilot for the mesh instance.	xx.xx.xx.xx
ServiceMeshInfo	object	The basic information about the service mesh.
Profile	string	The edition of the service mesh instance before commercialization. Valid values: `Pro`: Professional Edition. `Default`: Standard Edition.	Pro
CreationTime	string	The time when the service mesh was created.	2020-04-21T09:42:20+08:00
UpdateTime	string	The time when the service mesh was last modified.	2020-04-21T09:42:20+08:00
ErrorMessage	string	The error message.	error
Version	string	The version of the service mesh.	1
State	string	The status of the service mesh.	success
ServiceMeshId	string	The service mesh ID.	cb8963379255149cb98c8686f274x****
Name	string	The name of the service mesh.	test
RegionId	string	The ID of the region where the service mesh resides.	cn-beijing
Spec	object	The specifications.
Network	object	The network configurations of the service mesh.
VpcId	string	The virtual private cloud (VPC) ID.	vpc-2zew0rajjkmxy2369****
SecurityGroupId	string	The security group ID.	sg-2ze384sxttxbctnj****
VSwitches	array	The list of virtual switch IDs.
	string	The list of virtual switch IDs.	["1","2"]
LoadBalancer	object	The Server Load Balancer information.
PilotPublicEip	boolean	Indicates whether to expose Istio Pilot to the internet. Valid values: `true`: Istio Pilot is exposed to the internet. `false`: Istio Pilot is not exposed to the internet.	true
PilotPublicLoadbalancerId	string	The ID of the Server Load Balancer instance that is used to expose Istio Pilot.	lb-2zesa8qs8kbkj9jkl****
ApiServerLoadbalancerId	string	The ID of the Server Load Balancer instance that is used to expose the API server.	lb-2zekaak10uxds44vx****
ApiServerPublicEip	boolean	Indicates whether to expose the API server to the internet. Valid values: `true`: The API server is exposed to the internet. `false`: The API server is not exposed to the internet.	true
MeshConfig	object	The configurations of the service mesh.
Telemetry	boolean	Indicates whether to enable Prometheus to collect metrics. (Managed Service for Prometheus is recommended.) Valid values: `true`: Prometheus is enabled to collect metrics. `false`: Prometheus is not enabled to collect metrics.	true
OutboundTrafficPolicy	string	The outbound traffic policy. Valid values: `ALLOW_ANY`: allows access to services outside the mesh. `REGISTRY_ONLY`: allows access to only services that are registered in the mesh.	ALLOW_ANY
Tracing	boolean	Indicates whether to enable Tracing Analysis. To enable this feature, activate Managed Service for OpenTelemetry. Valid values: `true`: Tracing Analysis is enabled. `false`: Tracing Analysis is not enabled.	true
StrictMtls	boolean	The mode.	true
Pilot	object	The control plane configurations.
Http10Enabled	boolean	Indicates whether to enable HTTP 1.0. Valid values: `true`: HTTP 1.0 is supported. `false`: HTTP 1.0 is not supported.	true
TraceSampling	number	The sample rate for Tracing Analysis.	0.2
Mtls	boolean	Indicates whether to enable locality load balancing. Valid values: `true`: Locality load balancing is enabled. `false`: Locality load balancing is not enabled.	true
SidecarInjector	object	The configurations of the sidecar injector.
EnableNamespacesByDefault	boolean	Indicates whether to enable automatic sidecar injection for all namespaces. `true`: Automatic sidecar injection is enabled for all namespaces. `false`: Automatic sidecar injection is not enabled for all namespaces.	false
AutoInjectionPolicyEnabled	boolean	Indicates whether to enable automatic sidecar injection using pod annotations.	true
InitCNIConfiguration	object	The configurations of Container Network Interface (CNI) initialization.
ExcludeNamespaces	string	The namespaces that are excluded from the Istio pod check.	default,foo
Enabled	boolean	Indicates whether the istio-init container has privileged permissions for traffic redirection to istio-proxy. Valid values: `true`: The istio-init container does not have privileged permissions. `false`: The istio-init container has privileged permissions.	true
ExtraConfiguration	object	The extended configurations of the Service Mesh instance.
Playground	object	The configurations of the ASM lab. This parameter is valid only for ASM lab instances.
Scene	string	The ID of the ASM lab scenario.	ewmaLb
Clusters	array	The list of clusters.
	string	The list of clusters.	["caf089e56daba4c51a8906fe43ea1**","c80f45444b3da447da60a911390c2**"]
ClusterSpec	string	The instance type of the Service Mesh instance. Valid values: `standard`: Standard Edition. `enterprise`: Enterprise Edition. `ultimate`: Ultimate Edition.	standard
OwnerType	string	The type of the cloud service that created the mesh. Valid values: `ackone`: The mesh is created by ACK One. If this parameter is empty, the mesh is created by a user.	ackone
OwnerId	string	The ID of the cloud service instance that created the mesh.	cc3e96f249d124eb38b72718ec5*****
Tag	array<object>	The collection of tags.
	object	The resource tag.
Key	string	The tag key.	test
Value	string	The tag value.	yahaha
Upgradable	boolean	Indicates whether the mesh can be upgraded.	false

Examples

Success response

JSON format

{
  "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",
        "ReverseTunnelEndpoint": "none",
        "PublicPilotEndpoint": "xx.xx.xx.xx"
      },
      "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
            }
          },
          "ExtraConfiguration": {
            "Playground": {
              "Scene": "ewmaLb"
            }
          }
        }
      },
      "Clusters": [
        "[\"caf089e56daba4c51a8906fe43ea1****\",\"c80f45444b3da447da60a911390c2****\"]"
      ],
      "ClusterSpec": "standard",
      "OwnerType": "ackone",
      "OwnerId": "cc3e96f249d124eb38b72718ec5*****",
      "Tag": [
        {
          "Key": "test",
          "Value": "yahaha"
        }
      ],
      "Upgradable": false
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.