API | Operation | Description |
Setting a bucket replication rule | Sets a bucket replication rule for a bucket | |
Querying cross-bucket replication | Queries the bucket replication rule of a bucket | |
Deleting a cross-bucket replication rule | Deletes a bucket replication rule of a bucket |
put_bucket_replication(Bucket, ReplicationConfiguration={}, **kwargs)
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print information about the communication with the server.logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.secret_id = os.environ['COS_SECRET_ID'] # User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.secret_key = os.environ['COS_SECRET_KEY'] # User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.region = 'ap-beijing' # Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.# For the list of regions supported by COS, see https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1.token = None # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, see https://www.tencentcloud.com/document/product/436/14048?from_cn_redirect=1.scheme = 'https' # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default.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'}},]})
Parameter | Description | Type | Required |
Bucket | Bucket name in the format: BucketName-APPID | String | Yes |
Role | Replication initiator identifier: qcs::cam::uin/<OwnerUin>:uin/<SubUin> | String | No |
Rule | Sets the rule, including ID, Status, Prefix, and Destination | List | Yes |
ID | Rule ID | string | No |
Status | Whether a rule is enabled. Valid values: Enabled , Disabled | String | Yes |
Prefix | Specifies the prefix used to filter objects. If it is left empty, the rule applies to all objects in the bucket | String | Yes |
Destination | Describes the destination resource, including Bucket and StorageClass | Dict | Yes |
Bucket | Sets the destination bucket for cross-region replication. Format: qcs::cos:[region]::[BucketName-APPID] | String | Yes |
StorageClass | Sets the storage class of the object copies. Valid values: STANDARD , STANDARD_IA | String | No |
None
.get_bucket_replication(Bucket, **kwargs)
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print information about the communication with the server.logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.secret_id = os.environ['COS_SECRET_ID'] # User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.secret_key = os.environ['COS_SECRET_KEY'] # User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.region = 'ap-beijing' # Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.# For the list of regions supported by COS, see https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1.token = None # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, see https://www.tencentcloud.com/document/product/436/14048?from_cn_redirect=1.scheme = 'https' # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default.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')
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID | String | Yes |
{'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'}},]}
Parameter | Description | Type |
Role | Replication initiator identifier: qcs::cam::uin/<OwnerUin>:uin/<SubUin> | String |
Rule | Sets the rule for cross-region replication, including ID, Status, Prefix, and Destination | List |
Status | Sets whether the rule is enabled. Valid values: Enabled , Disabled | String |
Prefix | Specifies the prefix used to filter objects that are subject to the rule. If it is left empty, the rule applies to all objects in the bucket | String |
Destination | Describes the destination resource, including Bucket and StorageClass | Dict |
Bucket | Sets the destination bucket for cross-region replication. Format: qcs::cos:[region]::[BucketName-APPID] | String |
StorageClass | Sets the storage class of the object copies. Valid values: STANDARD , STANDARD_IA | String |
delete_bucket_replication(Bucket, **kwargs)
# -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clientimport sysimport osimport logging# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print information about the communication with the server.logging.basicConfig(level=logging.INFO, stream=sys.stdout)# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.secret_id = os.environ['COS_SECRET_ID'] # User `SecretId`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.secret_key = os.environ['COS_SECRET_KEY'] # User `SecretKey`. We recommend you use a sub-account key and follow the principle of least privilege to reduce risks. For information about how to obtain a sub-account key, visit https://www.tencentcloud.com/document/product/598/37140?from_cn_redirect=1.region = 'ap-beijing' # Replace it with the actual region, which can be viewed in the console at https://console.tencentcloud.com/cos5/bucket.# For the list of regions supported by COS, see https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1.token = None # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, see https://www.tencentcloud.com/document/product/436/14048?from_cn_redirect=1.scheme = 'https' # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default.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',)
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID | String | Yes |
None
.
Was this page helpful?