复制资源--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

复制资源

最近更新时间：2024.08.20 10:13:46首次发布时间：2024.08.20 10:13:46

本接口支持将源服务OriServiceId内的存储资源，复制到目标服务ServiceId。

注意

源服务与目标服务需所属同一个火山引擎账号，所属地域需保持一致。
归档与冷归档文件需恢复资源后，才能复制。

注意事项

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

请求说明

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

请求参数

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

Query

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

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

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

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

ServiceId

String

是

serviceid1

复制目标对应的服务 ID。

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

Body

参数	类型	是否必选	示例值	描述
OriServiceId	String	否	`serviceid222`	待复制资源对应的服务 ID
StoreUri	String	是	`tos-serviceid222/demo1.png`	待复制资源对应的存储 URI。您可在控制台的资源管理页面，获取上传文件的存储 URI；或者调用 GetImageStorageFiles 获取指定服务下的存储 URI。
DstKey	String	否	`a/test`	复制后资源的存储 Key。缺省情况下与源存储的资源存储 Key 相同。自定义规则如下所示：不支持空格。不支持以`/`开头或结尾，不支持`/`连续出现，Key 值最大长度限制为 180 个字节。
SkipDuplicate	Boolean	否	`true`	是否保留目标存储中的同名文件，取值如下所示： `false`：不保留目标存储中的同名文件，直接覆盖。 `true`：保留目标存储中的同名文件，不覆盖。

返回参数

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

参数	类型	示例值	描述
StoreUri	String	`tos-serviceid222/demo1.png`	待复制资源的源存储 URI
DstUri	String	`tos-serviceid111/a/test`	资源复制到目标服务后的存储 URI

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageFromUri&Version=2023-05-01&ServiceId=serviceid1
{
    "OriServiceId": "serviceid222",
    "StoreUri": "tos-serviceid222/demo1.png",
    "DstKey": "a/test",
    "SkipDuplicate": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageFromUri",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "StoreUri": "tos-serviceid222/demo1.png",
        "DstUri": "tos-serviceid111/a/test"
    }
}

错误码

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

服务端 SDK

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

历史版本

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