tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for advanced upload, upload in whole, multipart upload, and other object operations.

Simple operations

API	Operation	Description
PUT Object	Uploading object in whole	Uploads object to bucket.
APPEND Object	Appending parts	Uploads object to bucket by appending parts.

Multipart upload operations

API	Operation	Description
List Multipart Uploads	Querying multipart uploads	Queries multipart uploads in progress.
Initiate Multipart Upload	Initializing multipart upload operation	Initializes multipart upload operation.
Upload Part	Uploading parts	Uploads file in parts.
Upload Part - Copy	Copying part	Copies object as part.
List Parts	Querying uploaded parts	Queries uploaded parts of multipart upload.
Complete Multipart Upload	Completing multipart upload	Completes multipart upload.
Abort Multipart Upload	Aborting multipart upload	Aborts multipart upload operation and deletes uploaded parts.

Advanced APIs (Recommended)

Uploading object (checkpoint restart)

Feature description

This advanced upload API can automatically select between the PUT Object API and the Upload Part API according to the file size. It uses the former for files smaller than or equal to 20 MB and the latter for files larger than 20 MB. It also supports automatic checkpoint restart for suspended multipart uploads.
You can use the progress_callback function to query the multipart upload progress.

Method prototype

upload_file(Bucket, Key, LocalFilePath, PartSize=1, MAXThread=5, EnableMD5=False, progress_callback=None, **kwargs)

Sample request

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
from qcloud_cos.cos_exception import CosClientError, CosServiceError
import sys
import logging
# In most cases, set the log level to `INFO`. If you need debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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)
# Use the advanced API to upload once without retry. In this case, the checkpoint restart feature is not used.
response = client.upload_file(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  LocalFilePath='local.txt',
  EnableMD5=False,
  progress_callback=None
)
# Use the advanced API for checkpoint restart, and the successfully uploaded parts will not be uploaded again during retries (ten times here).
for i in range(0, 10):
  try:
      response = client.upload_file(
      Bucket='examplebucket-1250000000',
      Key='exampleobject',
      LocalFilePath='local.txt')
      break
  except CosClientError or CosServiceError as e:
      print(e)

Sample request with all parameters

def upload_percentage(consumed_bytes, total_bytes):
   """Callback function that calculates the upload progress (in percentage)
    :param consumed_bytes: Uploaded data amount
   :param total_bytes: Total data amount
   """
   if total_bytes:
       rate = int(100 * (float(consumed_bytes) / float(total_bytes)))
       print('\r{0}% '.format(rate))
       sys.stdout.flush()
response = client.upload_file(
   Bucket='examplebucket-1250000000',
   Key='exampleobject',
   LocalFilePath='local.txt',
   PartSize=1,
   MAXThread=5,
   progress_callback=upload_percentage,
   EnableMD5=False|True,
   ACL='private'|'public-read', # Note that the allowed maximum number (1000) of ACLs may be reached if you use this parameter.
   GrantFullControl='string',
   GrantRead='string',
   StorageClass='STANDARD'|'STANDARD_IA'|'ARCHIVE',
   Expires='string',
   CacheControl='string',
   ContentType='string',
   ContentDisposition='string',
   ContentEncoding='string',
   ContentLanguage='string',
   ContentLength='123',
   ContentMD5='string',
   Metadata={
       'x-cos-meta-key1': 'value1',
       'x-cos-meta-key2': 'value2'
   },
   TrafficLimit='1048576'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
LocalFilePath	Path to the local file	String	Yes
PartSize	Part size. Default value: 1 MB.	Int	No
MAXThread	Maximum number of threads for concurrent multipart uploads. Default value: 5.	Int	No
progress_callback	Callback function for the upload progress. You can customize this function to query the upload progress.	Func	No
EnableMD5	Whether to calculate the Content-MD5 checksum, which will increase the upload time. It's not calculated by default.	Bool	No
ACL	ACL of the object. Valid values: private, public-read.	String	No
GrantFullControl	Grants full permission in the format of id="OwnerUin"	String	No
GrantRead	Grants read permission in the format of id="OwnerUin"	String	No
StorageClass	Storage class of the object, such as STANDARD (default), STANDARD_IA, and ARCHIVE. For more information, see Storage Class Overview.	String	No
Expires	Expiration time	String	No
CacheControl	Cache policy. Sets Cache-Control.	String	No
ContentType	Content type. Sets Content-Type.	String	No
ContentDisposition	Filename. Sets Content-Disposition.	String	No
ContentEncoding	Encoding format. Sets Content-Encoding.	String	No
ContentLanguage	Language type. Sets Content-Language.	String	No
ContentLength	Sets the length of the request content	String	No
ContentMD5	MD5 checksum of the uploaded object, which is used for verification.	String	No
Metadata	Custom object metadata	Dict	No
TrafficLimit	Bandwidth limit in bit/s for a single request (or a single thread for the advanced download API). Value range: 819200–838860800, i.e., 100 KB/s–100 MB/s.	String	No

Response description

This response contains the attributes of the uploaded object in DICT format:

{
  'ETag': 'string'
}

Parameter	Description	Type
ETag	This value does not represent the MD5 checksum of the object content, but is used only to verify the uniqueness of the multipart uploaded object.	String

Batch upload (uploading local folders)

Feature description

The following sample shows how to use the SDK's basic APIs to batch upload local folders to COS.

Sample request

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
from qcloud_cos import CosServiceError
from qcloud_cos import CosClientError
from qcloud_cos.cos_threadpool import SimpleThreadPool
import sys
import os
import logging
# In most cases, set the log level to `INFO`. If you need debugging, you can set it to `DEBUG`, and the SDK will print the communication with the server.
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
# 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token)  # Get the configured object
client = CosS3Client(config)
uploadDir = '/root/logs'
bucket = 'examplebucket-125000000'
g = os.walk(uploadDir)
# Create a thread pool for the upload.
pool = SimpleThreadPool()
for path, dir_list, file_list in g:
  for file_name in file_list:
      srcKey = os.path.join(path, file_name)
      cosObjectKey = srcKey.strip('/')
      # Determine whether the object exists in COS.
      exists = False
      try:
          response = client.head_object(Bucket=bucket, Key=cosObjectKey)
          exists = True
      except CosServiceError as e:
          if e.get_status_code() == 404:
              exists = False
          else:
              print("Error happened, reupload it.")
      if not exists:
          print("File %s not exists in cos, upload it", srcKey)
          pool.add_task(client.upload_file, bucket, cosObjectKey, srcKey)
pool.wait_completion()
result = pool.get_result()
if not result['success_all']:
  print("Not all files upload sucessed. you should retry")

Simple Operations

Uploading object in whole

Feature description

This API (PUT Object) is used to upload an object to a bucket.

Method prototype

put_object(Bucket, Body, Key, **kwargs)

Sample 1: Uploading a file in whole

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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)
# File stream (upload in whole)
file_name = 'test.txt'
with open('test.txt', 'rb') as fp:
  response = client.put_object(
      Bucket='examplebucket-1250000000',  # Bucket name in the format of `BucketName-APPID`.
      Body=fp,
      Key=file_name,
      StorageClass='STANDARD',
      ContentType='text/html; charset=utf-8'
  )
  print(response['ETag'])
# Byte stream (upload in whole)
response = client.put_object(
  Bucket='examplebucket-1250000000',
  Body=b'abcdefg',
  Key=file_name
)
print(response['ETag'])
# Local path (upload in whole)
response = client.put_object_from_local_file(
  Bucket='examplebucket-1250000000',
  LocalFilePath='local.txt',
  Key=file_name,
)
print(response['ETag'])
# HTTP header (upload in whole)
response = client.put_object(
  Bucket='examplebucket-1250000000',
  Body=b'test',
  Key=file_name,
  ContentType='text/html; charset=utf-8'
)
print(response['ETag'])
# Custom header (upload in whole)
response = client.put_object(
  Bucket='examplebucket-1250000000',
  Body=b'test',
  Key=file_name,
  Metadata={
      'x-cos-meta-key1': 'value1',
      'x-cos-meta-key2': 'value2'
  }
)
print(response['ETag'])
# Limit the upload speed
with open('test.bin', 'rb') as fp:
  response = client.put_object(
      Bucket='examplebucket-1250000000',  
      Key='exampleobject',
      Body=fp,
      TrafficLimit='819200'
  )
  print(response['ETag'])

Sample 2: Creating a directory

In COS, a directory is an object whose name ends with a slash (/). Therefore, you can call the Put Object API.

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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)
# Create a directory.
dir_to_create='path/to/create/dir/'
response = client.put_object(
  Bucket='examplebucket-1250000000',  # Bucket name in the format of `BucketName-APPID`.
  Key=dir_to_create,
  Body=b'',
)
print(response)

Sample 3: Uploading an object to a specified directory

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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)
# You can upload an object whose name is separated by slashes. In this way, the directory that contains this object will be created automatically. To upload new objects to this COS directory, enter the value of `Key` as the directory's prefix.
dir_name = 'path/to/dir/'
file_name = 'test.txt'
object_key = dir_name + file_name
with open('test.txt', 'rb') as fp:
  response = client.put_object(
      Bucket='examplebucket-1250000000',  # Bucket name in the format of `BucketName-APPID`.
      Body=fp,
      Key=object_key,
      StorageClass='STANDARD',
      ContentType='text/html; charset=utf-8'
  )
  print(response['ETag'])

Sample request with all parameters

response = client.put_object(
  Bucket='examplebucket-1250000000',
  Body=b'bytes'|file,
  Key='exampleobject',
  EnableMD5=False|True,
  ACL='private'|'public-read', # Note that the allowed maximum number (1000) of ACLs may be reached if you use this parameter.
  GrantFullControl='string',
  GrantRead='string',
  StorageClass='STANDARD'|'STANDARD_IA'|'ARCHIVE',
  Expires='string',
  CacheControl='string',
  ContentType='string',
  ContentDisposition='string',
  ContentEncoding='string',
  ContentLanguage='string',
  ContentLength='123',
  ContentMD5='string',
  Metadata={
      'x-cos-meta-key1': 'value1',
      'x-cos-meta-key2': 'value2'
  },
  TrafficLimit='1048576'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Body	Content of the object to be uploaded, which can be a file stream or a byte stream.	file/bytes	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
EnableMD5	Whether to calculate the Content-MD5 checksum, which will increase the upload time. It's not calculated by default.	Bool	No
ACL	ACL of the object. Valid values: private, public-read.	String	No
GrantFullControl	Grants full permission in the format of id="OwnerUin"	String	No
GrantRead	Grants read permission in the format of id="OwnerUin"	String	No
StorageClass	Storage class of the object, such as STANDARD (default), STANDARD_IA, and ARCHIVE. For more information, see Storage Class Overview.	String	No
Expires	Expiration time	String	No
CacheControl	Cache policy. Sets Cache-Control.	String	No
ContentType	Content type. Sets Content-Type.	String	No
ContentDisposition	Object name. Sets Content-Disposition.	String	No
ContentEncoding	Encoding format. Sets Content-Encoding.	String	No
ContentLanguage	Language type. Sets Content-Language.	String	No
ContentLength	Sets the length of the request content	String	No
ContentMD5	MD5 checksum of the uploaded object, which is used for verification.	String	No
Metadata	Custom object metadata. This parameter must start with x-cos-meta; otherwise, it will be ignored.	Dict	No
TrafficLimit	Bandwidth limit in bit/s for a single request. Value range: 819200–838860800, i.e., 100 KB/s–100 MB/s.	String	No

Response description

This response contains the attributes of the uploaded object in DICT format:

{
  'ETag': 'string',
  'x-cos-version-id': 'string'
}

Parameter	Description	Type
ETag	MD5 checksum of the uploaded object	String
x-cos-version-id	Version number of the object if versioning is enabled	String

Appending parts

Feature description

This API (APPEND Object) is used to upload an object to a bucket by appending parts.

Method prototype

append_object(Bucket, Key, Position, Data, **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.append_object(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  Position=0,
  Data=b'b'*1024*1024
)

Sample request with all parameters

response = client.append_object(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  Position=0,
  Data=b'bytes'|file
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
Position	Starting point for the append operation (in bytes). For the first append, the value of this parameter is 0. For subsequent appends, the value is the content-length of the current object.	Int	Yes
Data	Content of the part to be uploaded, which can be a local file stream or an input stream.	file/bytes	Yes

Response description

This response contains the attributes of the object in DICT format after the append operation, including the position of the next append.

{
   'ETag': '"9a4802d5c99dafe1c04da0a8e7e166bf"',
   'x-cos-next-append-position': '12',
   'x-cos-request-id': 'NjEwN2Q0ZGZfMWNhZjU4NjRfMzM1M19hNzQzYjc2'
}

Multipart Upload Operations

With multipart upload, you can do the following:

• Multipart upload: Initializing a multipart upload operation, uploading parts, and completing a multipart upload operation.
• Multipart upload resumption: Querying uploaded parts, uploading remaining parts, and completing a multipart upload operation.
• Deleting uploaded parts.

Querying multipart upload

Feature description

This API (List Multipart Uploads) is used to query multipart uploads in progress in a specified bucket.

Method prototype

list_multipart_uploads(Bucket, Prefix="", Delimiter="", KeyMarker="", UploadIdMarker="", MaxUploads=1000, EncodingType="", **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.list_multipart_uploads(
  Bucket='examplebucket-1250000000',
  Prefix='dir'
)

Sample request with all parameters

response = client.list_multipart_uploads(
  Bucket='examplebucket-1250000000',
  Prefix='string',
  Delimiter='string',
  KeyMarker='string',
  UploadIdMarker='string',
  MaxUploads=100,
  EncodingType='url'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Prefix	Object key prefix to filter multipart uploads by, which is left empty by default.	String	No
Delimiter	Delimiter, which is left empty by default.	String	No
KeyMarker	Specifies the key of the object after which the returned list begins. It is used together with UploadIdMarker.	String	No
UploadIdMarker	Specifies the upload ID of the object after which the returned list begins. It is used together with KeyMarker. If KeyMarker is not specified, UploadIdMarker will be ignored.	String	No
MaxUploads	Maximum number of multipart uploads that can be returned at a time. Default value: 1000.	Int	No
EncodingType	Encoding type of the returned value. The returned value is not encoded by default. Valid value: url.	String	No

Response description

This response contains the information of the multipart uploads in DICT format:

{
  'Bucket': 'examplebucket-1250000000',
  'Prefix': 'string',
  'Delimiter': 'string',
  'KeyMarker': 'string',
  'UploadIdMarker': 'string',
  'NextKeyMarker': 'string',
  'NextUploadIdMarker': 'string',
  'MaxUploads': '1000',
  'IsTruncated': 'true'|'false',,
  'EncodingType': 'url',
  'Upload':[
      {
          'UploadId': 'string',
          'Key': 'string',
          'Initiated': 'string',
          'StorageClass': 'STANDARD',
          'Owner': {
              'DisplayName': 'string',
              'ID': 'string'
          },
          'Initiator': {
              'ID': 'string',
              'DisplayName': 'string'
          }
      },
  ],
  'CommonPrefixes':[
      {
          'Prefix': 'string'
      },
  ],
}

Parameter	Description	Type
Bucket	Bucket name in the format of BucketName-APPID	String
Prefix	Object key prefix to filter multipart uploads by, which is left empty by default.	String
Delimiter	Delimiter, which is left empty by default.	String
KeyMarker	Specifies the key of the object after which the returned list begins. It is used together with UploadIdMarker.	String
UploadIdMarker	Specifies the upload ID of the object after which the returned list begins. It is used together with KeyMarker. If KeyMarker is not specified, UploadIdMarker will be ignored.	String
NextKeyMarker	Specifies the key of the object after which the next listing should begin if IsTruncated is true	String
NextUploadIdMarker	Specifies the upload ID of the object after which the next listing should begin if IsTruncated is true	String
MaxUploads	Maximum number of multipart uploads that can be returned at a time. Default value: 1000.	Int
IsTruncated	Indicates whether the returned list is truncated	String
EncodingType	Encoding type of the returned value. The returned value is not encoded by default. Valid value: url.	String
Upload	List of the information of all the returned multipart uploads, including UploadId, StorageClass, Key, Owner, Initiator, and Initiated.	List
CommonPrefixes	All keys starting with the specified prefix and ending with the specified delimiter	List

Initializing multipart upload

Feature description

This API (Initiate Multipart Upload) is used to initialize a multipart upload and get its uploadId.

Method prototype

create_multipart_upload(Bucket, Key, **kwargs):

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.create_multipart_upload(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  StorageClass='STANDARD'
)

Sample request with all parameters

response = client.create_multipart_upload(
  Bucket='examplebucket-1250000000',
  Key='multipart.txt',
  StorageClass='STANDARD'|'STANDARD_IA'|'ARCHIVE',
  Expires='string',
  CacheControl='string',
  ContentType='string',
  ContentDisposition='string',
  ContentEncoding='string',
  ContentLanguage='string',
  Metadata={
      'x-cos-meta-key1': 'value1',
      'x-cos-meta-key2': 'value2'
  },
  ACL='private'|'public-read',
  GrantFullControl='string',
  GrantRead='string'
)
# Get the `UploadId` for subsequent API calls.
uploadid = response['UploadId']

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
StorageClass	Storage class of the object, such as STANDARD (default), STANDARD_IA, and ARCHIVE. For more information, see Storage Class Overview.	String	No
Expires	Expiration time	String	No
CacheControl	Cache policy. Sets Cache-Control.	String	No
ContentType	Content type. Sets Content-Type.	String	No
ContentDisposition	Filename. Sets Content-Disposition.	String	No
ContentEncoding	Encoding format. Sets Content-Encoding.	String	No
ContentLanguage	Language type. Sets Content-Language.	String	No
Metadata	Custom object metadata	Dict	No
ACL	ACL of the object. Valid values: private, public-read.	String	No
GrantFullControl	Grants full permission in the format of id="OwnerUin"	String	No
GrantRead	Grants read permission in the format of id="OwnerUin"	String	No

Response description

This response contains the initialization information of the multipart upload in DICT format:

{
  'UploadId': '150219101333cecfd6718d0caea1e2738401f93aa531a4be7a2afee0f8828416f3278e5570',
  'Bucket': 'examplebucket-1250000000', 
  'Key': 'exampleobject' 
}

Parameter	Description	Type
UploadId	ID that identifies the multipart upload	String
Bucket	Bucket name in the format of BucketName-APPID	String
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String

Uploading parts

This API is used to upload an object in parts.

Method prototype

upload_part(Bucket, Key, Body, PartNumber, UploadId, **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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)
# Note: Up to 10,000 parts can be uploaded.
response = client.upload_part(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  Body=b'b'*1024*1024,
  PartNumber=1,
  UploadId='exampleUploadId'
)

Sample request with all parameters

# Note: Up to 10,000 parts can be uploaded.
response = client.upload_part(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  Body=b'bytes'|file,
  PartNumber=1,
  UploadId='string',
  EnableMD5=False|True,
  ContentLength='123',
  ContentMD5='string',
  TrafficLimit='1048576'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
Body	Content of the part to be uploaded, which can be a local file stream or an input stream.	file/bytes	Yes
PartNumber	Number that identifies the uploaded part	Int	Yes
UploadId	ID that identifies the multipart upload	String	Yes
EnableMD5	Whether to calculate the Content-MD5 checksum, which will increase the upload time. It's not calculated by default.	Bool	No
ContentLength	Sets the length of the request content	String	No
ContentMD5	MD5 checksum of the uploaded object, which is used for verification.	String	No
TrafficLimit	Bandwidth limit in bit/s for a single request. Value range: 819200–838860800, i.e., 100 KB/s–100 MB/s.	String	No

Response description

This response contains the attributes of the uploaded parts in DICT format:

{
  'ETag': 'string'
}

Parameter	Description	Type
ETag	MD5 checksum of the uploaded part	String

Copying object part

This API (Upload Part - Copy) is used to copy an object as a part.

Method prototype

upload_part_copy(Bucket, Key, PartNumber, UploadId, CopySource, CopySourceRange='', **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.upload_part_copy(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  PartNumber=1,
  UploadId='exampleUploadId',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'exampleobject', 
      'Region': 'ap-guangzhou'
  }
)

Sample request with all parameters

response = client.upload_part_copy(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  PartNumber=100,
  UploadId='string',
  CopySource={
      'Bucket': 'sourcebucket-1250000000', 
      'Key': 'sourceObject', 
      'Region': 'COS_REGION', # Replace it with the source bucket region
      'VersionId': 'string'
  },
  CopySourceRange='string',
  CopySourceIfMatch='string',
  CopySourceIfModifiedSince='string',
  CopySourceIfNoneMatch='string',
  CopySourceIfUnmodifiedSince='string'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
PartNumber	Number that identifies the uploaded part	Int	Yes
UploadId	ID that identifies the multipart upload	String	Yes
CopySource	Path of the source object to be copied, which contains Bucket, Key, Region, and VersionId.	Dict	Yes
CopySourceRange	Byte range of the source object to be copied in the format of bytes=first-last. The entire source object will be copied by default if this parameter is not specified.	String	No
CopySourceIfMatch	ETag that must be matched. The source object will be copied only if its ETag matches the specified value.	String	No
CopySourceIfModifiedSince	Required modification time. The source object will be copied only if it has been modified since the specified time.	String	No
CopySourceIfNoneMatch	ETag that cannot be matched. The source object will be copied only if its ETag does not match the specified value.	String	No
CopySourceIfUnmodifiedSince	Required unmodified time. The source object will be copied only if it hasn't been modified since the specified time.	String	No

Response description

This response contains the attributes of the copied parts in DICT format:

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

Parameter	Description	Type
ETag	MD5 checksum of the copied part	String
LastModified	Time when the copied parts were last modified	String
x-cos-copy-source-version-id	Version number of the source object	String

Querying uploaded parts

Feature description

This API is used to query the uploaded parts of a multipart upload.

Method prototype

list_parts(Bucket, Key, UploadId, MaxParts=1000, PartNumberMarker=0, EncodingType='', **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.list_parts(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  UploadId='exampleUploadId'
)

Sample request with all parameters

response = client.list_parts(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  UploadId=uploadid,
  MaxParts=1000,
  PartNumberMarker=100,
  EncodingType='url'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
UploadId	ID that identifies the multipart upload	String	Yes
MaxParts	Maximum number of parts that can be returned at a time. Default value: 1000.	Int	No
PartNumberMarker	Specifies the part number after which the listing should begin. The default value is 0, which means the listing begins with the first part.	Int	No
EncodingType	Encoding type of the returned value. The returned value is not encoded by default. Valid value: url.	String	No

Response description

This response contains the information of all the uploaded parts in DICT format:

{
  'Bucket': 'examplebucket-1250000000', 
  'Key': 'exampleobject', 
  'UploadId': '1502192444bdb382add546a35b2eeab81e06ed84086ca0bb75ea45ca7fa073fa9cf74ec4f2', 
  'EncodingType': None, 
  'MaxParts': '1000',
  'IsTruncated': 'true',
  'PartNumberMarker': '0', 
  'NextPartNumberMarker': '1000', 
  'StorageClass': 'Standard',
  'Part': [
      {
          'LastModified': '2017-08-08T11:40:48.000Z',
          'PartNumber': '1',
          'ETag': '"8b8378787c0925f42ccb829f6cc2fb97"',
          'Size': '10485760'
      },
  ], 
  'Initiator': {
      'DisplayName': '3333333333', 
      'ID': 'qcs::cam::uin/3333333333:uin/3333333333'
  }, 
  'Owner': {
      'DisplayName': '124564654654',
      'ID': '124564654654'
  }
}

Parameter	Description	Type
Bucket	Bucket name in the format of BucketName-APPID	String
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String
UploadId	ID that identifies the multipart upload	String
EncodingType	Encoding type of the returned value. The returned value is not encoded by default. Valid value: url.	String
MaxParts	Maximum number of parts that can be returned at a time. Default value: 1000.	String
IsTruncated	Indicates whether the returned list is truncated	String
PartNumberMarker	Specifies the part number after which the listing should begin. The default value is 0, which means the listing begins with the first part.	String
NextPartNumberMarker	Specifies the part number after which the next listing should begin	String
StorageClass	Storage class of the object, such as STANDARD (default), STANDARD_IA, and ARCHIVE. For more information, see Storage Class Overview.	String
Part	Information of the uploaded part, including ETag, PartNumber, Size, and LastModified.	String
Initiator	Initiator of the multipart upload, including DisplayName and ID	Dict
Owner	Information of the object owner, including DisplayName and ID.	Dict

Completing multipart upload

Feature description

This API (Complete Multipart Upload) is used to complete a multipart upload.

Method prototype

complete_multipart_upload(Bucket, Key, UploadId, MultipartUpload={}, **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.complete_multipart_upload(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  UploadId='exampleUploadId',
  MultipartUpload={
      'Part': [
          {
              'ETag': 'string',
              'PartNumber': 1
          },
          {
              'ETag': 'string',
              'PartNumber': 2
          },
      ]
  },
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
UploadId	ID that identifies the multipart upload	String	Yes
MultipartUpload	Information of all parts, including ETag and PartNumber.	Dict	Yes

Response description

This response contains the information of the object assembled from the uploaded parts in DICT format:

{
  'ETag': '"3f866d0050f044750423e0a4104fa8cf-2"', 
  'Bucket': 'examplebucket-1250000000', 
  'Location': 'examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/exampleobject', 
  'Key': 'exampleobject'
}

Parameter	Description	Type
ETag	Unique tag of a merged object. This value does not represent the MD5 checksum of the object content, but is used only to verify the uniqueness of the object as a whole. To verify the object content, check the ETag of each part during the upload process.	String
Bucket	Bucket name in the format of BucketName-APPID	String
Location	URL	String
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String

Aborting multipart upload

Feature description

This API is used to abort a multipart upload and delete the uploaded parts.

Method prototype

abort_multipart_upload(Bucket, Key, UploadId, **kwargs)

Sample request

# -*- 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 debugging, you can set it to `DEBUG`, and the SDK will print 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 in the format of `BucketName-Appid`.
secret_id = 'SecretId'     # Replace it with your real `SecretId`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'   # Replace it with your real `SecretKey`, which can be viewed and managed in the CAM console at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with your real region information, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of all availability regions of COS, visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
token = None               # `token` is required for temporary keys but not permanent keys. For more information on how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048?from_cn_redirect=1.
scheme = 'https'           # Specify whether to use the 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.abort_multipart_upload(
  Bucket='examplebucket-1250000000',
  Key='exampleobject',
  UploadId='exampleUploadId'
)

Parameter description

Parameter	Description	Type	Required
Bucket	Bucket name in the format of BucketName-APPID	String	Yes
Key	Unique identifier of the object in the bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg.	String	Yes
UploadId	ID that identifies the multipart upload	String	Yes

Response description

This API returns None.