Groups

Generic volume group management

List groups

get

Lists all generic volume groups

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

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/groups
200

OK

Create group

post

Creates a generic volume group

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body
Responses
post
/v3/groups
202

Accepted

List groups with details

get

Lists all generic volume groups with details

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

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/groups/detail
200

OK

Show group details

get

Shows details for a group

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
group_idstring · uuidRequired

The UUID of the group

Responses
200

OK

application/json
get
/v3/groups/{group_id}
200

OK

Update group

put

Updates a group

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
group_idstring · uuidRequired

The UUID of the group

Body
Responses
200

OK

application/json
put
/v3/groups/{group_id}
200

OK

Delete group

delete

Deletes a group

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
group_idstring · uuidRequired

The UUID of the group

Query parameters
delete-volumesbooleanOptional

Also delete volumes in the group

Default: false
Responses
delete
/v3/groups/{group_id}
202

Request is accepted, but processing may take some time

No content

Perform group action

post

Performs various actions on a group

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
group_idstring · uuidRequired

The UUID of the group

Body
or
or
or
or
or
or
Responses
200

OK (for list operations)

application/json
Responseobject
post
/v3/groups/{group_id}/action

Last updated

Was this helpful?