Uploading an Object - Resumable (SDK for C)

options

const obs_options*

Yes

Explanation:

The context of the requested bucket. Refer to Configuring option (SDK for C) to set the AK, SK, endpoint, bucket, timeout, and temporary credentials through obs_options.

Restrictions:

None

key

char *

Yes

Explanation:

Object name. An object name is a complete path that does not contain the bucket name.

For example, if the access path is examplebucket.obs.eu-west-101.myhuaweicloud.eu/folder/test.txt, the object name is folder/test.txt.

Restrictions:

The name of each object in a bucket must be unique.

Value range:

The value can contain 1 to 1,024 characters.

Default value:

None

upload_file_config

obs_upload_file_configuration *

Yes

Explanation:

Configuration of the file upload.

Restrictions:

None

encryption_params

server_side_encryption_params *

No

Explanation:

Encryption setting of the uploaded object

Restrictions:

None

handler

obs_upload_file_response_handler *

Yes

Explanation:

A callback structure where all members are pointers to callback functions, used to set the callback functions that handle response data. You can set a callback function to copy the response data from the server to your custom callback_data.

Restrictions:

None

callback_data

void *

No

Explanation:

Custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

bucket_options

obs_bucket_context

Yes

Explanation:

The context of the requested bucket. Refer to Configuring option (SDK for C) to set the AK, SK, endpoint, bucket, timeout, and temporary credentials through obs_options.

Restrictions:

None

request_options

obs_http_request_option

Yes

Explanation:

A callback structure where all members are pointers to callback functions, used to set the callback functions that handle response data. You can set a callback function to copy the response data from the server to your custom callback_data.

Restrictions:

None

temp_auth

temp_auth_configure*

No

Explanation:

Custom callback data.

Restrictions:

None

host_name

char *

Yes

Explanation:

The requested host name, used as an address for connecting to OBS. It is the domain name (the endpoint) of the server where the requested resource is stored.

Example: host_name = "obs.eu-west-101.myhuaweicloud.eu";

Restrictions:

The value does not need to contain http:// or https:// as a prefix, which is controlled using obs_protocol.

Default value:

None

bucket_name

char *

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 a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
• If you repeatedly create buckets with 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

useCname

bool

No

Explanation:

Whether to use a custom domain name to access OBS.

Restrictions:

None

Value range:

true: A custom domain name is used.

false: A custom domain name is not used.

Default value:

false

protocol

obs_protocol

No

Explanation:

Whether to use the HTTP or HTTPS protocol.

Restrictions:

None

Value range:

For details, see obs_protocol.

Default value:

OBS_PROTOCOL_HTTPS (HTTPS is used by default.)

access_key

char *

Yes

Explanation:

Access key ID (AK).

Restrictions:

None

Value range:

For details, see 3.

Default value:

None

secret_access_key

char *

Yes

Explanation:

Secret access key (SK).

Restrictions:

None

Value range:

For details, see 3.

Default value:

None

storage_class

obs_storage_class

No

Explanation:

Bucket storage class that can be specified at bucket creation.

Restrictions:

None

Value range:

See obs_storage_class.

Default value:

OBS_STORAGE_CLASS_STANDARD (Standard storage class)

token

char *

No

Explanation:

The security token in temporary credentials.

Restrictions:

None

Value range:

For details, see 3.

Default value:

None

epid

char *

No

Explanation:

Enterprise project ID that can be specified during bucket creation. If you have enabled EPS, you can obtain the project ID from the EPS console.

Restrictions:

The value needs to be represented as a UUID. This parameter is not required if EPS is not enabled.

Example: 9892d768-2d13-450f-aac7-ed0e44c2585f

Default value:

None

OBS_STORAGE_CLASS_STANDARD

Standard storage class.

This class 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.

OBS_STORAGE_CLASS_STANDARD_IA

Infrequent Access storage class.

Used for storing data that is semi-frequently accessed (fewer than 12 times a year) but becomes instantly available when needed.

OBS_STORAGE_CLASS_GLACIER

Archive storage class.

Used for storing rarely accessed (once a year) data.

OBS_PROTOCOL_HTTPS

HTTPS is used for access.

OBS_PROTOCOL_HTTP

HTTP is used for access.

OBS_BUCKET_OBJECT

Object bucket

OBS_BUCKET_LIST_ALL

Lists all buckets.

OBS_BUCKET_LIST_OBJECT

Lists all object buckets.

connect_time

int

Yes

Explanation:

Timeout period for establishing an HTTP/HTTPS connection, in ms.

Restrictions:

None

Value range:

[10000, 60000]

Default value:

60000

max_connected_time

int

Yes

Explanation:

Timeout period (in seconds) of a request.

Restrictions:

None

Value range:

None

Default value:

0 (There is never automatic disconnection.)

proxy_auth

char*

No

Explanation:

Proxy authentication information, in the format username:password

Restrictions:

None

Value range:

None

Default value:

None

proxy_host

char*

No

Explanation:

IP address or host name of the proxy server.

Restrictions:

None

Value range:

None

Default value:

None

expires

long long int

Yes

Explanation:

Validity period of the temporary credentials, in seconds.

Restrictions:

None

Value range:

[0-630720000]

Default value:

None

temp_auth_callback

void(*temp_auth_callback)(char *temp_auth_url,

uint64_t temp_auth_url_len,

char*temp_auth_headers,

uint64_t temp_auth_headers_len,

void*callback_data)

Yes

Explanation:

The pointer to the custom callback function, which is used to record the temporary URL and involved signature header to the custom callback data.

Restrictions:

None

callback_data

void *

Yes

Explanation:

Custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

temp_auth_url

char *

Yes

Explanation:

Temporary URL. OBS allows you to construct a URL for a specific operation. In such a URL, you use Query parameters to provide authentication information including the user AK, signature, and validity period. Anyone who has the URL can perform the specified operation. After receiving a request made using such a URL, OBS treats the requester as the user who issued the URL and processes the request. For example, if you construct a pre-signed URL for downloading an object and provide it to various users, they can use the URL to download the object without authentication, but they must do so within the validity period specified by the Expires parameter.

Restrictions:

None

Value range:

None

Default value:

None

temp_auth_url_len

uint64_t

Yes

Explanation:

Length of the temporary URL.

Restrictions:

None

Value range:

None

Default value:

None

temp_auth_headers

char *

Yes

Explanation:

Headers for temporary authentication.

Restrictions:

None

Value range:

None

Default value:

None

temp_auth_headers_len

uint64_t

Yes

Explanation:

Number of temporary authentication headers.

Restrictions:

None

Value range:

None

Default value:

None

callback_data

void *

Yes

Explanation:

Custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

upload_file

char *

Yes

Explanation:

Path of the local file to be uploaded.

Restrictions:

None

Value range:

None

Default value:

None

part_size

uint64_t

No

Explanation:

Part size, in bytes

Restrictions:

None

Value range:

100 KB to 5 GB

Default value:

5 MB

check_point_file

char *

No

Explanation:

Path of the file that records the upload progress. This parameter is effective only in the resumable mode. If the value of this parameter is left blank, the file will be in the same directory as the local file to be uploaded.

Restrictions:

None

Value range:

None

Default value:

None

enable_check_point

int

No

Explanation:

Whether to enable the resumable mode

Restrictions:

None

Value range:

• 0: The resumable mode is disabled. In this case, this API works as a multipart upload API, and no checkpoint files are generated.
• 1: The resumable mode is enabled.

Default value:

0: disabled

task_num

int

No

Explanation:

Maximum number of parts that can be uploaded concurrently

Restrictions:

None

Value range:

None

Default value:

1

pause_upload_flag

int *

No

Explanation:

Flag indicating that the upload is paused.

Restrictions:

The value cannot be NULL. If the value is 1, the upload is paused.

Value range:

None

Default value:

None

put_properties

obs_put_properties *

Yes

Explanation:

Object properties.

Restrictions:

None

content_type

char *

Yes

Explanation:

It specifies the file type of an object when it is downloaded.

Restrictions:

None

Value range:

See the Content-Type values defined in HTTP.

Default value:

None

md5

char *

Yes

Explanation:

Indicates the base64-encoded digest of the object data. It is provided for the OBS server to verify data integrity. The OBS server will compare this MD5 value with the MD5 value calculated based on the object data. If the two values are not the same, HTTP status code 400 is returned.

Restrictions:

The MD5 value of the object must be Base64 encoded. If the MD5 value is not specified, the OBS server will not verify the MD5 value of the object.

Value range:

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

Example: n58IG6hfM7vqI4K0vnWpog==

Default value:

None

cache_control

char *

Yes

Explanation:

It specifies the cache behavior of the web page when an object is downloaded.

Restrictions:

None

Value range:

See the Cache-Control values defined in HTTP.

Default value:

None

content_disposition_filename

char *

Yes

Explanation:

It specifies the name of an object when it is downloaded. For example, if the value is set to test.txt, that is equivalent to adding the Content-Disposition: attachment; filename=test.txt header.

Restrictions:

None

Value range:

See the Content-Disposition values defined in HTTP.

Default value:

None

content_encoding

char *

Yes

Explanation:

It specifies the content encoding format when an object is downloaded.

Restrictions:

None

Value range:

See the Content-Encoding values defined in HTTP.

Default value:

None

website_redirect_location

char *

Yes

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.

To another object in the same bucket:

x-obs-website-redirect-location:/anotherPage.html

To an external URL:

x-obs-website-redirect-location:http://www.example.com/

Restrictions:

The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.

Value range:

None

Default value:

None

get_conditions

obs_get_conditions *

No

Explanation:

Specifies a series of parameters for copying an object.

Restrictions:

None

start_byte

uint64_t

No

Explanation:

Where the copy starts in the object

Restrictions:

None

Value range:

0 (included) to the object length minus 1 (not included), in bytes

Default value:

0 (The copy starts from the first byte of the object.)

byte_count

uint64_t

No

Explanation:

Specifies the copy length.

Restrictions:

• The value must be an integer greater than 0.
• If the sum of start_byte and byte_count is greater than the object length minus 1, the object length minus 1 is used. The unit is byte.

Value range:

None

Default value:

None

upload_limit

uint64_t

No

Explanation:

Bandwidth limit for single connection requests.

Restrictions:

None

Value range:

819200 to 838860800, in bit/s

Default value:

None

expires

int64_t

No

Explanation:

Specifies the cache expiration time of the web page when the object is downloaded.

Restrictions:

None

Value range:

None

Default value:

None

obs_expires

int64_t

No

Explanation:

Specifies when an object expires. It is measured in days. Once the object expires, it is automatically deleted.

Restrictions:

The value must be greater than the number of days that have passed since the object was created. For example, if the object was uploaded 10 days ago, you must specify a value greater than 10.

Value range:

The value is an integer greater than 0.

Default value:

None

canned_acl

obs_canned_acl

No

Explanation:

Access control policy

Restrictions:

None

Value range:

For details, see obs_canned_acl.

az_redundancy

obs_az_redundancy

No

Explanation:

Specifies a series of parameters for copying an object.

Restrictions:

None

Value range:

For details, see obs_az_redundancy.

meta_data_count

int

No

Explanation:

Number of elements in the meta_data array.

Restrictions:

None

Value range:

None

Default value:

None

meta_data

obs_name_value*

No

Explanation:

Custom metadata of the object. OBS allows you to use custom metadata to manage objects. When you retrieve or query the metadata of the object, the added custom metadata headers will be returned in the response.

Restrictions:

• If a request carries this header field, the response message must contain this header field.
• The total size of all custom metadata cannot exceed 8 KB. To measure the size, calculate the sum of bytes of all UTF-8 encoded keys and values.
• The custom metadata keys are case-insensitive, but are stored in lowercase by 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.

metadata_action

metadata_action_indicator

No

Explanation:

Metadata operation directive.

Restrictions:

None

Value range:

For details, see metadata_action_indicator.

server_callback

obs_upload_file_server_callback

No

Explanation:

Parameters related to server callback.

Restrictions:

None

OBS_CANNED_ACL_PRIVATE

Private read and write. A bucket or object can only be accessed by its owner.

OBS_CANNED_ACL_PUBLIC_READ

Public read and private write. If this permission is granted on a bucket, anyone can read the object list, multipart tasks, metadata, and object versions in the bucket.

If this permission is set for an object, everyone can obtain the content and metadata of the object.

OBS_CANNED_ACL_PUBLIC_READ_WRITE

Public read and write. If this permission is set for a bucket, everyone can obtain the object list in the bucket, multipart uploads in the bucket, metadata of the bucket; upload objects; delete objects; initialize multipart uploads; upload parts; combine parts; copy parts; and abort multipart uploads.

If this permission is set for an object, everyone can obtain the content and metadata of the object.

OBS_CANNED_ACL_PUBLIC_READ_DELIVERED

Public read on a bucket and its objects. If this permission is granted on a bucket, anyone can read the object list, multipart tasks, and bucket metadata, and can also read the content and metadata of the objects in the bucket.

This permission cannot be granted on objects.

OBS_CANNED_ACL_PUBLIC_READ_WRITE_DELIVERED

Public read and write on a bucket and its objects. If this permission is granted on a bucket, anyone can read the object list, multipart uploads, and bucket metadata, 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 the objects in the bucket.

This permission cannot be granted on objects.

OBS_REDUNDANCY_1AZ

By default, a single-AZ bucket is created.

OBS_REDUNDANCY_3AZ

A 3-AZ bucket is created.

start_byte

uint64_t

No

Explanation:

Start position for object download.

Restrictions:

None

Value range:

0 (included) to the object length minus 1 (not included), in bytes

Default value:

0 (indicating that the download starts from the first byte of the object)

byte_count

uint64_t

No

Explanation:

Specifies the length to be downloaded.

Restrictions:

• The value must be an integer greater than 0.
• If the sum of start_byte and byte_count is greater than the object length minus 1, the object length minus 1 is used. The unit is byte.

Value range:

None

Default value:

None

download_limit

uint64_t

No

Explanation:

Bandwidth limit for single connection requests.

Restrictions:

None

Value range:

819200 to 838860800, in bit/s

Default value:

None

if_modified_since

int64_t

No

Explanation:

The request succeeds if the object has been modified since the specified time; otherwise, an error is returned.

Restrictions:

None

Value range:

None

Default value:

None

if_not_modified_since

int64_t

No

Explanation:

The request succeeds if the object has not been modified since the specified time; otherwise, an error is returned.

Restrictions:

None

Value range:

None

Default value:

None

if_match_etag

char *

No

Explanation:

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

Restrictions:

None

Value range:

The value must contain 32 characters.

Default value:

None

if_not_match_etag

char *

No

Explanation:

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

Restrictions:

None

Value range:

The value must contain 32 characters.

Default value:

None

image_process_config

image_process_configure *

No

Explanation:

Image processing parameters.

Restrictions:

None

OBS_NO_METADATA_ACTION

Default invalid value.

OBS_REPLACE

Uses the complete header carried in the current request to replace the original one and deletes the metadata that is not specified.

OBS_REPLACE_NEW

The metadata that has an existing value is replaced. A value is assigned to the metadata that does not have a value. The metadata that is not specified remains unchanged. Custom metadata is replaced.

callback_url

char *

Yes

Explanation:

After an object is uploaded successfully, OBS sends a callback request to the URL using the POST method.

You can specify a maximum of 10 URLs. Use semicolons (;) to separate URLs.

URL-encoding is required.

Restrictions:

None

Value range:

None

Default value:

None

callback_host

char *

No

Explanation:

Value of the host header in the callback request. If this parameter is not specified, the value of host parsed from the callbackUrl parameter is used.

Restrictions:

None

Value range:

None

Default value:

None

callback_body_type

char *

No

Explanation:

Value of the Content-Type header in the callback request. application/x-www-form-urlencoded and application/json are supported. If this parameter is not specified, the default value is as follows:

application/json

Restrictions:

None

Value range:

None

Default value:

None

image_process_mode

image_process_mode_type

No

Explanation:

Image processing parameters.

Restrictions:

None

Value range:

For details, see image_process_mode_type.

cmds_stylename

char *

No

Explanation:

Image processing parameters.

Restrictions:

None

Value range:

None

Default value:

None

obs_image_process_invalid_mode

Default invalid value.

obs_image_process_cmd

Image processing parameters start with image.

obs_image_process_style

Image processing parameters start with style.

encryption_type

obs_encryption_type

No

Explanation:

Encryption type.

Restrictions:

None

Value range:

For details, see obs_encryption_type.

kms_server_side_encryption

char *

No

Explanation:

Indicates that SSE-KMS is used for server-side encryption.

Restrictions:

None

Value range:

• kms
• AES256

Default value:

None

kms_key_id

char *

No

Explanation:

Key ID. If the SSE-KMS encryption is used with a specified key, the key ID is required.

Restrictions:

This header can only be used when you specify kms for the kms_server_side_encryption header.

Value range:

To obtain the key ID, see Viewing a CMK.

Default value:

If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.

ssec_customer_algorithm

char *

No

Explanation:

Indicates the algorithm used to encrypt an object.

Restrictions:

The header is used only in SSE-C mode.

Value range:

AES256 (AES256 encryption algorithm)

Default value:

None

ssec_customer_key

char *

No

Explanation:

Indicates the key used to encrypt an object.

Restrictions:

The header is used only in SSE-C mode.

Value range:

Base64-encoded 256-bit key

Default value:

None

des_ssec_customer_algorithm

char *

No

Explanation:

Indicates the algorithm used to decrypt a source object.

Restrictions:

The header is used only in SSE-C mode.

Value range:

None

Default value:

None

des_ssec_customer_key

char *

No

Explanation:

Indicates the key used to decrypt the source object.

Restrictions:

The header is used only in SSE-C mode.

Value range:

None

Default value:

None

OBS_ENCRYPTION_KMS

Use the KMS encryption.

OBS_ENCRYPTION_SSEC

Use the SSE-C encryption.

response_handler

obs_response_handler *

Yes

Explanation:

Response callback function structure.

Restrictions:

None

upload_file_callback

obs_upload_file_callback *

Yes

Explanation:

The pointer to the callback function, where the callback parameters can be recorded in callback_data (custom callback data).

Restrictions:

None

progress_callback

obs_progress_callback *

Yes

Explanation:

Pointer to the progress callback function.

Restrictions:

None

status

obs_status

Yes

Explanation:

Request status

Restrictions:

None

Value range:

For details, see obs_status.

result_message

char *

Yes

Explanation:

Upload result

Restrictions:

None

Value range:

None

Default value:

None

part_count_return

int

Yes

Explanation:

Number of parts.

Restrictions:

None

Value range:

None

Default value:

None

upload_info_list

obs_upload_file_part_info *

Yes

Explanation:

Part information.

Restrictions:

None

callback_data

void *

Yes

Explanation:

The pointer to the custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

part_num

obs_response_handler *

Yes

Explanation:

Part number

Restrictions:

None

start_byte

uint64_t

Yes

Explanation:

Start position of part creation.

Restrictions:

None

Value range:

None

Default value:

None

part_size

uint64_t

Yes

Explanation:

Part size.

Restrictions:

None

Value range:

None

Default value:

None

status_return

part_upload_status

Yes

Explanation:

Part status.

Restrictions:

None

Value range:

For details, see part_upload_status.

UPLOAD_NOTSTART

The upload has not started.

UPLOADING

Uploading.

UPLOAD_FAILED

The upload fails.

UPLOAD_SUCCESS

The file is uploaded.

STATUS_BUTT

Default status.

progress

double

Yes

Explanation:

Progress percentage.

Restrictions:

None

Value range:

None

Default value:

None

uploadedSize

uint64_t

Yes

Explanation:

Number of bytes that have been uploaded.

Restrictions:

None

Value range:

None

Default value:

None

fileTotalSize

uint64_t

Yes

Explanation:

Total number of bytes to be uploaded.

Restrictions:

None

Value range:

None

Default value:

None

callback_data

void *

Yes

Explanation:

The pointer to the custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

properties_callback

obs_response_properties_callback *

Yes

Explanation:

The pointer to the response callback function. The content of properties in the callback can be recorded in callback_data (custom callback data).

Restrictions:

None

complete_callback

obs_response_complete_callback *

Yes

Explanation:

The pointer to the completion callback function. The content of obs_status and obs_error_details in the callback can be recorded in callback_data (custom callback data).

Restrictions:

None

properties

const obs_response_properties*

Yes

Explanation:

Parameters in the response headers. You are advised to record them to callback_data (custom callback data).

Restrictions:

None

callback_data

void *

Yes

Explanation:

The pointer to the custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

status

obs_status

Yes

Explanation:

Internal request status code of the SDK.

Restrictions:

None

Value range:

For details, see obs_status.

error_details

const obs_error_details*

Yes

Explanation:

The pointer to the response callback function. The content of properties in the callback can be recorded in callback_data (custom callback data).

Restrictions:

None

callback_data

void *

Yes

Explanation:

The pointer to the custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

request_id

const char *

No

Explanation:

The value created by OBS to uniquely identify the request. OBS uses this value to locate the fault.

Restrictions:

None

Value range:

None

Default value:

None

request_id2

const char *

No

Explanation:

A special symbol that helps troubleshoot.

Restrictions:

None

Value range:

None

Default value:

None

content_type

const char *

No

Explanation:

MIME type of the object. MIME type is a standard way of describing a data type and is used by the browser to decide how to display data.

Restrictions:

None

Value range:

None

Default value:

None

content_length

uint64_t

No

Explanation:

The size (in bytes) of the response body.

Restrictions:

None

Value range:

None

Default value:

None

server

const char *

No

Explanation:

Server header in an HTTP request.

Restrictions:

None

Value range:

None

Default value:

None

etag

const char *

No

Explanation:

Base64-encoded, 128-bit MD5 value of an object. It uniquely identifies the content of an object and can be used to check the object integrity. For example, if the ETag is A when an object is uploaded and is B when the object is downloaded, it indicates that the object content has been changed. The ETag reflects changes to the contents of the object, not its metadata. An object created by an upload or copy operation 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

expiration

const char *

No

Explanation:

Expiration details of the object.

Restrictions:

None

Value range:

An integer greater than 0, in days.

Default value:

None

website_redirect_location

const char *

No

Explanation:

Indicates where an object request is redirected. If the bucket that contains the object is configured with Website settings, this parameter can be set in the object metadata so that the request for the object can be redirected to another object in the same bucket or an external URL after the website returns a 301 redirect response.

To another object in the same bucket:

x-obs-website-redirect-location:/anotherPage.html

To an external URL:

x-obs-website-redirect-location:http://www.example.com/

OBS obtains the specified value from the header and stores it in the object metadata WebsiteRedirectLocation.

Restrictions:

• The value must start with a slash (/), http://, or https:// and cannot exceed 2 KB.
• OBS only supports redirection of objects that are in the root directory.

Default value:

None

version_id

const char *

No

Explanation:

Object version ID. If the object has no version ID, the value is NULL.

Restrictions:

The value must contain 32 characters.

Value range:

None

Default value:

None

meta_data_count

int

No

Explanation:

Number of elements in the meta_data array.

Restrictions:

None

Value range:

None

Default value:

None

meta_data

const obs_name_value *

No

Explanation:

Custom metadata of the object. You can add custom metadata headers that start with x-obs-meta- for easy object management. When you retrieve or query the metadata of the object, the added custom metadata headers will be returned in the response.

Restrictions:

None

use_server_side_encryption

char

No

Explanation:

If server-side encryption is enabled, this parameter is set to '\1'.

Restrictions:

None

Value range:

None

Default value:

None

allow_origin

const char *

No

Explanation:

Returned if the request origin meets the CORS configured on the server.

Restrictions:

None

Value range:

The value that complies with the CORS

Default value:

None

allow_headers

const char *

No

Explanation:

Returned if the request headers meet the CORS configured on the server.

Restrictions:

At most one asterisk (*) is allowed. Spaces, ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.

Value range:

The value that complies with the CORS

Default value:

None

max_age

const char *

No

Explanation:

MaxAgeSeconds in the CORS rules of the bucket. It specifies the time your client can cache the response for a cross-origin request.

Restrictions:

Each CORS rule can contain at most one MaxAgeSeconds.

Value range:

An integer greater than or equal to 0, in seconds.

Default value:

3000

allow_methods

const char *

No

Explanation:

Indicates that methods in the rule are included in the response if Access-Control-Request-Method in the request meets the CORS configuration requirements when CORS is configured for buckets.

Restrictions:

None

Value range:

• GET
• PUT
• HEAD
• POST
• DELETE

Value range:

None

expose_headers

const char *

No

Explanation:

ExposeHeader in the CORS rules of the bucket. It specifies additional headers allowed in the response by a CORS rule. These headers provide extra information to clients. By default, a browser can access only headers Content-Length and Content-Type. If the browser needs to access other headers, you need to configure them as additional headers.

Restrictions:

Spaces, asterisks (*), ampersands (&), colons (:), less-than signs (<), and full-width characters are not allowed.

Value range:

None

Default value:

None

storage_class

const char *

No

Explanation:

Object storage class.

Restrictions:

This header is returned only when the storage class of an object is not Standard.

Value range:

• WARM (Infrequent Access storage class)
• COLD (Archive storage class)

Default value:

None

server_side_encryption

const char *

No

Explanation:

The encryption method used by the server.

Example: x-obs-server-side-encryption:kms

Restrictions:

This header is included in a response if SSE-KMS is used.

Value range:

• kms (SSE-KMS encryption)

Default value:

None

kms_key_id

const char *

No

Explanation:

Key ID. If the SSE-KMS encryption is used with a specified key, the key ID is required.

Restrictions:

This header can only be used when you specify kms for the server_side_encryption header.

Value range:

To obtain the key ID, see Viewing a CMK.

Default value:

If you specify kms for encryption but do not specify a key ID, the default master key will be used. If there is not a default master key, OBS will create one and use it.

customer_algorithm

const char *

No

Explanation:

Indicates a decryption algorithm. This header is included in a response if SSE-C is used.

Restrictions:

None

Value range:

AES256 (AES256 decryption algorithm)

Default value:

None

customer_key_md5

const char *

No

Explanation:

Indicates the MD5 value of a key used to decrypt objects. This header is included in a response if SSE-C is used.

Restrictions:

Base64-encoded MD5 value of the key, for example, 4XvB3tbNTN+tIEVa0/fGaQ==.

Value range:

Base64-encoded MD5 value of the key ID.

Default value:

None

bucket_location

const char *

No

Explanation:

Indicates the region where the bucket resides.

Restrictions:

None

Value range:

None

Default value:

None

obs_version

const char *

No

Explanation:

OBS version of the bucket.

Restrictions:

None

Value range:

• 3.0: bucket of the latest version
• --: bucket of an earlier version

Default value:

None

restore

const char *

No

Explanation:

Restoration status of an object.

Examples: ongoing-request="true" (the object is being restored); ongoing-request="false", expiry-date="Wed, 7 Nov 2012 00:00:00 GMT" (the object has been restored) expiry-date indicates when the restored object will expire.

Restrictions:

This header is returned only for an Archive or Deep Archive object that is being restored or has been restored.

Value range:

None

Default value:

None

obs_object_type

const char *

No

Explanation:

Type of the object.

Restrictions:

This header is returned only when the object is not a Normal object.

Value range:

Appendable

Default value:

None

obs_next_append_position

const char *

No

Explanation:

Indicates the position to be provided for the next request.

Restrictions:

This header is returned only when the object is an Appendable object.

Value range:

None

Default value:

None

obs_head_epid

const char *

No

Explanation:

Enterprise project ID for the current bucket. Users who have enabled the enterprise project function can obtain the ID from the enterprise project service.

Restrictions:

The value is a UUID. This parameter is not required if you have not enabled an enterprise project.

Value range:

None

Default value:

None

reserved_indicator

const char *

No

Explanation:

A special symbol that helps troubleshoot.

Restrictions:

None

Value range:

None

Default value:

None

message

const char*

Explanation:

Error details in the XML error response body.

Restrictions:

None

Value range:

See Error Codes.

Default value:

None

resource

const char*

Explanation:

Bucket or object related to the error.

Restrictions:

None

Value range:

None

Default value:

None

further_details

const char*

Explanation:

The value of the FurtherDetails element in the XML error response body.

Restrictions:

None

Value range:

None

Default value:

None

extra_details_count

int

Explanation:

The number of other elements in the XML error response body.

Restrictions:

None

Value range:

None

Default value:

None

extra_details

obs_name_value*

Explanation:

Values of other elements in the XML error response body.

Restrictions:

None

error_headers_count

int

Explanation:

Number of headers in error_headers.

Restrictions:

None

Value range:

None

Default value:

None

error_headers

char**

Explanation:

All response headers that contain the error.

Restrictions:

None

Value range:

None

Default value:

None

name

char *

No

Explanation:

Key of a property.

Restrictions:

None

Value range:

None

Default value:

None

value

char *

No

Explanation:

Property value.

Restrictions:

None

Value range:

None

Default value:

None

OBS_STATUS_OK

The request is successful.

OBS_STATUS_InitCurlFailed

Failed to initialize curl.

OBS_STATUS_InternalError

Internal error.

OBS_STATUS_OutOfMemory

The local memory is insufficient.

OBS_STATUS_FailedToIInitializeRequest

Failed to initialize the request.

OBS_STATUS_ConnectionFailed

Network connection failed.

OBS_STATUS_XmlParseFailure

Failed to parse the XML file.

OBS_STATUS_NameLookupError

Domain name resolution failed.

OBS_STATUS_FailedToConnect

Failed to connect to the server.

OBS_STATUS_PartialFile

Network transmission.

OBS_STATUS_InvalidParameter

Invalid parameter.

OBS_STATUS_NoToken

The current number of concurrent tasks exceeds the maximum number (1000 by default). Use the set_online_request_max_count function to adjust the maximum number of concurrent tasks.

OBS_STATUS_OpenFileFailed

Failed to open the file.

OBS_STATUS_AccessDenied

The request is rejected.

OBS_STATUS_MalformedPolicy

The format of the request policy is incorrect.

OBS_STATUS_MalformedXML

The XML request format is incorrect.

OBS_STATUS_MethodNotAllowed

The request method is not allowed.

OBS_STATUS_SignatureDoesNotMatch

The signatures do not match. Check whether the AK, SK, and token are correct.

OBS_STATUS_ServiceUnavailable

Server exception.

OBS_STATUS_SlowDown

The request frequency is too high.