edit-icon download-icon

Query an API group

Last Updated: Dec 18, 2017

Description

This function is for querying the details about an API group, including the automatically generated second-level domain name, custom domain name, and SSL certificate of the API group.

  • This function is intended for API providers.
  • The DescribeApiGroup interface is used to query all details of a specified API group.

Request parameters

Name Type Required? Description
Action String Yes Interface name, which is a required parameter; value: DescribeApiGroup.
GroupId String Yes API group ID, which is generated by the system and globally unique.

Return parameters

Name Type Description
RequestId String Unique request ID.
GroupID String API group ID, which is generated by the system and globally unique.
GroupName String API group name.
SubDomain String Second-level domain name automatically assigned to the API group.
Description String API group description.
CreatedTime String Creation time (Greenwich mean time).
ModifiedTime String Last modification time (Greenwich mean time).
RegionId String The ID of the region where the API group is located.
Status String Status of the API group.
  • NORMAL: The API group is normal.
  • DELETE: The API group is deleted.
BillingStatus String Billing status.
  • NORMAL: The API group is normal.
  • LOCKED: Locked due to outstanding payment.
IllegalStatus String Locking in invalid state.
  • NORMAL: The API group is normal.
  • LOCKED: Locked due to illegality.
TrafficLimit Integer Upper QPS limit of the API group; default value: 500, which can be increased by submitting an application.
CustomDomains CustomDomain Information of the custom domain name.
StageItems StageInfo Stage information.

Examples

Request example

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

Response example

XML format

  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 format

  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. }
Thank you! We've received your feedback.