复制对象(Python SDK)
功能说明
用户可以根据需要将存储在OBS上的对象复制到其他路径下。复制对象操作将创建需要复制的对象的副本。在单次操作中,您可以创建最大5GB的对象副本。为指定桶中的对象创建一个副本。
接口约束
- 您必须是桶拥有者或拥有复制对象的权限,才能复制对象。建议使用IAM或桶策略进行授权,如果使用IAM则需授予obs:object:PutObject权限,如果使用桶策略则需授予PutObject权限。相关授权方式介绍可参见OBS权限控制概述,配置方式详见使用IAM自定义策略、配置对象策略。
- OBS支持的Region与Endpoint的对应关系,详细信息请参见地区与终端节点。
- 复制对象操作的请求需要通过头域携带拷贝的源桶和对象信息,不能携带消息实体。
- 目标对象大小范围是[0, 5GB],如果源对象大小超过5GB,只能使用多段相关接口(Python SDK)功能拷贝部分对象。
方法定义
ObsClient.copyObject(sourceBucketName, sourceObjectKey, destBucketName, destObjectKey, metadata, headers, versionId, extensionHeaders)
请求参数
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
sourceBucketName |
str |
必选 |
参数解释: 源桶名。 约束限制:
默认取值: 无 |
sourceObjectKey |
str |
必选 |
参数解释: 源对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
versionId |
str |
可选 |
参数解释: 源对象的版本号。例如:G001117FCE89978B0000401205D5DC9A。 取值范围: 长度为32的字符串。 默认取值: 如果不指定版本号,则默认复制源对象的最新版本。 |
destBucketName |
str |
必选 |
参数解释: 目标桶名。 约束限制:
默认取值: 无 |
destObjectKey |
str |
必选 |
参数解释: 目标对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。 例如,您对象的访问地址为examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。 取值范围: 长度大于0且不超过1024的字符串。 默认取值: 无 |
metadata |
dict |
可选 |
参数解释: 目标对象的自定义元数据。OBS支持用户使用以“x-obs-meta-”开头的消息头来加入自定义的元数据,以便对对象进行自定义管理。当用户获取此对象或查询此对象元数据时,加入的自定义元数据将会在返回的消息头中出现。 约束限制:
默认取值: 无 |
headers |
可选 |
参数解释: 复制对象的附加头域,详见CopyObjectHeader。 默认取值: 无 |
|
extensionHeaders |
dict |
可选 |
参数解释: 接口的拓展头域。 取值范围: 参考自定义头域。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
acl |
str |
可选 |
参数解释: 复制对象时可指定的预定义访问策略。 默认取值: 无 |
directive |
str |
可选 |
参数解释: 目标对象的属性是否从源对象中复制 取值范围:
默认取值: COPY |
if_match |
str |
可选 |
参数解释: 指定一个预设的Etag值,如果下载对象的ETag值与该参数值相同,则返回对象内容,否则返回错误。 取值范围: 长度为32的字符串。 默认取值: 无 |
if_none_match |
str |
可选 |
参数解释: 指定一个预设的Etag值,如果下载对象的ETag值与该参数值不相同,则返回对象内容,否则返回错误。 取值范围: 长度为32的字符串。 默认取值: 无 |
if_modified_since |
str 或 |
可选 |
参数解释: 如果源对象在指定的时间后有修改,则进行复制,否则抛出异常。 约束限制: 日期格式为GMT的格式。 例如:Wed, 25 Mar 2020 02:39:52 GMT。可以使用DateTime生成日期。 代码示例:DateTime(year=2023, month=9, day=12)。 默认取值: 无 |
if_unmodified_since |
str 或 |
可选 |
参数解释: 如果源对象在指定的时间后没有修改,则进行复制,否则抛出异常。 约束限制: 日期格式为GMT的格式。 例如:Wed, 25 Mar 2020 02:39:52 GMT。可以使用DateTime生成日期。 代码示例:DateTime(year=2023, month=9, day=12)。 默认取值: 无 |
location |
str |
可选 |
参数解释: 当桶设置了Website配置,可以将获取这个对象的请求重定向到桶内另一个对象或一个外部的URL。 例如,重定向请求到桶内另一对象: location:/anotherPage.html 或重定向请求到一个外部URL: location:http://www.example.com/ OBS将这个值从头域中取出,保存在对象的元数据“location”中。 约束限制:
默认取值: 无 |
destSseHeader |
或 |
可选 |
参数解释: 服务端加密头域,用于加密目标对象。 取值范围: 默认取值: 无 |
sourceSseHeader |
可选 |
参数解释 服务端解密头域,用于解密源对象。 取值范围: 默认取值: 无 |
|
cacheControl |
str |
可选 |
参数解释: 复制时重写响应中的Cache-Control头。 默认取值: 无 |
contentDisposition |
str |
可选 |
参数解释: 复制时重写响应中的Content-Disposition头。 默认取值: 无 |
contentEncoding |
str |
可选 |
参数解释: 复制时重写响应中的Content-Encoding头。 默认取值: 无 |
contentLanguage |
str |
可选 |
参数解释: 复制时重写响应中的Content-Language头。 默认取值: 无 |
contentType |
str |
可选 |
参数解释: 待上传对象的文件类型(MIME类型)。contentType(MIME)用于标识发送或接收数据的类型,浏览器根据该参数来决定数据的打开方式。 取值范围: 常见的contentType(MIME)列表参见如何理解Content-Type(MIME)?(Python SDK)。 默认取值: 无 |
expires |
str |
可选 |
参数解释: 对象的详细过期信息。比如:"expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\"" 默认取值: 无 |
storageClass |
str |
可选 |
参数解释: 对象的存储类型。 取值范围:
默认取值: 无 |
successActionRedirect |
str |
可选 |
参数解释: 此参数的值是一个URL,用于指定当此次请求操作成功响应后的重定向的地址。
默认取值: 无 |
extensionGrants |
list of ExtensionGrant |
可选 |
参数解释: 待上传对象的扩展权限列表。 取值范围: 默认取值: 无 |
常量名 |
原始值 |
说明 |
---|---|---|
HeadPermission.PRIVATE |
private |
私有读写。 桶或对象的所有者拥有完全控制的权限,其他任何人都没有访问权限。 |
HeadPermission.PUBLIC_READ |
public-read |
公共读私有写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 设在对象上,所有人可以获取该对象内容和元数据。 |
HeadPermission.PUBLIC_READ_WRITE |
public-read-write |
公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务。 设在对象上,所有人可以获取该对象内容和元数据。 |
HeadPermission.PUBLIC_READ_DELIVERED |
public-read-delivered |
桶公共读,桶内对象公共读。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本,可以获取该桶内对象的内容和元数据。
说明:
PUBLIC_READ_DELIVERED不能应用于对象。 |
HeadPermission.PUBLIC_READ_WRITE_DELIVERED |
public-read-write-delivered |
桶公共读写,桶内对象公共读写。 设在桶上,所有人可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本、上传对象、删除对象、初始化段任务、上传段、合并段、拷贝段、取消多段上传任务,可以获取该桶内对象的内容和元数据。
说明:
PUBLIC_READ_WRITE_DELIVERED不能应用于对象。 |
HeadPermission.BUCKET_OWNER_FULL_CONTROL |
public-read-write-delivered |
设在对象上,桶和对象的所有者拥有对象的完全控制权限,其他任何人都没有访问权限。默认情况下,上传对象至其他用户的桶中,桶拥有者没有对象的控制权限。对象拥有者为桶拥有者添加此权限控制策略后,桶所有者可以完全控制对象。例如,用户A上传对象x至用户B的桶中,系统默认用户B没有对象x的控制权。当用户A为对象x设置bucket-owner-full-control策略后,用户B就拥有了对象x的控制权。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
STANDARD |
标准存储 |
参数解释: 标准存储拥有低访问时延和较高的吞吐量,适用于有大量热点对象(平均一个月多次)或小对象(<1MB),且需要频繁访问数据的业务场景。 |
WARM |
低频访问存储 |
参数解释: 低频访问存储适用于不频繁访问(平均一年少于12次)但在需要时也要求能够快速访问数据的业务场景。 |
COLD |
归档存储 |
参数解释: 归档存储适用于很少访问(平均一年访问一次)数据的业务场景。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
year |
int |
参数解释: UTC时间中的年。 默认取值: 无 |
month |
int |
参数解释: UTC时间中的月。 默认取值: 无 |
day |
int |
参数解释: UTC时间中的日。 默认取值: 无 |
hour |
int |
参数解释: UTC时间中的小时。 约束限制: 24小时制。 默认取值: 0 |
min |
int |
参数解释: UTC时间中的分钟。 默认取值: 0 |
sec |
int |
参数解释: UTC时间中的秒数。 默认取值: 0 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
encryption |
str |
必选 |
参数解释: 以SSE-C方式加密对象。 取值范围: AES256,即高级加密标准(Advanced Encryption Standard,AES)。 默认取值: 无 |
key |
str |
必选 |
参数解释: SSE-C方式下加密的密钥,与加密方式对应,如encryption=‘AES256’,密钥就是由AES256加密算法得到的密钥。 取值范围: 长度为32字符串。 默认取值: 无 |
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
encryption |
str |
必选 |
参数解释: 以SSE-KMS方式加密对象。 取值范围: 可选值:kms,即选择SSE-KMS方式加密对象。 默认取值: 无 |
key |
str |
可选 |
参数解释: SSE-KMS方式下加密的主密钥。 取值范围: 支持两种格式的密钥描述方式:
其中:
默认取值:
|
参数名称 |
参数类型 |
是否必选 |
描述 |
---|---|---|---|
granteeId |
str |
可选 |
参数解释: 被授权用户的账号ID,即domain_id。 取值范围: 获取账号ID的方法请参见如何获取账号ID和用户ID?(Python SDK)。 默认取值: 无 |
permission |
str |
可选 |
参数解释: 被授予的权限。 默认取值: 无 |
常量值 |
说明 |
---|---|
READ |
读权限。 如果有桶的读权限,则可以获取该桶内对象列表、桶内多段任务、桶的元数据、桶的多版本。 如果有对象的读权限,则可以获取该对象内容和元数据。 |
WRITE |
写权限。 如果有桶的写权限,则可以上传、覆盖和删除该桶内任何对象和段。 此权限在对象上不适用。 |
READ_ACP |
读取ACL配置的权限。 如果有读ACP的权限,则可以获取对应的桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有读对应桶或对象ACP的权限。 |
WRITE_ACP |
修改ACL配置的权限。 如果有写ACP的权限,则可以更新对应桶或对象的权限控制列表(ACL)。 桶或对象的所有者永远拥有写对应桶或对象的ACP的权限。 拥有了写ACP的权限,由于可以更改权限控制策略,实际上意味着拥有了完全访问的权限。 |
FULL_CONTROL |
完全控制权限,包括对桶或对象的读写权限,以及对桶或对象ACL配置的读写权限。 如果有桶的完全控制权限意味着拥有READ、WRITE、READ_ACP和WRITE_ACP的权限。 如果有对象的完全控制权限意味着拥有READ、READ_ACP和WRITE_ACP的权限。 |
返回结果
类型 |
说明 |
---|---|
参数解释: SDK公共结果对象。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
status |
int |
参数解释: HTTP状态码。 取值范围: 状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码。 默认取值: 无 |
reason |
str |
参数解释: HTTP文本描述。 默认取值: 无 |
errorCode |
str |
参数解释: OBS服务端错误码,当status参数小于300时为空。 默认取值: 无 |
errorMessage |
str |
参数解释: OBS服务端错误描述,当status参数小于300时为空。 默认取值: 无 |
requestId |
str |
参数解释: OBS服务端返回的请求ID。 默认取值: 无 |
indicator |
str |
参数解释: OBS服务端返回的错误定位码。 默认取值: 无 |
hostId |
str |
参数解释: 请求的服务端ID,当status参数小于300时为空。 默认取值: 无 |
resource |
str |
参数解释: 发生错误时相关的桶或对象,当status参数小于300时为空。 默认取值: 无 |
header |
list |
参数解释: 响应消息头列表,由多个元组构成。每个元组均包含两个元素,代表响应头的键值对。 默认取值: 无 |
body |
object |
参数解释: 操作成功后的结果数据,当status大于300时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。 默认取值: 无 |
GetResult.body类型 |
说明 |
---|---|
参数解释: 复制对象响应结果。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
lastModified |
str |
参数解释: 目标对象的最近一次修改时间(UTC时间)。 取值范围: UTC时间 默认取值: 无 |
etag |
str |
参数解释: 目标对象的ETag值。对象的base64编码的128位MD5摘要。ETag是对象内容的唯一标识,可以通过该值识别对象内容是否有变化。比如上传对象时ETag为A,下载对象时ETag为B,则说明对象内容发生了变化。ETag只反映变化的内容,而不是其元数据。上传的对象或拷贝操作创建的对象,都有唯一的ETag。 约束限制: 当对象是服务端加密的对象时,ETag值不是对象的MD5值。 取值范围: 长度为32的字符串。 默认取值: 无 |
copySourceVersionId |
str |
参数解释: 源对象的版本号。 取值范围: 长度为32的字符串。 默认取值: 无 |
versionId |
str |
参数解释: 目标对象的版本号。 取值范围: 长度为32的字符串。 默认取值: 无 |
sseKms |
str |
参数解释: 表示服务端加密是SSE-KMS方式。对象使用SSE-KMS方式加密。 取值范围: 可选值:kms,即选择SSE-KMS方式加密对象。 默认取值: 无 |
sseKmsKey |
str |
参数解释: SSE-KMS加密方式下使用的KMS主密钥的ID值。 取值范围: 有效值支持两种格式:
其中:
默认取值:
|
sseC |
str |
参数解释: 使用SSE-C方式加解密对象时,选择的加解密算法。 取值范围: 支持的值为AES256,即高级加密标准(Advanced Encryption Standard,AES)。 默认取值: 无 |
sseCKeyMd5 |
str |
参数解释: SSE-C方式下加密使用密钥的MD5值,该值用于验证密钥传输过程中是否出错。 约束限制: 由密钥值经过MD5加密再经过Base64编码后得到,示例:4XvB3tbNTN+tIEVa0/fGaQ== 默认取值: 无 |
代码样例
本示例用于复制sourcebucket桶里的sourceobjectkey对象到destbucket桶里并命名为destobjectkey。
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 49 50 51 52 53 |
from obs import ObsClient from obs import CopyObjectHeader import os import traceback # 推荐通过环境变量获取AKSK,这里也可以使用其他外部引入方式传入,如果使用硬编码可能会存在泄露风险 # 您可以登录访问管理控制台获取访问密钥AK/SK,获取方式请参见https://support.huaweicloud.com/intl/zh-cn/usermanual-ca/ca_01_0003.html ak = os.getenv("AccessKeyID") sk = os.getenv("SecretAccessKey") # 【可选】如果使用临时AKSK和SecurityToken访问OBS,则同样推荐通过环境变量获取 # security_token = os.getenv("SecurityToken") # server填写Bucket对应的Endpoint, 这里以中国-香港为例,其他地区请按实际情况填写 server = "https://obs.ap-southeast-1.myhuaweicloud.com" # 创建obsClient实例 # 如果使用临时AKSK和SecurityToken访问OBS,需要在创建实例时通过security_token参数指定securityToken值 obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) try: # 复制对象的附加头域 headers = CopyObjectHeader() # 如果设置了metadata元数据,需要指定headers中的directive为'REPLACE' headers.directive = 'REPLACE' # if_match,如果源对象的ETag值与该参数值相同,则进行复制,否则返回异常码 headers.if_match = '8f4e******************ba8c' # 目标对象的自定义元数据 metadata = {'meta1': 'value1'} # 指定源桶 sourceBucketName = 'sourcebucket' # 指定源对象 sourceObjectKey = 'sourceobjectkey' # 指定目标桶 destBucketName = 'destbucket' # 指定目标对象名 destObjectKey = 'destobjectkey' # 复制对象 resp = obsClient.copyObject(sourceBucketName, sourceObjectKey, destBucketName, destObjectKey, metadata, headers) # 返回码为2xx时,接口调用成功,否则接口调用失败 if resp.status < 300: print('Copy Object Succeeded') print('requestId:', resp.requestId) print('etag:', resp.body.etag) print('lastModified:', resp.body.lastModified) print('versionId:', resp.body.versionId) print('copySourceVersionId:', resp.body.copySourceVersionId) else: print('Copy Object Failed') print('requestId:', resp.requestId) print('errorCode:', resp.errorCode) print('errorMessage:', resp.errorMessage) except: print('Copy Object Failed') print(traceback.format_exc()) |
相关链接
- 关于复制对象的API说明,请参见复制对象。
- 更多关于复制对象的示例代码,请参见Github示例。
- 复制对象过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码。
- 复制对象常见问题请参见我可以在桶间进行文件复制吗?。