Create a fingerprint computation session
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
POST /storage/snaplock/file-fingerprints
Introduced In: 9.7
Creates a fingerprint computation session on the file and returns a session-id. This session-id is a unique identifier that you can use to retrieve the progress of an ongoing fingerprint operation. When the operation is complete, you can use the session-id to retrieve the complete fingerprint output for the file .
Required properties
-
svm.uuid
orsvm.name
- Name or UUID of the SVM. -
volume.name
orvolume.uuid
- Name or UUID of the volume. -
path
- Path of the file.
Default property values
If not specified in POST, the follow default property values are assigned:
-
algorithm
- sha256
Related ONTAP commands
-
volume file fingerprint start
Example
POST "/api/storage/snaplock/file-fingerprints" '{"svm":{"uuid":"23940494-3f3a-11e9-8675-0050568e8f89"},"volume": {"uuid":"26cdb58c-3f3a-11e9-8675-0050568e8f89"},"path":"/vol/a1.txt","algorithm":"md5"}'
Learn more
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Request Body
Name | Type | Description |
---|---|---|
_links |
||
algorithm |
string |
The digest algorithm which is used for the fingerprint computation |
data_fingerprint |
string |
The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only. |
file_size |
integer |
The size of the file in bytes. |
file_type |
string |
The type of the file. |
id |
integer |
A unique identifier for the fingerprint operation |
metadata_fingerprint |
string |
The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only. |
path |
string |
Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory. |
scope |
string |
The scope of the file which is used for the fingerprint computation |
state |
string |
Specifies the status of fingerprint operation. |
svm |
SVM, applies only to SVM-scoped objects. |
|
volume |
Example request
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"algorithm": "sha256",
"data_fingerprint": "MOFJVevxNSJm3C/4Bn5oEEYH51CrudOzZYK4r5Cfy1g=",
"file_size": 1048576,
"file_type": "worm",
"id": 17039367,
"metadata_fingerprint": "8iMjqJXiNcqgXT5XuRhLiEwIrJEihDmwS0hrexnjgmc=",
"path": "/homedir/dir1",
"scope": "data_only",
"state": "completed",
"svm": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
},
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
}
}
Response
Status: 201, Created
Headers
Name | Description | Type |
---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: Default
ONTAP Error Response codes
Error code | Description |
---|---|
2 |
An invalid value was entered for one of the fields |
2621519 |
Invalid SVM name format |
14090347 |
Invalid path format |
14090443 |
Invalid volume name |
14090444 |
Invalid Vserver name |
14090447 |
Invalid volume UUID |
14090448 |
Invalid key values. Provide valid Vserver name and volume name or Vserver UUID and volume UUID |
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
svm
SVM, applies only to SVM-scoped objects.
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the SVM. This field cannot be specified in a PATCH method. |
uuid |
string |
The unique identifier of the SVM. This field cannot be specified in a PATCH method. |
volume
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
The name of the volume. This field cannot be specified in a POST or PATCH method. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
snaplock_file_fingerprint
Name | Type | Description |
---|---|---|
_links |
||
algorithm |
string |
The digest algorithm which is used for the fingerprint computation |
data_fingerprint |
string |
The digest value of data of the file. The fingerprint is base64 encoded. This field is not included if the scope is metadata-only. |
file_size |
integer |
The size of the file in bytes. |
file_type |
string |
The type of the file. |
id |
integer |
A unique identifier for the fingerprint operation |
metadata_fingerprint |
string |
The digest value of metadata of the file. The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, file gid, and file type. The fingerprint is base64 encoded. This field is not included if the scope is data-only. |
path |
string |
Specifies the path on which file fingerprint operation is running or has completed. Specifies the path relative to the output volume root, of the form "/path". The path can be path to a file or a directory. |
scope |
string |
The scope of the file which is used for the fingerprint computation |
state |
string |
Specifies the status of fingerprint operation. |