调用DescribeAuthorizedApis查询指定app已授权的API列表,即指定app可以调用的API列表。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
AppId Long 2386789

App编号,系统生成,全局唯一

Action String DescribeAuthorizedApis

接口名称,系统规定参数,取值:DescribeAuthorizedApis

PageNumber Integer 1

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

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
AuthorizedApis Array

已授权的API集合

AuthorizedApi

已授权的API集合

ApiId String baacc592e63a4cb6a41920d9d3f91f38

系统自动生成API唯一标识符

ApiName String AreaWeather

API名称

AuthVaildTime String 2018-10-05T16:00:00Z

授权有效时间的截止时间,格林威治时间

AuthorizationSource String CONSOLE

授权来源,取值:

  • CONSOLE:控制台
  • API:API
AuthorizedTime String 2016-07-21T06:17:20

授权操作的时间,格林威治时间

Description String 根据地区名称查询天气情况

授权说明

GroupId String 523e8dc7bbe04613b5b1d726c2a7889d

API分组ID,系统生成,全局唯一

GroupName String Weather

API分组名称

Operator String PROVIDER

授权的人,取值:

  • PROVIDER:API所有者
  • CONSUMER:API调用者
RegionId String cn-hangzhou

API所在区域

StageName String RELEASE

API环境,取值:

  • RELEASE:线上
  • TEST:测试
PageNumber Integer 1

返回指定的页码

PageSize Integer 10

返回指定的每页条数

RequestId String D6E46F10-F26C-4AA0-BB69-FE2743D9AE62

请求ID

TotalCount Integer 2

返回结果的总条数

示例

请求示例


http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApis
&AppId=2386789
&<公共请求参数>

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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