查询HTTP API的路由列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apig:ListHttpApiRoutes | list | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| 无 |
请求语法
GET /v1/http-apis/{httpApiId}/routes HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| httpApiId | string | 否 | HTTP API ID。 | 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 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "CBEEB8C1-108E-50F0-9BEA-DED79553C309",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 20,
"totalSize": 9,
"items": [
{
"routeId": "",
"name": "",
"deployStatus": "",
"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",
"services": [
{
"serviceId": "service-cq2bmmdlhtgj***",
"name": "item-service",
"protocol": "HTTP",
"port": 0,
"weight": 49,
"version": "v1"
}
]
},
"domainInfos": [
{
"domainId": "",
"name": "",
"protocol": ""
}
],
"environmentInfo": {
"environmentId": "",
"name": "",
"alias": "",
"gatewayInfo": {
"gatewayId": "",
"name": ""
},
"subDomains": [
{
"domainId": "",
"name": "",
"protocol": "",
"networkType": "Internet"
}
]
},
"createTimestamp": 0,
"updateTimestamp": 0,
"mcpServerInfo": {
"importInstanceId": "",
"importNamespace": "",
"importMcpServerId": "",
"createFromType": "",
"mcpServerConfig": "",
"mcpRouteConfig": {
"protocol": "",
"exposedUriPath": ""
}
},
"gatewayStatus": {
"key": ""
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史