复制段(Harmony SDK)
功能说明
初始化分段上传任务后,通过分段上传任务的ID,复制段到指定桶中。
多段上传任务创建后,用户可以通过指定多段上传任务号,为特定的任务上传段。添加段的方式还包括调用段复制接口。允许客户将已上传对象的一部分或全部复制为段。
将源对象object复制为一个段part1,如果在复制操作之前part1已经存在,复制操作执行之后,旧的段数据part1会被新复制的段数据覆盖。复制成功后,只能列举到最新的段part1,旧的段数据将会被删除。因此在使用复制段接口时请确保目标段不存在或者已无价值,避免因复制段导致数据误删除。复制过程中源对象object无任何变化。
接口约束
- 您必须是桶拥有者或拥有复制段的权限,才能复制段。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObject权限,如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 复制段的结果不能仅根据HTTP返回头域中的status_code来判断请求是否成功,头域中status_code返回200时表示服务端已经收到请求,且开始处理复制段请求。复制是否成功会在响应消息的body中,只有body体中有ETag标签才表示成功,否则表示复制失败。
方法定义
copyPart(input: CopyPartInput): Response<CopyPartOutput>
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
input |
必选 |
参数解释: 复制段接口入参,详见CopyPartInput。 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
Bucket |
string |
必选 |
参数解释: 目标桶名。 约束限制:
默认取值: 无 |
Key |
string |
必选 |
参数解释: 对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
PartNumber |
number |
必选 |
参数解释: 段号。 取值范围: [1,10000]的非负整数。 默认取值: 无 |
UploadId |
string |
必选 |
参数解释: 分段上传任务的ID。例如:000001648453845DBB78F2340DD460D8 取值范围: 长度为32的字符串。 默认取值: 无 |
CopySource |
string |
必选 |
参数解释: 用来指定复制对象操作的源桶名以及源对象名。当源对象存在多个版本时,通过versionId参数指定版本源对象。 示例:source_bucket/sourceObject?versionId=G001117FCE89978B0000401205D5DC9A 约束限制: 中文字符与%,需要进行URL编码。 默认取值: 无 |
返回结果
参数类型 |
描述 |
---|---|
说明:
该接口返回是一个Promise类型,需要使用Promise、async/await语法处理。 |
参数解释: 接口返回信息,详见Response。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
CommonMsg |
参数解释: 接口调用完成后的公共信息,包含HTTP状态码,操作失败的错误码等,详见ICommonMsg。 |
|
InterfaceResult |
参数解释: 操作成功后的结果数据,详见CopyPartOutput。 约束限制: 当Status大于300时为空。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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服务端返回的详细错误码。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
RequestId |
string |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
ETag |
string |
参数解释: 对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。ETag只反映变化的内容,而不是其元数据。上传的对象或复制操作创建的对象,都有唯一的ETag。 约束限制: 当对象是服务端加密的对象时,ETag值不是对象的MD5值。 取值范围: 长度为32的字符串。 默认取值: 无 |
LastModified |
string |
参数解释: 目标段的最近一次修改时间(UTC时间)。 约束限制: 日期格式必须为ISO8601的格式。 例如:2018-01-01T00:00:00.000Z,表示最后一次修改时间为2018-01-01T00:00:00.000Z。 默认取值: 无 |
PartNumber |
number |
参数解释: 段号。 取值范围: [1,10000]的非负整数。 默认取值: 无 |
SseKms |
string |
参数解释: 作为请求参数时必选 参数解释: 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围: 可选值:kms,即选择SSE-KMS方式加密对象。 默认取值: 无 |
SseKmsKey |
string |
参数解释: SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围: 有效值支持两种格式:
其中:
默认取值:
|
SseC |
string |
参数解释: 表示服务端加密是SSE-C方式。对象使用SSE-C加密方式。 取值范围: 可选值:AES256,即选择SSE-C方式加密对象。 默认取值: 无 |
SseCKeyMd5 |
string |
参数解释: SSE-C方式下加密使用密钥的MD5值,该值用于验证密钥传输过程中是否出错。 约束限制: 由密钥值经过MD5加密再经过Base64编码后得到,示例:4XvB3tbNTN+tIEVa0/fGaQ==。 默认取值: 无 |
代码示例
本示例用于复制源桶(sourcebucketname)下对象(example/sourceobjectname)的段,到目标桶examplebucket的对象(example/objectname)。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
// 引入依赖包 import ObsClient from '@obs/esdk-obs-harmony'; // 创建ObsClient实例 const obsClient = new ObsClient({ // 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 // 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/usermanual-ca/ca_01_0003.html AccessKeyId: process.env.ACCESS_KEY_ID, SecretAccessKey: process.env.SECRET_ACCESS_KEY, // 【可选】如果使用临时AK/SK和SecurityToken访问OBS,同样建议您尽量避免使用硬编码,以降低信息泄露风险。您可以通过环境变量获取访问密钥AK/SK,也可以使用其他外部引入方式传入 // SecurityToken: process.env.SECURITY_TOKEN, // Server填写Bucket对应的Endpoint, 这里以华北-北京四为例,其他地区请按实际情况填写 Server: "https://obs.cn-north-4.myhuaweicloud.com", }); async function copyPart() { try { const params = { // 指定目标桶名称 Bucket: "examplebucket", // 指定目标对象,此处以 example/objectname 为例 Key: "example/objectname", // 指定复制源桶名和源对象名,此处复制源桶名以sourcebucketname为例,源对象名以example/sourceobjectname为例 CopySource: "sourcebucketname/example/sourceobjectname", // 指定上传段的段号,此处以1为例 PartNumber: 1, // 指定多段上传任务号,此处以 00000188677110424014075CC4A77xxx 为例 UploadId: "00000188677110424014075CC4A77xxx", }; // 复制段 const result = await obsClient.copyPart(params); if (result.CommonMsg.Status <= 300) { console.log("Copy part(bucket:%s, object: %s) successful from bucket/object: %s!", params.Bucket, params.Key, params.CopySource); console.log("RequestId: %s", result.CommonMsg.RequestId); return; } console.log("An ObsError was found, which means your request sent to OBS was rejected with an error response."); console.log("Status: %d", result.CommonMsg.Status); console.log("Code: %s", result.CommonMsg.Code); console.log("Message: %s", result.CommonMsg.Message); console.log("RequestId: %s", result.CommonMsg.RequestId); } catch (error) { console.log("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network."); console.log(error); } } copyPart(); |