查询已购买的API分组列表
功能介绍
租户可以查询自己已购买的API分组列表。
URI
HTTP/HTTPS请求方法以及URI如下表所示。
|
请求方法 |
URI |
|---|---|
|
GET |
/v1.0/apigw/purchases/groups[?page_size, page_no, id, group_id, group_name] |
- 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
- 查询条件可为以下字段以及对应的值:id、group_id 、group_name 、page_size、page_no。
URI中的参数说明如下表所示。
|
名称 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
id |
否 |
String |
订购关系编号 |
|
group_id |
否 |
String |
API分组编号 |
|
group_name |
否 |
String |
API分组名称 |
|
page_size |
否 |
Integer |
每页显示的条数,默认值:20 |
|
page_no |
否 |
Integer |
页码,默认值:1 |
请求消息
无
响应消息
|
名称 |
类型 |
说明 |
|---|---|---|
|
total |
Integer |
满足查询条件的分组总数 |
|
size |
Integer |
本次查询返回的分组个数 |
|
purchases |
字典数据类型 |
本次查询返回的分组列表 |
|
参数 |
类型 |
说明 |
|---|---|---|
|
id |
String |
订购关系编号 |
|
group_id |
String |
分组编号 |
|
group_name |
String |
分组名称 |
|
group_remark |
String |
分组描述 |
|
order_time |
Timestamp |
订购时间 |
|
start_time |
Timestamp |
生效时间 |
|
expire_time |
Timestamp |
过期时间 |
|
group_domains |
[]String |
分组访问域名列表,查询列表时不返回 |
|
quota_left |
Integer |
剩余访问次数 |
|
quota_used |
Integer |
已使用访问次数 |
|
app_key |
String |
生成的APP的key |
|
app_secret |
String |
生成的APP的secret |
响应参数样例:
{
"total": 3,
"size": 3,
"purchases": [{
"id": "615af8d9-f31d-4cdf-8807-b191dc969a07",
"group_id": "f0585333-5722-4878-b7fa-31ae00b6ae3a",
"group_name": "api_group_003",
"group_remark": "分组003",
"group_domains": null,
"quota_used": 0,
"quota_left": 2000000000,
"order_time": "2017-12-29T06:22:46Z",
"start_time": "2018-01-01T00:00:00Z",
"expire_time": "2019-01-01T00:00:00Z",
"app_key": "0e24****4785",
"app_secret": "******"
},
{
"id": "9d0b****e4d13",
"group_id": "02a8****71ae7",
"group_name": "api_group_002",
"group_remark": "分组002",
"group_domains": null,
"quota_used": 0,
"quota_left": 2000000000,
"order_time": "2017-12-29T06:22:46Z",
"start_time": "2018-01-01T00:00:00Z",
"expire_time": "2019-01-01T00:00:00Z",
"app_key": "0e242****04785",
"app_secret": "******"
},
{
"id": "3f30d****c587",
"group_id": "73c5802****47f09",
"group_name": "api_group_001",
"group_remark": "分组001",
"group_domains": null,
"quota_used": 0,
"quota_left": 2000000000,
"order_time": "2017-12-29T06:16:03Z",
"start_time": "2018-01-01T00:00:00Z",
"expire_time": "2019-01-01T00:00:00Z",
"app_key": "0e242****4785",
"app_secret": "******"
}]
}
状态码
|
状态码 |
说明 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
500 |
Server Internal Error |