Request Parameters for Setting Access Labels for an Object
| 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 | 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 | Yes | Explanation: Data related to access labels. Restrictions: None Value range: None Default value: None |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| response_handler | Yes | Explanation: Response callback function structure. Restrictions: None Value range: None Default value: None | |
| put_access_label_callback_impl | Table 3 * | Yes | Explanation: Callback function pointer, which is used to copy the data to be uploaded to the data upload buffer. Restrictions: None Value range: None Default value: None |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| response_handler | Yes | Explanation: Response callback function structure. Restrictions: None Value range: None Default value: None | |
| put_access_label_callback_impl | Yes | Explanation: Callback function pointer, which is used to copy the data to be uploaded to the data upload buffer. Restrictions: None Value range: None Default value: None |
| 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 |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot