使用ListHttpApis获取HTTP API列表-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

获取HTTP API列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListHttpApis

list

*HttpApi

acs:apig:{#regionId}:{#accountId}:httpapi/*

无

请求语法

GET /v1/http-apis HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
keyword	string	否	搜索关键词，支持 API 名称模糊搜索或 API ID 精确搜索。	test-
pageNumber	integer	否	分页页码，从 1 开始，不填默认 1.	1
pageSize	integer	否	分页大小，有效范围[1, 100]，不填默认 10。	10
name	string	否	按照名称精确搜索。	login
types	string	否	HTTP API 的类型。支持传入多个类型，采用","分割。 Http Rest WebSocket HttpIngress	Http,Rest
gatewayId	string	否	云原生 API 网关 ID。	gw-cq2avtllh****
withAuthPolicyInEnvironmentId	string	否	响应中每个 API 信息携带指定环境 ID 下的消费者认证策略信息。	env-xxx
withConsumerInfoById	string	否	响应中每个 API 信息携带指定消费者 ID 的授权规则列表。	cs-xxx
withEnvironmentInfo	boolean	否	环境信息	true
withPluginAttachmentByPluginId	string	否	插件 ID，根据此插件 ID 获取插件发布信息。	pl-ct9qn3um1hktue8dqol0
resourceGroupId	string	否	资源组 ID。	rg-ahr5uil8raz0rq3b
withEnvironmentInfoById	string	否	环境 ID	env-ctovu5mm1hksb4q8ln40
withAuthPolicyList	boolean	否	是否开启了权限认证策略	true
withIngressInfo	boolean	否	是否包含 ingress 信息	false
withPolicyConfigs	boolean	否	是否包含策略信息	false
withAPIsPublishedToEnvironment	boolean	否	是否返回已发布到指定环境的 API 信息	true
gatewayType	string	否	网关类型过滤，目前支持 AI、API 两种网关类型。枚举值： AI : AI API : API	API

返回参数

名称	类型	描述	示例值
	object	返回体
requestId	string	请求 ID。	585657D2-1C20-5B8A-AF17-D727C6490BE4
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	API 列表。
pageNumber	integer	分页页码。	1
pageSize	integer	分页大小。	10
totalSize	integer	总数量。	10
items	array	API 信息。
	HttpApiInfoByName	按照 API 名进行分组的 API 信息。

示例

正常返回示例

JSON格式

{
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": []
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。