查询HTTP API的路由列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:ListHttpApiRoutes |
list |
*HttpApi
|
无 | 无 |
请求语法
GET /v1/http-apis/{httpApiId}/routes HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| httpApiId |
string |
否 |
HTTP API ID。此参数为 path 参数，实际必填，未提供时请求 URL 无法构造；可通过 ListHttpApis 返回的 versionedHttpApis[].httpApiId 获取有效值。此参数必须指向类型为 Http、HttpIngress 或 WebSocket 的 HTTP API，Rest 类型不支持路由操作。 |
api-cr68g1dlhtgm31f*** |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| pageNumber |
integer |
否 |
分页页码，从 1 开始，不填默认 1. |
1 |
| pageSize |
integer |
否 |
分页大小，有效范围[1, 100]，不填默认 10。 |
10 |
| environmentId |
string |
否 |
环境 id。 |
env-cpqnr6tlhtgubc*** |
| deployStatuses |
string |
否 |
路由的部署状态。 枚举值：
|
NotDeployed |
| name |
string |
否 |
路由名称。 |
itemcenter-gateway |
| nameLike |
string |
否 |
按路由名称模糊查询。 |
item |
| pathLike |
string |
否 |
按路由路径模糊查询。 |
/v1 |
| gatewayId |
string |
否 |
云原生 API 网关 ID。 |
gw-cpv4sqdl**** |
| withConsumerInfoById |
string |
否 |
响应中每个路由信息携带指定消费者 ID 的授权规则列表。 |
cs-xxx |
| consumerAuthorizationRuleId |
string |
否 |
根据特定的消费者授权规则 ID 过滤接口列表，响应中的接口列表仅包含已授权的接口。 |
cas-xxx |
| withAuthPolicyInfo |
boolean |
否 |
响应中携带消费者授权信息。 |
true |
| withPluginAttachmentByPluginId |
string |
否 |
响应中每个路由信息携带指定的插件 ID 的挂载信息。 |
pl-xxx |
| domainId |
string |
否 |
根据域名 ID 过滤路由信息。 |
d-xxx |
| forDeploy |
boolean |
否 |
是否为部署场景 |
true |
| backendServiceName |
string |
否 |
后端服务名称，可根据该名称过滤路由 |
test-svc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
CBEEB8C1-108E-50F0-9BEA-DED79553C309 |
| code |
string |
响应状态码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
响应数据。 |
|
| pageNumber |
integer |
分页页码。 |
1 |
| pageSize |
integer |
分页大小。 |
20 |
| totalSize |
integer |
总数量。 |
9 |
| items |
array |
路由列表。 |
|
| HttpRoute |
路由信息。 |
示例
正常返回示例
JSON格式
{
"requestId": "CBEEB8C1-108E-50F0-9BEA-DED79553C309",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 20,
"totalSize": 9,
"items": [
{
"routeId": "hr-crf5l7tlhtgp91t***",
"name": "itemcenter-pre-route",
"deployStatus": "Deployed",
"description": "商品中心预发路由",
"match": {
"ignoreUriCase": true,
"path": {
"type": "Prefix",
"value": "/user"
},
"headers": [
{
"type": "Exact",
"name": "dev",
"value": "true"
}
],
"methods": [
"GET"
],
"queryParams": [
{
"type": "Exact",
"name": "age",
"value": "17"
}
]
},
"backend": {
"scene": "Single",
"enableSystemModels": true,
"services": [
{
"serviceId": "service-cq2bmmdlhtgj***",
"modelName": "qwen-plus",
"name": "item-service",
"protocol": "HTTP",
"port": 0,
"weight": 49,
"version": "v1",
"sourceType": "MSE_NACOS",
"groupName": "DEFAULT_GROUP",
"namespace": "public",
"httpDubboTranscoder": {
"dubboServiceName": "com.example.DemoService",
"dubboServiceVersion": "1.0.0",
"dubboServiceGroup": "DEV",
"methodMapList": [
{
"dubboMethodName": "sayName",
"httpMethod": "ALL_GET",
"methodPath": "/mytestzbk/sayhello",
"passThroughAllHeaders": "PASS_NOT",
"passThroughList": [
"[\"x-request-id\", \"x-tenant\"]"
],
"paramMapsList": [
{
"extractKeySpec": "ALL_QUERY_PARAMETER",
"extractKey": "name",
"mappingType": "java.lang.String"
}
]
}
]
}
}
]
},
"environmentInfo": {
"environmentId": "env-crhq1u5lhtgju***",
"name": "itemcenter-pre",
"alias": "商品中心预发环境",
"gatewayInfo": {
"gatewayId": "gw-cqoohqtlh***",
"name": "itemcenter-gateway",
"gatewayEdition": "MultiTenantServerless"
},
"subDomains": [
{
"domainId": "d-cqu19hdlhtgjuv4***",
"name": "env-crmic3llht***-cn-hangzhou-vpc.alicloudapi.com",
"protocol": "HTTP",
"networkType": "Internet"
}
]
},
"createTimestamp": 1726649310593,
"updateTimestamp": 1726819895636,
"mcpServerInfo": {
"importInstanceId": "import-001",
"importNamespace": "default",
"importMcpServerId": "mcp-002",
"createFromType": "Nacos",
"mcpServerConfig": "{\\\"config\\\":{}}",
"mcpRouteConfig": {
"protocol": "SSE",
"exposedUriPath": "/mcp"
}
},
"domainInfos": [
{
"domainId": "d-cr3v7dllhtgi9s***",
"name": "itemcenter.dev",
"protocol": "HTTP"
}
],
"gatewayStatus": {
"key": "Running"
},
"builtin": "true"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。