List user buckets

Virtual Storage Platform One Object API Reference Guide

Version
3.0.x
File Size
270 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-01

You can retrieve a list of buckets owned by users of the VSP One Object system by user ID and bucket name. You can also filter the list to retrieve a subset.

Endpoint

POST /user/list_buckets

Request structure

{
  "id": "uuid",
  "count": [nnnn],
  "startingAfter": ["string"]
}
Parameter Type Description
id UUID The ID of the user.
count Integer The number of buckets to return. Up to 1000 buckets; default: 1000.
startingAfter String The bucket name to start after alphabetically. Leave blank to start from the beginning of the list. Use this parameter to retrieve bucket lists in groups.

Response structure

Note: If the user ID provided does not exist, the response is an empty list.
[
  {
    "bucketId": "",
    "bucketName": ""
  }
]

Parameter

Type

Description

bucketId UUID The UUID of the bucket.
bucketName String The display name of the bucket.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
400 Bad Request User ID not valid.
401 Unauthorized Access was denied because credentials are not valid.
404 Not Found The user ID can't be located.
405 Method Not Allowed The specified HTTP method is not allowed for user data. Resend using POST.