Uploading an Object - Resumable (SDK for Python)

Function

The resumable upload is an encapsulated and enhanced version of the multipart upload used for dealing with possible upload failures of large files when the network connection is unstable or a program crashes. This API splits the file into multiple parts and uploads them individually. The upload result of each part is recorded in a checkpoint file in real time. A success message is returned only when all parts are uploaded. If any parts fail, an error message is returned telling you to call the API again to upload the failed parts. Since the checkpoint file contains the progress of each part, it saves you uploading all parts again in the event of an error.

Restrictions

To upload an object, you must be the bucket owner or have the required permission (obs:object:PutObject in IAM or PutObject in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Configuring an Object Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
The file uploaded by the resumable upload API must exceed 100 KB.
To obtain the progress of the last upload, you must enable resumable upload when you use this API.

Method

ObsClient.uploadFile(bucketName, objectKey, uploadFile, partSize, taskNum, enableCheckpoint, checkpointFile, checkSum, metadata, progressCallback, headers, extensionHeaders)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Description	Description
bucketName	str	Yes	Explanation: Bucket name Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request. Default value: None
objectKey	str	Yes	Explanation: Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None
uploadFile	str	Yes	Explanation: Complete path of the local file to be uploaded, for example, aa/bb.txt. Default value: None
partSize	int	No	Explanation: Part size Value range: The value ranges from 100 KB to 5 GB, in bytes. Default value: 9 MB
taskNum	int	No	Explanation: Maximum number of parts that can be uploaded concurrently Value range: 1~10000 Default value: 1, indicating concurrent uploads are not used.
enableCheckpoint	bool	No	Explanation: Whether to enable the resumable upload mode Value range: True: The resumable upload mode is enabled. False: The resumable upload mode is disabled. Default value: False
checkpointFile	str	No	Explanation: Address of a file generated for recording the progress of a resumable upload. The file contains the information about parts and the upload progress. Restrictions: This parameter is valid only for resumable uploads. Default value: If this parameter is left blank, the progress file will be in the same directory as the local file to be uploaded.
checkSum	bool	No	Explanation: Whether to verify the file to upload. If this parameter is enabled, before each task restarts, the system verifies whether the file to upload is the one used during task initialization. Value range: True: The file to upload is verified. False: The file to upload is not verified. Default value: False
metadata	dict	No	Explanation: Custom metadata of the object to be uploaded. You can add a header starting with x-obs-meta- in the request to define metadata. The custom metadata will be returned in the response when you retrieve the object or query the object metadata. Restrictions: The custom metadata cannot exceed 8 KB. To measure the custom metadata, sum the number of bytes in the UTF-8 encoding of each key and value. The custom metadata keys are case insensitive, but are stored in lowercase in OBS. The key values are case sensitive. Both custom metadata keys and their values must conform to US-ASCII standards. If non-ASCII or unrecognizable characters are required, they must be encoded and decoded in URL or Base64 on the client, because the server does not perform such operations. Default value: None
progressCallback	callable	No	Explanation: Callback function for obtaining the upload progress Default value: None NOTE: This function contains the following parameters in sequence: number of uploaded bytes, total number of bytes, and used time (in seconds). For details about the sample code, see Obtaining the Upload Progress (SDK for Python).
headers	UploadFileHeader	No	Explanation: Headers in the request used for configuring the storage class, redundancy policy, and other basic information about the object Value range: See Table 2. Default value: None
extensionHeaders	dict	No	Explanation: Extension headers. Value range: See User-defined Header (SDK for Python). Default value: None

**Table 2** UploadFileHeader
Parameter	Type	Description	Description
acl	str	No	Explanation: Pre-defined access policy specified during object creation. For details about the ACL, see ACLs. Value range: See Table 3. Default value: None
location	str	No	Explanation: If the bucket is configured with website hosting, the request for obtaining the object can be redirected to another object in the bucket or an external URL. The request is redirected to object anotherPage.html in the same bucket: location:/anotherPage.html The request is redirected to an external URL http://www.example.com/: location:http://www.example.com/ OBS obtains the specified value from the header and stores it in the object metadata location. Restrictions: The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB. OBS only supports redirection for objects in the root directory of a bucket. Default value: None
contentType	str	No	Explanation: MIME type of the file to be uploaded. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data. Value range: See What Is Content-Type (MIME)? (Python SDK) Default value: If you do not specify contentType when uploading an object, the SDK determines the object type based on the suffix of the specified object name and automatically assigns a value to contentType.
sseHeader	SseCHeader or SseKmsHeader	No	Explanation: Server-side encryption header Default value: None
storageClass	str	No	Explanation: Storage class of the object Value range: For details about the available storage classes, see Table 4. Default value: None
successActionRedirect	str	No	Explanation: Address (URL) to which a successfully answered request is redirected If the value is valid and the request is successful, OBS returns status code 303. Location in the returned results contains SuccessActionRedirect as well as the bucket name, object name, and object ETag. If the value is invalid, OBS ignores this parameter. In such case, Location in the returned results indicates the object address, and OBS returns a status code based on whether the operation succeeds or fails. Default value: None
extensionGrants	list of ExtensionGrant	No	Explanation: List of the extended permissions for the object to be uploaded Value range: See Table 7. Default value: None
expires	int	No	Explanation: Expiration time of the object (calculated from the latest modification time of the object). Expired objects are automatically deleted. Restrictions: This parameter can be configured only when uploading the object. It cannot be modified by calling a metadata modification API. Value range: An integer greater than or equal to 0, in days Default value: None

**Table 3** HeadPermission
Constant	Default Value	Description
HeadPermission.PRIVATE	private	Private read/write A bucket or object can only be accessed by its owner.
HeadPermission.PUBLIC_READ	public-read	Public read and private write If this permission is granted on a bucket, anyone can read the object list, multipart uploads, metadata, and object versions in the bucket. If it is granted on an object, anyone can read the content and metadata of the object.
HeadPermission.PUBLIC_READ_WRITE	public-read-write	Public read/write If this permission is granted on a bucket, anyone can read the object list, multipart tasks, metadata, and object versions in the bucket, and can upload or delete objects, initiate multipart upload tasks, upload parts, assemble parts, copy parts, and abort multipart upload tasks. If it is granted on an object, anyone can read the content and metadata of the object.
HeadPermission.PUBLIC_READ_DELIVERED	public-read-delivered	Public read on a bucket as well as objects in the bucket If this permission is granted on a bucket, anyone can read the object list, multipart tasks, metadata, and object versions, and read the content and metadata of objects in the bucket. NOTE: PUBLIC_READ_DELIVERED cannot be applied to objects.
HeadPermission.PUBLIC_READ_WRITE_DELIVERED	public-read-write-delivered	Public read/write on a bucket as well as objects in the bucket If this permission is granted on a bucket, anyone can read the object list, multipart uploads, metadata, and object versions in the bucket, and can upload or delete objects, initiate multipart upload tasks, upload parts, assemble parts, copy parts, and abort multipart uploads. They can also read the content and metadata of objects in the bucket. NOTE: PUBLIC_READ_WRITE_DELIVERED cannot be applied to objects.
HeadPermission.BUCKET_OWNER_FULL_CONTROL	public-read-write-delivered	If this permission is granted on an object, only the bucket and object owners have the full control over the object. By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.

**Table 4** StorageClass
Parameter	Type	Description
STANDARD	Standard storage class	Explanation: Features low access latency and high throughput and is used for storing massive, frequently accessed (multiple times a month) or small objects (< 1 MB) requiring quick response.
WARM	Infrequent Access storage class	Explanation: Used for storing data that is semi-frequently accessed (fewer than 12 times a year) but is instantly available when needed.
COLD	Archive storage class	Explanation: Used for storing rarely accessed (once a year) data.

**Table 5** SseCHeader
Parameter	Type	Mandatory (Yes/No)	Description
encryption	str	Yes	Explanation: SSE-C used for encrypting objects Value range: AES256 Default value: None
key	str	Yes	Explanation: Key used in SSE-C encryption. It corresponds to the encryption method. For example, if encryption is set to AES256, the key is calculated using the AES-256 algorithm. Value range: The value must contain 32 characters. Default value: None

**Table 6** SseKmsHeader
Parameter	Type	Mandatory (Yes/No)	Description
encryption	str	Yes	Explanation: SSE-KMS used for encrypting objects Value range: kms Default value: None
key	str	No	Explanation: Master key used in SSE-KMS Value range: The following two formats are supported: regionID:domainID:key/key_id key_id In the preceding formats: regionID indicates the ID of the region where the key is used. You can obtain it from Regions and Endpoints. domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID? (SDK for Python) key_id indicates the ID of the key created on Data Encryption Workshop (DEW). To obtain it, see Viewing a CMK. Default value: If this parameter is not specified, the default master key will be used. If there is no such a default master key, OBS will create one and use it by default.

**Table 7** ExtensionGrant
Parameter	Type	Description	Description
granteeId	str	No	Explanation: Account (domain) ID of the grantee Value range: To obtain the account ID, see How Do I Get My Account ID and IAM User ID? (SDK for Python) Default value: None
permission	str	No	Explanation: Granted permissions Default value: None

**Table 8** Permission
Constant	Description
READ	Read permission A grantee with this permission for a bucket can obtain the list of objects, multipart uploads, bucket metadata, and object versions in the bucket. A grantee with this permission for an object can obtain the object content and metadata.
WRITE	Write permission A grantee with this permission for a bucket can upload, overwrite, and delete any object or part in the bucket. Such permission for an object is not applicable.
READ_ACP	Permission to read ACL configurations A grantee with this permission can obtain the ACL of a bucket or object. A bucket or object owner has this permission for the bucket or object permanently.
WRITE_ACP	Permission to modify ACL configurations A grantee with this permission can update the ACL of a bucket or object. A bucket or object owner has this permission for the bucket or object permanently. A grantee with this permission can modify the access control policy and thus the grantee obtains full access permissions.
FULL_CONTROL	Full control access, including read and write permissions for a bucket and its ACL, or for an object and its ACL. A grantee with this permission for a bucket has READ, WRITE, READ_ACP, and WRITE_ACP permissions for the bucket. A grantee with this permission for an object has READ, READ_ACP, and WRITE_ACP permissions for the object.

Responses

**Table 9** List of returned results
Type	Description
GetResult	Explanation: SDK common results

**Table 10** GetResult
Parameter	Type	Description
status	int	Explanation: HTTP status code Value range: A status code is a group of digits ranging from 2xx (indicating successes) to 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
reason	str	Explanation: Reason description. Default value: None
errorCode	str	Explanation: Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
errorMessage	str	Explanation: Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
requestId	str	Explanation: Request ID returned by the OBS server Default value: None
indicator	str	Explanation: Error indicator returned by the OBS server. Default value: None
hostId	str	Explanation: Requested server ID. If the value of status is less than 300, this parameter is left blank. Default value: None
resource	str	Explanation: Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank. Default value: None
header	list	Explanation: Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header. Default value: None
body	object	Explanation: Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python). Default value: None

**Table 11** GetResult.body
GetResult.body Type	Description
CompleteMultipartUploadResponse	Explanation: Response to the part assembling. For details, see Table 12.

**Table 12** CompleteMultipartUploadResponse
Parameter	Type	Description
etag	str	Explanation: The ETag that uniquely identifies the object after its parts were assembled, calculated based on the ETag of each part. Restrictions: If an object is encrypted using server-side encryption, the ETag is not the MD5 value of the object. Value range: The value must contain 32 characters. Default value: None
bucket	str	Explanation: Bucket in which parts are assembled Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None
key	str	Explanation: Object name obtained after part assembling. An object is uniquely identified by an object name in a bucket. An object name is a complete path that does not contain the bucket name. For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt. Value range: The value must contain 1 to 1,024 characters. Default value: None
location	str	Explanation: URL of the generated object after part assembling Example: https://example-Bucket.obs.regions.myhuaweicloud.com/example-Object Default value: None
versionId	str	Explanation: Version ID of the object obtained after part assembling Value range: The value must contain 32 characters. Default value: None
sseKms	str	Explanation: SSE-KMS algorithm Value range: kms Default value: None
sseKmsKey	str	Explanation: ID of the KMS master key when SSE-KMS is used Value range: Valid value formats are as follows: regionID:domainID:key/key_id key_id In the preceding formats: regionID indicates the ID of the region where the key is used. You can obtain it from Regions and Endpoints. domainID indicates the ID of the account that the key is for. To obtain it, see How Do I Get My Account ID and IAM User ID? (SDK for Python) key_id indicates the ID of the key created on Data Encryption Workshop (DEW). To obtain it, see Viewing a CMK. Default value: If this parameter is not specified, the default master key will be used. If there is no such a default master key, OBS will create one and use it by default.
sseC	str	Explanation: SSE-C algorithm Value range: AES256 Default value: None
sseCKeyMd5	str	Explanation: MD5 value of the key for encrypting objects when SSE-C is used. This value is used to check whether any error occurs during the transmission of the key. Restrictions: The value is encrypted by MD5 and then encoded by Base64, for example, 4XvB3tbNTN+tIEVa0/fGaQ==. Default value: None
objectUrl	str	Explanation: Full path to the obtained object after part assembling Default value: None
encoding_type	str	Explanation: Encoding type for Key in the response. If Key in the response contains control characters that are not supported by the XML 1.0 standard, you can specify this parameter to encode Key. Value range: url Default value: None. If you leave this parameter blank, encoding is not applied to Key.

Code Examples

This example uploads object localfile to bucket examplebucket using resumable upload.

    
     
       
       
         from obs import ObsClient
import os
import traceback

# Obtain an AK and SK pair using environment variables or import the AK and SK pair in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# (Optional) If you use a temporary AK and SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com"

# Create an obsClient instance.
# If you use a temporary AK and SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)

try:
    bucketName = "examplebucket"
    # Specify an object name (the name displayed after the file is uploaded to the bucket).
    objectKey = "objectname"
    # Specify the path of the file to be uploaded.
    uploadFile = 'localfile'
    # Specify the number of parts that can be concurrently uploaded.
    taskNum = 5
    # Specify the part size, in bytes. 10 MB is used as an example.
    partSize = 10 * 1024 * 1024
    # Enable the resumable upload by setting enableCheckpoint to True.
    enableCheckpoint = True
    # Upload the object using resumable upload.
    resp = obsClient.uploadFile(bucketName, objectKey, uploadFile, partSize, taskNum, enableCheckpoint, encoding_type='url')

    # If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.
    if resp.status < 300:
        print('Upload File Succeeded')
        print('requestId:', resp.requestId)
    else:
        print('Upload File Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Upload File Failed')
    print(traceback.format_exc())

        

      

    
   