Query an API group - Developer Guide| Alibaba Cloud Documentation Center

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

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

Response example

XML format

<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>NORMAL</DomainLegalStatus>
            <DomainRemark>The domain did not put on record</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 format

{
    "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":"The domain did not put on record"
      }
    },
    "StageItems": {
      "StageInfo": [
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7887e",
          "StageName": "RELEASE",
          "Description": "MYRELEASE"
        },
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
          "StageName": "TEST",
          "Description": "MYTEST"
        }
      ]
    }
}