版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

网站分组

把站点归类管理;同一租户内分组名唯一,分组里还有站点时不能删除。

site-groups网站鉴权: 用户(部分参数仅管理员)5 个接口

列出站点分组

GET/api/v2/site-groups
鉴权: 用户(部分参数仅管理员)

查询参数

字段类型必填说明
pageinteger— 页码,从 1 开始。
默认 1
page_sizeinteger— 每页条数。
默认 20
sortstring— 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger— 仅管理员可用:按租户过滤。租户凭据调用时忽略,只返回本租户数据。
idsstring— 只列这些 id:逗号分隔的正整数,去重后至多 200 个(同 page_size 上限,超了 400);空串等同不传。与其他条件取交集;看不到的 id 不返回也不报错。分页照旧,一次取回要把 page_size 设成不少于 id 个数。

创建站点分组

POST/api/v2/site-groups
鉴权: 用户(部分参数仅管理员)

查询参数

字段类型必填说明
tenant_idinteger— 管理员代建时的属主租户(必填);租户调用时忽略,属主恒为本人。

请求体 application/json

字段类型必填说明
desstring— 备注说明
namestring必填 名称

获取站点分组

GET/api/v2/site-groups/{id}
鉴权: 用户(部分参数仅管理员)

修改站点分组

PUT/api/v2/site-groups/{id}
鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型必填说明
desstring— 备注说明
namestring必填 名称

删除站点分组

DELETE/api/v2/site-groups/{id}
鉴权: 用户(部分参数仅管理员)

网站分组对象

字段类型必填说明
created_atstring— 创建时间
只读
desstring— 备注说明
idinteger— 记录 ID
只读
namestring— 名称
tenant_idinteger— 所属租户(用户)ID
只读
updated_atstring— 更新时间
只读