使用DescribeApis查询定义中的API列表-API 网关-阿里云

查询定义中的API列表。

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeApis	get	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	无	无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	否	指定的分组编号	c4a4d2de657548a2bd485d5d4df42b4a
ApiId	string	否	指定的 API 编号	f68c19ee3bd1478fb58aa05ce8ae9b5a
ApiName	string	否	API 名称(模糊匹配)	weather
CatalogId	string	否	分类 ID	1553414085247362
Visibility	string	否	API 是否公开，可以取值： PUBLIC：公开，如选择此类型，该 API 的线上环境定义，会在所有用户的控制台“发现 API”页面可见。 PRIVATE：不公开，如选择此类型，当该组 API 在云市场上架时，私有类型的 API 不会上架。	PUBLIC
PageSize	integer	否	指定分页查询时每页行数，默认值为 10	10
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
EnableTagAuth	boolean	否	是否启用标签验证	true
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。	Key， Value
	object	否
Key	string	否	标签键	key
Value	string	否	标签值	value
ApiPath	string	否	API 的请求 Path	/illegal/query
ApiMethod	string	否	API 的请求 HTTP 方法	GET
UnDeployed	boolean	否	是否过滤未发布的接口	true
StageName	string	否	指定要操作 API 的环境。 RELEASE: 线上 PRE: 预发 TEST: 测试	RELEASE

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	3
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSize	integer	返回指定的每页条数	15
TotalCount	integer	返回结果的总条数	32
ApiSummarys	array<object>	由 ApiSummary 组成的数组格式，返回 API 的定义信息
ApiSummary	object
Visibility	string	可见性，可选值： PUBLIC：公开 PRIVATE：私有	PUBLIC
ApiId	string	API 编号	5af418828f0344a3b588c0cc1331a3bc
ModifiedTime	string	修改时间（格林威治时间）	2016-07-23T08:28:48Z
Description	string	API 描述	创建对象接口
GroupName	string	API 分组名称	myGroup2
GroupId	string	API 分组编号	1084f9034c744137901057206b39d2b6
CreatedTime	string	创建时间（格林威治时间）	2016-05-20T18:18:25Z
ApiName	string	API 名称	创建对象
RegionId	string	API 所在地域 ID	cn-qingdao
ApiPath	string	api 的路径	/sqb/
ApiMethod	string	api 的请求方法	GET
DeployedInfos	array<object>	API 发布状态
DeployedInfo	object	API 发布状态
StageName	string	环境名称： RELEASE: 线上 PRE：预发 TEST: 测试	RELEASE
EffectiveVersion	string	已部署的版本	20220103170737313
DeployedStatus	string	部署状态，取值为：DEPLOYED、NONDEPLOYED，分别表示已部署、未部署	DEPLOYED
TagList	array<object>	标签信息
Tag	object	标签信息
TagKey	string	标签键	tagKey
TagValue	string	标签值	tagValue

示例

正常返回示例

JSON格式

{
  "PageNumber": 3,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002",
  "PageSize": 15,
  "TotalCount": 32,
  "ApiSummarys": {
    "ApiSummary": [
      {
        "Visibility": "PUBLIC",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "ModifiedTime": "2016-07-23T08:28:48Z",
        "Description": "创建对象接口",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "CreatedTime": "2016-05-20T18:18:25Z",
        "ApiName": "创建对象",
        "RegionId": "cn-qingdao",
        "ApiPath": "/sqb/",
        "ApiMethod": "GET",
        "DeployedInfos": {
          "DeployedInfo": [
            {
              "StageName": "RELEASE",
              "EffectiveVersion": 20220103170737310,
              "DeployedStatus": "DEPLOYED"
            }
          ]
        },
        "TagList": {
          "Tag": [
            {
              "TagKey": "tagKey",
              "TagValue": "tagValue"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-03-23	OpenAPI 返回结构发生变更	查看变更详情
2022-09-02	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情