调用DescribeServiceMeshes获取服务网格列表_服务网格(ASM)-阿里云帮助中心

调用DescribeServiceMeshes获取服务网格列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Tag	object []	否	标签列表。
Key	string	否	标签 Key。	test
Value	string	否	标签值。	yahaha

返回参数

名称	类型	描述	示例值
	object	响应体。
RequestId	string	请求 ID。	BD65C0AD-D3C6-48D3-8D93-38D2015C****
ServiceMeshes	object []	服务网格详情。
Endpoints	object	端点详情。
IntranetPilotEndpoint	string	Istio Pilot 地址（内网）。	192.168.xx.xx:15011
IntranetApiServerEndpoint	string	API Server 地址（内网）。	https://192.168.xx.xx:6443
PublicApiServerEndpoint	string	API Server 地址（公网）。	https://123.56.xx.xx:6443
ServiceMeshInfo	object	服务网格基本信息。
Profile	string	商业化之前的网格实例规格，取值： `Pro`：专业版。 `Default`：标准版。	Pro
CreationTime	string	服务网格创建时间。	2020-04-21T09:42:20+08:00
UpdateTime	string	服务网格最后修改时间。	2020-04-21T09:42:20+08:00
ErrorMessage	string	异常信息。	error
Version	string	服务网格版本号。	1
State	string	服务网格状态。	success
ServiceMeshId	string	服务网格 ID。	cb8963379255149cb98c8686f274x****
Name	string	服务网格名称。	test
RegionId	string	服务网格所在地域 ID。	cn-beijing
Spec	object	规格信息。
Network	object	服务网格网络配置信息。
VpcId	string	专有网络 ID。	vpc-2zew0rajjkmxy2369****
SecurityGroupId	string	安全组 ID。	sg-2ze384sxttxbctnj****
VSwitches	array	虚拟交换机 ID 列表。
	string	虚拟交换机 ID 列表。	["1","2"]
LoadBalancer	object	负载均衡信息。
PilotPublicEip	boolean	是否使用公网地址暴露 Istio Pilot，取值： `true`：使用公网地址暴露 Istio Pilot。 `false`：不使用公网地址暴露 Istio Pilot。	true
PilotPublicLoadbalancerId	string	公网地址暴露 Istio Pilot 对应的负载均衡 ID。	lb-2zesa8qs8kbkj9jkl****
ApiServerLoadbalancerId	string	公网地址暴露 API Server 对应的负载均衡 ID。	lb-2zekaak10uxds44vx****
ApiServerPublicEip	boolean	是否使用公网地址暴露 API Server，取值： `true`：使用公网地址暴露 API Server。 `false`：不使用公网地址暴露 API Server。	true
MeshConfig	object	服务网格配置信息。
Telemetry	boolean	是否开启采集 Prometheus 监控指标（建议使用阿里云 Prometheus 监控），取值： `true`：开启采集 Prometheus 监控指标。 `false`：不开启采集 Prometheus 监控指标。	true
OutboundTrafficPolicy	string	外部流量策略，取值： `ALLOW_ANY`：允许访问网格外的服务。 `REGISTRY_ONLY`：仅允许访问网格内的服务。	ALLOW_ANY
Tracing	boolean	是否启用链路追踪（需要开通可观测链路 OpenTelemetry 版），取值： `true`：启用链路追踪。 `false`：不启用链路追踪。	true
StrictMtls	boolean	模式。	true
Pilot	object	控制面配置。
Http10Enabled	boolean	是否启用支持 HTTP 1.0。取值： `true`：支持 HTTP 1.0。 `false`：不支持 HTTP 1.0。	true
TraceSampling	float	启用链路追踪时的采样率。	0.2
Mtls	boolean	是否启用服务就近访问，取值： `true`：启用服务就近访问。 `false`：不启用服务就近访问。	true
SidecarInjector	object	Sidecar 注入配置。
EnableNamespacesByDefault	boolean	是否为所有命名空间开启自动注入功能。 `true`：为全部命名空间开启自动注入。 `false`：不为全部命名空间开启自动注入。	false
AutoInjectionPolicyEnabled	boolean	通过 Pod Annotations 实现自动注入。	true
InitCNIConfiguration	object	CNI 初始化配置。
ExcludeNamespaces	string	要从 Istio Pod 检查中排除的名称空间。	default,foo
Enabled	boolean	为 istio-proxy 进行流量重定向时，是否需要赋予 istio-init 容器特权，取值： `true`：不需要赋予 istio-init 容器特权。 `false`：需要赋予 istio-init 容器特权。	true
Clusters	array	集群列表。
	string	集群列表。	["caf089e56daba4c51a8906fe43ea1**","c80f45444b3da447da60a911390c2**"]
ClusterSpec	string	服务网格实例规格，取值： `standard`：标准版。 `enterprise`：企业版。 `ultimate`：旗舰版。	standard
OwnerType	string	创建网格的云产品类型，取值： `ackone`：网格由 ACK One 创建。当此项取值为空时，代表网格由用户创建。	ackone
OwnerId	string	创建网格的云产品实例 ID。	cc3e96f249d124eb38b72718ec5*****
Tag	object []	标签信息集合。
Key	string	标签键	test
Value	string	标签值。	yahaha
Upgradable	boolean	该网格是否可以升级。	false

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-12-14

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-10-09

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-08-15

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：Tag
出参	OpenAPI 返回结构发生变更。