Clone a file system directory
Clones a file system directory.
HTTP request syntax (URI)
POST <base_URI>/v8/storage/filesystems/{filesystemId}/clone-directory
Parameters
| Name | Type | Required | Values | Description |
| filesystemId | URI_PARAM | Y | string | Either the file system object ID or HNAS file system ID. |
| 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 | Error Message | Missing or invalid request contents. |
| 403 | Error Message | Operation forbidden by access level. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example 1: Clone a directory using the file system object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/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
Request example 2: Clone a directory using the HNAS storage file system ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.57.75:8444/v8/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: Both requests produce the same response
HTTP/1.1 204 No Content