ListHttpApis
获取HTTP API列表
服务地址：
华东1（杭州）
输入参数
只看必填
keyword搜索关键词
pageNumber分页页码
pageSize分页大小
name按照名称精确搜索
typesHTTP API的类型
gatewayId云原生API网关ID
withAuthPolicyInEnvironmentId响应中每个API信息携带指定环境ID下...
withConsumerInfoById响应中每个API信息携带指定消费者ID...
withEnvironmentInfo环境信息
请选择布尔值
withPluginAttachmentByPluginId插件ID
resourceGroupId资源组ID
withEnvironmentInfoById环境ID
withAuthPolicyList是否开启了权限认证策略
请选择布尔值
withIngressInfo是否包含ingress信息
请选择布尔值
withPolicyConfigs
请选择布尔值
withAPIsPublishedToEnvironment
请选择布尔值
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

请求语法

GET /v1/http-apis HTTP/1.1

请求参数

字段名称字段详情
keywordstring

搜索关键词，支持 API 名称模糊搜索或 API ID 精确搜索。

示例值:test-
pageNumberinteger<int32>

分页页码，从 1 开始，不填默认 1.

示例值:1
pageSizeinteger<int32>

分页大小，有效范围[1, 100]，不填默认 10。

示例值:10
namestring

按照名称精确搜索。

示例值:login
typesstring

HTTP API 的类型。支持传入多个类型，采用","分割。展开详情

示例值:Http,Rest
gatewayIdstring

云原生 API 网关 ID。

示例值:gw-cq2avtllh****参考取值来源:
    GetGateway
    ListGateways
withAuthPolicyInEnvironmentIdstring

响应中每个 API 信息携带指定环境 ID 下的消费者认证策略信息。

示例值:env-xxx
withConsumerInfoByIdstring

响应中每个 API 信息携带指定消费者 ID 的授权规则列表。

示例值:cs-xxx
withEnvironmentInfoboolean

环境信息

示例值:true
withPluginAttachmentByPluginIdstring

插件 ID，根据此插件 ID 获取插件发布信息。

示例值:pl-ct9qn3um1hktue8dqol0
resourceGroupIdstring

资源组 ID。

示例值:rg-ahr5uil8raz0rq3b
withEnvironmentInfoByIdstring

环境 ID

示例值:env-ctovu5mm1hksb4q8ln40
withAuthPolicyListboolean

是否开启了权限认证策略

示例值:true
withIngressInfoboolean

是否包含 ingress 信息

示例值:false
withPolicyConfigsboolean
withAPIsPublishedToEnvironmentboolean

返回参数

字段名称字段详情
requestIdstring

请求 ID。

示例值:585657D2-1C20-5B8A-AF17-D727C6490BE4
codestring

响应状态码。

示例值:Ok
messagestring

响应消息。

示例值:success
dataobject

API 列表。

变更历史
变更时间变更内容概要操作
2025-03-31
新增请求参数withPolicyConfigs
新增请求参数withAPIsPublishedToEnvironment
2024-12-26
新增请求参数withIngressInfo
2024-11-28
新增请求参数withPluginAttachmentByPluginId
新增请求参数withEnvironmentInfoById
新增请求参数withAuthPolicyList
2024-11-20
新增请求参数resourceGroupId
2024-11-18
新增请求参数withEnvironmentInfo
2024-10-24
新增请求参数withAuthPolicyInEnvironmentId
新增请求参数withConsumerInfoById
2024-09-11
删除请求参数type
2024-09-06
删除请求参数publishedOnly
新增请求参数type
新增请求参数types
新增请求参数gatewayId
2024-08-05
新增请求参数name
  • 1
  • 2
  • 10 条/页