# Volume

Volume is a persistent storage to store data. This resource is created by clients and mounted to pod.

## METHOD

* [Create](https://hyperhq.gitbook.io/pi-docs/reference/api-v1.9/volume/create)
* [List](https://hyperhq.gitbook.io/pi-docs/reference/api-v1.9/volume/list)
* [Read](https://hyperhq.gitbook.io/pi-docs/reference/api-v1.9/volume/get)
* [Delete](https://hyperhq.gitbook.io/pi-docs/reference/api-v1.9/volume/delete)

## Reference

### VolumeCreateRequest

| Field           | Description                                                                                             |
| --------------- | ------------------------------------------------------------------------------------------------------- |
| name: *string*  | The volume name, unique in the region where the volume resides                                          |
| size: *integer* | The volume size in GB, range from 1 to 1024 (GB), default is 10                                         |
| zone: *string*  | The name of the availability zone where the volume is created. Optional for creating volumes, if empty, |

### VolumeResponse

| Field               | Description                                                                          |
| ------------------- | ------------------------------------------------------------------------------------ |
| name: *string*      | The volume name                                                                      |
| size: *integer*     | The volume size in GB                                                                |
| zone: *string*      | The name of the availability zone where the volume is created.                       |
| createdAt: *string* | The timestamp when the volume is created                                             |
| pod: *string*       | The name of the pod that the volume is mounted at. Empty if the volume is not in use |