调用DescribeAuthorizedApps查询当前可访问API的应用（app）列表。

  • 此功能面向API提供者
  • 查询结果返回的所有应用（app）均可访问指定的API

调试

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

请求参数

名称 类型 是否必选 示例值 描述
ApiId String 是 baacc592e63a4cb6a41920d9d3f91f38

API编号，系统生成，全局唯一
GroupId String 是 523e8dc7bbe04613b5b1d726c2a7889d

API分组ID，系统生成，全局唯一
Action String 否 DescribeAuthorizedApps

接口名称，系统规定参数，取值：DescribeAuthorizedApps。

AppId Long 否 20112314518278

App编号
AppName String 否 CreateApptest

App名称
AppOwnerId Long 否 1546564

App拥有者的阿里云账号ID
PageNumber Integer 否 1

指定要查询的页码，默认是1，起始是1
PageSize Integer 否 10

指定分页查询时每页行数，最大值100，默认值为10
StageName String 否 RELEASE

环境名称，取值为：

  • RELEASE：线上
  • TEST：测试

返回数据

名称 类型 示例值 描述
AuthorizedApps Array

返回分组集合
AuthorizedApp

返回分组集合
AppId Long 2386789

编号，系统生成，全局唯一
AppName String 天气

应用名称
AuthVaildTime String 2018-10-05T16:00:00Z

应用名称
AuthorizationSource String CONSOLE

授权来源，取值：

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

授权操作的时间，格林威治时间
Description String 根据地区名称查询天气情况

授权说明
Operator String PROVIDER

授权的人，取值:

  • PROVIDER：API所有者
  • CONSUMER：API调用者
StageName String RELEASE

环境名称，取值：

  • RELEASE
  • TEST
PageNumber Integer 1

返回指定的页码
PageSize Integer 10

返回指定的每页条数
RequestId String D6E46F10-F26C-4AA0-BB69-FE2743D9AE62

请求ID
TotalCount Integer 2

返回结果的总条数

示例

请求示例


http(s)://apigateway.cn-hangzhou.aliyuncs.com/?Action=DescribeAuthorizedApps
&ApiId=baacc592e63a4cb6a41920d9d3f91f38
&GroupId=523e8dc7bbe04613b5b1d726c2a7889d
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeAuthorizedAppsResponse>
      <TotalCount>2</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
      <AuthorizedApps>
            <AuthorizedApp>
                  <StageName>RELEASE</StageName>
                  <AppId>2386789</AppId>
                  <AppName>天气app</AppName>
                  <Operator>PROVIDER</Operator>
                  <AuthorizationSource>CONSOLE</AuthorizationSource>
                  <Description>根据地区名称查询天气情况</Description>
                  <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
                  <AuthVaildTime>2018-10-05T16:00:00Z</AuthVaildTime> 
            </AuthorizedApp>
            <AuthorizedApp>
                  <StageName>TEST</StageName>
                  <AppId>2386789</AppId>
                  <AppName>天气app</AppName>
                  <Operator>CONSUMER</Operator>
                  <AuthorizationSource>API</AuthorizationSource>
                  <Description>根据地区名称查询天气情况</Description>
                  <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
                  <AuthVaildTime></AuthVaildTime>
            </AuthorizedApp>
      </AuthorizedApps>    
</DescribeAuthorizedAppsResponse>

JSON 格式 

{
	"PageNumber":"1",
	"TotalCount":"2",
	"PageSize":"10",
	"AuthorizedApps":{
		"AuthorizedApp":[
			{
				"StageName":"RELEASE",
				"AuthVaildTime ":"2018-10-05T16:00:00Z",
				"Description":"根据地区名称查询天气情况",
				"Operator":"PROVIDER",
				"AppId":2386789,
				"AuthorizedTime":"2016-07-21T06:17:20Z",
				"AppName":"天气app",
				"AuthorizationSource":"CONSOLE"
			},
			{
				"StageName":"TEST",
				"AuthVaildTime ":"",
				"Description":"根据地区名称查询天气情况",
				"Operator":"CONSUMER",
				"AppId":2386789,
				"AuthorizedTime":"2016-07-21T06:17:20Z",
				"AppName":"天气app",
				"AuthorizationSource":"API"
			}
		]
	},
	"RequestId":"D6E46F10-F26C-4AA0-BB69-FE2743D9AE62"
}

错误码

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