对象存储存储桶复制-SDK 文档-文档中心-腾讯云

简介
本文档提供关于存储桶复制的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
PUT Bucket replication
设置存储桶复制
设置存储桶的存储桶复制规则
GET Bucket replication
查询存储桶复制
查询存储桶的存储桶复制规则
DELETE Bucket replication
删除存储桶复制
删除存储桶的存储桶复制规则
设置存储桶复制
功能说明
设置指定存储桶的存储桶复制规则（PUT Bucket replication）。
方法原型
put_bucket_replication(Bucket, ReplicationConfiguration={}, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import 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/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.put_bucket_replication(
    Bucket='examplebucket-1250000000',
    ReplicationConfiguration={
        'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
        'Rule': [
            {
                'ID': 'string',
                'Status': 'Enabled',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-shanghai::destinationbucket-1250000000',
                    'StorageClass': 'STANDARD'
                }
            }
        ]   
    }
)
全部参数请求示例
response = client.put_bucket_replication(
    Bucket='examplebucket-1250000000',
    ReplicationConfiguration={
        'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
        'Rule': [
            {
                'ID': 'string',
                'Status': 'Enabled'|'Disabled',
                'Prefix': 'string',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-beijing::destinationbucket-1250000000',
                    'StorageClass': 'STANDARD'|'STANDARD_IA'
                }
            },
            {
                'ID': 'string',
                'Status': 'Enabled'|'Disabled',
                'Prefix': 'string',
                'Destination': {
                    'Bucket': 'qcs::cos:ap-beijing::destinationbucket2-1250000000',
                    'StorageClass': 'STANDARD'|'STANDARD_IA'
                }
            }
        ]   
    }
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
源存储桶名称，由 BucketName-APPID 构成
String
是
Role
发起者身份标示, 格式为 qcs::cam::uin/<OwnerUin>:uin/<SubUin>
String
否
Rule
设置对应的规则，包括 ID，Status，Prefix，Destination
List
是
ID
设置规则的 ID
String
否
Status
设置 Rule 是否启用，可选值为 Enabled 或者 Disabled
String
是
Prefix
设置 Rule 的前缀匹配规则，为空时表示作用存储桶中的所有对象
String
是
Destination
描述目的资源，包括 Bucket 和StorageClass
Dict
是
Bucket
设置存储桶复制的目标存储桶，格式为 qcs::cos:[region]::[BucketName-APPID]
String
是
StorageClass
设置目的文件的存储类型，可选值为 STANDARD，STANDARD_IA
String
否
返回结果说明
该方法返回值为 None。
查询存储桶复制
功能说明
查询指定存储桶的存储桶复制规则（GET Bucket replication）。
方法原型
get_bucket_replication(Bucket, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import 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/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.get_bucket_replication(
    Bucket='examplebucket-1250000000'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
Bucket 存储桶复制配置，类型为 dict。
{
    'Role': 'qcs::cam::uin/100000000001:uin/100000000001',
    'Rule': [
        {
            'ID': 'string',
            'Status': 'Enabled'|'Disabled',
            'Prefix': 'string',
            'Destination': {
                'Bucket': 'qcs::cos:ap-beijing::destinationbucket-1250000000',
                'StorageClass': 'STANDARD'|'STANDARD_IA'
            }
        },
        {
            'ID': 'string',
            'Status': 'Enabled'|'Disabled',
            'Prefix': 'string',
            'Destination': {
                'Bucket': 'qcs::cos:ap-beijing::destinationbucket2-1250000000',
                'StorageClass': 'STANDARD'|'STANDARD_IA'
            }
        }
    ]  
}
参数名称
参数描述
类型
Role
发起者身份标示, 格式为 qcs::cam::uin/<OwnerUin>:uin/<SubUin>
String
Rule
存储桶复制对应的规则，包括 ID，Status，Prefix，Destination
List
ID
存储桶复制规则的 ID
String
Status
存储桶复制 Rule 是否启用，可选值为 Enabled 或者 Disabled
String
Prefix
存储桶复制 Rule 的前缀匹配规则，为空时表示作用存储桶中的所有对象
String
Destination
描述目的资源，包括 Bucket 和 StorageClass
Dict
Bucket
存储桶复制的目标存储桶，格式为 qcs::cos:[region]::[BucketName-APPID]
String
StorageClass
目的文件的存储类型，可选值为 STANDARD，STANDARD_IA
String
删除存储桶复制
功能说明
删除指定存储桶的存储桶复制规则（DELETE Bucket replication）。
方法原型
delete_bucket_replication(Bucket, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import 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/37140
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://cloud.tencent.com/document/product/598/37140
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://cloud.tencent.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://cloud.tencent.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.delete_bucket_replication(
    Bucket='examplebucket-1250000000'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
该方法返回值为 None。
相关示例
关于存储桶复制的完整示例，请前往 GitHub 查看。

API	操作名	操作描述
PUT Bucket replication	设置存储桶复制	设置存储桶的存储桶复制规则
GET Bucket replication	查询存储桶复制	查询存储桶的存储桶复制规则
DELETE Bucket replication	删除存储桶复制	删除存储桶的存储桶复制规则

参数名称	参数描述	类型	是否必填
Bucket	源存储桶名称，由 BucketName-APPID 构成	String	是
Role	发起者身份标示, 格式为 `qcs::cam::uin/<OwnerUin>:uin/<SubUin>`	String	否
Rule	设置对应的规则，包括 ID，Status，Prefix，Destination	List	是
ID	设置规则的 ID	String	否
Status	设置 Rule 是否启用，可选值为 Enabled 或者 Disabled	String	是
Prefix	设置 Rule 的前缀匹配规则，为空时表示作用存储桶中的所有对象	String	是
Destination	描述目的资源，包括 Bucket 和StorageClass	Dict	是
Bucket	设置存储桶复制的目标存储桶，格式为 `qcs::cos:[region]::[BucketName-APPID]`	String	是
StorageClass	设置目的文件的存储类型，可选值为 `STANDARD`，`STANDARD_IA`	String	否

存储桶复制

本页目录：

简介

设置存储桶复制

功能说明

方法原型

请求示例

全部参数请求示例

参数说明

返回结果说明

查询存储桶复制

功能说明

方法原型

请求示例

参数说明

返回结果说明

删除存储桶复制

功能说明

方法原型

请求示例

参数说明

返回结果说明

相关示例