Get snapshot rules
Gets all snapshot rules that belong to a virtual server ID.
HTTP request syntax (URI)
GET <base_URI>/v8/storage/virtual-servers/{virtualServerId}/snapshot-rules
Parameters
| Name | Type | Required | Values | Description |
| virtualServerId | URI_PARAM | Y | string | Specifies either the virtual server object ID or the HNAS storage virtual server ID to which the snapshot rules belong. |
Return codes
| Code | Data | Description |
| 200 | filesystemSnapshotRule | Retrieved one or more file system snapshot rules successfully. |
| 400 | Error Message | Missing or invalid request contents. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
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/v8/storage/virtual-servers/373a3a3a/snapshot-rules
Response example
HTTP/1.1 200 OK
{
"filesystemSnapshotRules": [
{
"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": 18446744073709552000,
"usedCapacity": 0,
"virtualServerId": 65535
},
"filesystemId": "3B6E4F23B46554770000000000000000",
"isValid": true,
"name": "rule1",
"objectId": "343a3a3a33423645344632334234363535343737303030303030303030303030303030303a3a3a6e69636b2d6f626a2d7265702d7372632d73732d72756c65313a3a3a303a3a3a4f49445f24232140255f56",
"queueSize": 4,
"virtualServerId": 4
},
{
"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": 18446744073709552000,
"usedCapacity": 0,
"virtualServerId": 65535
},
"filesystemId": "8664E653C9F413BF0000000000000000",
"isValid": true,
"name": "rule4",
"objectId": "343a3a3a38363634453635334339463431334246303030303030303030303030303030303a3a3a6170692d7372632d736e617073686f742d72756c653a3a3a303a3a3a4f49445f24232140255f56",
"queueSize": 25,
"virtualServerId": 4
}
]
}