Help Center/ Object Storage Service/ SDK Reference/ C/ Parameters/ Request parameters for listing objects in a parallel file system
Updated on 2026-08-03 GMT+08:00

Request parameters for listing objects in a parallel file system

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.

prefix

char *

No

Prefix that the names of objects to list must contain.

marker

char *

No

Object name to start with when listing objects. All objects are listed in the lexicographical order.

delimiter

char *

No

The character used to group object names. If the object name contains the value specified by the delimiter parameter, the string from the first character to the first delimiter in the object name (excluding the prefix if prefix is specified) is grouped into one commonPrefix to be returned.

For a parallel file system, if this parameter is not specified, all the content in the directory is recursively listed by default, including the content in subdirectories. In big data scenarios, file systems usually have multiple directory levels with a huge number of objects. In this case, you are advised to configure [delimiter="/"] to list only the objects in the current directory with no subdirectories included, making your listing more efficient.

maxkeys

int

Yes

Maximum number of objects listed in the response body. The value ranges from 1 to 1000. If the value exceeds 1000, only 1,000 objects are returned.

handler

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