edit-icon download-icon

Query an API group

最終更新日: Dec 13, 2018

詳述

本関数では、自動生成される第 2 レベル ドメイン名、カスタム ドメイン名および API グループの SSL 証明書といったAPI グループの詳細を照会します。

  • 本関数は、API プロバイダーを対象にしています。
  • DescribeApiGroup インターフェイスを使用して、指定した API グループの詳細をすべて照会します。

リクエスト パラメーター

名前 必須 説明
Action String はい インターフェイス名。必須パラメーター。値は、DescribeApiGroup
GroupId String はい API グループ ID。システムが生成し、グローバルに一意である

レスポンス パラメーター

名前 説明
RequestId String 一意のリクエスト ID
GroupID String API グループ ID。システムが生成し、グローバルに一意である
GroupName String API グループ名。
SubDomain String API グループに自動的に割り当てられる第 2 レベル ドメイン名
Description String API グループの説明
CreatedTime String 作成日時(グリニッジ標準時)
ModifiedTime String 最終修正日時(グリニッジ標準時)
RegionId String API グループのあるリージョンの ID
Status String API グループのステータス。
  • NORMAL:API グループは正常です。
  • DELETE:API グループは削除されています。
BillingStatus String 課金ステータス。
  • NORMAL: API グループは正常です。
  • LOCKED:未払いのため、ロックされています。
IllegalStatus String ロックによる無効状況。
  • NORMAL:API グループは正常です。
  • LOCKED:不正によりロックされています。
TrafficLimit Integer API グループの QPS 上限。デフォルト値は、500。申請することにより、増やすことができます
CustomDomains CustomDomain カスタム ドメイン名情報
StageItems StageInfo ステージ情報

リクエスト例

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

レスポンス例

XML 形式

  1. <DescribeApiGroupResponse>
  2. <RequestId>03442A3D-3B7D-434C-8A95-A5FEB989B519</RequestId>
  3. <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
  4. <GroupName>NewWeather</GroupName>
  5. <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
  6. <Description>New weather informations.</Description>
  7. <CreatedTime>2016-08-01T06:53:02Z</CreatedTime>
  8. <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
  9. <RegionId>cn-hangzhou</RegionId>
  10. <Status>NORMAL</Status>
  11. <BillingStatus>NORMAL</BillingStatus>
  12. <IllegalStatus>NORMAL</IllegalStatus>
  13. <TrafficLimit>500</TrafficLimit>
  14. <CustomDomains>
  15. <CustomDomain>
  16. <DomainName>api.demo.com</DomainName>
  17. <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
  18. <CertificateName>myCertificate</CertificateName>
  19. <DomainNameResolution>RESOLVED</DomainNameResolution>
  20. <DomainStatus>BINDING</DomainStatus>
  21. <DomainLegalStatus>NORMAL</DomainLegalStatus>
  22. <DomainRemark>The domain did not put on record</DomainRemark>
  23. </CustomDomain>
  24. </CustomDomains>
  25. <StageItems>
  26. <StageInfo>
  27. <StageId>123e8dc7bbe01613b5b1d726c2a7887e</StageId>
  28. <StageName>RELEASE</StageName>
  29. <Description>MYRELEASE</Description>
  30. </StageInfo>
  31. <StageInfo>
  32. <StageId>123e8dc7bbe01613b5b1d726c2a7888e</StageId>
  33. <StageName>TEST</StageName>
  34. <Description>MYTEST</Description>
  35. </StageInfo>
  36. </StageItems>
  37. </DescribeApiGroupResponse>

JSON 形式

  1. {
  2. "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
  3. "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  4. "GroupName": "NewWeather",
  5. "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
  6. "Description": "New weather informations.",
  7. "CreatedTime": "2016-08-01T06:53:02Z",
  8. "ModifiedTime": "2016-08-01T06:54:32Z",
  9. "RegionId": "cn-hangzhou",
  10. "Status": "NORMAL",
  11. "BillingStatus": "NORMAL",
  12. "IllegalStatus": "NORMAL",
  13. "TrafficLimit": "500",
  14. "CustomDomains": {
  15. "CustomDomain": {
  16. "DomainName": "api.demo.com",
  17. "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
  18. "CertificateName": "myCertificate",
  19. "DomainNameResolution": "RESOLVED",
  20. "DomainStatus": "BINDING",
  21. "DomainLegalStatus":"ABNORMAL",
  22. "DomainRemark":"The domain did not put on record"
  23. }
  24. },
  25. "StageItems": {
  26. "StageInfo": [
  27. {
  28. "StageId": "123e8dc7bbe01613b5b1d726c2a7887e",
  29. "StageName": "RELEASE",
  30. "Description": "MYRELEASE"
  31. },
  32. {
  33. "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
  34. "StageName": "TEST",
  35. "Description": "MYTEST"
  36. }
  37. ]
  38. }
  39. }