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

获取网关路由列表 - ListRoutes

功能介绍

该API用于获取网关路由列表

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    asm:mesh:listGatewayRoutes

    List

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

POST /v3/meshes/{mesh_id}/gateways/{gateway}/routes

表1 路径参数

参数

是否必选

参数类型

描述

mesh_id

是

String

网格ID。

gateway

是

String

服务名称。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）。

取值范围：

  • application/json;charset=utf-8：指定内容为JSON格式，并以UTF8字符编码进行编码

  • application/json：指定内容为JSON格式

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

Namespace

是

Map<String,String>

需要获取路由列表的网关所在的命名空间，key为"namespace"，value为命名空间名称

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

gatewayNamespace

String

网关所在命名空间

routes

GatewayVirtualRoute object

路由列表
表5 GatewayVirtualRoute

参数

参数类型

描述

namespace

String

后端服务所在命名空间

matchRule

String

匹配规则，目前支持"prefix"（前缀匹配）和"exact"（完全匹配）

path

String

匹配路径

serviceName

String

后端服务名称

servicePort

Integer

后端服务端口

rewrite

HTTPRewrite object

重写规则
表6 HTTPRewrite

参数

参数类型

描述

uri

String

重写URI的路径（或前缀），如果原始URI是基于前缀匹配，那么将替换相应匹配的前缀

authority

String

重写HTTP的Host/Authority头

状态码：400

表7 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMsg

String

错误描述

状态码：500

表8 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMsg

String

错误描述

请求示例

{
  "Namespace" : [ null ]
}

响应示例

无

状态码

状态码

描述

200

获取网关路由列表成功

400

参数错误，获取路由列表失败

500

内部错误

错误码

请参见错误码。

父主题： 网关管理

相关文档