tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to bucket copying.

Setting Cross-Bucket Replication

Description

This API (PUT Bucket replication) is used to set the cross-bucket replication rule for a bucket.

Method prototype

public void setBucketReplicationConfiguration(
      SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest)
              throws CosClientException, CosServiceException;

Sample request

// Source bucket name, including appid
String bucketName = "examplebucket-1250000000";
BucketReplicationConfiguration bucketReplicationConfiguration = new BucketReplicationConfiguration();
// Configure initiator identity in the format: qcs::cam::uin/<OwnerUin>:uin/<SubUin>
bucketReplicationConfiguration.setRoleName("qcs::cam::uin/100000000001:uin/100000000001");
// Configure the destination bucket and storage class in the QCS format: qcs::cos:[region]::[bucketname-AppId]
ReplicationDestinationConfig replicationDestinationConfig = new ReplicationDestinationConfig();
replicationDestinationConfig.setBucketQCS("qcs::cos:ap-beijing::destinationbucket-1250000000");
replicationDestinationConfig.setStorageClass(StorageClass.Standard);
// Configure the rule status and prefix
ReplicationRule replicationRule = new ReplicationRule();
replicationRule.setStatus(ReplicationRuleStatus.Enabled);
replicationRule.setPrefix("");
replicationRule.setDestinationConfig(replicationDestinationConfig);
// Add a rule
String ruleId = "replication-to-beijing";
bucketReplicationConfiguration.addRule(replicationRule);
SetBucketReplicationConfigurationRequest setBucketReplicationConfigurationRequest =
       new SetBucketReplicationConfigurationRequest(bucketName, bucketReplicationConfiguration);
cosClient.setBucketReplicationConfiguration(setBucketReplicationConfigurationRequest);

Parameter description

Response description

• Success: No value is returned.
• Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.

Querying Cross-Bucket Replication

Description

This API (GET Bucket replication) is used to query the cross-bucket replication rule of a bucket.

Method prototype

// Method 1 to get the cross-bucket replication configuration of the bucket
public BucketReplicationConfiguration getBucketReplicationConfiguration(String bucketName)
           throws CosClientException, CosServiceException;
// Method 2 to get the cross-bucket replication configuration of the bucket        
public BucketReplicationConfiguration getBucketReplicationConfiguration(
           GetBucketReplicationConfigurationRequest getBucketReplicationConfigurationRequest)
           throws CosClientException, CosServiceException;

Sample request

String bucketName = "examplebucket-1250000000";
// Method 1 to get the cross-bucket replication configuration of the bucket
BucketReplicationConfiguration brcfRet = cosClient.getBucketReplicationConfiguration(bucketName);
// Method 2 to get the cross-bucket replication configuration of the bucket
BucketReplicationConfiguration brcfRet2 = cosClient.getBucketReplicationConfiguration(
       new GetBucketReplicationConfigurationRequest(bucketName));

Parameter description

Response description

• Success: Returns the cross-bucket replication rule for the bucket.
• Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.

Deleting Cross-Bucket Replication

Description

This API (DELETE Bucket replication) is used to delete a cross-bucket replication rule from a bucket.

Method prototype

// Method 1 to delete the cross-bucket replication configuration of the bucket
public void deleteBucketReplicationConfiguration(String bucketName)
           throws CosClientException, CosServiceException;
// Method 2 to delete the cross-bucket replication configuration of the bucket        
public void deleteBucketReplicationConfiguration(
           DeleteBucketReplicationConfigurationRequest deleteBucketReplicationConfigurationRequest)
           throws CosClientException, CosServiceException;

Sample request

String bucketName = "examplebucket-1250000000";
// Method 1 to delete the cross-bucket replication configuration of the bucket
cosClient.deleteBucketReplicationConfiguration(bucketName);
// Method 2 to delete the cross-bucket replication configuration of the bucket
cosClient.deleteBucketReplicationConfiguration(new DeleteBucketReplicationConfigurationRequest(bucketName));

Parameter description

Response description

• Success: No value is returned.
• Failure: If an error (such as authentication failure) occurs, the CosClientException or CosServiceException exception will be thrown. For more information, please see Troubleshooting.