Querying a Service Mesh¶

Function¶

This API is used to obtain details about a service mesh.

URI¶

GET /v1/{project_id}/meshes/{mesh_id}

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
mesh_id	Yes	String	Service mesh ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.

Response Parameters¶

Status code: 200

**Table 3** Parameters in the response body¶
Parameter	Type	Description
apiVersion	String	API version. The value is fixed at v1 and cannot be changed.
kind	String	API type. The value is fixed at Mesh or mesh and cannot be changed.
metadata	Table 4 object	Basic information about the service mesh. Metadata is a collection of attributes.
spec	Table 5 object	Detailed description of the service mesh. ASM creates or updates the service mesh by spec.
status	Table 14 object	Service mesh status, which is automatically generated by ASM.

**Table 4** MeshMetadata¶
Parameter	Type	Description
name	String	Service mesh name. Enter 4 to 64 characters. The name must start with a lowercase letter and not end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.
uid	String	Service mesh ID, which is unique and automatically generated after the service mesh is created.
creationTimestamp	String	Time when the service mesh was created.

**Table 5** MeshSpec¶
Parameter	Type	Description
type	String	Service mesh type. InCluster: service mesh with an in-cluster control plane. The value is InCluster for the service mesh of the Basic edition.
version	String	Service mesh version.
extendParams	Table 6 object	Extensions of the service mesh.
ipv6Enable	Boolean	Whether the service mesh supports IPv6.
config	Table 8 object	Service mesh configuration.

**Table 6** MeshExtendParams¶
Parameter	Type	Description
clusters	Array of Table 7 objects	Cluster information in the service mesh.

**Table 7** MeshCluster¶
Parameter	Type	Description
clusterID	String	Cluster ID, which is unique and can be used to query the cluster to be added.

**Table 8** MeshConfig¶
Parameter	Type	Description
proxyConfig	Table 9 object	Data plane configuration of the service mesh.
telemetryConfig	Table 10 object	Observability configuration of the service mesh.

**Table 9** ProxyConfig¶
Parameter	Type	Description
includeIPRanges	String	IP address ranges that will be included for outbound traffic redirection. Use commas (,) to separate the IP address ranges.
excludeIPRanges	String	IP address ranges that will be excluded for outbound traffic redirection. Use commas (,) to separate the IP address ranges.
excludeOutboundPorts	String	Ports that will be excluded for outbound traffic redirection. Use commas (,) to separate the ports.
excludeInboundPorts	String	Ports that will be excluded for inbound traffic redirection. Use commas (,) to separate the ports.
includeOutboundPorts	String	Ports that will be included for outbound traffic redirection. Use commas (,) to separate the ports.
includeInboundPorts	String	Ports that will be included for inbound traffic redirection. Use commas (,) to separate the ports.

**Table 10** TelemetryConfig¶
Parameter	Type	Description
tracing	Table 11 object	Tracing configuration, which is used to report traces in the service mesh.

**Table 11** Tracing¶
Parameter	Type	Description
randomSamplingPercentage	Float	Tracing sampling rate.
defaultProviders	Array of strings	Name of the default provider that tracing reports data to, which must match the name field in extensionProviders or use the preset provider apm-otel of ASM. If apm-otel is used, ensure that APM 2.0 is supported in the current region and the service mesh version is later than 1.18.
extensionProviders	Array of Table 12 objects	User-defined provider. Currently, Zipkin is supported. If you configure the Zipkin provider, ensure that the service mesh version is 1.15 or later.

**Table 12** TracingExtensionProvider¶
Parameter	Type	Description
name	String	Provider name.
zipkin	Table 13 object	Self-defined configuration of Zipkin.

**Table 13** ZipkinTracingProvider¶
Parameter	Type	Description
service	String	Service address of Zipkin.
port	Integer	Service port of Zipkin.

**Table 14** MeshStatus¶
Parameter	Type	Description
phase	String	Service mesh status. The options are as follows: Running: The service mesh is running. Creating: The service mesh is being created. CreateFailed: The service mesh fails to be created. Deleting: The service mesh is being deleted. DeleteFailed: The service mesh fails to be deleted. Upgrading: The service mesh is being upgraded. UpgradeFailed: The service mesh fails to be upgraded. RollingBack: The service mesh is being rolled back. RollbackFailed: The service mesh fails to be rolled back.
updateTimestamp	String	Time when the service mesh was updated.

Status code: 400

**Table 15** Parameters in the response body¶
Parameter	Type	Description
errorCode	String	Error code. Minimum length: 8 Maximum length: 36
errorMsg	String	Error message. Minimum length: 2 Maximum length: 512

Status code: 404

**Table 16** Parameters in the response body¶
Parameter	Type	Description
errorCode	String	Error code. Minimum length: 8 Maximum length: 36
errorMsg	String	Error message. Minimum length: 2 Maximum length: 512

Status code: 500

**Table 17** Parameters in the response body¶
Parameter	Type	Description
errorCode	String	Error code. Minimum length: 8 Maximum length: 36
errorMsg	String	Error message. Minimum length: 2 Maximum length: 512

Example Request¶

None

Example Response¶

Status code: 200

The details about the service mesh are obtained.

{
  "kind" : "Mesh",
  "apiVersion" : "v1",
  "metadata" : {
    "name" : "mesh-test-api",
    "uid" : "a1efdc3e-xxxx-xxxx-xxxx-94bef433347e",
    "creationTimestamp" : "2025-04-10T07:48:37Z"
  },
  "spec" : {
    "type" : "InCluster",
    "version" : "1.18.7-r5",
    "config" : {
      "telemetryConfig" : {
        "tracing" : {
          "randomSamplingPercentage" : 1,
          "defaultProviders" : [ "zipkin" ],
          "extensionProviders" : [ {
            "name" : "zipkin",
            "zipkin" : {
              "service" : "zipkin.monitoring.svc.cluster.local",
              "port" : 9411
            }
          } ]
        }
      },
      "proxyConfig" : {
        "includeIPRanges" : "10.247.0.0/16"
      }
    },
    "extendParams" : {
      "clusters" : [ {
        "clusterID" : "cb0ef541-xxxx-xxxx-xxxx-0255ac1001b7"
      } ]
    }
  },
  "status" : {
    "phase" : "Running",
    "updateTimestamp" : "2025-04-10T07:58:43Z"
  }
}

Status Codes¶

Status Code	Description
200	The details about the service mesh are obtained.
400	Verification failed due to incorrect parameters for obtaining the details about the service mesh.
404	The specified service mesh is not found.
500	An error occurs during the service mesh query.

last updated: 2025-07-14 14:13 UTC - commit: 65f39961934893c289a669d0b619e47408019cf2