Retrieve a volume
GET /accounts/{account_id}/topology/v1/volumes/{volume_id}
Returns the stored Volume API resource in the JSON response body.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
account_id |
string |
path |
True |
ID of the containing account resource
|
volume_id |
string |
path |
True |
ID of the volume collection to list |
Response
Status: 200, Returns the stored Volume 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 the name of the volume. Defined values are:
|
state |
string |
False |
JSON string containing a value indicating the operational state of the volume. |
size |
string |
False |
JSON string containing the size of the volume. |
used |
number |
False |
JSON number containing the number of bytes of quota used by the provisioned volume. |
usedPercentage |
number |
False |
JSON number containing the percentage of volume used. |
total |
number |
False |
JSON number containing the total bytes of volumes provisioned. |
creationToken |
string |
False |
JSON string containing the creation token of the volume. Defined values are:
|
snapshotPossible |
string |
False |
JSON string indicating whether the driver can perform a snapshot of the volume. Defined values are:
|
storageClass |
string |
False |
JSON string containing the storage class for the volume.
|
pvcName |
string |
False |
JSON string containing the PersistentVolumeClaim (PVC) name of the volume.
|
internalName |
string |
False |
JSON string containing the internal name of the volume on the target storage cluster, if available. This name is obtained from the Kubernetes CSI driver.
|
appsUsing |
array[string] |
True |
JSON array of JSON strings, each containing the ID of an application that is using the volume. Defined values are:
|
storageBackendID |
string |
False |
JSON string containing the ID of the storage backend that provides the volume. Defined values are:
|
orchestrator |
string |
False |
JSON string containing the orchestrator for this volume. This will be defined for Astra Data Store volumes. Defined values are:
|
serviceLevel |
string |
False |
JSON string containing the quality of service (QoS) policy defined for this volume at the storage backend level. This will be defined for Astra Data Store volumes. |
exportPolicy |
string |
False |
JSON string containing the export policy associated with this volume. This will be defined for Astra Data Store volumes. |
nodeId |
string |
False |
JSON string containing the node ID serving the volume. This will be defined for Astra Data Store volumes. Defined values are:
|
healthState |
string |
False |
JSON string containing a value indicating the health state of the volume. This will be defined for Astra Data Store volumes. Defined values are:
|
healthStateDetails |
array[type_astra_stateDetail] |
True |
JSON array of JSON objects that lists additional details about the current health. If no details are available, this array will be empty.
|
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
additionalDetails
type_astra_stateDetail
Name | Type | Required | Description |
---|---|---|---|
type |
string |
True |
|
title |
string |
True |
|
detail |
string |
True |
|
additionalDetails |
False |
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 |