S3 List Buckets | vCloud Director Object Storage Extension API

S3 List Buckets

API code: S3_LIST_BUCKETS
Pre-authorized role(s): TENANT_USER | TENANT_ADMIN

Request

URI

GET

https://{api_host}//api/v1/s3

COPY

Query Parameters

integer

offset

Optional

The start index of items to return for the current page.

integer

limit

Optional

The max count of items to return for the current page.

string

order

Optional

The sort spec of the collection. The value is of pattern 'property ASC|DESC'. Only single property order is supported.
Examples:

lastModifiedDate DESC
name ASC

string

filter

Optional

The RSQL expression to filter page results based on property comparison.
The logical operations include:

Logical AND ';' or 'and'
Logical OR ',' or 'or'

The comparison operations include:

Equal to '=='
Not equal to '!='
Less than '=lt=' or '<'
Less than or equal to '=le=' or '<='
Greater than operator '=gt=' or '>'
Greater than or equal to '=ge=' or '>='
In '=in='
Not in '=out='

The logic operations can be grouped by parentheses:

(..)
(..);(..)
(..),(..)

To know which property supports which filter operators, please refer to the type resource, e.g. /api/v1/types/bucket.
Date property value format must be ISO8601 compliant, e.g. yyyy-MM-ddTHH:mm:ss.SSSZ. When a timezone offset is presented with a plus (+) separator, the plus character must be encoded as %2D.
Examples:

lastModifiedDate<2018-10-14T02:36:08.262%2D0000
foo1=="value1" and foo2>value2
foo1=in=(value1,value2);foo2=out=(value3,value4,value5),foo3==value6*value7

Authentication

This operation uses the following authentication methods.

apiKeyAuth

Responses

200

Returns ListAllMyBucketsResult of type(s) application/json

{
    "owner": {
        "id": "string",
        "displayName": "string"
    },
    "buckets": [
        {
            "name": "string",
            "creationDate": "string"
        }
    ]
}

Owner

owner

Optional

owner

array of Bucket

buckets

Optional

buckets

On This Page

Description

Request

Query Parameters