Skip to main content
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Retrieve a storage class for a cluster

Colaboradores
PDF

GET /accounts/{account_id}/topology/v1/clusters/{cluster_id}/storageClasses/{storageClass_id}

Returns the stored Storage Class 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}}

cluster_id

string

path

True

ID of the containing cluster resource

storageClass_id

string

path

True

ID of the storageClass collection to list

Response

Status: 200, Returns the stored Storage Class API resource in the JSON response body.
Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/astra-storageClass"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

  • "1.1"

id

string

True

Globally unique identifier of the resource. Defined values are:

  • Conforms to the UUIDv4 Schema

name

string

True

JSON string containing a value indicating the name of the storage class. Defined values are:

  • Minimum length: 1

  • Maximum length: 255

provisioner

string

True

JSON string containing a value indicating the provisioner associated with the storage class. Defined values are:

  • Minimum length: 1

  • Maximum length: 255

available

string

True

JSON string indicating whether the storage class is available for the cluster or is eligible to be added to the cluster when under management. Defined values are:

  • "available" - The storage class is available for use

  • "eligible" - The storage class is eligible to be used by the cluster when it is under management

  • "ineligible" - The storage class is ineligible to be used by the cluster when it is under management

allowVolumeExpansion

string

True

JSON string indicating whether the storage class allows volume expansion. Defined values are:

  • "true" - The storage class allows volume expansion

  • "false" - The storage class does not allow volume expansion

  • "unavailable" - It is unknown whether the storage class allows volume expansion

reclaimPolicy

string

True

JSON string containing a cloud-specific value indicating the retention policy of the storage class. Defined values are:

  • Minimum length: 1

  • Maximum length: 255

volumeBindingMode

string

True

JSON string containing a cloud-specific value indicating the binding mode for the storage class. Defined values are:

  • Minimum length: 1

  • Maximum length: 255

isDefault

string

False

JSON string indicating whether the storage class contains the default annotation. Defined values are:

  • "true" - The storage class contains the default annotation

maxSnapshotCount

number

False

JSON number indicating how many snapshots are supported. This information is attached to storage classes provided by NetApp.

maxBackupCount

number

False

JSON number indicating how many backups are supported. This information is attached to storage classes provided by NetApp.

price

string

False

JSON string indicating the currency units per unit of time for the storage class. This information is attached to storage classes provided by NetApp. Defined values are:

  • Minimum length: 1

  • Maximum length: 63

currency

string

False

JSON string indicating the ISO 4217 three-letter code for the currency that the price is measured in. This information is attached to storage classes provided by NetApp. Defined values are:

  • Minimum length: 1

  • Maximum length: 255

performance

number

False

JSON number indicating the performance service-level objective (SLO) in MBps. This information is attached to storage classes provided by NetApp.

resilience

string

False

JSON string indicating the resilience configuration for the storage. This information is attached to storage classes provided by NetApp. Defined values are:

  • "regional" - The volume will become unavailable if a given region becomes unavailable

  • "multisite" - The volume will continue to be available if a given region becomes unavailable

metadata

type_astra_metadata

True

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

  • Conforms to the Astra Metadata Schema
Example response 
{
  "type": "application/astra-storageClass",
  "version": "1.1",
  "id": "ad9be22b-53c7-540c-8647-76afe2878952",
  "name": "my-storage-class",
  "provisioner": "csi.trident.netapp.io",
  "available": "eligible",
  "allowVolumeExpansion": "true",
  "reclaimPolicy": "recycle",
  "volumeBindingMode": "immediate",
  "isDefault": "true",
  "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

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

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

type_astra_label

Name Type Required Description

name

string

True

value

string

True

type_astra_metadata

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

  • Conforms to the Astra Metadata Schema

Name Type Required Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

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