閱讀198 返回首頁    go 阿裏雲

查詢API分組詳情__API分組相關接口_API_API 網關-阿裏雲

描述

用於查詢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. https://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.         </CustomDomain>
  22.     </CustomDomains>
  23.     <StageItems>
  24.         <StageInfo>
  25.             <StageId>123e8dc7bbe01613b5b1d726c2a7887e</StageId>
  26.             <StageName>RELEASE</StageName>
  27.             <Description>MYRELEASE</Description>
  28.         </StageInfo>
  29.         <StageInfo>
  30.             <StageId>123e8dc7bbe01613b5b1d726c2a7888e</StageId>
  31.             <StageName>TEST</StageName>
  32.             <Description>MYTEST</Description>
  33.         </StageInfo>
  34.     </StageItems>
  35. </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.       }
  22.     },
  23.     "StageItems": {
  24.       "StageInfo": [
  25.         {
  26.           "StageId": "123e8dc7bbe01613b5b1d726c2a7887e",
  27.           "StageName": "RELEASE",
  28.           "Description": "MYRELEASE"
  29.         },
  30.         {
  31.           "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
  32.           "StageName": "TEST",
  33.           "Description": "MYTEST"
  34.         }
  35.       ]
  36.     }
  37. }

最後更新：2016-11-23 17:16:09

  上一篇：go 刪除環境的指定變量__API分組相關接口_API_API 網關-阿裏雲
  下一篇：go 查詢API分組列表__API分組相關接口_API_API 網關-阿裏雲