Retrieve a list of snapshot details for a volume
Retrieves a list of snapshot details for a volume, providing information about snapshots specific to the specified system and volume. Use this to query snapshot records based on parameters such as maximum number of results, snapshot UUID, or CP-COUNT.
HTTP method and endpoint
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment/{workingEnvironmentId}/volume/{volumeId}/snapshot
Token usage
NetApp Console user token.
Usage notes
Retrieves a list of snapshot details pertaining to a specific volume in a particular system. The system ID, volume ID, and snapshot ID are passed as parameters for the REST API call. You can query by passing parameters to specify the maximum number of records that should be returned, the next subsequent snapshot UUID to get results from, and the next CP-COUNT from where the results should be fetched.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
max-records |
number |
query |
False |
Maximum records to return |
cursor |
string |
query |
False |
Next snapshot UUID to get results from |
cp-count |
number |
query |
False |
Next CP count to get results from |
include-indexing-status |
boolean |
query |
False |
Include the field named indexing-status on each snapshot in the response |
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 |
|---|---|---|---|
snapshot |
array[snapshot] |
False |
|
num-records |
number |
False |
|
cursor |
string |
False |
|
cp-count |
number |
False |
Example response
{
"snapshot": [
{
"id": "string",
"name": "string",
"indexing-status": "string"
}
],
"cursor": "string"
}
Definitions
See Definitions
snapshot
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
|
name |
string |
False |
|
size |
number |
False |
|
creation-time |
number |
False |
|
indexing-status |
string |
False |
Whether the snapshot has been indexed by the Indexed Catalog. Returned only for catalogs running version 2 indexing, and only when the name of the volume is known. A snapshot the catalog does not account for, including when the catalog cannot be reached, is reported as NOT_INDEXED. |