跳到主要内容

查询素材详情

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

按素材 ID 查询素材详情与入库状态。

请求参数​

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

Idstring必填

素材 ID。

默认值:-
字段与列表一致

返回的字段与 ListAssets 中 Items 的元素完全一致,包含 OneTime。

认证​

所有接口使用同一套 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 签名。

默认值:-

响应​

Idstring可选

素材 ID,后续查询、更新、删除都用它。

默认值:-
Namestring可选

素材名称。

默认值:-
URLstring可选

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

默认值:-
AssetTypestring可选

素材类型:Image、Video、Audio。

默认值:-
GroupIdstring可选

所属分组 ID。

默认值:-
Statusstring可选

入库状态:Active、Processing、Failed。

默认值:-
OneTimeboolean可选

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

默认值:-
CreateTimestring可选

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

默认值:-
UpdateTimestring可选

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

默认值:-
ProjectNamestring可选

项目名,当前为 default。

默认值:-
Moderationobject可选

内容审核信息。

默认值:-
LastInferenceTimestring可选

最近一次推理时间。

默认值:-
Errorobject可选

Status 为 Failed 时含 Code 与 Message。

默认值:-

错误​

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

相关​