Get bucket information
Get information about a subset of the existing buckets.
If uid is specified without bucket then all buckets belonging
to the user will be returned. If bucket alone is specified, information for that
particular bucket will be retrieved.
Capabilities
`buckets=read`Syntax
GET /admin/bucket?format=json HTTP/1.1
Host FULLY_QUALIFIED_DOMAIN_NAMERequest Parameters
bucket
- Description
-
The bucket to return info on.
- Type
-
String
- Example
-
foo_bucket - Required
-
No
uid
- Description
-
The user to retrieve bucket information for.
- Type
-
String
- Example
-
foo_user - Required
-
No
stats
- Description
-
Return bucket statistics.
- Type
-
Boolean
- Example
-
True [False]
- Required
-
No
Response Entities
stats
- Description
-
Per bucket information.
- Type
-
Container
- Parent
-
N/A
buckets
- Description
-
Contains a list of one or more bucket containers.
- Type
-
Container
- Parent
-
buckets
bucket
- Description
-
Container for single bucket information.
- Type
-
Container
- Parent
-
buckets
name
- Description
-
The name of the bucket.
- Type
-
String
- Parent
-
bucket
pool
- Description
-
The pool the bucket is stored in.
- Type
-
String
- Parent
-
bucket
id
- Description
-
The unique bucket ID.
- Type
-
String
- Parent
-
bucket
marker
- Description
-
Internal bucket tag.
- Type
-
String
- Parent
-
bucket
owner
- Description
-
The user ID of the bucket owner.
- Type
-
String
- Parent
-
bucket
usage
- Description
-
Storage usage information.
- Type
-
Container
- Parent
-
bucket
index
- Description
-
Status of bucket index.
- Type
-
String
- Parent
-
bucket
If successful, then the request returns a bucket’s container with the bucket information.
Special Error Responses
IndexRepairFailed
- Description
-
Bucket index repair failed.
- Code
-
409 Conflict