DescribeApis_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
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
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 此功能面向开放 API 的用户
  • 接口返回所有定义中的 API 列表,以及概况信息
  • 请注意是返回所有编辑中的 API 定义信息,跟环境无关,也可能跟环境中正在运行的定义不同,是最新的编辑结果

流控信息

请求速率为10000/1(s)。更多流控信息,请前往配额中心查看

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
GroupIdstring

指定的分组编号

示例值:c4a4d2de657548a2bd485d5d4df42b4a参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
ApiIdstring

指定的 API 编号

示例值:f68c19ee3bd1478fb58aa05ce8ae9b5a参考取值来源:
    CreateApi
ApiNamestring

API 名称(模糊匹配)

示例值:weather参考取值来源:
    CreateApi
    DescribeApi
CatalogIdstring

分类 ID

示例值:1553414085247362
Visibilitystring

API 是否公开,可以取值:展开详情

示例值:PUBLIC
PageSizeinteger<int32>

指定分页查询时每页行数,默认值为 10

示例值:10
PageNumberinteger<int32>

指定要查询的页码,默认是 1,起始是 1

示例值:1
EnableTagAuthboolean

是否启用标签验证

示例值:true
Tagarray<object>

指定规则所适用的对象标签,可设置多个。

示例值:Key, Value子级条数 <= 50
ApiPathstring

API 的请求 Path

示例值:/illegal/query
ApiMethodstring

API 的请求 HTTP 方法

示例值:GET参考取值来源:
    DescribeDeployedApis
UnDeployedboolean

是否过滤未发布的接口

示例值:true
StageNamestring

指定要操作 API 的环境。展开详情

示例值:RELEASE

返回参数

字段名称字段详情
PageNumberinteger<int32>

返回指定的页码

示例值:3
RequestIdstring

请求 ID

示例值:CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSizeinteger<int32>

返回指定的每页条数

示例值:15
TotalCountinteger<int32>

返回结果的总条数

示例值:32
ApiSummarysobject

返回示例

变更历史

变更时间变更内容概要操作
2023-03-23
变更返回参数
2022-12-08
新增请求参数StageName
变更返回参数
2022-09-02
新增请求参数ApiPath
新增请求参数ApiMethod
新增请求参数UnDeployed
变更返回参数

相关示例