帮你快速理解、总结文档立即下载

创建群组

最近更新时间:2026-10-27 17:33:38
本文档已由 AI 辅助审校
我的收藏

功能描述

用于在指定媒体库下创建群组。

接口说明

群组层级深度限制为 10 层,超过则返回错误。
若指定 parentGroupId,系统将把该群组创建为指定父群组的子群组。

请求

请求示例

POST /api/v1/group/{LibraryId}?access_token={AccessToken}

请求参数

请求参数
描述
类型
是否必选
LibraryId
媒体库 ID
String
是
AccessToken
访问令牌
String
是

请求体

application/json
请求体示例:
{
"groupName": "研发部",
"description": "研发团队",
"parentGroupId": "0f1e2d3c4b5a69780f1e2d3c4b5a6978"
}
请求体字段说明:
请求参数
描述
类型
是否必选
groupName
字符串,群组名称,最长 128 字符,必选参数;
String
是
description
字符串,描述,可选参数;
String
否
parentGroupId
字符串,父群组 ID;不传则该群组为根群组,可选参数;
String
否

响应

响应码

创建成功,返回 HTTP 201 Created

响应体

application/json
响应体示例:
{
"libraryId": "lib_xxx",
"groupId": "a1b2c3d4e5f67890a1b2c3d4e5f67890",
"groupName": "研发部",
"description": "研发团队",
"parentGroupId": "0f1e2d3c4b5a69780f1e2d3c4b5a6978",
"creator": "admin_001",
"creationTime": "2024-01-01T10:00:00.000Z",
"modifyTime": "2024-01-01T10:00:00.000Z"
}
说明:
根群组响应中 parentGroupId 字段为空串 ""。
响应体字段说明:
节点名称(关键字)
描述
类型
libraryId
字符串,媒体库 ID;
String
groupId
字符串,群组唯一标识;
String
groupName
字符串,群组名称;
String
description
字符串,描述;
String
parentGroupId
字符串,父群组 ID;根群组为空串 "";
String
creator
字符串,创建者用户 ID;
String
creationTime
字符串,创建时间,ISO 8601 格式,例如 2024-01-01T10:00:00.000Z;
String
modifyTime
字符串,最后修改时间,ISO 8601 格式;
String

错误码

错误码
HTTP 状态码
说明
InvalidParameter
400
群组层级深度超过 10 层
GroupNotFound
404
父群组不存在