Skip to main content
A newer release of this product is available.

List all buckets

Contributors
PDFs

GET /accounts/{account_id}/topology/v1/buckets

Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.

Parameters

Name Type In Required Description

account_id

string

path

True

ID of the containing account resource

  • example: {{.Account}}

Response

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name Type Required Description

items

array[Any of: bucket_1.2_get_response_body, array[]]

True

metadata

type_astra_metadata_list

True
Example response 
{
  "type": "application/astra-buckets",
  "version": "1.2",
  "items": [
    [
      "4c753e39-25e9-4b36-a8de-69f168aa59cd",
      "Test Bucket",
      "gcp"
    ],
    [
      "d8fd585d-6429-4c08-a308-af193a88eac7",
      "Local",
      "ontap-s3"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters
Example response 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example response 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found
Name Type Required Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False
Example error response 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_stateDetails

Name Type Required Description

type

string

True

title

string

True

detail

string

True

s3

JSON object that provides Simple Storage Service (S3) protocol parameters. (Use this object for all S3 type providers).

Name Type Required Description

serverURL

string

True

JSON string containing a URL to the base path for the bucket. Defined values are:

  • Minimum length: 0

  • Maximum length: 1023

bucketName

string

True

JSON string containing the name of the S3 bucket. Defined values are:

  • Minimum length: 0

  • Maximum length: 63

gcp

JSON object that provides Google Cloud protocol parameters.

Name Type Required Description

bucketName

string

True

JSON string containing the name of the backing Google Cloud bucket name. Defined values are:

  • Minimum length: 0

  • Maximum length: 63

azure

JSON object that provides Azure protocol parameters.

Name Type Required Description

storageAccount

string

True

JSON string containing the Azure storage account name. Defined values are:

  • Minimum length: 0

  • Maximum length: 63

bucketName

string

True

JSON string containing the name of the backing Azure blob name. Defined values are:

  • Minimum length: 0

  • Maximum length: 63

bucketParameters

JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket differ per provider.

Name Type Required Description

s3

s3

False

JSON object that provides Simple Storage Service (S3) protocol parameters. (Use this object for all S3 type providers).

gcp

gcp

False

JSON object that provides Google Cloud protocol parameters.

azure

azure

False

JSON object that provides Azure protocol parameters.

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

Name Type Required Description

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

bucket_1.2_get_response_body

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-bucket"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

  • "1.2"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a user-assigned name for the bucket. Defined values are:

  • Minimum length: 1

  • Maximum length: 256

credentialID

string

True

JSON string containing the identifier of the credentials used to access the bucket. Defined values are:

  • Conforms to the Astra Identifier Schema

state

string

True

JSON string containing a value indicating the operational state of the bucket. Defined values are:

  • "pending" - The bucket is scheduled for discovery

  • "available" - The bucket is available for use

  • "failed" - The bucket is in a permanent failure state

  • "removed" - The bucket is not currently accessible

  • "unknown" - The bucket state cannot be determined

stateDetails

array[type_astra_stateDetails]

True

JSON array of JSON objects that lists additional details about why "state" transitioned to "removed" or "failed". If no details are available, this array will be empty.

  • Minimum items: 0

provider

string

True

JSON string indicating the bucket protocol that can be used to access the bucket. Defined values are:

  • "ontap-s3"

  • "storagegrid-s3"

  • "generic-s3"

  • "gcp"

  • "azure"

  • "aws"

bucketParameters

bucketParameters

True

JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket differ per provider.

metadata

type_astra_metadata_update

True

Client and service-specified metadata associated with the resource. Defined values are:

  • Conforms to the Astra Metadata Schema If not specified on create, a metadata object will be created with no labels. If not specified on update, the metadata object's labels, creationTimestamp and createdBy, will be preserved without modification.

type_astra_metadata_list

Name Type Required Description

continue

string

False

count

number

False

labels

array[type_astra_label]

False

creationTimestamp

string

False

modificationTimestamp

string

False

createdBy

string

False

modifiedBy

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid