跳到主要内容

查询素材列表

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

按分组、名称、入库状态与一次性标记查询素材,支持排序与两种分页模式。

请求参数​

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

Filter.GroupTypestring必填

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

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

分组 ID 列表。

默认值:-
Filter.Namestring可选

按素材名称或素材 ID 模糊匹配。

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

入库状态:Active、Processing、Failed;不传时默认只返回 Active。

默认值:-
Filter.OneTimeboolean可选

按一次性/永久筛选;传 true 只返回一次性素材,传 false 只返回永久素材,不传表示不限。

默认值:-
SortBystring可选

排序字段:CreateTime、UpdateTime、GroupId。

默认值:-
SortOrderstring可选

排序方向:Asc、Desc,默认 Desc。

默认值:-
PageNumberinteger可选

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

默认值:-
PageSizeinteger可选

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

默认值:-
MaxResultsinteger可选

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

默认值:-
NextTokenstring可选

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

默认值:-
不传 Statuses 时只返回已入库素材

不传 Filter.Statuses 时只会返回 Active 状态的素材,Processing 与 Failed 的素材不会出现在结果中。需要查看这些素材时必须显式传入对应状态。

预览地址有效期 1 小时

URL 是临时预览地址,有效期 1 小时,不要持久化;需要时重新调用本接口或 GetAsset 获取。

认证​

所有接口使用同一套 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[].URLstring可选

预览地址,有效期 1 小时。

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

素材类型:Image、Video、Audio。

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

所属分组 ID。

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

入库状态:Active、Processing、Failed。

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

是否为一次性素材;true 表示被模型调用完成后自动删除,false 表示永久保留。

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

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

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

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

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

项目名。

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

内容审核信息。

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

最近一次推理时间。

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

Status 为 Failed 时含 Code 与 Message。

默认值:-
TotalCountinteger可选

符合条件的素材总数。

默认值:-
PageNumberinteger可选

当前页码。

默认值:-
PageSizeinteger可选

每页数量。

默认值:-
NextTokenstring可选

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

默认值:-

错误​

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

相关​