Get bulk volume API

Edit online

The Get bulk volume API lists multiple volumes that are created on PowerVC with a single request. The Get bulk volume API provides multiple filter options to fetch the volumes.

Get bulk volume API option

Table 1. Options for Get bulk volume API
Method	URI	Description
GET	`/v3/{tenant_id}/bulk-volumes`	Returns all the volumes across all storage controllers.
GET	`/v3/{tenant_id}/bulk-volumes?project_id={project_id}`	Returns all the volumes for the specified project ID.
GET	`/v3/{tenant_id}/bulk-volumes?name={bulk_vol_name}`	Returns all the volumes that start with the specified name.
GET	`/v3/{tenant_id}/bulk-volumes?name={string of volume names separated by commas}`	Returns the volumes with the specified names.
GET	`/v3/{tenant_id}/bulk-volumes?volume_id={list of volume IDs separated by commas}`	Returns the volume for the specified volume IDs. A maximum of 219 volume IDs can be provided.
GET	`/v3/{tenant_id}/bulk-volumes?storage_hostname={host_name}`	Returns all the volumes for the specified host.
GET	`/v3/{tenant_id}/bulk-volumes?status_list={list of status separated by commas}`	Returns all the volumes for the specified status.

Get bulk volume API

The Get bulk volume API returns all the volumes for specific project, storage host, volume status, and volume name prefix. The Get bulk volume API provides the project_id, name, volume_id, storage_hostname, and status_list options to fetch the volume information. The response body contains a list of volumes with volume details.

Response codes

Normal response code - OK (200)
Partial response code - Partial Content (206)
Error response code - Bad Request (400), Not Authorized (401), Not Found(404), Server Error (500)

Response parameters

Table 2. Parameters in the response for Get bulk volume API
Name	Style	Type	Description
`bulk_volumes`	Body	Array	List of successfully retrieved volume objects.
`Volume`	Body	Array	Volume object with details.

Example of response body

{
   "bulk_volumes":
     [
        {
           "volume": 
              {
                 "id": "10095b45-e724-4856-8f86-df651c44134f",
                 "status": "available",
                 "size": 1,
                 "availability_zone": "nova",
                 "created_at": "2025-06-17T08:58:04.000000",
                 "updated_at": "2025-06-17T08:58:10.000000",
                 "name": "bulk_vol-1",
                 "description": null,
                 "volume_type": "bulk volume template",
                 "snapshot_id": null,
                 "source_volid": null,
                 "metadata":
                    {
                       "volume_wwn": "600507640081000000000032ACC"
                    },
                 "links": [
                            {"rel": "self", "href": "https://1.0.0.1:9000/v3/882d8f6d81f24cc6af34bb56e34e282d/volumes/10095b45-e724-4856-8f86-df651c44134f"},
                            {"rel": "bookmark", "href": "https://1.0.0.1:9000/882d8f6d81f24cc6af34bb56e34e282d/volumes/10095b45-e724-4856-8f86-df651c44134f"}
                            ],
                 "user_id": "0688b01e6439fb1a4ddafcebb97d854e836c9",
                 "bootable": "false",
                 "encrypted": false,
                 "replication_status": "not-capable",
                 "consistencygroup_id": null,
                 "multiattach": false,
                 "host": "c387f1_v7k#mdiskgrp",
                 "attachments": [],
                 "migration_status": null,
                 "group_id": null,
                 "provider_id": null,
                 "shared_targets": false,
                 "service_uuid": "602cb5e4-426c-9133-f010471b2518",
                 "cluster_name": null,
                 "volume_type_id": "39d30791-41a0-88f8-bf9198cb7cba",
                 "backend_host": "c387f1_v7k",
                 "os-vol-host-attr:host": "c387f1_v7k#mdiskgrp"
              }
        }
     ]
}