开发者社区 问答 正文

如何查询 API 分组列表?



描述


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

  • 此功能面向API提供者


请求参数


名称类型是否必须描述
ActionString接口名称,系统规定参数,取值:DescribeApiGroups
GroupIdStringAPI分组 ID,系统生成,全局唯一
GroupNameStringAPI组名称中,可指定的关键字
PageNumberInteger指定要查询的页码,默认是1,起始是1
PageSizeInteger指定分页查询时每页行数,最大值50,默认值为10


返回参数


名称类型描述
RequestIdString请求唯一标识
TotalCountInteger返回结果的总条数
PageNumberInteger返回指定的页码
PageSizeInteger返回指定的每页条数
ApiGroupAttributesApiGroupAttribute返回分组集合


示例



请求示例







展开
收起
轩墨 2017-10-26 13:45:53 1782 分享 版权
阿里云 AI 助理回答

功能描述: 此功能允许API提供者查询当前已存在的API分组列表及其基本信息,便于管理和监控API分组状态。通过调用DescribeApiGroups接口,用户可以获取分组的ID、名称、描述、计费状态、QPS限制等关键信息,同时支持分页查询和按名称关键字过滤。

前提条件: - 用户需拥有API网关相关权限,尤其是apigateway:DescribeApiGroups的访问权限。 - 已在阿里云上创建了API分组。

请求参数

  • Action: String, 必填。接口名称,固定值为DescribeApiGroups
  • GroupId: String, 可选。指定的API分组ID。
  • GroupName: String, 可选。API组名称中的关键字,用于过滤分组。
  • PageNumber: Integer, 可选。指定要查询的页码,默认为1。
  • PageSize: Integer, 可选。每页返回的记录数,默认为10,最大不超过50。

请求示例: 具体请求构造请参考OpenAPI Explorer提供的直接运行接口功能,可免去手动计算签名的步骤,并自动生成SDK代码示例。

响应参数:

  • RequestId: String。请求的唯一标识。
  • TotalCount: Integer。返回结果的总条数。
  • PageNumber: Integer。返回的页码。
  • PageSize: Integer。每页的记录数。
  • ApiGroupAttributes: Array of ApiGroupAttribute对象。包含多个分组的详细信息,如分组ID、名称、描述、计费状态等。

响应示例:

{
  "PageNumber": 1,
  "RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
  "PageSize": 10,
  "TotalCount": 2,
  "ApiGroupAttributes": {
    "ApiGroupAttribute": [
      {
        // 分组属性详情...
      }
    ]
  }
}

注意事项: - 查询时可以通过组合GroupIdGroupName进行精确或模糊查询。 - 注意PageSize的上限为50,合理设置以避免数据量过大。 - 调用接口可能受到频率限制,确保在合理的间隔时间内进行调用。

相关文档: 本解答基于阿里云API Gateway服务的官方文档相关内容。

参考资料: DescribeApiGroups - 查询 API 分组列表

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答