全部产品

查询 API 的应用授权列表(DescribeAuthorizedApps)

更新时间:2019-03-22 19:29:08

查询 API 的应用授权列表(DescribeAuthorizedApps)

描述

用于查询当前可访问API的应用(app)列表

  • 此功能面向API提供者
  • 查询当前可访问指定API的应用应用(app)列表
  • 查询结果返回的所有应用(app)均可访问指定的API

请求参数

名称 类型 是否必须 描述
Action String 接口名称,系统规定参数,取值:DescribeAuthorizedApps
GroupId String API分组 ID,系统生成,全局唯一
ApiId String API编号,系统生成,全局唯一
StageName String 环境名称,取值为:
  • RELEASE:线上
  • TEST:测试
PageNumber Integer 指定要查询的页码,默认是1,起始是1
PageSize Integer 指定分页查询时每页行数,最大值100,默认值为10

返回参数

名称 类型 描述
RequestId String 请求唯一标识
TotalCount Integer 返回结果的总条数
PageNumber Integer 返回指定的页码
PageSize Integer 返回指定的每页条数
AuthorizedApps AuthorizedApp 返回分组集合

示例

请求示例

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApps
  2. &ApiIdbaacc592e63a4cb6a41920d9d3f91f38
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeAuthorizedAppsResponse>
  2. <TotalCount>2</TotalCount>
  3. <PageNumber>1</PageNumber>
  4. <PageSize>10</PageSize>
  5. <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
  6. <AuthorizedApps>
  7. <AuthorizedApp>
  8. <StageName>RELEASE</StageName>
  9. <AppId>2386789</AppId>
  10. <AppName>天气app</AppName>
  11. <Operator>PROVIDER</Operator>
  12. <AuthorizationSource>CONSOLE</AuthorizationSource>
  13. <Description>根据地区名称查询天气情况</Description>
  14. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  15. <AuthVaildTime>2018-10-05T16:00:00Z</AuthVaildTime>
  16. </AuthorizedApp>
  17. <AuthorizedApp>
  18. <StageName>TEST</StageName>
  19. <AppId>2386789</AppId>
  20. <AppName>天气app</AppName>
  21. <Operator>CONSUMER</Operator>
  22. <AuthorizationSource>API</AuthorizationSource>
  23. <Description>根据地区名称查询天气情况</Description>
  24. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  25. <AuthVaildTime></AuthVaildTime>
  26. </AuthorizedApp>
  27. </AuthorizedApps>
  28. </DescribeAuthorizedAppsResponse>

JSON格式

  1. {
  2. "TotalCount": "2",
  3. "PageNumber": "1",
  4. "PageSize": "10",
  5. "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  6. "AuthorizedApps": {
  7. "AuthorizedApp": [
  8. {
  9. "StageName": "RELEASE",
  10. "AppId": 2386789,
  11. "AppName": "天气app",
  12. "Operator": "PROVIDER",
  13. "AuthorizationSource": "CONSOLE",
  14. "Description": "根据地区名称查询天气情况",
  15. "AuthorizedTime": "2016-07-21T06:17:20Z",
  16. "AuthVaildTime " : "2018-10-05T16:00:00Z"
  17. },
  18. {
  19. "StageName": "TEST",
  20. "AppId": 2386789,
  21. "AppName": "天气app",
  22. "Operator": "CONSUMER",
  23. "AuthorizationSource": "API",
  24. "Description": "根据地区名称查询天气情况",
  25. "AuthorizedTime": "2016-07-21T06:17:20Z",
  26. "AuthVaildTime " : ""
  27. }
  28. ]
  29. }
  30. }