Retrieve the local snapshots report
Retrieves the local snapshots report data generated by the Local Snapshot Inventory Report POST API. Use this to download snapshot report data based on the scope specified during the deployment of the Replication Inventory Report POST API.
HTTP method and endpoint
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}
Token usage
NetApp Console user token.
Usage notes
Retrieves the local snapshots report data that was generated by the Local Snapshot Inventory Report POST API. When called, it downloads the local snapshot report data based on the scope (account, system) specified during the deployment of the Replication Inventory Report POST API.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
page |
number |
query |
False |
Page number to fetch the paginated report. The last page of the report must be accessed to clean up the report from the memory |
accountId |
string |
path |
True |
Account ID |
jobId |
string |
path |
True |
Job ID |
authorization |
string |
header |
True |
User token |
X-Agent-Id |
string |
header |
True |
Request identifier |
Response
Status: 200, Default response
| Name | Type | Required | Description |
|---|---|---|---|
report |
array[report] |
False |
|
page |
number |
False |
|
total-pages |
number |
False |
Example response
{
"report": [
{
"working-environment-name": "string",
"working-environment-id": "string",
"volumes": [
{
"name": "string",
"svm": "string",
"state": "string",
"snapshot-policy": "string",
"snapshots": [
{
"name": "string",
"state": "string"
}
]
}
]
}
]
}
Definitions
See Definitions
snapshots
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
creation-time |
number |
False |
|
size |
number |
False |
|
state |
string |
False |
|
expiry-time |
number |
False |
|
snaplock-expiry-time |
number |
False |
volumes
| Name | Type | Required | Description |
|---|---|---|---|
name |
string |
False |
|
svm |
string |
False |
|
state |
string |
False |
|
snapshot-count |
number |
False |
|
snapshot-policy |
string |
False |
|
snapshots |
array[snapshots] |
False |
report
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-name |
string |
False |
|
working-environment-id |
string |
False |
|
volume-count |
number |
False |
|
volumes |
array[volumes] |
False |