Renames a storage pool. To rename a storage pool, change its associated label.
HTTP request syntax (URI)
PATCH <base_URI>/v7/storage/storage-pools/{id}
Parameters
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| id | URI_PARAM | Y | string/number | Specifies either the storage pool object ID or HNAS storage pool ID to rename. |
| label | BODY | Y | string | Storage pool label. |
Return codes
| Code | Data | Description |
|---|---|---|
| 204 | No data | Storage pool renamed 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 storage pool object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/storage-pools/3530353739333031303130363332303038383a3a3a -d '{"label":"sp-test1"}' -X PATCH
Response example: Using the storage pool object ID
HTTP/1.1 204 No Content
Request example: Using the HNAS storage pool ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/storage-pools/505793010106320088 -d '{"label":"sp-test1"}' -X PATCH
Response example: Using the HNAS storage pool ID
HTTP/1.1 204 No Content