tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to object copy and movement.

Advanced APIs (Recommended)

Copying objects

Description

This advanced API copies objects smaller than 5 GB by calling copy_object. If an object is larger than or equal to 5 GB, it calls upload_part_copy.

Method prototype

copy(Bucket, Key, CopySource, CopyStatus='Copy', PartSize=10, MAXThread=5, **kwargs)

Sample 1. Copying an object

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import 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 the communication information of the client.
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 = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
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.copy(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'sourceobject', 
      'Region': 'ap-guangzhou'
  }
)

Sample 2: moving an object

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import 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 the communication information of the client.
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 = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
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)
bucket = 'examplebucket-1250000000'
srcKey = 'src_object_key'  # Path of the source object
destKey = 'dest_object_key'   # Path of the destination object
# COS does not offer an API to move objects. To move an object, you can copy it first and delete the old one.
response = client.copy(
  Bucket=bucket,
  Key=destKey,
  CopySource={
      'Bucket':bucket,
      'Key':srcKey,
      'Region':'ap-guangzhou',
  })
client.delete_object(Bucket=bucket, Key=srcKey)

Sample request with all parameters

response = client.copy(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'exampleobject', 
      'Region': 'ap-guangzhou'
  }
  CopyStatus='Copy'|'Replaced',
  PartSize=20,
  MAXThread=10
)

Parameter description

Response description

If the object is smaller than 5 GB, the response of copy_object is returned. Otherwise, the response of complete_multipart_upload is returned. The format is dict.

Simple Operations

Copying objects

Description

This API is used to copy an existing object to a destination path.

Method prototype

copy_object(Bucket, Key, CopySource, CopyStatus='Copy', **kwargs)

Sample 1. Copying an object

If the source and destination objects are different, a new object will be generated. The metadata of the destination object will be copied from the source.

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import 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 the communication information of the client.
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 = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
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.copy_object(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'sourceobject', 
      'Region': 'ap-guangzhou'
  }
)

Sample 2: moving an object

COS does not offer an API to move objects. To move an object, you can copy it first and delete the old one.

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import 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 the communication information of the client.
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 = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
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.copy_object(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'sourceobject', 
      'Region': 'ap-guangzhou'
  }
)
client.delete_object(Bucket='sourcebucket-1250000000', Key='sourceobject')

Parameter description

Response description

The response contains the attributes of the copied object in dict format:

{
  'ETag': 'string',
  'LastModified': 'string',
  'VersionId': 'string',
  'x-cos-copy-source-version-id': 'string'
}