查询 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	运行环境信息

示例

请求示例

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

返回示例

XML格式

<DescribeApiGroupResponse>
    <RequestId>03442A3D-3B7D-434C-8A95-A5FEB989B519</RequestId>
    <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
    <GroupName>NewWeather</GroupName>
    <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
    <Description>New weather informations.</Description>
    <CreatedTime>2016-08-01T06:53:02Z</CreatedTime>
    <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
    <RegionId>cn-hangzhou</RegionId>
    <Status>NORMAL</Status>
    <BillingStatus>NORMAL</BillingStatus>
    <IllegalStatus>NORMAL</IllegalStatus>
    <TrafficLimit>500</TrafficLimit>
    <CustomDomains>
        <CustomDomain>
            <DomainName>api.demo.com</DomainName>
            <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
            <CertificateName>myCertificate</CertificateName>
            <DomainNameResolution>RESOLVED</DomainNameResolution>
            <DomainStatus>BINDING</DomainStatus>
            <DomainLegalStatus>ABNORMAL</DomainLegalStatus>
            <DomainRemark>该域名未备案</DomainRemark>
        </CustomDomain>
    </CustomDomains>
    <StageItems>
        <StageInfo>
            <StageId>123e8dc7bbe01613b5b1d726c2a7887e</StageId>
            <StageName>RELEASE</StageName>
            <Description>MYRELEASE</Description>
        </StageInfo>
        <StageInfo>
            <StageId>123e8dc7bbe01613b5b1d726c2a7888e</StageId>
            <StageName>TEST</StageName>
            <Description>MYTEST</Description>
        </StageInfo>
    </StageItems>
</DescribeApiGroupResponse>

JSON格式

{
    "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
    "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
    "GroupName": "NewWeather",
    "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
    "Description": "New weather informations.",
    "CreatedTime": "2016-08-01T06:53:02Z",
    "ModifiedTime": "2016-08-01T06:54:32Z",
    "RegionId": "cn-hangzhou",
    "Status": "NORMAL",
    "BillingStatus": "NORMAL",
    "IllegalStatus": "NORMAL",
    "TrafficLimit": "500",
    "CustomDomains": {
      "CustomDomain": {
        "DomainName": "api.demo.com",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "CertificateName": "myCertificate",
        "DomainNameResolution": "RESOLVED",
        "DomainStatus": "BINDING",
        "DomainLegalStatus":"ABNORMAL",
        "DomainRemark":"该域名未备案"
      }
    },
    "StageItems": {
      "StageInfo": [
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7887e",
          "StageName": "RELEASE",
          "Description": "MYRELEASE"
        },
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
          "StageName": "TEST",
          "Description": "MYTEST"
        }
      ]
    }
}