- 最新动态
- 功能总览
- 服务公告
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- APIG业务使用流程
- 创建用户并授权使用APIG
- 创建APIG实例
- 开放API
- 配置API调用授权(可选)
- 调用API
-
管理API
- 管理API概述
- 查看或编辑APIG的API信息
- 配置API的自定义认证
- 配置API的参数编排规则
- 自定义API的错误响应信息
- 克隆APIG的API
- 下线APIG的API
- 导入导出API
-
APIG的API设计文件扩展定义
- x-apigateway-auth-type
- x-apigateway-request-type
- x-apigateway-match-mode
- x-apigateway-cors
- x-apigateway-is-send-fg-body-base64
- x-apigateway-any-method
- x-apigateway-backend
- x-apigateway-backend.parameters
- x-apigateway-backend.httpEndpoints
- x-apigateway-backend.httpVpcEndpoints
- x-apigateway-backend.functionEndpoints
- x-apigateway-backend.mockEndpoints
- x-apigateway-backend-policies
- x-apigateway-backend-policies.conditions
- x-apigateway-ratelimit
- x-apigateway-ratelimits
- x-apigateway-ratelimits.policy
- x-apigateway-ratelimits.policy.special
- x-apigateway-access-control
- x-apigateway-access-controls
- x-apigateway-access-controls.policy
- x-apigateway-plugins
- x-apigateway-auth-opt
- x-apigateway-result-normal-sample
- x-apigateway-result-failure-sample
- x-apigateway-authorizer
- x-apigateway-response
- x-apigateway-responses
- x-apigateway-pass-through
- x-apigateway-sample
- x-apigateway-content-type
- x-apigateway-orchestrations
- 配置API策略
- 配置凭据策略
- 管理APIG实例
- 查看监控指标与配置告警
- 查看APIG审计日志
- 共享版操作指导(仅存量用户使用)
- 最佳实践
- 开发指南
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
专享版API(V2)
- 专享版-API分组管理
- 专享版-环境管理
- 专享版-环境变量管理
- 专享版-流控策略管理
- 专享版-API管理
- 专享版-签名密钥管理
- 专享版-签名密钥绑定关系管理
- 专享版-API绑定流控策略
- 专享版-设置特殊流控
- 专享版-APP授权管理
- 专享版-概要查询
- 专享版-域名管理
- 专享版-ACL策略管理
- 专享版-API绑定ACL策略
- 专享版-自定义认证管理
- 专享版-OpenAPI接口
- 专享版-VPC通道管理
- 专享版-监控信息查询
- 专享版-分组自定义响应管理
- 专享版-标签管理
- 专享版-实例特性管理
- 专享版-配置管理
- 专享版-实例管理
- 专享版-实例终端节点管理
- 专享版-实例标签管理
- 专享版-微服务中心管理
- 专享版-SSL证书管理
- 专享版-插件管理
- 专享版-凭据管理
- 专享版-凭据配额管理
- 专享版-异步任务管理
- 专享版-编排规则管理
- 专享版-实例自定义入方向端口管理
- 共享版API(仅存量用户使用)
- 专享版API(V1)(待下线)
- 权限策略和授权项
- 附录
- 修订记录
- SDK参考
- 场景代码示例
-
常见问题
- 热门咨询
- 产品咨询
- 开放API
- 发布API
-
调用API
- 调用API失败的可能原因
- 调用API报“414 Request URI too large”
- 调用API报“The API does not exist or has not been published in the environment”
- 调用API报“No backend available”
- API的后端服务报“Backend unavailable”或“Backend timeout”
- API的后端服务报“Backend domain name resolution failed”
- 调用API报“Incorrect IAM authentication information”
- 调用API报“Incorrect app authentication information”
- 修改API后端服务的超时时间上限“backend_timeout”后未生效
- APIG对API请求体的大小是否有限制?
- API调用对请求的响应消息体限制
- 使用iOS系统时,如何使用APP认证调用API?
- 新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token?
- 是否支持移动应用调用API?
- 部署在VPC下的应用是否可以调用API?
- APIG是否支持WebSocket数据传输?
- API的策略后端有多个时,怎么匹配和执行API请求?
- 如何通过APIG访问公网后端服务?
- API认证
- API策略
- 导入导出API
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询分组列表
功能介绍
查询API分组列表。
如果是租户操作,则查询该租户下所有的分组;如果是管理员操作,则查询的是所有租户的分组。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
请求方法 |
URI |
---|---|
GET |
/v1/{project_id}/apigw/instances/{instance_id}/api-groups[?page_size, page_no, id, name] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:id、name、page_size、page_no。
URI中的参数说明如下表所示。
名称 |
是否必选 |
类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 |
instance_id |
是 |
String |
实例ID,可从API网关控制台的专享版实例信息中获取。 |
id |
否 |
String |
编号 |
name |
否 |
String |
名称 |
page_size |
否 |
Integer |
每页显示的条数,默认值:20 |
page_no |
否 |
Integer |
页码,默认值:1 |
precise_search |
否 |
String |
指定需要精确匹配查找的参数名称,目前仅支持name |
请求消息
无
响应消息
名称 |
类型 |
说明 |
---|---|---|
total |
Integer |
满足条件的分组总数 |
size |
Integer |
本次返回的列表长度 |
groups |
字典数据类型 |
分组列表 |
名称 |
类型 |
说明 |
---|---|---|
id |
String |
编号 |
name |
String |
名称 |
status |
Integer |
状态 |
sl_domain |
String |
系统默认分配的子域名 |
register_time |
Timestamp |
创建时间 |
update_time |
Timestamp |
最近修改时间 |
remark |
String |
描述 |
on_sell_status |
Integer |
是否已上架云商店:
|
call_limits |
Integer |
流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 |
time_interval |
Integer |
流控时长 |
time_unit |
String |
流控的时间单位 |
url_domains |
字典数据类型 |
分组上绑定的独立域名列表 |
响应消息样例:
{ "total": 2, "size": 2, "groups": [{ "id": "02a8ab3c-b278-4de5-a096-852829671ae7", "name": "api_group_002", "status": 1, "sl_domain": "19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com", "remark": "分组002", "register_time": "2017-12-28T11:57:35Z", "update_time": "2017-12-28T11:57:35Z", "on_sell_status": 2 }, { "id": "73c58022-f20d-495a-a188-85d718647f09", "name": "api_group_001", "status": 1, "sl_domain": "c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com", "remark": "分组001", "register_time": "2017-12-28T11:57:27Z", "update_time": "2017-12-28T11:57:27Z", "on_sell_status": 2 }] }
状态码
状态码 |
说明 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
500 |
Server Internal Error |