• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Volumes
  6. Overview

Overview

Object

This interface is used to manage and perform operations on volumes, including querying volumes, creating a volume, querying a specified volume, deleting a volume, and updating a volume.

Object Model

Volume attribute list

Attribute

Type

CRUD

Default Value

Restriction

Remarks

created_at

Datetime

R

N/A

N/A

Specifies the time when a volume was created.

updated_at

Datetime

RU

N/A

N/A

Specifies the time when a volume was updated.

deleted_at

Datetime

R

N/A

N/A

Specifies the time when a volume was deleted.

deleted

Boolean

R

N/A

N/A

Specifies whether a volume is deleted.

id

String

R

N/A

N/A

Specifies the volume ID.

ec2_id

String

R

N/A

N/A

Specifies the backend storage information of the volume.

user_id

String

R

N/A

Existing user ID

Specifies the ID of the user to which the volume belongs.

project_id

String

R

N/A

Existing tenant ID

Specifies the ID of the tenant to which the volume belongs.

host

String

R

N/A

Existing host name

If the volume is created from a snapshot and snapshot_same_host is enabled, the new volume and snapshot are created on the same host. If the volume is created from a source volume, the new volume and source volume are created on the same host.

Specifies the host with cinder-volume deployed to which the volume belongs.

size

Int

RC

N/A

The value cannot be less than 0. If the volume is created from a source volume or image, the size of the new volume cannot be less than that of the source volume and snapshot.

Specifies the volume size.

availability_zone

String

RC

az1.dc1

N/A

Specifies the AZ to which the volume belongs.

instance_uuid

String

RC

N/A

Existing ECS UUID

Specifies the ECS to which the volume is attached.

mountpoint

String

RC

N/A

N/A

Specifies the attachment point.

attach_time

String

R

N/A

N/A

Specifies the time when the volume is attached to the ECS.

status

String

RU

N/A

N/A

Specifies the volume status.

attach_status

String

R

detached

N/A

Specifies the volume attachment status.

scheduled_at

Datetime

R

N/A

N/A

Specifies the volume scheduling time.

launched_at

Datetime

R

N/A

N/A

Specifies the time when a volume was created.

terminated_at

Datetime

R

N/A

N/A

Specifies the time when a volume was deleted.

display_name

String

RUCD

N/A

Corresponding to name specified during volume creation

Specifies the volume name.

display_description

String

RUCD

N/A

N/A

Specifies the volume description.

provider_location

String

R

N/A

The value varies based on the driver.

Specifies the volume location.

provider_auth

String

R

N/A

The value varies based on the driver.

Specifies the parameter for volume location access authentication.

snapshot_id

String

RC

N/A

N/A

Specifies the ID of the volume snapshot.

volume_type_id

String

RC

N/A

N/A

Specifies the volume type ID.

source_volid

String

RCUD

N/A

N/A

Specifies the source volume ID.

metadata

List(Dict)

RCUD

N/A

N/A

Specifies the volume metadata.

bootable

Boolean

R

N/A

N/A

Specifies whether the volume is bootable.

Specifies the volume status.

Parameter

Description

CREATING

The volume is being created.

AVAILABLE

The volume is created and can be attached to an ECS.

IN-USE

The volume is attached to an ECS and used.

ERROR

A volume error occurred.

ATTACHING

The volume is being attached to an ECS.

ERROR_ATTACHING

An error occurred during volume attachment.

DETACHING

The volume is being detached from an ECS.

ERROR_DETACHING

An error occurred during volume detachment.

BACKING-UP

The volume is being backed up.

RESTORING-BACKUP

The volume is being restored.

ERROR_RESTORING

An error occurred during volume restoration using a backup.

UPLOADING

The images are being exported from a volume.

EXTENDING

The capacity of the volume is being expanded.

ERROR_EXTENDING

An error occurred during volume capacity expansion.

RETYPING

The type of the volume is being changed.

AWAITING-TRANSFER

The volume is being transferred.

DELETING

The volume is being deleted.

ERROR_DELETING

An error occurred during volume deletion.

DELETED

The volume is deleted.