Retrieve a storage class for a cluster
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
|
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:
|
version |
string |
True |
Version of the resource. Defined values are:
|
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
name |
string |
True |
JSON string containing a value indicating the name of the storage class. Defined values are:
|
provisioner |
string |
True |
JSON string containing a value indicating the provisioner associated with the storage class. Defined values are:
|
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:
|
allowVolumeExpansion |
string |
True |
JSON string indicating whether the storage class allows volume expansion. Defined values are:
|
reclaimPolicy |
string |
True |
JSON string containing a cloud-specific value indicating the retention policy of the storage class. Defined values are:
|
volumeBindingMode |
string |
True |
JSON string containing a cloud-specific value indicating the binding mode for the storage class. Defined values are:
|
isDefault |
string |
False |
JSON string indicating whether the storage class contains the default annotation. Defined values are:
|
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:
|
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:
|
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:
|
metadata |
True |
Client and service-specified metadata associated with the resource. Defined values are:
|
Example response
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
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
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
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
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 |