删除常用图片/背景/蒙版要素--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

删除常用图片/背景/蒙版要素

最近更新时间：2024.09.03 16:47:46首次发布时间：2024.04.19 11:39:02

在样式的要素列表删除常用的图片、背景或蒙版等要素记录，如果删除失败将返回失败的要素 URI。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=DeleteImageElements&Version=2023-05-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DeleteImageElements`	接口名称。当前 API 的名称为 `DeleteImageElements`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Type	String	是	`background`	要素类型，取值如下所示： `image`：图片要素； `background`：背景要素； `mask`：蒙版要素。
ImageList	Array of String	是	`["tos-cn-i-nnsl1jf0m/mofang/16e5f3*be5bcbece.png"]`	待删除的要素存储 URI 列表，您可调用 GetImageElements 获取全部常用要素的存储 URI。

Type

String

是

background

要素类型，取值如下所示：

image：图片要素；
background：背景要素；
mask：蒙版要素。

ImageList Array of String 是 ["tos-cn-i-nnsl1jf0m*/mofang/16e5f3**be5bcbece.png"] 待删除的要素存储 URI 列表，您可调用 GetImageElements 获取全部常用要素的存储 URI。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
FailedList	Array of String	`["tos-cn-i-nnsl1jf0m/mofang/16e5f3*be5bcbece.png"]`	删除失败的要素 URI 列表。若全部删除失败，则接口将返回失败。

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageElements&Version=2023-05-01
{
  "Type": "background",
  "ImageList": [
    "tos-cn-i-nn***0m/mofang/20220629-111*.jpeg"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DeleteImageElements",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedList": [
            "tos-cn-i-nnsl1jf0m*/mofang/16e5f3**be5bcbece.png"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

历史版本

2018-08-01 版本 DeleteImageElements 接口文档现已停止维护，建议您参考本文档使用最新版本。