edit-icon download-icon

Query the APIs bound to a key

最終更新日: Dec 13, 2018

詳述

指定された署名鍵にバインドされた API を照会します。

  • 本関数は API を有効化するユーザーを対象としています。
  • 本関数は、指定された署名鍵にバインドされた API のリストを照会するために使用されます。
  • 結果はページ単位で返されます。

リクエスト パラメーター

名前 必須 説明
Action String はい 操作インターフェイス名。必須のパラメーター。値は、DescribeApisBySignature
SignatureId String はい 照会する署名鍵の ID
PageSize Integer いいえ ページング照会する 1 ページあたりの行数の指定。最大値は 100、デフォルト値は、10
PageNumber Integer いいえ 照会ページ番号の指定。デフォルト値は 1、開始番号は 1

レスポンス パラメーター

名前 説明
RequestId String 本リクエストの ID
TotalCount Integer 返された結果の合計
PageSize Integer ページごとに返された結果の合計を指定します
PageNumber Integer 返されるように指定されたページ番号
ApiInfos ApiInfo 返された API 情報。ApiInfos で構成される配列

リクエスト例

  1. https://apigateway.cn-qingdao.aliyuncs.com/?Action=DescribeApisBySignature
  2. &SignatureId=dd05f1c54d6749eda95f9fa6d491449a
  3. &<Public request parameters>

レスポンス例

XML 形式

  1. <DescribeApisBySignatureResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. <TotalCount>20</TotalCount>
  4. <PageSize>10</PageSize>
  5. <PageNumber>1</PageNumber>
  6. <ApiInfos>
  7. <ApiInfo>
  8. <RegionId>cn-qingdao</RegionId>
  9. <GroupId>0009db9c828549768a200320714b8930</GroupId>
  10. <GroupName>mygroup</GroupName>
  11. <StageName>test</StageName>
  12. <ApiId>3b81fd160f5645e097cc8855d75a1cf6</ApiId>
  13. <ApiName>testapi</ApiName>
  14. <Description> Description</Description>
  15. <Visibility>public</Visibility>
  16. <BoundTime>2016-07-23T08:28:48Z</BoundTime>
  17. </ApiInfo>
  18. </ApiInfos>
  19. </DescribeApisBySignatureResponse>

JSON 形式

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004",
  3. "TotalCount": "20",
  4. "PageSize": "10",
  5. "PageNumber": "1",
  6. "ApiInfos": {
  7. "ApiInfo": [
  8. {
  9. "RegionId": "cn-qingdao",
  10. "GroupId": "0009db9c828549768a200320714b8930",
  11. "GroupName": "mygroup",
  12. "StageName": "test",
  13. "ApiId": "3b81fd160f5645e097cc8855d75a1cf6",
  14. "ApiName": "testapi",
  15. "Description": " Description",
  16. "Visibility": "public",
  17. "BoundTime": "2016-07-23T08:28:48Z"
  18. }
  19. ]
  20. }
  21. }