Clone a file system directory

NAS File Storage REST API v7 Reference

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

Clones a file system directory.

HTTP request syntax (URI)

POST <base_URI>/v7/storage/filesystems/{id}/clone-directory

Parameters

Name Type Required Values Description
id URI_PARAM Y string Specifies the object ID of the file system or the HNAS storage file system ID to clone a file system directory.
srcDirectory BODY Y string Source directory absolute path of the directory to be cloned. The path should be in UNIX format.
dstDirectory BODY Y string Destination directory absolute path of the cloned copy. The path should be in UNIX format.
ensureCreate BODY Y boolean Indicates whether to create the destination directory if it does not exist. The operation fails when it is false and the destination directory exists.

Return codes

Code Data Description
204 No Data File system directory clone has been done 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 204 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.57.75:8444/v7/storage/filesystems/4141453043393746413838393331303630303030303030303030303030303030/clone-directory -d ‘{"srcDirectory":"/xyz-src-submit-tree-clone-job", "dstDirectory":"/xyz-create-directory-0825-submit-tree-clone-job-dest", “ensureCreate”: true}’ -X POST

Response example: Using the file system object ID

HTTP/1.1 204 No Content

Request example: Using the HNAS storage file system ID

curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v7/storage/filesystems/864DC6E1DFB68C210000000000000000/clone-directory -d ‘{"srcDirectory":"/xyz-src-submit-tree-clone-job","dstDirectory":"/xyz-create-directory-0825-submit-tree-clone-job-dest", “ensureCreate”: true}’ -X POST

Response example: Using the HNAS storage file system ID

HTTP/1.1 204 No Content