edit-icon download-icon

View data volume list

Last Updated: Feb 12, 2018

Description

View all the data volumes of the current cluster.

Request information

Request line (RequestLine)

  1. Get /volumes HTTP/1.1

Request line parameter (URI Param)

None

Special request header (RequestHead)

None

Request body (RequestBody)

None

Response information

Response line (ResponseLine)

  1. HTTP/1.1 200 OK

Response body (ResponseBody)

JSON object

  1. {
  2. "Name": "volume",
  3. "Driver": "***",
  4. "Mountpoint": "/mnt/acs_mnt/**/***",
  5. "Labels": null,
  6. "Scope": "",
  7. "Node": "***",
  8. "Refs": []
  9. }
Name Type Description
Name string The data volume name.
Driver string The type of the data volume driver: ossfs.
Mountpoint string The mount point of the data volume on the host: /mnt/acs_mnt/**/***.
Labels map[string]string The metadata information of the data volume.
Scope string The data volume management range. global indicates the cluster level. local indicates inside the host.
Node string The host name of the node in which the data volume resides.
Refs []VolumeRef The list of containers that use this data volume. For more information, see the definition of VolumeRef.

VolumeRef data type:

Name Type Description
Name string Container name
ID string Container ID

Example

Return example

  1. {
  2. "Volumes": [
  3. {
  4. "Name": "docker2",
  5. "Driver": "ossfs",
  6. "Mountpoint": "/mnt/acs_mnt/ossfs/bucket2",
  7. "Labels": null,
  8. "Scope": "",
  9. "Node": "b347bcf0e68b",
  10. "Refs": []
  11. },
  12. {
  13. "Name": "docker1",
  14. "Driver": "ossfs",
  15. "Mountpoint": "/mnt/acs_mnt/ossfs/bucket1",
  16. "Labels": null,
  17. "Scope": "",
  18. "Node": "b347bcf0e68b",
  19. "Refs": []
  20. }
  21. ]
  22. }
Thank you! We've received your feedback.