Retrieve volume information
Retrieves information for a specified volume backed up using the NetApp Backup and Recovery service. Use this to review detailed backup and ransomware-related attributes for the volume, such as capacity, object lock status, and ransomware detected snapshots.
HTTP method and endpoint
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/backup/working-environment/{workingEnvironmentId}/volume/{volumeId}
Token usage
NetApp Console user token.
Usage notes
Retrieves information for a specified volume backed up by using the NetApp Backup and Recovery service. It retrieves the details of the volume from the NetApp Console SaaS application. It retrieves the archive after days, backup status, relationship policy name, and capacity details. It also retrieves details of the archive after days, object lock, ransomware scan status, last ransomware scan, and ransomware detected snapshots with last ransomware scan information.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
accountId |
string |
path |
True |
Account ID |
workingEnvironmentId |
string |
path |
True |
System ID |
volumeId |
string |
path |
True |
Volume ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Response
Status: 200, Default response
| Name | Type | Required | Description |
|---|---|---|---|
file-system-id |
string |
False |
|
name |
string |
False |
|
protocol |
string |
False |
|
svm |
string |
False |
|
status |
string |
False |
|
backup-status |
string |
False |
|
last-backup-creation-time |
number |
False |
|
snapshot-count |
string |
False |
|
backup-policy |
False |
||
lag |
string |
False |
|
capacity |
False |
||
type |
string |
False |
|
snaplock-type |
string |
False |
|
style |
string |
False |
|
object-lock |
string |
False |
|
ransomware-scan-status |
string |
False |
|
last-ransomware-scan |
number |
False |
|
ransomware-detected-snapshots |
False |
||
geometry |
number |
False |
|
aggregate-count |
number |
False |
|
cbsChargingEnabled |
boolean |
False |
Example response
{
"file-system-id": "string",
"name": "string",
"protocol": "string",
"svm": "string",
"status": "string",
"backup-status": "string",
"snapshot-count": "string",
"backup-policy": {
"name": "string",
"rule": [
{
"label": "string",
"retention": "string"
}
],
"archive-after-days": "string"
},
"lag": "string",
"capacity": {
"allocated": "string",
"used": "string",
"charging": "string",
"logicalUsedSize": "string"
},
"type": "string",
"snaplock-type": "string",
"style": "string",
"object-lock": "string",
"ransomware-scan-status": "string",
"ransomware-detected-snapshots": [
{
"snapshot-id": "string",
"snapshot-name": "string"
}
]
}
Definitions
See Definitions
rule
| Name | Type | Required | Description |
|---|---|---|---|
label |
string |
False |
|
retention |
string |
False |
backup-policy
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
rule |
array[rule] |
False |
|
archive-after-days |
string |
False |
capacity
| Name | Type | Required | Description |
|---|---|---|---|
allocated |
string |
False |
|
used |
string |
False |
|
charging |
string |
False |
|
logicalUsedSize |
string |
False |
ransomware-detected-snapshots
| Name | Type | Required | Description |
|---|---|---|---|
snapshot-id |
string |
False |
|
snapshot-name |
string |
False |
|
last-ransomware-scan |
number |
False |