跳到主要内容

查询分组列表

POST/xmind-cloud-platform/openapi/volcengine?Action=ListAssetGroups&Version=2024-01-01

按分组类型、分组 ID 与名称分页查询素材分组。

请求参数​

Action 与 Version 通过查询参数传递,其余参数放在 JSON 请求体中。

Filter.GroupTypestring必填

分组类型,当前只支持 AIGC。

默认值:-
Filter.GroupIdsarray<string>可选

分组 ID 列表,元素为平台分组 ID 字符串。

默认值:-
Filter.Namestring可选

按分组名称模糊匹配。

默认值:-
PageNumberinteger可选

页码,大于 0;不传时默认第 1 页。

默认值:-
PageSizeinteger可选

每页数量,取 1-100;不传时默认 20。PageSize * PageNumber 不能超过 10000。

默认值:-
MaxResultsinteger可选

游标分页模式,取 1-100;与 PageNumber 不能混用。

默认值:-
NextTokenstring可选

游标分页的翻页令牌,首次请求不传。

默认值:-
分页模式不能混用

PageNumber、PageSize 属于页码分页,MaxResults、NextToken 属于游标分页。同一次请求只能选择一种;超过页码窗口时需要改用 NextToken 做深翻页。

认证​

所有接口使用同一套 V4 签名,凭证与签名方式见火山方舟素材库 API 概览。以下请求头为通用要求:

Content-Typestring必填

固定为 application/json。

默认值:application/json
Hoststring必填

实际访问的域名和端口;包含端口时必须写入签名。

默认值:-
X-Datestring必填

UTC 时间,格式 yyyyMMdd'T'HHmmss'Z',例如 20261022T131900Z;与平台时间偏差不能超过 300 秒。

默认值:-
X-Content-Sha256string必填

原始请求体的 SHA-256 小写十六进制。

默认值:-
Authorizationstring必填

V4 HMAC-SHA256 签名。

默认值:-

响应​

Itemsarray<object>可选

分组列表。

默认值:-
Items[].Idstring可选

分组 ID。

默认值:-
Items[].Namestring可选

分组名称。

默认值:-
Items[].Descriptionstring可选

分组描述。

默认值:-
Items[].GroupTypestring可选

分组类型,固定为 AIGC。

默认值:-
Items[].CreateTimestring可选

创建时间,UTC 时间字符串。

默认值:-
Items[].UpdateTimestring可选

更新时间,UTC 时间字符串。

默认值:-
TotalCountinteger可选

符合条件的分组总数。

默认值:-
PageNumberinteger可选

当前页码。

默认值:-
PageSizeinteger可选

每页数量。

默认值:-
NextTokenstring可选

游标分页时有下一页才会返回。

默认值:-

错误​

Code说明
400InvalidParameter:参数格式或取值非法
401SignatureDoesNotMatch、InvalidTimestamp、XContentSha256Mismatch、MissingParameter.Authorization 等签名或时间相关错误
403AccessDenied 凭证被禁用或无权限;ExpiredToken 凭证已过期
429QuotaWriteQPMExceeded 每分钟写入额度用尽;AccountFlowLimitExceeded 每秒请求上限触发;TooManyRequests 请求过于频繁

相关​