文档首页/API网关 APIG/API参考/共享版API（仅存量用户使用）/API分组管理/查询分组列表
更新时间：2023-01-05 GMT+08:00
查看PDF
分享

查询分组列表

功能介绍

查询API分组列表。

如果是租户操作，则查询该租户下所有的分组；如果是管理租户操作，则查询的是所有租户的分组。

URI

HTTP/HTTPS请求方法以及URI如下表所示。

表1 HTTP/HTTPS请求方法以及URI

请求方法

URI

GET

/v1.0/apigw/api-groups[?page_size, page_no, id, name]

  • 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。
  • 查询条件可为以下字段以及对应的值：id、name、page_size、page_no。

URI中的参数说明如下表所示。

表2 参数说明

名称

是否必选

类型

说明

id

否

String

编号

name

否

String

名称

page_size

否

Integer

每页显示的条数，默认值：20

最大值：500

page_no

否

Integer

页码，默认值：1

precise_search

否

String

指定需要精确匹配查找的参数名称，目前仅支持name

请求消息

无

响应消息

表3 参数说明

名称

类型

说明

total

Integer

满足条件的分组总数

size

Integer

本次返回的列表长度

groups

字典数据类型

分组列表

表4 字典数据类型：分组字段说明

名称

类型

说明

id

String

编号

name

String

名称

status

Integer

状态

sl_domain

String

系统默认分配的子域名

sl_domains

Array of strings

系统默认分配的子域名列表

register_time

Timestamp

创建时间

update_time

Timestamp

最近修改时间

remark

String

描述

on_sell_status

Integer

是否已上架云商店：

  • 1：已上架
  • 2：未上架
  • 3：审核中

call_limits

Integer

流控时长内分组下的API的总访问次数限制，默认不限，请根据服务的负载能力自行设置

time_interval

Integer

流控时长

time_unit

String

流控的时间单位

url_domains

Array of UrlDomainsResp objects

分组上绑定的独立域名列表

表5 UrlDomainsResp

名称

类型

说明

id

String

域名编号

domain

String

访问域名

cname_status

Integer

域名cname状态：

  • 1：未解析
  • 2：解析中
  • 3：解析成功
  • 4：解析失败

ssl_id

String

SSL证书编号

ssl_name

String

SSL证书名称

响应消息样例：

{
	"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",
                "sl_domains": ["19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.com","19e62eca-43d9-4ce2-a478-b3f48e67fb91.apigw.example.cn"],
		"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",
                "sl_domains": ["c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.com","c4c230d1-a8f2-4816-b9df-09ac5989180c.apigw.example.cn"],
		"remark": "分组001",
		"register_time": "2017-12-28T11:57:27Z",
		"update_time": "2017-12-28T11:57:27Z",
		"on_sell_status": 2
	}]
}

状态码

表6 返回消息说明

状态码

说明

200

OK

400

Bad Request

401

Unauthorized

500

Server Internal Error

父主题：API分组管理