文档首页/ 应用服务网格 ASM/ API参考/ API/ 网格接口/ 查询网格
更新时间：2025-05-28 GMT+08:00
查看PDF
分享

查询网格

功能介绍

该API用于获取指定网格的详细信息

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

mesh_id

是

String

网格ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本，固定值“v1”，该值不可修改

kind

String

API类型，固定值“Mesh”或“mesh”，该值不可修改

metadata

表4 object

网格的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性

spec

表5 object

集合类的元素类型，您对需要管理的网格进行详细描述的主体部分都在spec中给出。ASM通过spec的描述来创建或更新网格对象

status

表18 object

集合类的元素类型，用于记录网格在系统中的当前状态信息。

该参数为系统自动生成，不需要用户填写
表4 MeshMetadata

参数

参数类型

描述

name

String

网格名称。

命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-64位，且不能以中划线(-)结尾

uid

String

网格ID，资源唯一标识，创建成功后自动生成

creationTimestamp

String

网格创建时间
表5 MeshSpec

参数

参数类型

描述

type

String

网格类型：

InCluster: 集群内控制平面形态，基础版网格取值为InCluster

version

String

网格版本

extendParams

表6 object

服务网格扩展信息

ipv6Enable

Boolean

网格是否支持IPV6

config

表8 object

网格配置。
表6 MeshExtendParams

参数

参数类型

描述

clusters

Array of 表7 objects

网格内集群信息
表7 MeshCluster

参数

参数类型

描述

clusterID

String

集群ID，资源唯一标识，通过该ID查询需要添加的集群
表8 MeshConfig

参数

参数类型

描述

proxyConfig

表9 object

网格数据面配置

telemetryConfig

表10 object

网格的可观测性配置
表9 ProxyConfig

参数

参数类型

描述

includeIPRanges

String

拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段

excludeIPRanges

String

排除拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段

excludeOutboundPorts

String

排除拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表

excludeInboundPorts

String

排除拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表

includeOutboundPorts

String

拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表

includeInboundPorts

String

拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表
表10 TelemetryConfig

参数

参数类型

描述

metrics

表11 object

应用指标配置，用于上报ASM网格指标数据。如果要启用该配置，集群需安装云原生监控插件。

accessLogging

表13 object

AccessLog配置，用于上报ASM网格内Istio代理的访问日志。如果要启用该配置，集群需安装云原生日志采集插件。

tracing

表15 object

Tracing配置，用于上报ASM网格内的调用链数据。
表11 Metric

参数

参数类型

描述

aom

Array of 表12 objects

AOM实例配置。
表12 Aom

参数

参数类型

描述

instanceID

String

AOM实例ID。
表13 AccessLogging

参数

参数类型

描述

lts

Array of 表14 objects

LTS配置
表14 LtsConfig

参数

参数类型

描述

logGroupID

String

AccessLog日志组ID

logStreamID

String

AccessLog输出日志流ID
表15 Tracing

参数

参数类型

描述

randomSamplingPercentage

Float

tracing采样率

defaultProviders

Array of strings

tracing默认上报的provider名称，必须与extensionProviders中的name字段匹配，或使用ASM预设的provider "apm-otel"。

如果使用"apm-otel"，需确认当前region已支持APM2.0且网格版本大于1.18。

extensionProviders

Array of 表16 objects

用户自配置provider，目前支持zipkin。

如果用户配置zipkin的provider，请保证网格版本大于等于1.15。
表16 TracingExtensionProvider

参数

参数类型

描述

name

String

provider实例name

zipkin

表17 object

zipkin provider自有配置
表17 ZipkinTracingProvider

参数

参数类型

描述

service

String

zipkin服务地址

port

Integer

zipkin服务端口
表18 MeshStatus

参数

参数类型

描述

phase

String

网格状态，取值如下

  • Running：运行中，表示网格处于正常运行状态
  • Creating：创建中，表示网格正处于创建过程中
  • CreateFailed：创建失败
  • Deleting：删除中，表示网格正处于删除过程中
  • DeleteFailed：删除失败
  • Upgrading：升级中，表示网格正处于升级过程中
  • UpgradeFailed：升级失败
  • RollingBack：回滚中，表示网格正处于回滚过程中
  • RollbackFailed：回滚失败

updateTimestamp

String

网格更新时间

状态码： 400

表19 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

最小长度：8

最大长度：36

errorMsg

String

错误描述

最小长度：2

最大长度：512

状态码： 404

表20 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

最小长度：8

最大长度：36

errorMsg

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表21 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

最小长度：8

最大长度：36

errorMsg

String

错误描述

最小长度：2

最大长度：512

请求示例

无

响应示例

状态码： 200

表示获取网格成功

{ 
  "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" : { 
        "metrics" : { 
          "aom" : [ { 
            "instanceID" : "602a5b7e-xxxx-xxxx-xxxx-4268c35b0424" 
          } ] 
        }, 
        "accessLogging" : { 
          "lts" : [ { 
            "logGroupID" : "b884eaeb-xxxx-xxxx-xxxx-f442de73c392", 
            "logStreamID" : "362e11e8-xxxx-xxxx-xxxx-0afdc68da7d2" 
          } ] 
        }, 
        "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" 
  } 
}

状态码

状态码

描述

200

表示获取网格成功

400

用户提供的参数有问题，未通过校验

404

未找到指定的网格

500

查询过程中出现问题

错误码

请参见错误码。

父主题： 网格接口