edit-icon download-icon

Query the apps authorized to access an API

最終更新日: Dec 13, 2018

詳述

現在 API にアクセスできるアプリのリストを照会します。

  • 本 API は API プロバイダを対象としています。
  • 本インターフェイスは、指定した API に現在アクセスできるアプリのリストを照会するときに使用します。
  • 照会結果に返されるすべてのアプリは、指定された API にアクセスできます。

リクエスト パラメーター

名前 必須 説明
Action String はい インターフェイス名。必須パラメーター。値は DescribeAuthorizedApps
GroupId String はい API のグループ ID。システムが生成し、グローバルに一意です
ApiId String はい システムの生成する、グローバルに一意のアプリ ID
StageName String いいえ ステージ名。値は、
  • RELEASE:オンライン
  • TEST:テスト
PageNumber Integer いいえ 照会するページ番号を指定。デフォルト値は 1、開始番号は 1
PageSize Integer いいえ ページング照会時の 1 ページあたりの行数を指定。最大値は 100、デフォルト値は 10

レスポンス パラメーター

名前 説明
RequestId String 一意のリクエスト ID
TotalCount Integer 返された結果の合計
PageNumber Integer 返すよう指定されたページ番号
PageSize Integer 指定された、各ページに含める結果の合計
AuthorizedApps AuthorizedApp 返されたグループ セット

リクエスト例

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

レスポンス例

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> 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 形式

  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. }