分段复制
功能说明
分段复制是分段上传的一种特殊情况,即分段上传任务中的段可以通过复制OBS指定桶中现有对象(或对象的一部分)来实现。
您可以通过ObsClient.copyPart来复制段。
开发过程中,您有任何问题可以在github上提交issue,或者在华为云对象存储服务论坛中发帖求助。接口参考文档详细介绍了每个接口的参数和使用方法。
接口约束
- 您必须是桶拥有者或拥有复制对象的权限,才能复制对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObject权限,如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- 用户有待复制的源对象的读权限。
- OBS支持的region以及region与endPoint的对应关系,详细信息请参见地区与终端节点。
- 复制对象操作的请求需要通过头域携带拷贝的源桶和对象信息,不能携带消息实体。
- 支持同区域跨桶复制,不支持跨区域复制。
- 如果待复制的源对象是归档或深度归档存储类别,则必须先恢复源对象才能进行复制。
方法定义
ObsClient.copyPart(params)
请求参数说明
| 参数名称 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| Bucket | String | 必选 | 参数解释: 桶名。 约束限制:
默认取值: 无 |
| Key | String | 必选 | 参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 说明: 对象链接地址格式为:https://桶名.域名/文件夹目录层级/对象名。如果该对象存在于桶的根目录下,则链接地址将不需要有文件夹目录层级。 |
| RequestDate | String 或 Date | 可选 | 参数解释: 指定请求时间。 说明: 当为String类型时,必须符合ISO8601或RFC822规范。 |
| PartNumber | Number | 必选 | 参数解释: 段号。 取值范围: [1,10000] 默认取值: 无 |
| UploadId | String | 必选 | 参数解释: 分段上传任务的ID。任务ID可以通过初始化分段上传任务生成。例如:000001648453845DBB78F2340DD460D8。 约束限制: 长度为32的字符串。 默认取值: 无 |
| CopySource | String | 必选 | 参数解释: 指定源桶、源对象和源对象版本号(可为空)的参数。 约束限制: 格式:源桶名/源对象名?versionId=源对象版本号。 默认取值: 无 |
| CopySourceRange | String | 可选 | 参数解释: 指定复制源对象的范围。 取值范围: [0,源对象长度-1] 约束限制:
默认取值: 完整对象 |
| SseC | String | 可选 | 参数解释: 使用SSE-C时使用的算法。 取值范围: AES256:表示使用SSE-C加密方式且使用AES256算法 默认取值: 无。 |
| SseCKey | String | 可选 | 参数解释: SSE-C方式下加密的密钥,该密钥需要您自定义,并由256bit的密钥经过base64编码得到。 默认取值: 无 |
| CopySourceSseC | String | 可选 | 参数解释: 以SSE-C方式解密源对象。 取值范围: AES256:表示使用SSE-C加密方式且使用AES256算法 默认取值: 无。 |
| CopySourceSseCKey | String | 可选 | 参数解释: SSE-C方式下解密源对象的密钥。 默认取值: 无 |
返回结果说明
| 参数名称 | 参数类型 | 描述 |
| Status | number | 参数解释: OBS服务端返回的HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 |
| Code | string | 参数解释: OBS服务端返回的错误码。 |
| Message | string | 参数解释: OBS服务端返回的错误描述。 |
| HostId | string | 参数解释: OBS服务端返回的请求服务端ID。 |
| RequestId | string | 参数解释: OBS服务端返回的请求ID。 |
| Id2 | string | 参数解释: OBS服务端返回的请求ID2。 |
| Indicator | string | 参数解释: OBS服务端返回的详细错误码。 |
| 参数名称 | 参数类型 | 描述 |
|---|---|---|
| ETag | String | 参数解释: 段的base64编码的128位MD5摘要。ETag是段内容的唯一标识,可以通过该值识别段内容是否有变化。 取值范围: 长度为32的字符串。 默认取值: 无 |
| LastModified | String | 参数解释: 目标段的最近一次修改时间。 默认取值: 无 |
示例代码
本示例用于复制段,将sourcebucketname源桶下的sourceobjectname对象的一部分复制为destbucketname目标桶下的destobjectname对象的一个段中。
// 创建ObsClient实例
var obsClient = new ObsClient({
// 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;本示例以ak和sk保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量AccessKeyID和SecretAccessKey。
// 前端本身没有process对象,可以使用webpack类打包工具定义环境变量,就可以在代码中运行了。
// 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html
access_key_id: process.env.AccessKeyID,
secret_access_key: process.env.SecretAccessKey,
// 这里以华北-北京四为例,其他地区请按实际情况填写
server: 'https://obs.cn-north-4.myhuaweicloud.com'
});
var destBucketName = 'destbucketname';
var destObjectKey = 'destobjectname';
var sourceBucketName = 'sourcebucketname';
var sourceObjectKey = 'sourceobjectname';
obsClient.CopyPart({
Bucket : destBucketName,
Key : destObjectKey,
// 设置分段号,范围是1~10000
PartNumber : 1,
// 设置Upload ID
UploadId : 'upload id from initiateMultipartUpload',
// 设置待复制的源对象
CopySource : sourceBucketName + '/' + sourceObjectKey,
// 设置待复制的源对象的字节范围
CopySourceRange : 'bytes=0-100'
}, function(err, result) {
if (err) {
console.log('Error-->' + err);
} else {
console.log('Status-->' + result.CommonMsg.Status);
if (result.CommonMsg.Status < 300 && result.InterfaceResult) {
console.log('RequestId-->' + result.InterfaceResult.RequestId);
console.log('LastModified-->' + result.InterfaceResult.LastModified);
console.log('ETag-->' + result.InterfaceResult.ETag);
}
}
});
- 复制段时,使用PartNumber参数指定分段号;使用UploadId参数指定分段上传任务的全局唯一标识;使用CopySource参数指定复制时的源对象信息;使用CopySourceRange参数指定待复制的源对象的字节范围。