본 한국어 번역은 사용자 편의를 위해 제공되는 기계 번역입니다. 영어 버전과 한국어 버전이 서로 어긋나는 경우에는 언제나 영어 버전이 우선합니다.

Retrieve a bucket

10/21/2024 기여자

PDF

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

Returns the stored Bucket API resource in the JSON response body.

Parameters

Name	Type	In	Required	Description
account_id	string	path	True	ID of the containing account resource example: {{.Account}}
bucket_id	string	path	True	ID of the bucket collection to list

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

bucket_id

string

path

True

ID of the bucket collection to list

Response

Status: 200, Returns the stored Bucket API resource in the JSON 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_stateDetail]	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
retentionTime	number	False	Number of seconds representing the time a file on this bucket will be retained for. Defined values are: -1 (Unsupported bucket) 0 (No known retention policy) 0 (Known retention policy)
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 vary 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.

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"

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_stateDetail]

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

retentionTime

number

False

Number of seconds representing the time a file on this bucket will be retained for. Defined values are:

-1 (Unsupported bucket)
0 (No known retention policy)
0 (Known retention policy)

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

True

JSON object that provides bucket provider-specific information required to access the bucket. The specific values in this bucket vary 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.

Example response

{
  "type": "application/astra-bucket",
  "version": "1.2",
  "id": "9b296ce0-c545-5022-acfa-1980c5aaea97",
  "name": "Test Bucket",
  "credentialID": "8f039324-7795-40bf-a5ca-4442580f7ab0",
  "state": "available",
  "stateDetails": [],
  "retentionTime": 57627,
  "provider": "gcp",
  "bucketParameters": {
    "gcp": {
      "bucketName": "bucketName"
    }
  },
  "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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

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	True
status	string	True
correlationID	string	False
invalidParams	array[invalidParams]	False	List of invalid query parameters

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

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
type	string	True
title	string	True
detail	string	True
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

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

additionalDetails

type_astra_stateDetail

Name	Type	Required
type	string	True
title	string	True
detail	string	True
additionalDetails	additionalDetails	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

True

additionalDetails

False

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

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

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

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 vary 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.

Name

Type

Required

Description

False

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

gcp

False

JSON object that provides Google Cloud protocol parameters.

azure

False

JSON object that provides Azure protocol parameters.

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

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
labels	array[type_astra_label]	False
creationTimestamp	string	False
modificationTimestamp	string	False
createdBy	string	False
modifiedBy	string	False

Name

Type

Required

Description

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

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

Retrieve a bucket

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions