Bucket:Get Bucket Lock

Search (SHIFT+S)

Get Bucket Lock

GET /object/bucket/{bucketName}/lock

Gets lock information for the specified bucket. The current user's namespace is used.

bucketName	Name of the bucket for which lock information is to be retrieved

Query Parameters

namespace	Namespace associated

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR
NAMESPACE_ADMIN

Prerequisites

The following conditions must be met in order to call this operation.

Bucket must exist.

Response Body

Response contains lock information for the specified bucket.

Field	Description	Type	Notes
object_bucket_lock
bucket_name	Bucket name to be locked.	String
isLocked	Set to "true" for lock bucket and "false" for unlock bucket.	Boolean	Valid Values: true. false.

Examples

Request

GET https://192.168.0.0:4443/object/bucket/standalone-bucket/lock HTTP/1.1  

Concept-Type: application/xml 
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_bucket_lock>
    <bucket_name>standalone-bucket</bucket_name>
    <isLocked>false</isLocked>
</object_bucket_lock>

Request

GET https://192.168.0.0:4443/object/bucket/standalone-bucket/lock.json HTTP/1.1 

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK 
Content-Type: application/json 

{
    "bucket_name": "standalone-bucket",
    "isLocked": false
}

Request

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/object/bucket/standalone-bucket/lock

Response

HTTP/1.1 200 OK
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<object_bucket_lock>
    <bucket_name>standalone-bucket</bucket_name>
    <isLocked>false</isLocked>
</object_bucket_lock>