Updated on 2024-03-26 GMT+08:00

API Actions

This topic describes only the authorization information of EVS v2 APIs. For the v3 APIs that provide the same functions as their v2 APIs, their authorization information is the same as that of the v2 APIs.

For example, the v2 API for creating disks is POST /v2/{project_id}/cloudvolumes, and the v3 API for creating disks is POST /v3/{project_id}/cloudvolumes. The authorization information of both APIs is the same.

In the following tables, √ indicates that the item is supported, and × indicates that the item is not supported.

API Version Query

Permission

API

Action

Query API versions (OpenStack Cinder API).

GET /

None

Query the API version (OpenStack Cinder API).

GET /{api_version}

None

EVS Disk

Permission

API

Action

Create EVS disks.

POST /v2/{project_id}/cloudvolumes

evs:volumes:create

Create EVS disks (OpenStack Cinder API).

POST /v2/{project_id}/volumes

  • Create empty EVS disks.

    evs:volumes:create

    evs:volumes:get

  • Create EVS disks from images.

    evs:volumes:create

    ims:images:get

    evs:volumes:get

  • Create EVS disks from snapshots.

    evs:volumes:create

    evs:snapshots:get

    evs:volumes:get

Expand the capacity of an EVS disk.

POST /v2/{project_id}/cloudvolumes/{volume_id}/action

evs:volumes:extend

Query EVS disks.

GET /v2/{project_id}/cloudvolumes

evs:volumes:list

Query EVS disks (OpenStack Cinder API).

GET /v2/{project_id}/volumes

evs:volumes:list

Query details of all EVS disks.

GET /v2/{project_id}/cloudvolumes/detail

evs:volumes:list

Querying Details About All Disks

GET /v2/{project_id}/os-vendor-volumes/detail

evs:volumes:list

Query details of all EVS disks (OpenStack Cinder API).

GET /v2/{project_id}/volumes/detail

evs:volumes:list

Query details of an EVS disk.

GET /v2/{project_id}/os-vendor-volumes/{volume_id}

evs:volumes:get

Query details of an EVS disk (OpenStack Cinder API).

GET /v2/{project_id}/volumes/{volume_id}

evs:volumes:get

Delete an EVS disk.

DELETE /v2/{project_id}/cloudvolumes/{volume_id}

evs:volumes:delete

Delete an EVS disk (OpenStack Cinder API).

DELETE /v2/{project_id}/volumes/{volume_id}

evs:volumes:delete

evs:volumes:get

Update EVS disk information.

PUT /v2/{project_id}/cloudvolumes/{volume_id}

evs:volumes:update

Update EVS disk information (OpenStack Cinder API).

PUT /v2/{project_id}/volumes/{volume_id}

evs:volumes:update

evs:volumes:get

Update one piece of EVS disk metadata (OpenStack Cinder API).

PUT /v2/{project_id}/volumes/{volume_id}/metadata/{key}

evs:volumes:update

evs:volumes:get

Update the metadata of an EVS disk (OpenStack Cinder API).

PUT /v2/{project_id}/volumes/{volume_id}/metadata

evs:volumes:update

evs:volumes:get

Query one piece of EVS disk metadata (OpenStack Cinder API).

GET /v2/{project_id}/volumes/{volume_id}/metadata/{key}

evs:volumes:get

Delete one piece of EVS disk metadata (OpenStack Cinder API).

DELETE /v2/{project_id}/volumes/{volume_id}/metadata/{key}

evs:volumes:delete

evs:volumes:get

Query the metadata of an EVS disk (OpenStack Cinder API).

GET /v2/{project_id}/volumes/{volume_id}/metadata/{key}

evs:volumes:get

Add the metadata of an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/metadata

evs:volumes:update

evs:volumes:get

Query EVS disk types (OpenStack Cinder API).

GET /v2/{project_id}/types

evs:types:get

Query details of an EVS disk type (OpenStack Cinder API).

GET /v2/{project_id}/types/{type_id}

evs:types:get

Query tenant quotas (OpenStack Cinder API).

GET /v2/{project_id}/os-quota-sets/{project_id}

evs:quotas:get

Query extension APIs (OpenStack Cinder API).

GET /v2/{project_id}/extensions

None

Query information of all AZs (OpenStack Cinder API).

GET /v2/{project_id}/os-availability-zone

None

EVS Disk Actions

Permission

API

Action

Expand the capacity of an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-extend"

evs:volumes:extend

evs:volumes:get

Export the EVS disk data as an image (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-volume_upload_image"

evs:volumes:uploadImage

Attach an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-attach"

evs:volumes:attach

evs:volumes:get

Detach an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-detach"

evs:volumes:detach

evs:volumes:get

Reserve an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-reserve"

evs:volumes:attach

Cancel reservation of an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-unreserve"

evs:volumes:attach

Set the bootable flag for an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-set_bootable"

evs:volumes:update

Set the read-only attribute for an EVS disk (OpenStack Cinder API).

POST /v2/{project_id}/volumes/{volume_id}/action

action="os-update_readonly_flag"

evs:volumes:update

EVS Snapshot

Permission

API

Action

Create an EVS snapshot (OpenStack Cinder API).

POST /v2/{project_id}/snapshots

evs:snapshots:create

evs:volumes:get

Query EVS snapshots (OpenStack Cinder API).

GET /v2/{project_id}/snapshots

evs:snapshots:list

Query details of EVS snapshots (OpenStack Cinder API).

GET /v2/{project_id}/snapshots/detail

evs:snapshots:list

Update an EVS snapshot (OpenStack Cinder API).

PUT /v2/{project_id}/snapshots/{snapshot_id}

evs:snapshots:update

evs:snapshots:get

Query details about a single EVS snapshot (OpenStack Cinder API).

GET /v2/{project_id}/snapshots/{snapshot_id}

evs:snapshots:get

Delete an EVS snapshot (OpenStack Cinder API).

DELETE /v2/{project_id}/snapshots/{snapshot_id}

evs:snapshots:delete

evs:snapshots:get

evs:volumes:get

Roll back a snapshot to an EVS disk.

POST /v2/{project_id}/os-vendor-snapshots/{snapshot_id}/rollback

evs:snapshots:rollback

evs:snapshots:get

evs:volumes:get

Add the metadata of an EVS snapshot (OpenStack Cinder API).

POST /v2/{project_id}/snapshots/{snapshot_id}/metadata

evs:snapshots:update

evs:snapshots:get

Query the metadata of an EVS snapshot (OpenStack Cinder API).

GET /v2/{project_id}/snapshots/{snapshot_id}/metadata

evs:snapshots:get

Update one piece of EVS snapshot metadata (OpenStack Cinder API).

PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}

evs:snapshots:update

evs:snapshots:get

Update the metadata of an EVS snapshot (OpenStack Cinder API).

PUT /v2/{project_id}/snapshots/{snapshot_id}/metadata

evs:snapshots:update

evs:snapshots:get

Query one piece of EVS snapshot metadata (OpenStack Cinder API).

GET /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}

evs:snapshots:get

Delete one piece of EVS snapshot metadata (OpenStack Cinder API).

DELETE /v2/{project_id}/snapshots/{snapshot_id}/metadata/{key}

evs:snapshots:delete

evs:snapshots:get