调用DescribeApiGroups查询当前存在的API分组列表及基本信息。

  • 此功能面向API提供者

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeApiGroups

接口名称,系统规定参数,取值:DescribeApiGroups

GroupId String be6d2abcc0dd4f749fc2d2edd6567164

API分组 ID,系统生成,全局唯一

GroupName String Traffic

API组名称中,可指定的关键字

PageNumber Integer 1

指定要查询的页码,默认是1,起始是1

PageSize Integer 10

指定分页查询时每页行数,最大值50,默认值为10

Tag.N.Key String key

标签的key

Tag.N.Value String value

标签的value

InstanceId String apigateway-cn-v6419k43245xx

实例ID

Sort String desc

排序,默认值是desc,可选asc,desc

  • asc:按修改时间升序排列;
  • desc:按修改时间降序排列

返回数据

名称 类型 示例值 描述
ApiGroupAttributes Array of ApiGroupAttribute

返回分组集合

ApiGroupAttribute
BillingStatus String NORMAL

计费状态,取值:

  • NORMAL:正常
  • LOCKED:欠费锁定
CreatedTime String 2016-08-01T08:45:15Z

创建时间,格林威治时间

Description String TrafficInformations.

分组描述

GroupId String be6d2abcc0dd4f749fc2d2edd6567164

API分组 ID,系统生成,全局唯一

GroupName String Traffic

API组名称

HttpsPolicy String HTTPS2_TLS1_0

HTTPS安全策略

IllegalStatus String NORMAL

违法锁定,取值:

  • NORMAL:正常
  • LOCKED:违法锁定
InstanceId String apigateway-cn-v6419k43245xx

实例ID

InstanceType String VPC_SHARED

实例类型

ModifiedTime String 2016-08-01T08:45:15Z

最后修改时间,格林威治时间

RegionId String cn-hangzhou

分组所在区域

SubDomain String be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com

API组对应的二级域名,自定义域名cname所用

Tags Array of TagInfo

标签

TagInfo
Key String key

标签的key

Value String value

标签的value

TrafficLimit Integer 500

分组最高QPS限制,默认500,可申请提高

PageNumber Integer 1

返回指定的页码

PageSize Integer 10

返回指定的每页条数

RequestId String D6E46F10-F26C-4AA0-BB69-FE2743D9AE62

请求唯一标识

TotalCount Integer 2

返回结果的总条数

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeApiGroups
&<公共请求参数>

正常返回示例

XML格式

<DescribeApiGroupsResponse>
      <RequestId>D6E46F10-F26C-4AA0-BB69-FE2743D9AE62</RequestId>
      <TotalCount>2</TotalCount>
      <PageSize>10</PageSize>
      <PageNumber>1</PageNumber>
          <ApiGroupAttributes>
                <ApiGroupAttribute>
                      <GroupId>be6d2abcc0dd4f749fc2d2edd6567164</GroupId>
                      <GroupName>Traffic</GroupName>
                      <SubDomain>be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com</SubDomain>
                      <Description>TrafficInformations.</Description>
                        <CreatedTime>2016-08-01T08:45:15Z</CreatedTime>
                        <ModifiedTime>2016-08-01T08:45:15Z</ModifiedTime>
                        <RegionId>cn-hangzhou</RegionId>
                        <TrafficLimit>500</TrafficLimit>
                        <BillingStatus>NORMAL</BillingStatus>
                        <IllegalStatus>NORMAL</IllegalStatus>
                </ApiGroupAttribute>
                <ApiGroupAttribute>
                      <GroupId>927d50c0f2e54b359919923d908bb015</GroupId>
                      <GroupName>NewWeather</GroupName>
                        <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
                        <Description>NewWeatherInformations.</Description>
                        <CreatedTime>2016-08-01T06:54:32Z</CreatedTime>
                        <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
                        <RegionId>cn-hangzhou</RegionId>
                        <TrafficLimit>500</TrafficLimit>
                        <BillingStatus>NORMAL</BillingStatus>
                        <IllegalStatus>NORMAL</IllegalStatus>
                </ApiGroupAttribute>
          </ApiGroupAttributes>
</DescribeApiGroupsResponse>

JSON格式

{
    "DescribeApiGroupsResponse": {
        "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
        "TotalCount": 2,
        "PageSize": 10,
        "PageNumber": 1,
        "ApiGroupAttributes": {
            "ApiGroupAttribute": [
                {
                    "GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
                    "GroupName": "Traffic",
                    "SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
                    "Description": "TrafficInformations.",
                    "CreatedTime": "2016-08-01T08:45:15Z",
                    "ModifiedTime": "2016-08-01T08:45:15Z",
                    "RegionId": "cn-hangzhou",
                    "TrafficLimit": 500,
                    "BillingStatus": "NORMAL",
                    "IllegalStatus": "NORMAL"
                },
                {
                    "GroupId": "927d50c0f2e54b359919923d908bb015",
                    "GroupName": "NewWeather",
                    "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
                    "Description": "NewWeatherInformations.",
                    "CreatedTime": "2016-08-01T06:54:32Z",
                    "ModifiedTime": "2016-08-01T06:54:32Z",
                    "RegionId": "cn-hangzhou",
                    "TrafficLimit": 500,
                    "BillingStatus": "NORMAL",
                    "IllegalStatus": "NORMAL"
                }
            ]
        }
    }
}

错误码

访问错误中心查看更多错误码。