全部产品
Search
文档中心

服务网格 ASM:DescribeServiceMeshes - 获取服务网格列表

更新时间:Sep 18, 2024

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
servicemesh:DescribeServiceMeshesget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tagarray<object>

标签列表。

object

资源的标签。

Keystring

标签 Key。

test
Valuestring

标签值。

yahaha

返回参数

名称类型描述示例值
object

响应体。

RequestIdstring

请求 ID。

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

服务网格详情。

object
Endpointsobject

端点详情。

IntranetPilotEndpointstring

Istio Pilot 地址(内网)。

192.168.xx.xx:15011
IntranetApiServerEndpointstring

API Server 地址(内网)。

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

API Server 地址(公网)。

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

服务网格基本信息。

Profilestring

商业化之前的网格实例规格,取值:

  • Pro:专业版。

  • Default:标准版。

Pro
CreationTimestring

服务网格创建时间。

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

服务网格最后修改时间。

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

异常信息。

error
Versionstring

服务网格版本号。

1
Statestring

服务网格状态。

success
ServiceMeshIdstring

服务网格 ID。

cb8963379255149cb98c8686f274x****
Namestring

服务网格名称。

test
RegionIdstring

服务网格所在地域 ID。

cn-beijing
Specobject

规格信息。

Networkobject

服务网格网络配置信息。

VpcIdstring

专有网络 ID。

vpc-2zew0rajjkmxy2369****
SecurityGroupIdstring

安全组 ID。

sg-2ze384sxttxbctnj****
VSwitchesarray

虚拟交换机 ID 列表。

string

虚拟交换机 ID 列表。

["1","2"]
LoadBalancerobject

负载均衡信息。

PilotPublicEipboolean

是否使用公网地址暴露 Istio Pilot,取值:

  • true:使用公网地址暴露 Istio Pilot。

  • false:不使用公网地址暴露 Istio Pilot。

true
PilotPublicLoadbalancerIdstring

公网地址暴露 Istio Pilot 对应的负载均衡 ID。

lb-2zesa8qs8kbkj9jkl****
ApiServerLoadbalancerIdstring

公网地址暴露 API Server 对应的负载均衡 ID。

lb-2zekaak10uxds44vx****
ApiServerPublicEipboolean

是否使用公网地址暴露 API Server,取值:

  • true:使用公网地址暴露 API Server。

  • false:不使用公网地址暴露 API Server。

true
MeshConfigobject

服务网格配置信息。

Telemetryboolean

是否开启采集 Prometheus 监控指标(建议使用阿里云 Prometheus 监控),取值:

  • true:开启采集 Prometheus 监控指标。

  • false:不开启采集 Prometheus 监控指标。

true
OutboundTrafficPolicystring

外部流量策略,取值:

  • ALLOW_ANY:允许访问网格外的服务。

  • REGISTRY_ONLY:仅允许访问网格内的服务。

ALLOW_ANY
Tracingboolean

是否启用链路追踪(需要开通可观测链路 OpenTelemetry 版),取值:

  • true:启用链路追踪。

  • false:不启用链路追踪。

true
StrictMtlsboolean

模式。

true
Pilotobject

控制面配置。

Http10Enabledboolean

是否启用支持 HTTP 1.0。取值:

  • true:支持 HTTP 1.0。

  • false:不支持 HTTP 1.0。

true
TraceSamplingfloat

启用链路追踪时的采样率。

0.2
Mtlsboolean

是否启用服务就近访问,取值:

  • true:启用服务就近访问。

  • false:不启用服务就近访问。

true
SidecarInjectorobject

Sidecar 注入配置。

EnableNamespacesByDefaultboolean

是否为所有命名空间开启自动注入功能。

  • true:为全部命名空间开启自动注入。

  • false:不为全部命名空间开启自动注入。

false
AutoInjectionPolicyEnabledboolean

通过 Pod Annotations 实现自动注入。

true
InitCNIConfigurationobject

CNI 初始化配置。

ExcludeNamespacesstring

要从 Istio Pod 检查中排除的名称空间。

default,foo
Enabledboolean

为 istio-proxy 进行流量重定向时,是否需要赋予 istio-init 容器特权,取值:

  • true:不需要赋予 istio-init 容器特权。

  • false:需要赋予 istio-init 容器特权。

true
Clustersarray

集群列表。

string

集群列表。

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

服务网格实例规格,取值:

  • standard:标准版。

  • enterprise:企业版。

  • ultimate:旗舰版。

standard
OwnerTypestring

创建网格的云产品类型,取值:

  • ackone:网格由 ACK One 创建。

  • 当此项取值为空时,代表网格由用户创建。

ackone
OwnerIdstring

创建网格的云产品实例 ID。

cc3e96f249d124eb38b72718ec5*****
Tagarray<object>

标签信息集合。

object

资源标签。

Keystring

标签键

test
Valuestring

标签值。

yahaha
Upgradableboolean

该网格是否可以升级。

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-18OpenAPI 返回结构发生变更查看变更详情
2023-12-14OpenAPI 返回结构发生变更查看变更详情
2023-10-09OpenAPI 返回结构发生变更查看变更详情
2023-08-15OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情