重命名文件--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

重命名文件

最近更新时间：2025.02.20 17:33:34首次发布时间：2023.06.28 19:56:32

本接口支持通过指定源文件的 storekey 来对指定文件进行重命名操作。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

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

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

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

ServiceId

String

是

8h**9q

服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
OriKey	String	是	`bb6d0430d***7feac525023d52`	源文件名，即上传文件的存储 Key。
DstKey	String	是	`image`	重命名后的文件名，存储 Key 详细命名规范请参看 veImageX 存储 Key 通用字符规则。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageFileKey&Version=2018-08-01&ServiceId=hi****3d
{
    "OriKey": "bb6d0430d***7feac525023d52",
    "DstKey": "image"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateImageFileKey",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {}
}

错误码

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