面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-asset-groups-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

查询素材资产组合列表

POST https://ark.cn-beijing.volcengineapi.com/?Action=ListAssetGroups&Version=2024-01-01

查询符合筛选条件的 Asset Groups(素材资产组合)列表。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

Filter object 必选  |  过滤条件

搜索的过滤条件

GroupType string 必选  |  素材组类型

Filter.GroupType

Asset Group(素材资产组合)的类型。取值:

  • AIGC:虚拟人像;
  • LivenessFace:真人素材
GroupIds string[]  |  素材组 ID 列表

Filter.GroupIds

Asset Group(素材资产组合)的 Id 列表。通过创建素材资产组合接口 (CreateAssetGroup) 返回, 或通过 ListAssetGroups 接口查询获取。

Name string  |  素材组名称

Filter.Name

Asset Group(素材资产组合)的名称,上限为 64 个字符

NextToken string  |  翻页凭证

NextToken 分页的翻页凭证。取值为前一次调用本接口时返回的 NextToken。

MaxResults integer  |  每页记录数

NextToken 分页时每页返回的最大记录数。

取值范围:[1, 100]

SortBy string 默认值 CreateTime  |  排序字段

用于排序的字段名称。取值:

  • CreateTime:根据创建时间排序;
  • UpdateTime:根据更新时间排序。
SortOrder string 默认值 Desc  |  排序顺序

排序顺序。取值:

  • Desc:降序;
  • Asc:升序。
ProjectName string 默认值 default  |  所属项目

资源所属的项目名称。若资源不在默认项目中,需填写正确的项目名称。

PageNumber integer  |  页码(当 PageSize * PageNumber > 10000 时,请使用 NextToken 深翻页)

页码分页的页码,从 1 开始。

PageSize integer  |  每页记录数(当 PageSize * PageNumber > 10000 时,请使用 NextToken 深翻页)

页码分页时每页返回的记录数。

取值范围:[1, 100]

响应参数#

Items object[]  |  素材组列表

符合筛选条件的 Asset Group(素材资产组合)数组。没有符合条件的素材组时返回空数组。

CreateTime string  |  创建时间

Items.CreateTime

Description string  |  素材组描述

Items.Description

Asset Group(素材资产组合)的描述,上限为 300 字符

GroupType string  |  素材组类型

Items.GroupType

Asset Group(素材资产组合)的类型。取值:

  • AIGC:虚拟人像;
  • LivenessFace:真人素材
Id string  |  素材组 ID

Items.Id

Asset Group(素材资产组合)的 Id

Name string  |  素材组名称

Items.Name

Asset Group(素材资产组合)的名称,上限为 64 个字符

ProjectName string  |  所属项目

Items.ProjectName

资源所属的项目名称

UpdateTime string  |  更新时间

Items.UpdateTime

NextToken string  |  下一页翻页凭证

下一页的翻页凭证。仅在 NextToken 分页且存在下一页时返回。

后续请求应原样传入;未返回该字段表示遍历结束。

PageNumber integer  |  页码

当前页码。仅在页码分页时返回。

PageSize integer  |  每页记录数

每页返回的记录数。仅在页码分页时返回。

取值范围:[1, 100]

TotalCount integer  |  总数

符合筛选条件的 Asset Group(素材资产组合)总数。仅在页码分页时返回。