Skip to content

查询素材列表

POST https://art-api.yuyuflow.com/?Action=ListAssets&Version=2024-01-01

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

鉴权

本接口仅支持 Access Key(AK/SK)鉴权,请在 https://art-api.yuyuflow.com/dashboard/overview 获取 API 访问密钥(AK/SK)。

请求参数

请求体


Filter object

搜索的过滤条件。


Filter.GroupIds string[]

Asset(素材资产)所属的 Asset Group(素材资产组合)的 Id 列表。


Filter.GroupType string

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

  • AIGC:虚拟人像
  • LivenessFace:真人素材

Filter.Statuses string[]

素材资产状态。可选值:

  • Active:素材资产已处理完毕,可以使用
  • Processing:素材资产正在预处理,无法使用
  • Failed:素材资产处理失败

Filter.Name string

Asset(素材资产)的名称,上限为 64 字符。


PageNumber integer (i64)

搜索页码,从 1 开始。例如:1 表示返回第一页的搜索结果。


PageSize integer (i64)

每页搜索结果的数量,上限为 100。


SortBy string

用于排序的字段名称,默认值为 CreateTime。可选值:

  • CreateTime:根据创建时间排序
  • UpdateTime:根据更新时间排序
  • GroupId:根据资产素材组的 Id 排序

SortOrder string

排序顺序,默认值为 Desc。可选值:

  • Desc:降序
  • Asc:升序

ProjectName string

资源所属的项目名称,默认值为 default

若资源不在默认项目中,需填写正确的项目名称,详情请参见 项目隔离说明

响应参数


Items object[]

符合筛选条件的 Asset(素材资产)数组。


Items.Id string

Asset(素材资产)的 Id。


Items.Name string

Asset(素材资产)的名称,上限为 64 字符。


Items.URL string

Asset(素材资产)的公共可访问地址。有效期为 12 小时,请及时保存。


Items.GroupId string

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


Items.AssetType string

Asset(素材资产)的类型。可选值:

  • Image:图像
  • Video:视频
  • Audio:音频

Items.Status string

任务状态。可选值:

  • Active
  • Processing
  • Failed

Items.Moderation object

内容审核相关信息。


Items.Moderation.Strategy string

该素材的内容审核策略,该字段返回固定值 Default


Items.Error object

错误信息。


Items.Error.Code string

错误码。


Items.Error.Message string

错误信息。


Items.ProjectName string

资源所属的项目名称。


Items.CreateTime string

创建时间。


Items.UpdateTime string

更新时间。


TotalCount integer (i64)

返回总数。


PageNumber integer (i64)

返回的页数。


PageSize integer (i64)

每页搜索结果的数量,上限为 100。

请求示例

text
POST /?Action=ListAssets&Version=2024-01-01 HTTP/1.1
Host: art-api.yuyuflow.com
Content-Type: application/json
X-Date: 20260328T000000Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AKLTYz******/20260328/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=47a7d934******e41085f

{
  "Filter": {
    "GroupIds": [
      "group-2026**********-*****"
    ],
    "GroupType": "AIGC",
    "Statuses": [
      "Active"
    ],
    "Name": "test"
  },
  "PageNumber": 1,
  "PageSize": 10,
  "SortBy": "CreateTime",
  "SortOrder": "Desc",
  "ProjectName": "default"
}

响应示例

json
{
  "ResponseMetadata": {
    "RequestId": "20260328000000000000000000000000",
    "Action": "ListAssets",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Items": [
      {
        "Id": "Asset-2026**********-*****",
        "Name": "test",
        "URL": "https://example.com/asset-url",
        "GroupId": "group-2026**********-*****",
        "AssetType": "Image",
        "Status": "Active",
        "Moderation": {
          "Strategy": "Default"
        },
        "Error": {
          "Code": "",
          "Message": ""
        },
        "ProjectName": "default",
        "CreateTime": "2026-03-28T00:00:00Z",
        "UpdateTime": "2026-03-28T00:00:00Z"
      }
    ],
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10
  }
}