删除服务下多个文件

最近更新时间：2023.05.19 15:49:35

首次发布时间：2021.02.23 10:42:24

通过指定服务 ID 以及上传文件的 Uri 列表，来删除指定的文件。

请求说明

接口名称：DeleteImageUploadFiles
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=DeleteImageUploadFiles&Version=2018-08-01
请求频率限制：1000 次/秒
超时时间：20 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选描述

Action String 是接口名称。

Version String 是接口版本。veImageX 当前 API 的版本为 2018-08-01。

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
ServiceId	String	是	服务 ID。您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

服务 ID。

您可以在veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数	类型	是否必选	描述
StoreUris	Array of String	是	文件 Uri 列表，最多传 1000 个。说明您可以通过调用获取服务下的上传文件来获取所需的文件 Uri。

返回参数

参数	类型	描述
ServiceId	String	服务 ID。
DeletedFiles	Array of String	成功删除的文件 Uri 列表。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageUploadFiles&Version=2018-08-01&ServiceId=fc51f8f9*
{
        "StoreUris": [
            "xxx",
            "yyy"
        ]
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DeleteImageUploadFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "DeletedFiles": [
            "xxx",
            "yyy"
        ],
        "ServiceId": "fc51f8f9cf"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DeleteImageUploadFiles",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "Code": "DeleteUploadFilesFailure",
            "Message": "Service not found."
        }
    }
}

错误码

访问公共错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：