素材 Action
查询素材列表
火山文档原文ListAssets - 按素材组、类型、状态或名称分页查询素材
AuthorizationBearer <token>
兼容网关 API Key,例如 sk-...。
In: header
Query Parameters
Action*string
Default
"ListAssets"Version*string
Default
"2024-01-01"Header Parameters
X-Date?string
使用 HMAC-SHA256 时必填,格式为 YYYYMMDDTHHMMSSZ。
X-Content-Sha256?string
使用 HMAC-SHA256 时必填,请求体 SHA-256 小写十六进制。
Request Body
application/json
Filter?
PageNumber?integer
Default
1Range
1 <= valuePageSize?integer
Default
20Range
1 <= value <= 100SortBy?string
Default
"CreateTime"Value in
"CreateTime" | "UpdateTime" | "GroupId"SortOrder?string
Default
"Desc"Value in
"Desc" | "Asc"ProjectName?string
资源所属项目名称,大小写敏感。省略时使用 default。
Default
"default"Response Body
application/json
application/json
curl -X POST "https://jieyun.cc/?Action=ListAssets&Version=2024-01-01" \ -H "Content-Type: application/json" \ -d '{ "Filter": { "GroupIds": [ "group-202607210001-example" ], "Statuses": [ "Active" ] }, "PageNumber": 1, "PageSize": 20, "SortBy": "CreateTime", "SortOrder": "Desc", "ProjectName": "default" }'{
"ResponseMetadata": {
"RequestId": "20260721000000000000000000000000",
"Action": "ListAssets",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing"
},
"Result": {
"Items": [
{
"Id": "asset-202607210001-example",
"Name": "产品主图",
"URL": "https://example.com/temporary/product.png",
"GroupId": "group-202607210001-example",
"AssetType": "Image",
"Status": "Active",
"Moderation": {
"Strategy": "Default"
},
"Error": {
"Code": "",
"Message": ""
},
"ProjectName": "default",
"CreateTime": "2026-07-21T00:00:00Z",
"UpdateTime": "2026-07-21T00:00:00Z"
}
],
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 20
}
}{
"ResponseMetadata": {
"RequestId": "string",
"Action": "ListAssets",
"Version": "2024-01-01",
"Service": "ark",
"Region": "cn-beijing",
"Error": {
"Code": "string",
"Message": "string"
}
}
}Empty
Empty
Empty
Empty
接口说明
按素材组、类型、处理状态或名称分页查询素材。本文档已按火山引擎官方接口说明校对。
POST https://jieyun.cc/?Action=ListAssets&Version=2024-01-01
Content-Type: application/json
Authorization: Bearer <API_KEY>也可使用 AK/SK HMAC-SHA256 签名,详见素材库认证与签名。
请求参数
| 字段 | 类型 | 必选 | 说明 |
|---|---|---|---|
Filter | object | 否 | 搜索过滤条件。 |
Filter.GroupIds | string[] | 否 | 素材所属的素材组 ID 列表。 |
Filter.GroupType | string | 否 | AIGC 或 LivenessFace。 |
Filter.Statuses | string[] | 否 | Active、Processing 或 Failed。 |
Filter.Name | string | 否 | 按素材名称搜索,最长 64 个字符。 |
PageNumber | integer | 否 | 页码,从 1 开始,默认 1。 |
PageSize | integer | 否 | 每页数量,最大 100。 |
SortBy | string | 否 | 默认 CreateTime;还可按 UpdateTime 或 GroupId 排序。 |
SortOrder | string | 否 | 默认 Desc;可选 Desc 或 Asc。 |
ProjectName | string | 否 | 资源所属项目,默认 default,大小写敏感。 |
{
"Filter": {
"GroupIds": ["group-2026-example"],
"Statuses": ["Active"]
},
"PageNumber": 1,
"PageSize": 20,
"SortBy": "CreateTime",
"SortOrder": "Desc",
"ProjectName": "default"
}响应内容
| 字段 | 类型 | 说明 |
|---|---|---|
Items | object[] | 符合筛选条件的素材列表。 |
Items.Id | string | 素材 ID。 |
Items.Name | string | 素材名称。 |
Items.URL | string | 素材临时访问地址,有效期为 12 小时。 |
Items.GroupId | string | 所属素材组 ID。 |
Items.AssetType | string | Image、Video 或 Audio。 |
Items.Status | string | Active、Processing 或 Failed。 |
Items.Moderation.Strategy | string | 内容审核策略,当前固定为 Default。 |
Items.Error.Code | string | 处理失败错误码。 |
Items.Error.Message | string | 处理失败错误信息。 |
TotalCount | integer | 符合筛选条件的素材总数。 |
PageNumber | integer | 当前页码。 |
PageSize | integer | 当前每页数量。 |
临时 URL
响应中的素材 URL 有效期为 12 小时。需要长期使用时,请及时下载或转存,不要把该地址作为永久素材地址保存。