跳到主要内容

删除素材

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

删除素材,支持单个或批量。

请求参数​

Action 与 Version 通过查询参数传递,其余参数放在 JSON 请求体中。单个删除传 Id,批量删除传 Ids。

Idstring可选

单个素材 ID,与 Ids 二选一。

默认值:-
Idsarray<string>可选

素材 ID 列表,单次最多 100 条;与 Id 同时传时以 Ids 为准。

默认值:-

单个删除:

{ "Id": "asset-20261026170847-7dnj6" }

批量删除:

{ "Ids": ["asset-20261026170847-7dnj6", "asset-20261022101200-bh62n"] }
  • Ids 单次最多 100 条;Id 与 Ids 同时传时以 Ids 为准。
  • 成功返回 {}。
删除是幂等的

删除已删除或不存在的素材 ID 返回成功,重试同一批 ID 是安全的。

部分失败的语义

批量删除中只要有素材删除失败,整批返回 400 InvalidRequest,不返回失败明细。由于删除幂等,整批重试即可。

整批被限流时返回 429,此时素材未被删除,退避后重试,不要当作素材不存在。

认证​

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

默认值:-

响应​

—object可选

成功时返回空对象 {},无其他字段。

默认值:-

错误​

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

相关​