Get status of disaster recovery state change of a file system

NAS File Storage REST API v7 Reference

Version
14.7.x
14.6.x
Audience
anonymous
Part Number
MK-92HNAS088-05

Gets the status of a disaster recovery state change of a file system.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/filesystems/{id}/dr-state-change-status

Parameters

Name Type Required Values Description
id URI_PARAM Y string Specifies either the file system object ID or the HNAS storage file system ID.
isMostRecent BODY N boolean True returns only the most recent status. False returns a list of previous statuses. Default is False if the parameter is not supplied.

Return codes

Code Data Description
200 filesystemDRStateChangeReport Status of disaster recovery state change of the file system object retrieved successfully
400 No Data Missing or invalid request contents.
404 Error Message Requested resource not found.
500 Error message Error associated with the storage system.
501 No Data Server has not implemented the request operation on the resource.

Any HTTP status code other than 200 indicates that the API did not complete successfully.

Request example: Using the file system object ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/865a1e306b0d4ee70000000000000000/dr-state-change-status -X GET -d '{"isMostRecent":true}'

Response example: Using the file system object ID

HTTP/1.1 200 OK
{
  "filesystemDRStateChangeReport" :
  [
    {
      "endTime" : 1545960264,
      "fileSystemId" : "865A1E306B0D4EE70000000000000000",
      "isActive" : false,
      "logName" : "/2/simm/DR_2018-12-27_172422-0800.bin",
      "startTime" : 1545960262,
      "statistics" :
      [
        {
          "name" : "numShareRecoveredEvents",
          "value" : 0
        },
        {
          "name" : "numShareRecoveryFailureEvents",
          "value" : 0
        },
        {
          "name" : "numShareRecoveryFailureDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numShareNameClashFixedEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToDoNotTransferEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToUseFsDefaultEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToNameClashIdenticalShareEvents",
          "value" : 0
        },
        {
          "name" : "numShareDeletedEvents",
          "value" : 0
        },
        {
          "name" : "numShareDeletionFailureEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveredEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveryFailureEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveryFailureDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportNameClashFixedEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToDoNotTransferEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToUseFsDefaultEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToNameClashIdenticalShareEvents",
          "value" : 0
        },
        {
          "name" : "numExportIdClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportDeletedEvents",
          "value" : 0
        },
        {
          "name" : "numExportDeletionFailureEvents",
          "value" : 0
        },
        {
          "name" : "numFailedToLogToDrLogEvents",
          "value" : 0
        }
      ],
      "status" : "SUCCESSFULLY",
      "transitionId" : "0ff38b10-9e4c-11d4-9645-49e1bb864b23"
    }  
  ]
}

Request example: Using the HNAS storage file system ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/filesystems/8659E4DE8E2FF4EA0000000000000000/dr-state-change-status -X GET -d
'{"isMostRecent":true}'

Response example: Using the HNAS storage file system ID

HTTP/1.1 200 OK
{
  "filesystemDRStateChangeReport" :
  [
    {
      "endTime" : 1545960264,
      "fileSystemId" : "865A1E306B0D4EE70000000000000000",
      "isActive" : false,
      "logName" : "/2/simm/DR_2018-12-27_172422-0800.bin",
      "startTime" : 1545960262,
      "statistics" :
      [
        {
          "name" : "numShareRecoveredEvents",
          "value" : 0
        },
        {
          "name" : "numShareRecoveryFailureEvents",
          "value" : 0
        },
        {
          "name" : "numShareRecoveryFailureDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numShareNameClashFixedEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToDoNotTransferEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToUseFsDefaultEvents",
          "value" : 0
        },
        {
          "name" : "numShareSkippedDueToNameClashIdenticalShareEvents",
          "value" : 0
        },
        {
          "name" : "numShareDeletedEvents",
          "value" : 0
        },
        {
          "name" : "numShareDeletionFailureEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveredEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveryFailureEvents",
          "value" : 0
        },
        {
          "name" : "numExportRecoveryFailureDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportNameClashFixedEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToNameClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToDoNotTransferEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToUseFsDefaultEvents",
          "value" : 0
        },
        {
          "name" : "numExportSkippedDueToNameClashIdenticalShareEvents",
          "value" : 0
        },
        {
          "name" : "numExportIdClashEvents",
          "value" : 0
        },
        {
          "name" : "numExportDeletedEvents",
          "value" : 0
        },
        {
          "name" : "numExportDeletionFailureEvents",
          "value" : 0
        },
        {
          "name" : "numFailedToLogToDrLogEvents",
          "value" : 0
        }
      ],
      "status" : "SUCCESSFULLY",
      "transitionId" : "0ff38b10-9e4c-11d4-9645-49e1bb864b23"
    }
  ]
}