Help Center/ Object Storage Service/ SDK Reference/ Python/ Object-Related APIs (SDK for Python)/ Uploading an Object - File-Based (SDK for Python)
Updated on 2024-11-26 GMT+08:00
View PDF

Uploading an Object - File-Based (SDK for Python)

Function

This API uploads local files to OBS over the Internet. These files can be texts, images, videos, or any other type of files.

  • OBS does not involve folders like in a file system. All elements stored in OBS buckets are objects. To create a folder in OBS is essentially to create an object whose size is 0 and whose name ends with a slash (/). You can perform download, delete, or other operations on such objects as you do on ordinary objects.
  • If versioning is enabled, when uploading an object, OBS automatically allocates a unique version ID for the object. Objects with the same name are stored in OBS as objects with different version IDs. If versioning is not enabled, when uploading an object to a folder where there is already an object with the same name, the new object will overwrite the existing one.
  • You can pass user-defined headers in extensionHeaders in a dictionary. For details, see User-defined Header (SDK for Python).

Restrictions

Method

ObsClient.putFile(bucketName, objectKey, file_path, metadata, headers, progressCallback, extensionHeaders)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

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.eu-west-101.myhuaweicloud.eu/folder/test.txt, the object name is folder/test.txt.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

file_path

str

Yes

Explanation:

Full path of the file or folder to be uploaded, for example, aa/bb.txt or aa/.

Default value:

None

NOTE:

If file_path is a folder, contentLength, md5, and contentType in headers cannot take effect.

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

headers

PutObjectHeader

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

progressCallback

callable

No

Explanation:

Callback function for obtaining the upload progress

Restrictions:

The progress of a folder upload cannot be obtained.

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).

Upload progress callback only supports streaming, file-based, multipart, appendable, and resumable uploads.

extensionHeaders

dict

No

Explanation:

Extension headers.

Value range:

See User-defined Header (SDK for Python).

Default value:

None
Table 2 PutObjectHeader

Parameter

Type

Mandatory (Yes/No)

Description

md5

str

No

Explanation:

Base64-encoded MD5 value of the data to be uploaded. It is used for the OBS server to verify data integrity.

Value range:

Base64-encoded 128-bit MD5 value of the request body calculated according to RFC 1864

Example: n58IG6hfM7vqI4K0vnWpog==

Default value:

None

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.

contentLength

int

No

Explanation:

Size of the object to be uploaded

Restrictions:

  • The object size in a single upload ranges from 0 to 5 GB.
  • To upload files larger than 5 GB, multipart uploads should be used.

Default value:

If this parameter is not specified, OBS SDK for Python automatically calculates the size of the object.

sseHeader

SseCHeader

or

SseKmsHeader

No

Explanation:

Server-side encryption header

Default value:

None

storageClass

str

No

Explanation:

Storage class of the object

Value range:

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:

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

Mandatory (Yes/No)

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

PutContentResponse

Explanation:

Response to the request for uploading an object. For details, see Table 12.

Default value:

None

If file_path is a folder, the returned result is a GetResult list.

Table 12 PutContentResponse

Parameter

Type

Description

storageClass

str

Explanation:

Storage class of the object

Value range:

  • If the storage class is Standard, leave this parameter blank.
  • For details about the available storage classes, see Table 4.

Default value:

None

versionId

str

Explanation:

Object version ID. If versioning is enabled for the bucket, the object version ID will be returned.

Value range:

The value must contain 32 characters.

Default value:

None

etag

str

Explanation:

ETag of an object, which is a base64-encoded 128-bit MD5 digest. ETag is the unique identifier of the object content. It can be used to determine whether the object content is changed. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, the object content is changed. The ETag reflects changes only to the contents of the object, not its metadata. An uploaded object or copied object has a unique ETag.

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

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:

  1. regionID:domainID:key/key_id
  2. key_id

In the preceding formats:

Default value:

  • If this parameter is not specified, the default master key will be used.
  • If there is no such a default master key, the system 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 object

Default value:

None

Code Example 1: Uploading a Single File

This example uploads a single file.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
from obs import ObsClient
from obs import PutObjectHeader
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/eu/usermanual-ca/ca_01_0003.html.
# Before running the sample code, ensure that the environment variables AccessKeyID and SecretAccessKey have been configured.
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. EU-Dublin is used here as an example. Replace it with the one in use.
server = "https://obs.eu-west-101.myhuaweicloud.eu" 

# 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:
    # Specify the additional headers of the request for uploading an object.
    headers = PutObjectHeader()
    # (Optional) Specify the MIME type of the object.
    headers.contentType = 'text/plain'
    bucketName = "examplebucket"
    # Specify an object name (the name displayed after the file is uploaded to the bucket).
    objectKey = "objectname"
    # Specify the full path of the file to be uploaded, for example, aa/bb.txt.
    file_path = 'localfile'
    # Specify the custom metadata of the object.
    metadata = {'meta1': 'value1', 'meta2': 'value2'}
    # Perform the file-based upload.
    resp = obsClient.putFile(bucketName, objectKey, file_path, metadata, headers)
    # If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.
    if resp.status < 300:
        print('Put File Succeeded')
        print('requestId:', resp.requestId)
        print('etag:', resp.body.etag)
        print('versionId:', resp.body.versionId)
        print('storageClass:', resp.body.storageClass)
    else:
        print('Put File Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Put File Failed')
    print(traceback.format_exc())

Code Example 2: Uploading a Folder

This example uploads all files in a folder. The putFile method does not support concurrent uploads. If you need to upload all files in a folder concurrently for better performance, see Code Example 3. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
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/eu/usermanual-ca/ca_01_0003.html.
# Before running the sample code, ensure that the environment variables AccessKeyID and SecretAccessKey have been configured.
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. EU-Dublin is used here as an example. Replace it with the one in use.
server = "https://obs.eu-west-101.myhuaweicloud.eu" 

# 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)

def out_put_res(resp, objectKey=None):
    if isinstance(resp, list):
        for res in resp:
            out_put_res(res)
    elif isinstance(resp, tuple) and isinstance(resp[1], list):
        out_put_res(resp[1])
    elif isinstance(resp, tuple):
        if resp[1].status < 300:
            print(f'Put File Succeeded, objectkey: {resp[0]}')
        else:
            print(f'Put File Failed, objectkey: {resp[0]}')
            print('requestId:', resp[1].requestId)
            print('errorCode:', resp[1].errorCode)
            print('errorMessage:', resp[1].errorMessage)
    else:
        if resp.status < 300:
            print(f'Put File Succeeded, objectkey: {objectKey}')
        else:
            print(f'Put File Failed, objectkey: {objectKey}')
            print('requestId:', resp.requestId)
            print('errorCode:', resp.errorCode)
            print('errorMessage:', resp.errorMessage)
try:
    bucketName = "examplebucket"
    # Specify a name for the uploaded folder. All files in the local folder are uploaded to this folder. Its name cannot end with a slash (/).
    objectKey = "folder"
    # Specify the full path of the folder to be uploaded, for example, aa/.
    folder_path = 'localfolder/'
    # Upload the folder.
    resp = obsClient.putFile(bucketName, objectKey, folder_path)
    # resp is a list of upload results of each file in the folder.
    out_put_res(resp, objectKey)
except:
    print('Put File Failed')
    print(traceback.format_exc())

Code Example 3: Uploading the Files in a Folder Concurrently

This example uploads all files in a folder concurrently. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
from obs import ObsClient
from concurrent.futures import ThreadPoolExecutor, as_completed
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/eu/usermanual-ca/ca_01_0003.html.
# Before running the sample code, ensure that the environment variables AccessKeyID and SecretAccessKey have been configured.
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. EU-Dublin is used here as an example. Replace it with the one in use.
server = "https://obs.eu-west-101.myhuaweicloud.eu" 

# 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)
folder_path = 'localfolder/'
bucketName = 'examplebucket'
# Specify a name for the uploaded folder. All files in the local folder are uploaded to this folder. Its name must end with a slash (/). If you want to upload files to the root directory, enter an empty string for the prefix, that is, prefix = ''.
prefix = 'testobs/'
ThreadNum = 20
g = os.walk(folder_path)
# Create a thread pool for upload.
pool = ThreadPoolExecutor(ThreadNum)
all_task = []
for path, dir_list, file_list in g:
    for file_name in file_list:
        srcKey = os.path.join(path, file_name)
        obsObjectKey = prefix + srcKey.split(folder_path)[1].replace('\\', '/')
        exists = False
        try:
            # (Optional) Check whether the file already exists on OBS based on the object name.
            # resp = obsClient.headObject(bucketName, obsObjectKey)
            # if resp.status < 300:
            #     exists = True
            # elif resp.status == 404:
            #     exists = False
            # else:
            #     print('Error happened, reupload it.')
            if not exists:
                print("File %s not exists in obs, upload it", srcKey)
                all_task.append(pool.submit(obsClient.putFile, bucketName, obsObjectKey, srcKey))
                # You are advised to use obsClient.uploadFile to upload large files. For details about the parameters, see the section about the API for resumable upload.
                # partSize = 9 * 1024 * 1024
                # taskNum = 10
                # enableCheckpoint = True
                # all_task.append(pool.submit(obsClient.uploadFile, bucketName, obsObjectKey, srcKey, partSize, taskNum, enableCheckpoint))
        except:
            print(traceback.format_exc())
for future in as_completed(all_task):
    put_resp = future.result()
    if put_resp.status < 300:
        print(f'Put File Succeeded, objectUrl: {put_resp.body.objectUrl}')
    else:
        print('Put File Failed')
        print('requestId:', put_resp.requestId)
        print('errorCode:', put_resp.errorCode)
        print('errorMessage:', put_resp.errorMessage)

Helpful Links