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

文档中心

立即注册

导航

veImageX

重命名文件

最近更新时间：2024.03.15 15:47:00首次发布时间：2023.06.28 19:56:32

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

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：超时时间为 30 秒。

请求说明

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

说明

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

请求参数

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

Query

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

Action String 是 UpdateImageFileKey 接口名称。UpdateImageFileKey

Version String 是 2018-08-01 接口版本

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

ServiceId

String

是

hi****3d

服务 ID。

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

Body

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

OriKey String 是 bb6d0430d***7feac525023d52 源文件名，即上传文件的 storekey。

参数	类型	是否必选	示例值	描述
OriKey	String	是	`bb6d0430d***7feac525023d52`	源文件名，即上传文件的 storekey。
DstKey	String	是	`image`	重命名后的文件名。输入限制如下所示：不支持空格，如果中间有空格将会导致重命名失败。不支持以/开头或结尾，不支持/连续出现，Key 值最大长度限制为 180 个字节。

DstKey

String

是

image

重命名后的文件名。输入限制如下所示：

不支持空格，如果中间有空格将会导致重命名失败。
不支持以/开头或结尾，不支持/连续出现，Key 值最大长度限制为 180 个字节。

返回参数

无。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateImageFileKey",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
  }
}

错误码

访问公共错误码以及通用错误码获取详细信息。

服务端 SDK

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