删除服务下多个文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

删除服务下多个文件

最近更新时间：2024.11.15 13:33:59首次发布时间：2021.02.23 10:42:24

通过指定服务 ID 以及文件 URI 列表来删除指定的文件，并返回成功删除的文件 URI 以及文件不存在的无效 URI。

注意事项

请求频率：单用户请求频率限制为 10 次/秒
超时时间：超时时间约为 20 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=DeleteImageUploadFiles&Version=2018-08-01

请求参数

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

Query

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

Action String 是 DeleteImageUploadFiles 接口名称。当前 API 的名称为 DeleteImageUploadFiles。

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

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

ServiceId

String

是

ui**jh

待删除文件所在的服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
StoreUris	Array of String	是	`["tos-cn-i-36m*6tf/demo.png"]`	待删除文件的存储 URI 列表，最多传 1000 个。您可以通过调用获取服务下的上传文件来获取所需的文件 URI。
StoreVersions	Array of String	否	`["56DE530B6D7AAD3DA1F0"]`	待删除文件的存储版本 ID。传值时需要和 `StoreUris` 一一对应。您可在 veImageX 控制台资源管理查看文件版本号，或调用 GetImageStorageVersionFiles 查询服务下所有文件的版本信息。注意当删除文件未指定 StoreVersions，那么删除逻辑将根据版本控制的状态产生以下差异。若此时版本控制为未开启，则 StoreUris 对应文件将被永久删除，不可恢复。若此时版本控制为开启，则 StoreUris 对应文件未被真正删除，该文件可以被恢复，同时将增加一个删除标记用于标识该文件为删除状态。若此时版本控制为暂停，则根据版本 ID 是否为 null 而有以下差异：若文件的版本 ID 为 null，则 StoreUris 对应文件被真正删除，不可恢复，同时将增加一个删除标记用于标识该文件为删除状态。若文件的版本 ID 不为 null，则 StoreUris 对应文件未被真正删除，而是转换为历史版本保留。该文件可以被恢复，同时将增加一个删除标记。

返回参数

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

参数	类型	示例值	描述
DeletedFiles	Array of String	`["tos-cn-i-36m*6tf/demo.png"]`	文件成功删除的 URI 列表
InvaildFiles	Array of String	`["uri2"]`	文件不存在的无效 URI 列表
DeletedFilesVersion	Array of String	`["56DE530B6D7AAD3DA1F0"]`	已删除文件的版本列表。
InvaildFilesVersion	Array of String	`["56DE530B6D7AAD3DA1F0"]`	无效文件版本列表。

请求示例

POST https://imagex.volcengineapi.com/?Action=DeleteImageUploadFiles&Version=2018-08-01&ServiceId=ui**jh
{
    "StoreUris": [
        "tos-cn-i-36m*6tf/demo.png"
    ],
    "StoreVersions": [
        "56DE530B6D7AAD3DA1F0"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DeleteImageUploadFiles",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "DeletedFiles": [
            "tos-cn-i-36m*6tf/demo.png"
        ],
        "InvaildFiles": [
            ""
        ],
        "DeletedFilesVersion": [
            "56DE530B6D7AAD3DA1F0"
        ],
        "InvaildFilesVersion": [
            ""
        ]
    }
}

错误码

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

服务端 SDK

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