Copying an Object (SDK for Python)

sourceBucketName

str

Yes

Explanation:

Name of the source bucket

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

sourceObjectKey

str

Yes

Explanation:

Source 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

versionId

str

No

Explanation:

Version ID of the source object, for example, G001117FCE89978B0000401205D5DC9A

Value range:

The value must contain 32 characters.

Default value:

If this parameter is left blank, the latest version of the source object is copied.

destBucketName

str

Yes

Explanation:

Target 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 attributes comply with those set in the first creation request.

Default value:

None

destObjectKey

str

Yes

Explanation:

Target 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

metadata

dict

No

Explanation:

Custom metadata of the target object 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:

• You need to set directive in headers to REPLACE.
• 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 or decoded in URL or Base64 on the client, because the server does not perform such operations.

Default value:

None

headers

CopyObjectHeader

No

Explanation:

Request headers for copying an object. For details, see Table 2.

Default value:

None

acl

str

No

Explanation:

Pre-defined access control policies, which can be specified when copying the object

Default value:

None

directive

str

No

Explanation:

Whether to copy source object attributes to the target object

Value range:

• COPY (attributes of the target object are copied from the source object)
• REPLACE (attributes of the target object are replaced with values specified in the request parameters)

Default value:

COPY

if_match

str

No

Explanation:

Preset ETag. If the ETag of the object to be downloaded is the same as the preset ETag, the object is returned. Otherwise, an error is returned.

Value range:

The value must contain 32 characters.

Default value:

None

if_none_match

str

No

Explanation:

Preset ETag. If the ETag of the object to be downloaded is different from the preset ETag, the object is returned. Otherwise, an error is returned.

Value range:

The value must contain 32 characters.

Default value:

None

if_modified_since

str

or

DateTime

No

Explanation:

The source object is copied if it has been modified since the specified time; otherwise, an exception is thrown.

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 5 to specify time.

For example, DateTime(year=2023, month=9, day=12)

Default value:

None

if_unmodified_since

str

or

DateTime

No

Explanation:

The source object is copied if it has not been modified since the specified time; otherwise, an exception is thrown.

Restrictions:

The value must be in the GMT format. For example, Wed, 25 Mar 2020 02:39:52 GMT. You can refer to Table 5 to specify time.

For example, DateTime(year=2023, month=9, day=12)

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

destSseHeader

SseCHeader

or

SseKmsHeader

No

Explanation:

Header for server-side encryption. It is used to encrypt the target object.

Value range:

See Table 6 or Table 7.

Default value:

None

sourceSseHeader

SseCHeader

No

Explanation:

Header for server-side decryption. It is used to decrypt the source object.

Value range:

See Table 6.

Default value:

None

cacheControl

str

No

Explanation:

Cache-Control is rewritten in the response.

Default value:

None

contentDisposition

str

No

Explanation:

Content-Disposition is rewritten in the response.

Default value:

None

contentEncoding

str

No

Explanation:

Content-Encoding is rewritten in the response.

Default value:

None

contentLanguage

str

No

Explanation:

Content-Language is rewritten in the response.

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:

None

expires

str

No

Explanation:

Expiration details. Example: "expiry-date=\"Mon, 11 Sep 2023 00:00:00 GMT\""

Default value:

None

storageClass

str

No

Explanation:

Object storage class.

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

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

Value range:

See Table 8.

Default value:

None

PRIVATE

Private read/write

A bucket or object can only be accessed by its owner.

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.

PUBLIC_READ_WRITE

Public read/write

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 uploads, upload parts, merge parts, copy parts, and cancel multipart upload tasks.

If it is granted on an object, anyone can read the content and metadata of the object.

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.

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. You can also read the content and metadata of objects in the bucket.

BUCKET_OWNER_FULL_CONTROL

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.

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.

year

int

Explanation:

Year

Default value:

None

month

int

Explanation:

Month

Default value:

None

day

int

Explanation:

Day

Default value:

None

hour

int

Explanation:

Hour

Restrictions:

The value is in 24-hour format.

Default value:

0

min

int

Explanation:

Minute

Default value:

0

sec

int

Explanation:

Second

Default value:

0

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

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 belongs. You can obtain it from Regions and Endpoints.
• domainID indicates the ID of the account which the key belongs to. 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.

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

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, WRITE, READ_ACP, and WRITE_ACP permissions for the object.

GetResult

Explanation:

SDK common results

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, this parameter value 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

CopyObjectResponse

Explanation:

Response to the request for copying an object

lastModified

str

Explanation:

Time when the last modification was made to the target object

Value range:

UTC time

Default value:

None

etag

str

Explanation:

Base64-encoded, 128-bit MD5 value of an object. ETag is the unique identifier of the object contents and is used to determine whether the contents of an object are changed. For example, if the ETag value is A when an object is uploaded and is B when the object is downloaded, this indicates the contents of the object are changed. The ETag reflects changes only to the contents of an object, not its metadata. Objects created by the upload and copy operations have unique ETags after being encrypted using MD5.

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

copySourceVersionId

str

Explanation:

Version ID of the source object.

Value range:

The value must contain 32 characters.

Default value:

None

versionId

str

Explanation:

Version ID of the target object

Value range:

The value must contain 32 characters.

Default value:

None

sseKms

str

Explanation:

SSE-KMS is used for encrypting objects on the server side.

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:

• regionID indicates the ID of the region where the key belongs. You can obtain it from Regions and Endpoints.
• domainID indicates the ID of the account where the key belongs. 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:

Algorithm used to encrypt and decrypt objects with SSE-C

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