Manageable Volumes

Volume manage extension

List manageable volumes

get

Lists all manageable volumes

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters
hoststringRequired

The host name

clusterstringOptional

The cluster name

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

Responses
200

OK

application/json
get
/v3/manageable_volumes
GET /v3/v3/manageable_volumes?host=text HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "manageable-volumes": [
    {
      "reference": {},
      "size": 1,
      "safe_to_manage": true,
      "reason_not_safe": "text",
      "cinder_id": "123e4567-e89b-12d3-a456-426614174000",
      "extra_info": "text"
    }
  ]
}

List manageable volumes with details

get

Lists all manageable volumes with details

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters
hoststringRequired

The host name

clusterstringOptional

The cluster name

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

Responses
200

OK

application/json
get
/v3/manageable_volumes/detail
GET /v3/v3/manageable_volumes/detail?host=text HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "manageable-volumes": [
    {
      "reference": {},
      "size": 1,
      "safe_to_manage": true,
      "reason_not_safe": "text",
      "cinder_id": "123e4567-e89b-12d3-a456-426614174000",
      "extra_info": "text"
    }
  ]
}

Last updated

Was this helpful?