文档

DescribeApiGroups - 查询 API 分组列表

更新时间:

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

接口说明

  • 此功能面向 API 提供者

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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>

标签列表

object
Keystring

标签的 key

key
Valuestring

标签的 value

value

返回参数

名称类型描述示例值
object
PageNumberinteger

返回指定的页码

1
RequestIdstring

请求唯一标识

D6E46F10-F26C-4AA0-BB69-FE2743D9AE62
PageSizeinteger

返回指定的每页条数

10
TotalCountinteger

返回结果的总条数

2
ApiGroupAttributesarray<object>

返回分组集合

ApiGroupAttributeobject
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>

标签列表

TagInfoobject
Keystring

标签的 key

key
Valuestring

标签的 value

value

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "ApiGroupAttributes": {
    "ApiGroupAttribute": [
      {
        "BasePath": "/v2/",
        "BillingStatus": "NORMAL",
        "TrafficLimit": 500,
        "InstanceId": "apigateway-cn-v6419k43245xx",
        "InstanceType": "VPC_SHARED",
        "RegionId": "cn-hangzhou",
        "ModifiedTime": "2016-08-01T08:45:15Z",
        "GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
        "GroupName": "Traffic",
        "Description": "TrafficInformations.",
        "IllegalStatus": "NORMAL",
        "HttpsPolicy": "HTTPS2_TLS1_0",
        "SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
        "CreatedTime": "2016-08-01T08:45:15Z",
        "Tags": {
          "TagInfo": [
            {
              "Key": "key",
              "Value": "value"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史