调用DescribeApisByApp根据应用查询API列表_API 网关(API Gateway)-阿里云帮助中心

根据APP查询关联的API列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeApisByApp	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	long	是	APP 的 ID	333486644
PageNumber	integer	否	当前页码	1
PageSize	integer	否	每页条目	10
ApiUid	string	否	API 的 ID	b19240592b1b4e74961fb8438ed7550c
ApiName	string	否	API 名称	getPersonInfo
Path	string	否	API 请求路径	/tt
Method	string	否	API 的请求 HTTP Method	POST
Description	string	否	API 描述信息	test

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前页码	1
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSize	integer	每页条目	10
TotalCount	integer	总条目数	2
AppApiRelationInfos	object []	API 授权信息
ApiId	string	API 的 ID	c625795a1e664782a918eaa629e96ab5
AuthorizationSource	string	授权来源	SELF
AuthVaildTime	string	授权有效时间	Sun, 02 Jan 2022 16:00:00 GMT
Description	string	描述	b1008kz
GroupName	string	分组名称	wb2022012101605749
GroupId	string	分组 ID	38bed48d664149e4b9b5ea576319673f
Operator	string	授权的人，取值： PROVIDER：API 所有者 CONSUMER：API 调用者	PROVIDER
StageName	string	环境名称	RELEASE
CreatedTime	string	授权时间	Sun, 02 Jan 2022 16:00:00 GMT
ApiName	string	API 名称	sd2_h5_player_history_competition
RegionId	string	地区 ID	cn-shanghai
Path	string	API 的请求路径	/api/offline/cacheData
Method	string	API 的请求 HTTP Method	GET

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 2,
  "AppApiRelationInfos": {
    "AppApiRelationInfo": [
      {
        "ApiId": "c625795a1e664782a918eaa629e96ab5",
        "AuthorizationSource": "SELF",
        "AuthVaildTime": "Sun, 02 Jan 2022 16:00:00 GMT",
        "Description": "b1008kz",
        "GroupName": "wb2022012101605749",
        "GroupId": "38bed48d664149e4b9b5ea576319673f",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "StageAlias": "",
        "CreatedTime": "Sun, 02 Jan 2022 16:00:00 GMT",
        "ApiName": "sd2_h5_player_history_competition",
        "RegionId": "cn-shanghai",
        "Path": "/api/offline/cacheData",
        "Method": "GET"
      }
    ]
  }
}