All Products
Search
Document Center

Alibaba Cloud Service Mesh:DescribeServiceMeshes

Last Updated:Oct 14, 2024

Queries a list of Service Mesh (ASM) instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
servicemesh:DescribeServiceMeshesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
Tagarray<object>No

The tags.

objectNo
KeystringNo

The tag key.

test
ValuestringNo

The tag value.

yahaha

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

BD65C0AD-D3C6-48D3-8D93-38D2015C****
ServiceMeshesarray<object>

The information about the ASM instances.

ServiceMeshobject
Endpointsobject

The information about all endpoints of the ASM instances.

IntranetPilotEndpointstring

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

192.168.xx.xx:15011
IntranetApiServerEndpointstring

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

https://192.168.xx.xx:6443
PublicApiServerEndpointstring

The endpoint that is used to access the API server over the Internet.

https://123.56.xx.xx:6443
ServiceMeshInfoobject

The basic information about the ASM instances.

Profilestring

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

  • Pro: Professional Edition
  • Default: Standard Edition
Pro
CreationTimestring

The time when the ASM instance was created.

2020-04-21T09:42:20+08:00
UpdateTimestring

The time when the ASM instance was last modified.

2020-04-21T09:42:20+08:00
ErrorMessagestring

The returned error message.

error
Versionstring

The version number of the ASM instance.

1
Statestring

The state of the ASM instance.

success
ServiceMeshIdstring

The ID of the ASM instance.

cb8963379255149cb98c8686f274x****
Namestring

The name of the ASM instance.

test
RegionIdstring

The region ID of the ASM instance.

cn-beijing
Specobject

The specifications of the ASM instance.

Networkobject

The network configurations of the ASM instance.

VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-2zew0rajjkmxy2369****
SecurityGroupIdstring

The ID of the security group.

sg-2ze384sxttxbctnj****
VSwitchesarray

The IDs of the vSwitches.

VSwitchstring

The ID of the vSwitch.

["1","2"]
LoadBalancerobject

The information about load balancing.

PilotPublicEipboolean

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

  • true
  • false
true
PilotPublicLoadbalancerIdstring

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

lb-2zesa8qs8kbkj9jkl****
ApiServerLoadbalancerIdstring

The ID of the CLB instance that is used when the API server is exposed to the Internet.

lb-2zekaak10uxds44vx****
ApiServerPublicEipboolean

Indicates whether the API server is exposed to the Internet. Valid values:

  • true
  • false
true
MeshConfigobject

The configurations of the ASM instance.

Telemetryboolean

Indicates whether Prometheus monitoring is enabled. We recommend that you use Managed Service for Prometheus. Valid values:

  • true
  • false
true
OutboundTrafficPolicystring

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
Tracingboolean

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
StrictMtlsboolean

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

true
Pilotobject

The configurations of the control plane.

Http10Enabledboolean

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

  • true
  • false
true
TraceSamplingfloat

The sampling rate when Managed Service for OpenTelemetry is enabled.

0.2
Mtlsboolean

Indicates whether nearby access is enabled. Valid values:

  • true
  • false
true
SidecarInjectorobject

The configurations of sidecar proxy injection.

EnableNamespacesByDefaultboolean

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

  • true
  • false
false
AutoInjectionPolicyEnabledboolean

Indicates whether automatic sidecar proxy injection is enabled by using annotations.

true
InitCNIConfigurationobject

The initial configurations of Container Network Interface (CNI).

ExcludeNamespacesstring

The namespaces in which the CNI plug-in does not check the pods.

default,foo
Enabledboolean

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
Clustersarray

The clusters.

Clusterstring

The cluster.

["caf089e56daba4c51a8906fe43ea1****","c80f45444b3da447da60a911390c2****"]
ClusterSpecstring

The edition of the ASM instance. Valid values:

  • standard: Standard Edition
  • enterprise: Enterprise Edition
  • ultimate: Ultimate Edition
standard
OwnerTypestring

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
OwnerIdstring

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

cc3e96f249d124eb38b72718ec5*****
Tagarray<object>

The details about the tags.

Tagsobject
Keystring

The tag key.

test
Valuestring

The tag value.

yahaha
Upgradableboolean

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",
        "ReverseTunnelEndpoint": "",
        "PublicPilotEndpoint": ""
      },
      "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": ""
            }
          }
        }
      },
      "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 timeSummary of changesOperation
2024-09-18The response structure of the API has changedView Change Details
2023-12-14The response structure of the API has changedView Change Details
2023-10-09The response structure of the API has changedView Change Details
2023-08-15The request parameters of the API has changed. The response structure of the API has changedView Change Details