edit-icon download-icon

Query the apps authorized to access an API

Last Updated: Nov 08, 2017

Description

For querying the list of apps that can access an API currently.

  • This API is intended for API providers.
  • The interface is used to query the list of apps that can access a specified API currently.
  • All apps included in the returned query results can access a specified API.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: DescribeAuthorizedApps.
GroupId String Yes API group ID, which is generated by the system and globally unique.
ApiId String Yes App ID, which is generated by the system and globally unique.
StageName String No Stage name; values:
  • RELEASE: Online
  • TEST: Test
PageNumber Integer No The page number specified for query; default value: 1; the starting number: 1.
PageSize Integer No Number of lines per page set at paging query; maximum value: 100; default value: 10.

Return parameters

Name Type Description
RequestId String Unique request ID.
TotalCount Integer Total number of returned results.
PageNumber Integer Page number specified to be returned.
PageSize Integer Specified total number of results returned per page.
AuthorizedApps AuthorizedApp Returned group set.

Examples

Request example

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApps
  2. &GroupId=523e8dc7bbe04613b5b1d726c2a7889d
  3. &ApiId=baacc592e63a4cb6a41920d9d3f91f38
  4. &<Public request parameters>

Response example

XML format

  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> Weather app</AppName>
  11. <Operator>PROVIDER</Operator>
  12. <AuthorizationSource>CONSOLE</AuthorizationSource>
  13. <Description> Query weather conditions by region name</Description>
  14. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  15. </AuthorizedApp>
  16. <AuthorizedApp>
  17. <StageName>TEST</StageName>
  18. <AppId>2386789</AppId>
  19. <AppName> Weather app</AppName>
  20. <Operator>CONSUMER</Operator>
  21. <AuthorizationSource>API</AuthorizationSource>
  22. <Description> Query weather conditions by region name</Description>
  23. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  24. </AuthorizedApp>
  25. </AuthorizedApps>
  26. </DescribeAuthorizedAppsResponse>

JSON format

  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": " Weather app",
  12. "Operator": "PROVIDER",
  13. "AuthorizationSource": "CONSOLE",
  14. "Description": " Query weather conditions by region name",
  15. "AuthorizedTime": "2016-07-21T06:17:20Z"
  16. },
  17. {
  18. "StageName": "TEST",
  19. "AppId": 2386789,
  20. "AppName": " Weather app",
  21. "Operator": "CONSUMER",
  22. "AuthorizationSource": "API",
  23. "Description": " Query weather conditions by region name",
  24. "AuthorizedTime": "2016-07-21T06:17:20Z"
  25. }
  26. ]
  27. }
  28. }
Thank you! We've received your feedback.