Supported OpenStack block storage (Cinder) APIs
These OpenStack block storage APIs are supported in IBM® Cloud Infrastructure Center.
For information about how to use them, refer to the OpenStack Docs: Block storage API.
Volumes
Table 1. OpenStack block storage volumes APIs that are used with IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| POST | /v3/{tenant_id}/volumes | Creates a volume. Specify multiattach=True to create a multiattach-capable volume. |
| GET | /v3/{tenant_id}/volumes | Views a list of simple volume entities. |
| GET | /v3/{tenant_id}/volumes/detail | Views a list of detailed volume entities. |
| GET | /v3/{tenant_id}/volumes/{volume_id} | Views all information about a specified volume. |
| DELETE | /v3/{tenant_id}/volumes/{volume_id} | Deletes a specified volume. |
| POST | /v3/{project_id}/volumes/{volume_id}/action | Extends a volume size. |
Volume types
Volume types called storage templates in IBM Cloud Infrastructure Center.
Table 2. OpenStack block storage volume types APIs that are used with IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| POST | /v3/{tenant_id}/types | Creates a volume type. For information about the keys that are supported, see Supported volume type extra-specs. |
| GET | /v3/{tenant_id}/types | Requests a list of volume types. |
| GET | /v3/{tenant_id}/types/{volume_type_id} | Requests a single volume type. |
| PUT | /v3/{tenant_id}/types/{volume_type_id} | Updates a volume type. |
| DELETE | /v3/{tenant_id}/types/{volume_type_id} | Deletes a volume type. |
| PUT | /v3/{tenant_id}/types/{volume_type_id}/extra_specs/{key_id} | Updates the extra specs of a volume type. For information about the keys that are supported, see Supported volume type extra-specs. |
Hosts
Table 3. OpenStack block storage hosts APIs that are used with IBM Cloud Infrastructure Center.
| Method | URI | Description |
|---|---|---|
| GET | /v3/{tenant_id}/os-hosts | Lists all hosts. |
| GET | /v3/{tenant_id}/os-hosts/{host_name} | Describes a specific host. |
Quotas APIs
Table 4. OpenStack quotas APIs that are used with IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| GET | /v3/{project_id}/os-quota-sets/{project_id} | Shows quotas for a project. Pass the usage=True query parameter to view current usage. |
| GET | /v3/{project_id}/os-quota-sets/defaults | Retrieves default quotas for a project. |
| PUT | /v3/{project_id}/os-quota-sets/{project_id} | Updates quotas for a project. |
| DELETE | /v3/{project_id}/os-quota-sets/{project_id} | Deletes quotas for a project. |
Generic groups APIs
The IBM Cloud Infrastructure Center consistency groups feature uses OpenStack generic volume group APIs.
Table 5. Openstack generic group APIs that are used with the IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| GET | /v3/{project_id}/groups | List groups. |
| GET | /v3/{project_id}/groups/detail | List groups with details. |
| GET | /v3/{project_id}/groups/{group_id} | Show group details. |
| POST | /v3/{project_id}/groups | Create a group. |
| POST | /v3/{tenant_id}/groups/{group_id}/action | Delete a group. |
| POST | /v3/{tenant_id}/groups/action | Clone a group or create group from snapshot. Refer to Clone consistency groups or create consistency group from group snapshot for details. |
| PUT | /v3/{project_id}/groups/{group_id} | Update a group. |
| POST | /v3/{tenant_id}/groups/{group_id}/action | Delete a group. |
| POST | /v3/{project_id}/groups/{group_id}/action | Reset group status. |
Group snapshots APIs
The IBM Cloud Infrastructure Center consistency group snapshots feature uses OpenStack generic group snapshot APIs.
Table 5. Openstack group snapshot APIs that are used with the IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| GET | /v3/{project_id}/group_snapshots | List group snapshots |
| GET | /v3/{project_id}/group_snapshots/detail | List group snapshots with details. |
| GET | /v3/{project_id}/group_snapshots/{group_snapshot_id} | Show group snapshot details |
| POST | /v3/{project_id}/group_snapshots | Create a group snapshot. |
| POST | /v3/{project_id}/group_snapshots/{group_snapshot_id}/action | Reset group snapshot status |
| DELETE | /v3/{project_id}/group_snapshots/{group_snapshot_id} | Delete group snapshot |
Group types APIs
To create a generic volume group, you must specify a group type.
The IBM Cloud Infrastructure Center only supports
default_grouptype
, currently.
Table 6. Openstack group type API that is used with the IBM Cloud Infrastructure Center
| Method | URI | Description |
|---|---|---|
| GET | /v3/{project_id}/group_types | List group types |