Retrieve inventory report data
Retrieves the inventory report data generated by the Inventory Report POST API. Use this to download report data based on the specified scope, such as account, system, or storage VM.
HTTP method and endpoint
GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/job/{jobId}
Token usage
NetApp Console user token.
Usage notes
Retrieves the inventory report data that was generated by the Inventory Report POST API. When called, it downloads the inventory report data based on the scope (account, system, storage VM) specified during the deployment of the 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-id": "string",
"working-environment-name": "string",
"working-environment-status": "string",
"backup-enablement-status": "string",
"working-environment-type": "string",
"provider": "string",
"provider-account-id": "string",
"bucket": "string",
"archive-storage-class": "string",
"region": "string",
"volumes": [
{
"uuid": "string",
"name": "string",
"svm": "string",
"status": "string",
"backup-status": "string",
"snapshot-count": "string",
"backup-policy": {
"name": "string",
"rule": [
{
"label": "string",
"retention": "string"
}
],
"archive-after-days": "string"
},
"snapshot": [
{
"id": "string",
"name": "string",
"object-lock": "string"
}
],
"object-lock": "string",
"ransomware-scan-status": "string"
}
]
}
]
}
Definitions
See Definitions
keyDetails
JSON data containing data specific to Customer Managed Encryption Keys
cmek
| Name | Type | Required | Description |
|---|---|---|---|
enabled |
boolean |
False |
|
keyDetails |
False |
JSON data containing data specific to Customer Managed Encryption Keys |
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 |
snapshot
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
False |
|
name |
string |
False |
|
creation-time |
number |
False |
|
size |
number |
False |
|
object-lock |
string |
False |
|
archived |
boolean |
False |
volumes
| Name | Type | Required | Description |
|---|---|---|---|
uuid |
string |
False |
|
name |
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 |
||
snapshot |
array[snapshot] |
False |
|
object-lock |
string |
False |
|
ransomware-scan-status |
string |
False |
|
last-ransomware-scan |
number |
False |
report
| Name | Type | Required | Description |
|---|---|---|---|
working-environment-id |
string |
False |
|
working-environment-name |
string |
False |
|
working-environment-status |
string |
False |
|
backup-enablement-status |
string |
False |
|
working-environment-type |
string |
False |
|
total-volumes-count |
number |
False |
|
backed-up-volumes-count |
number |
False |
|
provider |
string |
False |
|
provider-account-id |
string |
False |
|
bucket |
string |
False |
|
archive-storage-class |
string |
False |
|
region |
string |
False |
|
cmek |
False |
||
volumes |
array[volumes] |
False |