Help Center/ Object Storage Service/ SDK Reference/ C/ Parameters/ Request Parameters for a Resumable Upload
Updated on 2026-08-03 GMT+08:00

Request Parameters for a Resumable Upload

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

options

const obs_options *

Yes

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.

key

char *

Yes

Object name

upload_file_config

obs_upload_file_configuration *

Yes

For details about the configuration of the file to be uploaded, see the table below.

encryption_params

server_side_encryption_params *

No

Encryption setting of the uploaded object

handler

obs_upload_file_response_handler *

Yes

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.

callback_data

void *

No

Custom callback data.

The following table describes the obs_upload_file_configuration:

Table 2 obs_upload_file_configuration

Parameter

Type

Mandatory (Yes/No)

Description

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. The value ranges from 100 KB to 5 GB. The default value is 5 MB.

Restrictions:

None

Value range:

None

Default value:

None

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 transmission 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

Value range:

None

Default value:

None