edit-icon download-icon

Query the authorized apps

Last Updated: Nov 08, 2017

Description

For querying the authorized API list of a specified app, that is, the APIs that a specified app can call.

  • This API is intended for API users.
  • Apps can call all APIs returned by the query results.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: DescribeAuthorizedApis.
AppId Long Yes app ID, which is generated by the system and globally unique.
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.
PageSize Integer Specified total number of results returned per page.
PageNumber Integer Page number specified to be returned.
AuthorizedApis AuthorizedApi Authorized API set.

Examples

Request example

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeAuthorizedApis
  2. &AppId=2386789
  3. &<Public request parameters>

Response example

XML format

  1. <DescribeAuthorizedApisResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>2</TotalCount>
  4. <PageSize>10</PageSize>
  5. <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
  6. <AuthorizedApis>
  7. <AuthorizedApi>
  8. <RegionId>cn-hangzhou</RegionId>
  9. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  10. <GroupName>Weather</GroupName>
  11. <StageName>RELEASE</StageName>
  12. <Operator>PROVIDER</Operator>
  13. <ApiId>baacc592e63a4cb6a41920d9d3f91f38</ApiId>
  14. <ApiName>AreaWeather</ApiName>
  15. <AuthorizationSource>CONSOLE</AuthorizationSource>
  16. <Description> Query weather conditions by region name</Description>
  17. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  18. </AuthorizedApi>
  19. <AuthorizedApi>
  20. <RegionId>cn-hangzhou</RegionId>
  21. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  22. <GroupName>Weather</GroupName>
  23. <StageName>RELEASE</StageName>
  24. <Operator>CONSUMER</Operator>
  25. <ApiId>baacc592e63a4cb6a41920d9d3f89g76</ApiId>
  26. <ApiName>Area</ApiName>
  27. <AuthorizationSource>API</AuthorizationSource>
  28. <Description> Query a region</Description>
  29. <AuthorizedTime>2016-07-21T06:17:20Z</AuthorizedTime>
  30. </AuthorizedApi>
  31. </AuthorizedApis>
  32. </DescribeAuthorizedApisResponse>

JSON format

  1. {
  2. "PageNumber": "1",
  3. "TotalCount": "2",
  4. "PageSize": "10",
  5. "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  6. "AuthorizedApis": {
  7. "AuthorizedApi": [
  8. {
  9. "RegionId": "cn-hangzhou",
  10. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  11. "GroupName": "Weather",
  12. "StageName": "RELEASE",
  13. "Operator": "Provider",
  14. "ApiId": "baacc592e63a4cb6a41920d9d3f91f38",
  15. "ApiName": "AreaWeather",
  16. "AuthorizationSource": "CONSOLE",
  17. "Description": " Query weather conditions by region name",
  18. "AuthorizedTime": "2016-07-21T06:17:20Z"
  19. },
  20. {
  21. "RegionId": "cn-hangzhou",
  22. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  23. "GroupName": "Weather",
  24. "StageName": "RELEASE",
  25. "Operator": "CONSUMER",
  26. "ApiId": "baacc592e63a4cb6a41920d9d3f89g76",
  27. "ApiName": "Area",
  28. "AuthorizationSource": "API",
  29. "Description": " Query a region",
  30. "AuthorizedTime": "2016-07-21T06:17:20Z"
  31. }
  32. ]
  33. }
  34. }
Thank you! We've received your feedback.