Help Center/ Object Storage Service/ SDK Reference/ C/ Parameters/ Request Parameters for Obtaining the Access Labels of an Object
Updated on 2026-08-03 GMT+08:00

Request Parameters for Obtaining the Access Labels of an Object

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

options

const obs_options *

Yes

Explanation:

Context of the requested bucket. You can set the AK, SK, endpoint, bucket, timeout interval, and temporary credentials through obs_options.

Restrictions:

None

Value range:

None

Default value:

None

key

char *

Yes

Explanation:

Name of a directory in a PFS

Restrictions:

The name of a directory stored in a PFS must be unique.

Value range:

The value can contain 1 to 1,024 characters.

Default value:

None

handler

Table 2*

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 callback_data (custom callback data).

Restrictions:

None

Value range:

None

Default value:

None

dir_access_labels

Access_label_data*

Yes

Explanation:

Data related to access labels.

Restrictions:

None

Value range:

None

Default value:

None

Table 2 get_access_label_handler

Parameter

Type

Mandatory (Yes/No)

Description

response_handler

obs_response_handler *

Yes

Explanation:

Response callback function structure.

Restrictions:

None

Value range:

None

Default value:

None

get_access_label_callback_impl

Table 3*

Yes

Explanation:

Pointer to the callback function, which is used to write the obtained access labels to the buffer.

Restrictions:

None

Value range:

None

Default value:

None

Table 3 get_access_label_callback

Parameter

Type

Mandatory (Yes/No)

Description

buffer_size

int

Yes

Explanation:

Length of the buffer.

Restrictions:

None

Value range:

None

Default value:

None

buffer

char *

Yes

Explanation:

Buffer for storing the obtained access labels.

Restrictions:

None

Value range:

None

Default value:

None

callback_data

void *

Yes

Explanation:

Pointer to the custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

Table 4 Access_label_data

Parameter

Type

Mandatory (Yes/No)

Description

labels

char[512][53]

Yes when calling set_access_label

Explanation:

Array for storing access labels.

Restrictions:

A single label can contain a maximum of 53 characters, and an array can contain a maximum of 512 labels.

Value range:

None

Default value:

None

labels_len

int

Yes when calling set_access_label. When calling get_access_label, this field will be returned by the SDK.

Explanation:

Number of access labels in the labels array.

Restrictions:

None

Value range:

[0, 512]

Default value:

None

json_str

char*

No

Explanation:

Access label data in JSON format.

Restrictions:

The value is automatically set by the SDK. You do not need to set it.

Value range:

None

Default value:

None

json_str_remain_size

int

No

Explanation:

Remaining available space size in json_str.

Restrictions:

None

Value range:

None

Default value:

None

json_current_offset

int

No

Explanation:

Current write offset in json_str.

Restrictions:

None

Value range:

None

Default value:

None

callback_data

void *

No

Explanation:

Custom callback data.

Restrictions:

None

Value range:

None

Default value:

None

status

obs_status

Returned by the SDK

Explanation:

Status code indicating that whether the request is successful.

Restrictions:

The value is automatically set by the SDK. You do not need to set it.

Value range:

For details, see Table 7.

Default value:

None