描述
用于查询当前存在的API分组列表及基本信息
名称 | 类型 | 是否必须 | 描述 |
Action | String | 是 | 接口名称,系统规定参数,取值:DescribeApiGroups |
GroupId | String | 否 | API分组 ID,系统生成,全局唯一 |
GroupName | String | 否 | API组名称中,可指定的关键字 |
PageNumber | Integer | 否 | 指定要查询的页码,默认是1,起始是1 |
PageSize | Integer | 否 | 指定分页查询时每页行数,最大值50,默认值为10 |
名称 | 类型 | 描述 |
RequestId | String | 请求唯一标识 |
TotalCount | Integer | 返回结果的总条数 |
PageNumber | Integer | 返回指定的页码 |
PageSize | Integer | 返回指定的每页条数 |
ApiGroupAttributes | ApiGroupAttribute | 返回分组集合 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
功能描述: 此功能允许API提供者查询当前已存在的API分组列表及其基本信息,便于管理和监控API分组状态。通过调用DescribeApiGroups
接口,用户可以获取分组的ID、名称、描述、计费状态、QPS限制等关键信息,同时支持分页查询和按名称关键字过滤。
前提条件: - 用户需拥有API网关相关权限,尤其是apigateway:DescribeApiGroups
的访问权限。 - 已在阿里云上创建了API分组。
请求参数:
DescribeApiGroups
。请求示例: 具体请求构造请参考OpenAPI Explorer提供的直接运行接口功能,可免去手动计算签名的步骤,并自动生成SDK代码示例。
响应参数:
响应示例:
{
"PageNumber": 1,
"RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
"PageSize": 10,
"TotalCount": 2,
"ApiGroupAttributes": {
"ApiGroupAttribute": [
{
// 分组属性详情...
}
]
}
}
注意事项: - 查询时可以通过组合GroupId
、GroupName
进行精确或模糊查询。 - 注意PageSize
的上限为50,合理设置以避免数据量过大。 - 调用接口可能受到频率限制,确保在合理的间隔时间内进行调用。
相关文档: 本解答基于阿里云API Gateway服务的官方文档相关内容。
参考资料: DescribeApiGroups - 查询 API 分组列表