Skip to main content

Retrieve the local snapshots report

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/report/snapshot/job/{jobId}

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.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

page

number

query

False

accountId

string

path

True

jobId

string

path

True

authorization

string

header

True

X-Agent-Id

string

header

True

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