Get a snapshot rule

NAS File Storage REST API v7 Reference

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

Gets a specific snapshot rule.

HTTP request syntax (URI)

GET <base_URI>/v7/storage/snapshot-rules/{snapshotRuleObjectID}

Parameters

Name Type Required Values Description
snapshotRuleObjectId URI_PARAM Y string ID of the snapshot rule object.

Return codes

Code Data Description
200 filesystemSnapshotRule Retrieved a filesystem snapshot rule 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

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.239.120:8444/v7/storage/snapshot-rules/ 343a3a3a38363433383839313931313336393443303030303030303030303030303030303a3a3a6170692d6473742d736e617073686f742d72756c653a3a3a303a3a3a4f49445f24232140255f56

Response example

HTTP/1.1 200 OK
{
   "filesystemSnapshotRule" :
        {
                "filesystem" :
                {
                        "blockSize" : 0,
                        "capacity" : 0,
                        "expansionLimits" : 0,
                        "filesystemId" : "",
                        "freeCapacity" : 0,
                        "isDedupeEnabled" : false,
                        "isDedupeSupported" : false,
                        "isLogicalCapacityFreeCapacityValid" : false,
                        "isLogicalCapacityValid" : false,
                        "isNDMPRecoveryTarget" : false,
                        "isNonStrictWORM" : false,
                        "isReadCached" : false,
                        "isReadOnly" : false,
                        "isSysLocked" : false,
                        "isThinProvisioningEnabled" : false,
                        "isThinProvisioningEnabledValid" : false,
                        "isTrueSparseFileEnabled" : false,
                        "isTrueSparseFileEnabledValid" : false,
                        "isUnlimitedExpansion" : false,
                        "isWORM" : false,
                        "label" : "",
                        "logicalCapacity" : 0,
                        "logicalFreeCapacity" : 0,
                        "objectId" : "3a3a3a303a3a3a4f49445f24232140255f56",
                        "status" : "FAILING",
                        "storagePoolId" : 18446744073709551615,
                        "usedCapacity" : 0,
                        "virtualServerId" : 65535
                },
                "filesystemId" : "864388919113694C0000000000000000",
                "isValid" : true,
                "name" : "api-dst-snapshot-rule",
                "objectId" : "343a3a3a38363433383839313931313336393443303030303030303030303030303030303a3a3a6170692d6473742d736e617073686f742d72756c653a3a3a303a3a3a4f49445f24232140255f56",
                "queueSize" : 25,
                "virtualServerId" : 4
      }
}