Skip to main content
REST API reference

Retrieve details of a specific S3 bucket snapshot

PDFs

GET /protocols/s3/services/{svm.uuid}/buckets/{s3_bucket.uuid}/snapshots/{uuid}

Introduced In: 9.16

Retrieves details of a specific S3 bucket snapshot.

  • vserver object-store-server bucket snapshot show

Learn more

Parameters

Name Type In Required Description

s3_bucket.uuid

string

path

True

The unique identifier of the bucket.

uuid

string

path

True

The unique identifier of the S3 bucket snapshot.

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

bucket_uuid

string

The unique identifier of the bucket.

create_time

string

Creation time of the snapshot. It is the storage unit access time when the snapshot was created.

name

string

The name of the snapshot. Snapshot names must start with a lowercase letter, a number, or a hyphen, must end with a lowercase letter or a number, and cannot exceed 30 characters.

svm

svm

Specifies the name of the SVM where this bucket exists.

uuid

string

The UUID of the snapshot in the bucket that uniquely identifies the snapshot in that bucket.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "bucket_uuid": "2aec8270-58e3-11ef-861e-005056ae1130",
  "create_time": "2024-08-21 20:18:04 -0400",
  "name": "snap1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "uuid": "522b29a1-3b26-11e9-bd58-0050568ea321"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm

Specifies the name of the SVM where this bucket exists.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.