全部产品

查询 API 分组详情

更新时间:2017-07-05 15:14:31

描述

用于查询API分组的详情信息,包含分组系统自动生成的二级域名、自定义域名及SSL证书信息

  • 此功能面向API提供者
  • 用于查询指定分组全部详情信息

请求参数

名称 类型 是否必须 描述
Action String 接口名称,系统规定参数,取值:DescribeApiGroup
GroupId String API分组 ID,系统生成,全局唯一

返回参数

名称 类型 描述
RequestId String 请求唯一标识
GroupID String API分组 ID,系统生成,全局唯一
GroupName String API分组名称
SubDomain String 系统为分组分配的二级域名
Description String API分组描述
CreatedTime String 创建时间,格林威治时间
ModifiedTime String 最后修改时间,格林威治时间
RegionId String 分组所在区域
Status String 分组状态
  • NORMAL:正常
  • DELETE:删除
BillingStatus String 计费状态
  • NORMAL:正常
  • LOCKED:欠费锁定
IllegalStatus String 违法锁定
  • NORMAL:正常
  • LOCKED:违法锁定
TrafficLimit Integer 分组最高QPS限制,默认500,可申请提高
CustomDomains CustomDomain 自定义域名信息
StageItems StageInfo 运行环境信息

示例

请求示例

  1. http://apigateway.cn-hangzhou.aliyuncs.com?Action=DescribeApiGroup
  2. &GroupId=523e8dc7bbe04613b5b1d726c2a7889d
  3. &<公共请求参数>

返回示例

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>ABNORMAL</DomainLegalStatus>
  22. <DomainRemark>该域名未备案</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":"该域名未备案"
  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. }