简介
本文介绍对象存储 COS 通过 Python SDK 实现修改对象元数据的示例代码和描述。
注意事项
若您想要修改某个对象的元数据,您需要具有该对象的读权限和写权限:在您进行 授权策略 时,action 需要设置为
cos:PutObject
和cos:GetObject
,更多授权请参见 支持CAM的业务接口。使用案例
修改对象自定义元数据或内容类型
源和目标是同一个对象,且 CopyStatus 设置为 Replaced,即可以通过头域来修改对象的自定义元数据或内容类型(ContentType)。
请求示例
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. 设置用户属性, 包括 secret_id, secret_key, region等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket# COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)client = CosS3Client(config)response = client.copy_object(Bucket='examplebucket-1250000000',Key='exampleobject',CopySource={'Bucket': 'sourcebucket-1250000000','Key': 'exampleobject','Region': 'ap-guangzhou'},CopyStatus='Replaced',ContentType='text/plain', # 修改对象 ContentTypeMetadata={'x-cos-meta-key1': 'value1', 'x-cos-meta-key2': 'value2'} # 修改自定义元数据)
全部请求参数示例
response = client.copy_object(Bucket='examplebucket-1250000000',Key='exampleobject',CopySource={'Bucket': 'sourcebucket-1250000000','Key': 'exampleobject','Region': 'ap-guangzhou','VersionId': 'string'},CopyStatus='Copy'|'Replaced',ACL='private'|'public-read',GrantFullControl='string',GrantRead='string',StorageClass='STANDARD'|'STANDARD_IA',Expires='string',CacheControl='string',ContentType='string',ContentDisposition='string',ContentEncoding='string',ContentLanguage='string',Metadata={'x-cos-meta-key1': 'value1','x-cos-meta-key2': 'value2'})
参数说明
参数名称 | 参数描述 | 类型 | 是否必填 |
Bucket | 存储桶名称,由 BucketName-APPID 构成 | String | 是 |
Key | 对象键(Key)是对象在存储桶中的唯一标识。例如,在对象的访问域名 examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg 中,对象键为 doc/pic.jpg | String | 是 |
CopySource | 描述拷贝源对象的路径,包含 Bucket、Key、Region、VersionId | Dict | 是 |
CopyStatus | 可选值为 Copy、Replaced。 设置为 Copy 时,忽略设置的用户元数据信息直接复制。 设置为 Replaced 时,按设置的元信息修改元数据,当目标路径和源路径一样时,必须设置为 Replaced。 | String | 是 |
ACL | 设置对象的 ACL,如 private,public-read | String | 否 |
GrantFullControl | 赋予指定账户对对象的所有权限,格式为 id="OwnerUin" | String | 否 |
GrantRead | 赋予指定账户对对象的读权限,格式为 id="OwnerUin" | String | 否 |
Expires | 设置 Expires | String | 否 |
CacheControl | 缓存策略,设置 Cache-Control | String | 否 |
ContentType | 内容类型,设置 Content-Type | String | 否 |
ContentDisposition | 文件名称,设置 Content-Disposition | String | 否 |
ContentEncoding | 编码格式,设置 Content-Encoding | String | 否 |
ContentLanguage | 语言类型,设置 Content-Language | String | 否 |
Metadata | 用户自定义的对象元数据 | Dict | 否 |
返回结果说明
除 HTTP 公共响应头外,还包括修改元数据后对象的属性,类型为 dict:
{'ETag': 'string','CRC64': 'string','LastModified': 'string','x-cos-request-id': 'string'}
参数名称 | 参数描述 | 类型 |
ETag | 对象的 MD5 值 | String |
CRC64 | 对象的 CRC64 校验值 | String |
LastModified | 对象的最后一次修改时间 | String |
VersionId | 开启版本控制后,对象的版本号 | String |
x-cos-request-id | 请求ID | String |
修改对象存储类型
源和目标是同一个对象,且 CopyStatus 设置为 Replaced,即可以通过 StorageClass 参数来修改对象的存储类型。
请求示例
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket# COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)client = CosS3Client(config)response = client.copy_object(Bucket='examplebucket-1250000000',Key='exampleobject',CopySource={'Bucket': 'examplebucket-1250000000','Key': 'exampleobject','Region': 'ap-guangzhou'},CopyStatus='Replaced',StorageClass='STANDARD_IA' # 修改为低频存储)