调用DescribeAuthorizedApis查询已授权的API列表_API 网关(API Gateway)-阿里云帮助中心

查询指定 APP 已授权的API列表，即指定 APP 的API列表。

接口说明

此功能面向 API 使用者
App 可以调用查询结果返回的所有 API

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeAuthorizedApis	get	App acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	long	是	App 编号，系统生成，全局唯一	2386789
PageNumber	integer	否	指定要查询的页码，默认是 1，起始是 1	1
PageSize	integer	否	指定分页查询时每页行数，最大值 100，默认值为 10	10

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	返回指定的页码	1
RequestId	string	请求 ID	D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSize	integer	返回指定的每页条数	10
TotalCount	integer	返回结果的总条数	2
AuthorizedApis	array<object>	已授权的 API 集合
AuthorizedApi	object
ApiId	string	系统自动生成 API 唯一标识符	baacc592e63a4cb6a41920d9d3f91f38
AuthorizationSource	string	授权来源，取值： CONSOLE：控制台 API：API	CONSOLE
AuthVaildTime	string	授权有效时间的截止时间，格林威治时间	2018-10-05T16:00:00Z
Description	string	授权说明	根据地区名称查询天气情况
GroupName	string	API 分组名称	Weather
GroupId	string	API 分组 ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
AuthorizedTime	string	授权操作的时间，格林威治时间	2016-07-21T06:17:20
Operator	string	授权的人，取值： PROVIDER：API 所有者 CONSUMER：API 调用者	PROVIDER
StageName	string	API 环境，取值： RELEASE：线上 TEST：测试	RELEASE
ApiName	string	API 名称	AreaWeather
RegionId	string	API 所在区域	cn-hangzhou

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "AuthorizedApis": {
    "AuthorizedApi": [
      {
        "ApiId": "baacc592e63a4cb6a41920d9d3f91f38",
        "AuthorizationSource": "CONSOLE",
        "AuthVaildTime": "2018-10-05T16:00:00Z",
        "Description": "根据地区名称查询天气情况",
        "GroupName": "Weather",
        "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
        "AuthorizedTime": "2016-07-21T06:17:20",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "ApiName": "AreaWeather",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

JSON格式

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "AuthorizedApis": {
    "AuthorizedApi": [
      {
        "ApiId": "baacc592e63a4cb6a41920d9d3f91f38",
        "AuthorizationSource": "CONSOLE",
        "AuthVaildTime": "2018-10-05T16:00:00Z",
        "Description": "根据地区名称查询天气情况",
        "GroupName": "Weather",
        "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
        "AuthorizedTime": "2016-07-21T06:17:20",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "ApiName": "AreaWeather",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史