文档首页/应用服务网格 ASM/API参考/API/网关管理/获取网关列表 - ListGateways
更新时间：2026-02-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取网关列表 - ListGateways

功能介绍

该API用于获取网关列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    asm:mesh:listGateways

    List

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v3/meshes/{mesh_id}/gateways

表1 路径参数

参数

是否必选

参数类型

描述

mesh_id

是

String

网格ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

gateways

Array of VirtualGatewayInstance objects

网关实例列表

表4 VirtualGatewayInstance

参数

参数类型

描述

gatewayName

String

网关名称

cluster

GatewayCluster object

网关对应的入口服务所属的集群

address

String

外部访问地址

protocol

String

网关协议

certList

Array of CertServer objects

tls终止使用的证书

status

String

网关状态

namespace

String

网关所在命名空间

externalIPs

String

网关gateway service对应的外网IP，即elb ip

ASMStyled

ASMStyled object

网关支持ASM Console能力

表5 GatewayCluster

参数

参数类型

描述

id

String

集群id

name

String

集群名称

表6 CertServer

参数

参数类型

描述

secretName

String

证书内容所在的secret名称

hosts

Array of strings

证书hosts

maxProtocolVersion

String

支持的最高TLS协议版本

minProtocolVersion

String

支持的最低TLS协议版本

表7 ASMStyled

参数

参数类型

描述

traffic_manage

String

是否支持ASM Console流量治理能力，如果值为NotMatch则不支持

security

String

是否支持ASM Console服务安全能力，如果值为NotMatch则不支持

gateway_route

String

是否支持ASM Console网关路由能力，如果值为NotMatch则不支持

请求示例

无

响应示例

无

状态码

状态码

描述

200

获取网关列表成功

错误码

请参见错误码。

父主题：网关管理

相关文档