首页 API 网关 开发指南 API参考指南 API目录 分组 DescribeApiGroups - 查询 API 分组列表

DescribeApiGroups - 查询 API 分组列表

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

接口说明

  • 此功能面向API提供者

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiGroupsRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

名称类型必填描述示例值
GroupIdstring

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

be6d2abcc0dd4f749fc2d2edd6567164
GroupNamestring

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

Traffic
PageNumberinteger

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

1
PageSizeinteger

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

10
EnableTagAuthboolean

是否启用标签验证

true
InstanceIdstring

实例ID

apigateway-cn-v6419k43245xx
Sortstring

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

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

标签列表

object
Keystring

标签的key

key
Valuestring

标签的value

value

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求唯一标识

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

2
ApiGroupAttributesarray

返回分组集合

object
BasePathstring

基准路径

/v2/
BillingStatusstring

计费状态,取值:

  • NORMAL:正常
  • LOCKED:欠费锁定
NORMAL
TrafficLimitinteger

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

500
InstanceIdstring

实例ID

apigateway-cn-v6419k43245xx
InstanceTypestring

实例类型

VPC_SHARED
RegionIdstring

分组所在区域

cn-hangzhou
ModifiedTimestring

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

2016-08-01T08:45:15Z
GroupIdstring

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

be6d2abcc0dd4f749fc2d2edd6567164
GroupNamestring

API组名称

Traffic
Descriptionstring

分组描述

TrafficInformations.
IllegalStatusstring

违法锁定,取值:

  • NORMAL:正常
  • LOCKED:违法锁定
NORMAL
HttpsPolicystring

HTTPS安全策略

HTTPS2_TLS1_0
SubDomainstring

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

be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com
CreatedTimestring

创建时间,格林威治时间

2016-08-01T08:45:15Z
Tagsarray

标签列表

object
Keystring

标签的key

key
Valuestring

标签的value

value

示例

正常返回示例

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"
                }
            ]
        }
    }
}

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>

错误码

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

阿里云首页 API 网关 相关技术圈