Block Storage

Version:

3.70

Note

attachments

Lists all, lists all with details, shows details for, creates, and deletes attachment.

Note: Everything except for Complete attachment is new as of the 3.27 microversion. Complete attachment is new as of the 3.44 microversion.

When you create, list, update, or delete attachment, the possible status values are:

• attached: A volume is attached for the attachment.

• attaching: A volume is attaching for the attachment.

• detached: A volume is detached for the attachment.

• reserved: A volume is reserved for the attachment.

• error_attaching: A volume is error attaching for the attachment.

• error_detaching: A volume is error detaching for the attachment.

• deleted: The attachment is deleted.

GET

/v3/{project_id}/attachments/detail

List attachments with details

Lists all attachments with details. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Available starting in the 3.27 microversion.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/attachments

List attachments

Lists all attachments, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Available starting in the 3.27 microversion.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/attachments

Create attachment

Creates an attachment.

Available starting in the 3.27 microversion.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/attachments/{id} API
  attachment	body	object	An attachment object.
  attachment.instance_uuid	body	string	The UUID of the volume which the attachment belongs to.
  attachment.connector	body	[‘object’, ‘null’]	The connector object.
  attachment.volume_uuid	body	string	The UUID of the volume which the attachment belongs to.
  attachment.mode	body	string	The attach mode of attachment, acceptable values are read-only (‘ro’) and read-and-write (‘rw’). New in version 3.54

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "attachment": {
            "type": "object",
            "description": "An attachment object.",
            "properties": {
              "instance_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "connector": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The `connector` object."
              },
              "volume_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_uuid"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.27",
          "max-ver": "3.53"
        },
        "required": [
          "attachment"
        ]
      },
      {
        "type": "object",
        "properties": {
          "attachment": {
            "type": "object",
            "description": "An attachment object.",
            "properties": {
              "instance_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "connector": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The `connector` object."
              },
              "volume_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "mode": {
                "type": "string",
                "enum": [
                  "rw",
                  "ro"
                ],
                "description": "The attach mode of attachment, acceptable values are\nread-only (\u2018ro\u2019) and read-and-write (\u2018rw\u2019).\n\n\n**New in version 3.54**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_uuid"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.54"
        },
        "required": [
          "attachment"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

POST

/v3/{project_id}/attachments/{id}/action

`os-complete` action

Empty body for os-complete action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/attachments/{id}/action API
  id	path	string	id parameter for /v3/attachments/{id}/action API
  os-complete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-complete action",
    "properties": {
      "os-complete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-complete"
    }
  }
  

Responses

204

Ok

404

Error

GET

/v3/{project_id}/attachments/{id}

Return data about the given attachment.

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

PUT

/v3/{project_id}/attachments/{id}

Update an attachment record.

Update a reserved attachment record with connector information and set up the appropriate connection_info from the driver.

Expected format of the input parameter ‘body’:

{
    "attachment":
    {
        "connector":
        {
            "initiator": "iqn.1993-08.org.debian:01:cad181614cec",
            "ip": "192.168.1.20",
            "platform": "x86_64",
            "host": "tempest-1",
            "os_type": "linux2",
            "multipath": false,
            "mountpoint": "/dev/vdb",
            "mode": "None|rw|ro"
        }
    }
}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/attachments/{id} API
  id	path	string	id parameter for /v3/attachments/{id} API
  attachment	body	object
  attachment.connector	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "attachment": {
        "type": "object",
        "properties": {
          "connector": {
            "type": "object",
            "minProperties": 1
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.27"
    },
    "required": [
      "attachment"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

DELETE

/v3/{project_id}/attachments/{id}

Delete an attachment.

Disconnects/Deletes the specified attachment, returns a list of any known shared attachment-id’s for the effected backend device.

returns: A summary list of any attachments sharing this connection

Responses

204

Ok

404

Error

GET

/v3/attachments/detail

Return a detailed list of attachments.

Responses

200

Ok

404

Error

GET

/v3/attachments

Return a summary list of attachments.

Responses

200

Ok

404

Error

POST

/v3/attachments

Create an attachment.

This method can be used to create an empty attachment (reserve) or to create and initialize a volume attachment based on the provided input parameters.

If the caller does not yet have the connector information but needs to reserve an attachment for the volume (ie Nova BootFromVolume) the create can be called with just the volume-uuid and the server identifier. This will reserve an attachment, mark the volume as reserved and prevent any new attachment_create calls from being made until the attachment is updated (completed).

The alternative is that the connection can be reserved and initialized all at once with a single call if the caller has all of the required information (connector data) at the time of the call.

NOTE: In Nova terms server == instance, the server_id parameter referenced below is the UUID of the Instance, for non-nova consumers this can be a server UUID or some other arbitrary unique identifier.

Starting from microversion 3.54, we can pass the attach mode as argument in the request body.

Expected format of the input parameter ‘body’:

{
    "attachment":
    {
        "volume_uuid": "volume-uuid",
        "instance_uuid": "null|nova-server-uuid",
        "connector": "null|<connector-object>",
        "mode": "null|rw|ro"
    }
}

Example connector:

{
    "connector":
    {
        "initiator": "iqn.1993-08.org.debian:01:cad181614cec",
        "ip": "192.168.1.20",
        "platform": "x86_64",
        "host": "tempest-1",
        "os_type": "linux2",
        "multipath": false,
        "mountpoint": "/dev/vdb",
        "mode": "null|rw|ro"
    }
}

NOTE all that’s required for a reserve is volume_uuid and an instance_uuid.

returns: A summary view of the attachment object

Request

• Description

  Name	Location	Type	Description
  attachment	body	object	An attachment object.
  attachment.instance_uuid	body	string	The UUID of the volume which the attachment belongs to.
  attachment.connector	body	[‘object’, ‘null’]	The connector object.
  attachment.volume_uuid	body	string	The UUID of the volume which the attachment belongs to.
  attachment.mode	body	string	The attach mode of attachment, acceptable values are read-only (‘ro’) and read-and-write (‘rw’). New in version 3.54

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "attachment": {
            "type": "object",
            "description": "An attachment object.",
            "properties": {
              "instance_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "connector": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The `connector` object."
              },
              "volume_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_uuid"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.27",
          "max-ver": "3.53"
        },
        "required": [
          "attachment"
        ]
      },
      {
        "type": "object",
        "properties": {
          "attachment": {
            "type": "object",
            "description": "An attachment object.",
            "properties": {
              "instance_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "connector": {
                "type": [
                  "object",
                  "null"
                ],
                "description": "The `connector` object."
              },
              "volume_uuid": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume which the attachment belongs\nto."
              },
              "mode": {
                "type": "string",
                "enum": [
                  "rw",
                  "ro"
                ],
                "description": "The attach mode of attachment, acceptable values are\nread-only (\u2018ro\u2019) and read-and-write (\u2018rw\u2019).\n\n\n**New in version 3.54**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_uuid"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.54"
        },
        "required": [
          "attachment"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

POST

/v3/attachments/{id}/action

`os-complete` action

Empty body for os-complete action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/attachments/{id}/action API
  os-complete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-complete action",
    "properties": {
      "os-complete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-complete"
    }
  }
  

Responses

204

Ok

404

Error

GET

/v3/attachments/{id}

Return data about the given attachment.

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

PUT

/v3/attachments/{id}

Update an attachment record.

Update a reserved attachment record with connector information and set up the appropriate connection_info from the driver.

Expected format of the input parameter ‘body’:

{
    "attachment":
    {
        "connector":
        {
            "initiator": "iqn.1993-08.org.debian:01:cad181614cec",
            "ip": "192.168.1.20",
            "platform": "x86_64",
            "host": "tempest-1",
            "os_type": "linux2",
            "multipath": false,
            "mountpoint": "/dev/vdb",
            "mode": "None|rw|ro"
        }
    }
}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/attachments/{id} API
  attachment	body	object
  attachment.connector	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "attachment": {
        "type": "object",
        "properties": {
          "connector": {
            "type": "object",
            "minProperties": 1
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.27"
    },
    "required": [
      "attachment"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
attachment	body	object	An attachment object.
attachment.attach_mode	body	string	The attach mode of attachment, read-only (‘ro’) or read-and-write (‘rw’), default is ‘rw’. New in version 3.54
attachment.attached_at	body	string	The time when attachment is attached.
attachment.connection_info	body	object	The connection info used for server to connect the volume.
attachment.detached_at	body	string	The time when attachment is detached.
attachment.id	body	string	The ID of attachment.
attachment.instance	body	[‘string’, ‘null’]	The UUID of the attaching instance.
attachment.volume_id	body	string	The UUID of the volume which the attachment belongs to.
attachment.status	body	string	The status of the attachment.

404

Error

DELETE

/v3/attachments/{id}

Delete an attachment.

Disconnects/Deletes the specified attachment, returns a list of any known shared attachment-id’s for the effected backend device.

returns: A summary list of any attachments sharing this connection

Responses

204

Ok

404

Error

backups

A backup is a full copy of a volume stored in an external service. The service can be configured. The only supported service is Object Storage. A backup can subsequently be restored from the external service to either the same volume that the backup was originally taken from or to a new volume.

When you create, list, or delete backups, these status values are possible:

• creating: The backup is being created.

• available: The backup is ready to restore to a volume.

• deleting: The backup is being deleted.

• error: A backup error occurred.

• restoring: The backup is being restored to a volume.

• error_deleting: An error occurred while deleting the backup.

If an error occurs, you can find more information about the error in the fail_reason field for the backup.

GET

/v3/{project_id}/backups/detail

List backups with detail

Lists Block Storage backups, with details, to which the project has access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/backups

List backups for project

Lists Block Storage backups to which the project has access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/backups

Create a backup

Creates a Block Storage backup from a volume or snapshot.

The status of the volume must be available or if the force flag is used, backups of in-use volumes may also be created.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/{id} API
  backup	body	object	A backup object.
  backup.volume_id	body	string	The UUID of the volume that you want to back up.
  backup.container	body	[‘string’, ‘null’]	The container name or null.
  backup.description	body	[‘string’, ‘null’]	The backup description or null.
  backup.incremental	body	[‘boolean’, ‘string’]	Indicates whether to backup, even if the volume is attached. Default is false. See valid boolean values
  backup.force	body	[‘boolean’, ‘string’]	Indicates whether to backup, even if the volume is attached. Default is false. See valid boolean values
  backup.name	body	[‘string’, ‘null’]	The name of the Volume Backup.
  backup.metadata	body	[‘object’, ‘null’]	The backup metadata key value pairs. New in version 3.43
  backup.availability_zone	body	[‘string’, ‘null’]	The backup availability zone key value pair. New in version 3.51

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.42"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "The backup metadata key value pairs.\n\n\n**New in version 3.43**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.43",
          "max-ver": "3.50"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "The backup metadata key value pairs.\n\n\n**New in version 3.43**"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The backup availability zone key value pair.\n\n\n**New in version 3.51**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.51"
        },
        "required": [
          "backup"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/{project_id}/backups/{id}

Return data about the given backup.

Responses

200

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

PUT

/v3/{project_id}/backups/{id}

Update a backup.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/{id} API
  id	path	string	id parameter for /v3/backups/{id} API
  backup	body	[‘object’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.9",
          "max-ver": "3.42"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "metadata": {
                "type": "object",
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.43"
        },
        "required": [
          "backup"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/{project_id}/backups/{id}

Delete a backup.

Responses

202

Ok

404

Error

GET

/v3/backups/detail

Returns a detailed list of backups.

Responses

200

Ok

404

Error

GET

/v3/backups

Returns a summary list of backups.

Responses

200

Ok

404

Error

POST

/v3/backups

Create a new backup.

Request

• Description

  Name	Location	Type	Description
  backup	body	object	A backup object.
  backup.volume_id	body	string	The UUID of the volume that you want to back up.
  backup.container	body	[‘string’, ‘null’]	The container name or null.
  backup.description	body	[‘string’, ‘null’]	The backup description or null.
  backup.incremental	body	[‘boolean’, ‘string’]	Indicates whether to backup, even if the volume is attached. Default is false. See valid boolean values
  backup.force	body	[‘boolean’, ‘string’]	Indicates whether to backup, even if the volume is attached. Default is false. See valid boolean values
  backup.name	body	[‘string’, ‘null’]	The name of the Volume Backup.
  backup.metadata	body	[‘object’, ‘null’]	The backup metadata key value pairs. New in version 3.43
  backup.availability_zone	body	[‘string’, ‘null’]	The backup availability zone key value pair. New in version 3.51

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.42"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "The backup metadata key value pairs.\n\n\n**New in version 3.43**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.43",
          "max-ver": "3.50"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": "object",
            "description": "A `backup` object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume that you want to back up."
              },
              "container": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The container name or null."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
                "description": "The backup description or null."
              },
              "incremental": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Indicates whether to backup, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The name of the Volume Backup."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "The UUID of the volume that you want to back up."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The UUID of the source snapshot that you want to back up."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "The backup metadata key value pairs.\n\n\n**New in version 3.43**"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The backup availability zone key value pair.\n\n\n**New in version 3.51**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.51"
        },
        "required": [
          "backup"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/backups/{id}

Return data about the given backup.

Responses

200

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

PUT

/v3/backups/{id}

Update a backup.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/backups/{id} API
  backup	body	[‘object’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.9",
          "max-ver": "3.42"
        },
        "required": [
          "backup"
        ]
      },
      {
        "type": "object",
        "properties": {
          "backup": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "metadata": {
                "type": "object",
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.43"
        },
        "required": [
          "backup"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.availability_zone	body	string	The name of the availability zone.
backup.container	body	[‘string’, ‘null’]	The container name or null.
backup.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601
backup.data_timestamp	body	string	The time when the data on the volume was first saved. If it is a backup from volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it will be the same as created_at for the snapshot.
backup.description	body	[‘string’, ‘null’]	The backup description or null.
backup.fail_reason	body	[‘string’, ‘null’]	If the backup failed, the reason for the failure. Otherwise, null.
backup.has_dependent_backups	body	boolean	If this value is true, there are other backups depending on this backup.
backup.id	body	string	The UUID of the backup.
backup.is_incremental	body	boolean	Indicates whether the backup mode is incremental. If this value is true, the backup mode is incremental. If this value is false, the backup mode is full.
backup.metadata	body	object	The backup metadata key value pairs. New in version 3.43
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.object_count	body	integer	The number of objects in the backup.
backup.size	body	integer	The size of the volume, in gibibytes (GiB).
backup.snapshot_id	body	[‘string’, ‘null’]	The UUID of the source volume snapshot.
backup.status	body	string	The backup status. Refer to Backup statuses table for the possible status value.
backup.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601
backup.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/backups/{id}

Delete a backup.

Responses

202

Ok

404

Error

POST

/v3/{project_id}/backups/import_record

Import a backup

Import information about a backup.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/import_record API
  backup-record	body	object	An object recording volume backup metadata, including backup_service and backup_url.
  backup-record.backup_service	body	string	The service used to perform the backup.
  backup-record.backup_url	body	string	An identifier string to locate the backup.

• Schema

  {
    "type": "object",
    "properties": {
      "backup-record": {
        "type": "object",
        "description": "An object recording volume backup metadata, including `backup_service`\nand `backup_url`.",
        "properties": {
          "backup_service": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255,
            "description": "The service used to perform the backup."
          },
          "backup_url": {
            "type": "string",
            "minLength": 1,
            "format": "base64",
            "description": "An identifier string to locate the backup."
          }
        },
        "additionalProperties": false,
        "required": [
          "backup_service",
          "backup_url"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "backup-record"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.id	body	string	The UUID of the backup.

404

Error

POST

/v3/{project_id}/backups/{id}/restore

Restore an existing backup to a volume.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/{id}/restore API
  id	path	string	id parameter for /v3/backups/{id}/restore API
  restore	body	[‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "restore": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "volume_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "required": [
      "restore"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
restore	body	object
restore.backup_id	body	string	The UUID for a backup.
restore.volume_id	body	string	The UUID of the volume.
restore.backup_name	body	string	The volume name.

404

Error

POST

/v3/{project_id}/backups/{id}/action

`os-reset_status` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/{id}/action API
  id	path	string	id parameter for /v3/backups/{id}/action API
  os-reset_status	body	object
  os-reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "backup_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-reset_status"
    },
    "required": [
      "os-reset_status"
    ]
  }
  

Responses

202

Ok

404

Error

POST

/v3/{project_id}/backups/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/backups/{id}/action API
  id	path	string	id parameter for /v3/backups/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/{project_id}/backups/{id}/export_record

Export a backup.

Responses

200

Ok

Name	Location	Type	Description
backup-record	body	object	An object recording volume backup metadata, including backup_service and backup_url.
backup-record.backup_service	body	string	The service used to perform the backup.
backup-record.backup_url	body	string	An identifier string to locate the backup.

404

Error

POST

/v3/backups/import_record

Import a backup.

Request

• Description

  Name	Location	Type	Description
  backup-record	body	object	An object recording volume backup metadata, including backup_service and backup_url.
  backup-record.backup_service	body	string	The service used to perform the backup.
  backup-record.backup_url	body	string	An identifier string to locate the backup.

• Schema

  {
    "type": "object",
    "properties": {
      "backup-record": {
        "type": "object",
        "description": "An object recording volume backup metadata, including `backup_service`\nand `backup_url`.",
        "properties": {
          "backup_service": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255,
            "description": "The service used to perform the backup."
          },
          "backup_url": {
            "type": "string",
            "minLength": 1,
            "format": "base64",
            "description": "An identifier string to locate the backup."
          }
        },
        "additionalProperties": false,
        "required": [
          "backup_service",
          "backup_url"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "backup-record"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
backup	body	object	A backup object.
backup.name	body	[‘string’, ‘null’]	The backup name.
backup.id	body	string	The UUID of the backup.

404

Error

POST

/v3/backups/{id}/restore

Restore an existing backup to a volume.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/backups/{id}/restore API
  restore	body	[‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "restore": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "volume_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "required": [
      "restore"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
restore	body	object
restore.backup_id	body	string	The UUID for a backup.
restore.volume_id	body	string	The UUID of the volume.
restore.backup_name	body	string	The volume name.

404

Error

POST

/v3/backups/{id}/action

`os-reset_status` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/backups/{id}/action API
  os-reset_status	body	object
  os-reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "backup_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-reset_status"
    },
    "required": [
      "os-reset_status"
    ]
  }
  

Responses

202

Ok

404

Error

POST

/v3/backups/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/backups/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/backups/{id}/export_record

Export a backup.

Responses

200

Ok

Name	Location	Type	Description
backup-record	body	object	An object recording volume backup metadata, including backup_service and backup_url.
backup-record.backup_service	body	string	The service used to perform the backup.
backup-record.backup_url	body	string	An identifier string to locate the backup.

404

Error

capabilities

Shows capabilities for a storage back end.

GET

/v3/{project_id}/capabilities/{id}

Return capabilities list of given backend.

Responses

200

Ok

404

Error

GET

/v3/capabilities/{id}

Return capabilities list of given backend.

Responses

200

Ok

404

Error

cgsnapshots

Lists all, lists all with details, shows details for, creates, and deletes consistency group snapshots.

GET

/v3/{project_id}/cgsnapshots/detail

List all consistency group snapshots with details

Lists all consistency group snapshots with details.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/cgsnapshots

List all consistency group snapshots

Lists all consistency group snapshots.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/cgsnapshots

Create a consistency group snapshot

Creates a consistency group snapshot.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/cgsnapshots/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/cgsnapshots:post operation",
    "x-openstack": {
      "action-name": "create"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/{project_id}/cgsnapshots/{id}

Return data about the given cgsnapshot.

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/cgsnapshots/{id}

Delete a cgsnapshot.

Responses

204

Ok

404

Error

GET

/v3/cgsnapshots/detail

Returns a detailed list of cgsnapshots.

Responses

200

Ok

404

Error

GET

/v3/cgsnapshots

Returns a summary list of cgsnapshots.

Responses

200

Ok

404

Error

POST

/v3/cgsnapshots

Create a new cgsnapshot.

Request

• Description

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/cgsnapshots:post operation",
    "x-openstack": {
      "action-name": "create"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/cgsnapshots/{id}

Return data about the given cgsnapshot.

Responses

200

Ok

404

Error

DELETE

/v3/cgsnapshots/{id}

Delete a cgsnapshot.

Responses

204

Ok

404

Error

clusters

Administrator only. Lists all Cinder clusters, show cluster detail, enable or disable a cluster.

Each cinder service runs on a host computer (possibly multiple services on the same host; it depends how you decide to deploy cinder). In order to support High Availability scenarios, services can be grouped into clusters where the same type of service (for example, cinder-volume) can run on different hosts so that if one host goes down the service is still available on a different host. Since there’s no point having these services sitting around doing nothing while waiting for some other host to go down (which is also known as Active/Passive mode), grouping services into clusters also allows cinder to support Active/Active mode in which all services in a cluster are doing work all the time.

Note: Currently the only service that can be grouped into clusters is cinder-volume.

Clusters are determined by the deployment configuration; that’s why there is no create-cluster API call listed below. Once your services are up and running, however, you can use the following API requests to get information about your clusters and to update their status.

GET

/v3/{project_id}/clusters/detail

List clusters with details

Lists all clusters with details.

Available starting in the 3.7 microversion.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/clusters

List clusters

Lists all clusters.

Available starting in the 3.7 microversion.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/clusters/{id}

Return data for a given cluster name with optional binary.

Responses

200

Ok

Name	Location	Type	Description
cluster	body	object
cluster.num_hosts	body	integer	The number of hosts in the cluster.
cluster.num_down_hosts	body	integer	The number of down hosts in the cluster.
cluster.last_heartbeat	body	string	The last periodic heartbeat received.
cluster.created_at	body	string	The date and time when the resource was created.
cluster.updated_at	body	string	The date and time when the resource was updated.
cluster.disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.
cluster.frozen	body	[‘boolean’, ‘null’]	Whether the cluster is frozen or not. New in version 3.26
cluster.active_backend_id	body	[‘string’, ‘null’]	The ID of active storage backend. Only in cinder-volume service. New in version 3.26
cluster.binary	body	string	The binary name of the services in the cluster.
cluster.name	body	string	The name of the service cluster.
cluster.replication_status	body	string	The cluster replication status. Only included in responses if configured.
cluster.state	body	string	The state of the cluster.
cluster.status	body	string	The status of the cluster.

404

Error

PUT

/v3/{project_id}/clusters/{id}

Enable/Disable scheduling for a cluster.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/clusters/{id} API
  id	path	string	id parameter for /v3/clusters/{id} API
  name	body	string	The name to identify the service cluster.
  binary	body	[‘string’, ‘null’]	The binary name of the services in the cluster.
  disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.

• Schema

  {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "format": "name",
        "description": "The name to identify the service cluster."
      },
      "binary": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 255,
        "description": "The binary name of the services in the cluster."
      },
      "disabled_reason": {
        "type": [
          "string",
          "null"
        ],
        "description": "The reason for disabling a resource."
      }
    },
    "additionalProperties": false,
    "required": [
      "name"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
cluster	body	object
cluster.num_hosts	body	integer	The number of hosts in the cluster.
cluster.num_down_hosts	body	integer	The number of down hosts in the cluster.
cluster.last_heartbeat	body	string	The last periodic heartbeat received.
cluster.created_at	body	string	The date and time when the resource was created.
cluster.updated_at	body	string	The date and time when the resource was updated.
cluster.disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.
cluster.frozen	body	[‘boolean’, ‘null’]	Whether the cluster is frozen or not. New in version 3.26
cluster.active_backend_id	body	[‘string’, ‘null’]	The ID of active storage backend. Only in cinder-volume service. New in version 3.26
cluster.binary	body	string	The binary name of the services in the cluster.
cluster.name	body	string	The name of the service cluster.
cluster.replication_status	body	string	The cluster replication status. Only included in responses if configured.
cluster.state	body	string	The state of the cluster.
cluster.status	body	string	The status of the cluster.

404

Error

GET

/v3/clusters/detail

Return a detailed list of all existing clusters.

Filter by is_up, disabled, num_hosts, and num_down_hosts.

Responses

200

Ok

404

Error

GET

/v3/clusters

Return a non detailed list of all existing clusters.

Filter by is_up, disabled, num_hosts, and num_down_hosts.

Responses

200

Ok

404

Error

GET

/v3/clusters/{id}

Return data for a given cluster name with optional binary.

Responses

200

Ok

Name	Location	Type	Description
cluster	body	object
cluster.num_hosts	body	integer	The number of hosts in the cluster.
cluster.num_down_hosts	body	integer	The number of down hosts in the cluster.
cluster.last_heartbeat	body	string	The last periodic heartbeat received.
cluster.created_at	body	string	The date and time when the resource was created.
cluster.updated_at	body	string	The date and time when the resource was updated.
cluster.disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.
cluster.frozen	body	[‘boolean’, ‘null’]	Whether the cluster is frozen or not. New in version 3.26
cluster.active_backend_id	body	[‘string’, ‘null’]	The ID of active storage backend. Only in cinder-volume service. New in version 3.26
cluster.binary	body	string	The binary name of the services in the cluster.
cluster.name	body	string	The name of the service cluster.
cluster.replication_status	body	string	The cluster replication status. Only included in responses if configured.
cluster.state	body	string	The state of the cluster.
cluster.status	body	string	The status of the cluster.

404

Error

PUT

/v3/clusters/{id}

Enable/Disable scheduling for a cluster.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/clusters/{id} API
  name	body	string	The name to identify the service cluster.
  binary	body	[‘string’, ‘null’]	The binary name of the services in the cluster.
  disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.

• Schema

  {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "format": "name",
        "description": "The name to identify the service cluster."
      },
      "binary": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 255,
        "description": "The binary name of the services in the cluster."
      },
      "disabled_reason": {
        "type": [
          "string",
          "null"
        ],
        "description": "The reason for disabling a resource."
      }
    },
    "additionalProperties": false,
    "required": [
      "name"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
cluster	body	object
cluster.num_hosts	body	integer	The number of hosts in the cluster.
cluster.num_down_hosts	body	integer	The number of down hosts in the cluster.
cluster.last_heartbeat	body	string	The last periodic heartbeat received.
cluster.created_at	body	string	The date and time when the resource was created.
cluster.updated_at	body	string	The date and time when the resource was updated.
cluster.disabled_reason	body	[‘string’, ‘null’]	The reason for disabling a resource.
cluster.frozen	body	[‘boolean’, ‘null’]	Whether the cluster is frozen or not. New in version 3.26
cluster.active_backend_id	body	[‘string’, ‘null’]	The ID of active storage backend. Only in cinder-volume service. New in version 3.26
cluster.binary	body	string	The binary name of the services in the cluster.
cluster.name	body	string	The name of the service cluster.
cluster.replication_status	body	string	The cluster replication status. Only included in responses if configured.
cluster.state	body	string	The state of the cluster.
cluster.status	body	string	The status of the cluster.

404

Error

consistencygroups

Consistency groups enable you to create snapshots at the exact same point in time from multiple volumes. For example, a database might place its tables, logs, and configuration on separate volumes. To restore this database from a previous point in time, it makes sense to restore the logs, tables, and configuration together from the exact same point in time.

Use the policy configuration file to grant permissions for these actions to limit roles.

GET

/v3/{project_id}/consistencygroups/detail

List consistency groups and details

Lists consistency groups with details.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/consistencygroups

List project’s consistency groups

Lists consistency groups.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/consistencygroups

Create a consistency group

Creates a consistency group.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/consistencygroups/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups:post operation",
    "x-openstack": {
      "action-name": "create"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/{project_id}/consistencygroups/{id}

Return data about the given consistency group.

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/consistencygroups/{id}

Update the consistency group.

Expected format of the input parameter ‘body’:

{
    "consistencygroup":
    {
        "name": "my_cg",
        "description": "My consistency group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/consistencygroups/{id} API
  id	path	string	id parameter for /v3/consistencygroups/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/consistencygroups/{id}

Delete a consistency group.

Responses

204

Ok

404

Error

GET

/v3/consistencygroups/detail

Returns a detailed list of consistency groups.

Responses

200

Ok

404

Error

GET

/v3/consistencygroups

Returns a summary list of consistency groups.

Responses

200

Ok

404

Error

POST

/v3/consistencygroups

Create a new consistency group.

Request

• Description

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups:post operation",
    "x-openstack": {
      "action-name": "create"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/consistencygroups/{id}

Return data about the given consistency group.

Responses

200

Ok

404

Error

PUT

/v3/consistencygroups/{id}

Update the consistency group.

Expected format of the input parameter ‘body’:

{
    "consistencygroup":
    {
        "name": "my_cg",
        "description": "My consistency group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/consistencygroups/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/consistencygroups/{id}

Delete a consistency group.

Responses

204

Ok

404

Error

POST

/v3/{project_id}/consistencygroups/create_from_src

Create a consistency group from source

Creates a consistency group from source.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/consistencygroups/create_from_src API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/create_from_src:post operation",
    "x-openstack": {
      "action-name": "create_from_src"
    }
  }
  

Responses

202

Ok

404

Error

POST

/v3/{project_id}/consistencygroups/{id}/delete

Delete a consistency group.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/consistencygroups/{id}/delete API
  id	path	string	id parameter for /v3/consistencygroups/{id}/delete API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id/delete:post operation",
    "x-openstack": {
      "action-name": "delete"
    }
  }
  

Responses

201

Ok

404

Error

PUT

/v3/{project_id}/consistencygroups/{id}/update

Update the consistency group.

Expected format of the input parameter ‘body’:

{
    "consistencygroup":
    {
        "name": "my_cg",
        "description": "My consistency group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/consistencygroups/{id}/update API
  id	path	string	id parameter for /v3/consistencygroups/{id}/update API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id/update:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

POST

/v3/consistencygroups/create_from_src

Create a new consistency group from a source.

The source can be a CG snapshot or a CG. Note that this does not require volume_types as the “create” API above.

Request

• Description

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/create_from_src:post operation",
    "x-openstack": {
      "action-name": "create_from_src"
    }
  }
  

Responses

202

Ok

404

Error

POST

/v3/consistencygroups/{id}/delete

Delete a consistency group.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/consistencygroups/{id}/delete API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id/delete:post operation",
    "x-openstack": {
      "action-name": "delete"
    }
  }
  

Responses

201

Ok

404

Error

PUT

/v3/consistencygroups/{id}/update

Update the consistency group.

Expected format of the input parameter ‘body’:

{
    "consistencygroup":
    {
        "name": "my_cg",
        "description": "My consistency group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/consistencygroups/{id}/update API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/consistencygroups/id/update:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

default-types

Manage a default volume type for individual projects.

By default, a volume-create request that does not specify a volume-type will assign the configured system default volume type to the volume. You can override this behavior on a per-project basis by setting a different default volume type for any project.

Available in microversion 3.62 or higher.

Note: The default policy for list API is system admin so you would require a system scoped token to access it. To get a system scoped token, you need to run the following command:

openstack –os-system-scope all –os-project-name=’’ token issue

GET

/v3/default-types/{id}

Return detail of a default type.

Responses

200

Ok

Name	Location	Type	Description
default_type	body	object
default_type.project_id	body	string	The UUID of the project.
default_type.volume_type_id	body	string	The UUID for an existing volume type.

404

Error

PUT

/v3/default-types/{id}

Set a default volume type for the specified project.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/default-types/{id} API
  default_type	body	object
  default_type.volume_type	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "default_type": {
        "type": "object",
        "properties": {
          "volume_type": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name"
          }
        },
        "additionalProperties": false,
        "required": [
          "volume_type"
        ]
      }
    },
    "x-openstack": {
      "min-ver": "3.62"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
default_type	body	object
default_type.project_id	body	string	The UUID of the project.
default_type.volume_type_id	body	string	The UUID for an existing volume type.

404

Error

DELETE

/v3/default-types/{id}

Unset a default volume type for a project.

Responses

204

Ok

404

Error

GET

/v3/default-types

Return a list of default types.

Responses

200

Ok

404

Error

group_snapshots

Lists all, lists all with details, shows details for, creates, and deletes group snapshots.

GET

/v3/{project_id}/group_snapshots/detail

List group snapshots with details

Lists all group snapshots with details. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/group_snapshots

List group snapshots

Lists all group snapshots, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/group_snapshots

Create group snapshot

Creates a group snapshot.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_snapshots/{id} API
  group_snapshot	body	object	The group snapshot.
  group_snapshot.group_id	body	string	The ID of the group.
  group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
  group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.

• Schema

  {
    "type": "object",
    "properties": {
      "group_snapshot": {
        "type": "object",
        "description": "The group snapshot.",
        "properties": {
          "group_id": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the group."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The group snapshot name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group snapshot description."
          }
        },
        "additionalProperties": false,
        "required": [
          "group_id"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14"
    },
    "required": [
      "group_snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_snapshot	body	object	The group snapshot.
group_snapshot.status	body	string	The status of the generic group snapshot.
group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.
group_snapshot.created_at	body	string	The date and time when the resource was created.
group_snapshot.group_type	body	string	The group type ID.
group_snapshot.group_id	body	string	The ID of the group.
group_snapshot.group_type_id	body	string	The group type ID.
group_snapshot.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
group_snapshot.id	body	string	The ID of the group snapshot.

404

Error

POST

/v3/{project_id}/group_snapshots/{id}/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_snapshots/{id}/action API
  id	path	string	id parameter for /v3/group_snapshots/{id}/action API
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_snapshot_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.19",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

404

Error

GET

/v3/{project_id}/group_snapshots/{id}

Return data about the given group_snapshot.

Responses

200

Ok

Name	Location	Type	Description
group_snapshot	body	object	The group snapshot.
group_snapshot.status	body	string	The status of the generic group snapshot.
group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.
group_snapshot.created_at	body	string	The date and time when the resource was created.
group_snapshot.group_type	body	string	The group type ID.
group_snapshot.group_id	body	string	The ID of the group.
group_snapshot.group_type_id	body	string	The group type ID.
group_snapshot.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
group_snapshot.id	body	string	The ID of the group snapshot.

404

Error

DELETE

/v3/{project_id}/group_snapshots/{id}

Delete a group_snapshot.

Responses

204

Ok

404

Error

GET

/v3/group_snapshots/detail

Returns a detailed list of group_snapshots.

Responses

200

Ok

404

Error

GET

/v3/group_snapshots

Returns a summary list of group_snapshots.

Responses

200

Ok

404

Error

POST

/v3/group_snapshots

Create a new group_snapshot.

Request

• Description

  Name	Location	Type	Description
  group_snapshot	body	object	The group snapshot.
  group_snapshot.group_id	body	string	The ID of the group.
  group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
  group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.

• Schema

  {
    "type": "object",
    "properties": {
      "group_snapshot": {
        "type": "object",
        "description": "The group snapshot.",
        "properties": {
          "group_id": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the group."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The group snapshot name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group snapshot description."
          }
        },
        "additionalProperties": false,
        "required": [
          "group_id"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14"
    },
    "required": [
      "group_snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_snapshot	body	object	The group snapshot.
group_snapshot.status	body	string	The status of the generic group snapshot.
group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.
group_snapshot.created_at	body	string	The date and time when the resource was created.
group_snapshot.group_type	body	string	The group type ID.
group_snapshot.group_id	body	string	The ID of the group.
group_snapshot.group_type_id	body	string	The group type ID.
group_snapshot.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
group_snapshot.id	body	string	The ID of the group snapshot.

404

Error

POST

/v3/group_snapshots/{id}/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/group_snapshots/{id}/action API
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_snapshot_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.19",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

404

Error

GET

/v3/group_snapshots/{id}

Return data about the given group_snapshot.

Responses

200

Ok

Name	Location	Type	Description
group_snapshot	body	object	The group snapshot.
group_snapshot.status	body	string	The status of the generic group snapshot.
group_snapshot.description	body	[‘string’, ‘null’]	The group snapshot description.
group_snapshot.created_at	body	string	The date and time when the resource was created.
group_snapshot.group_type	body	string	The group type ID.
group_snapshot.group_id	body	string	The ID of the group.
group_snapshot.group_type_id	body	string	The group type ID.
group_snapshot.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group_snapshot.name	body	[‘string’, ‘null’]	The group snapshot name.
group_snapshot.id	body	string	The ID of the group snapshot.

404

Error

DELETE

/v3/group_snapshots/{id}

Delete a group_snapshot.

Responses

204

Ok

404

Error

group_types

To create a generic volume group, you must specify a group type.

GET

/v3/{project_id}/group_types

List group types

Lists group types.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/group_types

Create group type

Creates a group type.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_types/{id} API
  group_type	body	object	A group_type object.
  group_type.name	body	string	The group type name.
  group_type.description	body	[‘string’, ‘null’]	The group type description.
  group_type.is_public	body	[‘boolean’, ‘string’]	Whether the group type is publicly visible. See valid boolean values
  group_type.group_specs	body	[‘object’, ‘null’]	A set of key and value pairs that contains the specifications for a group type.

• Schema

  {
    "type": "object",
    "properties": {
      "group_type": {
        "type": "object",
        "description": "A `group_type` object.",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name",
            "description": "The group type name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group type description."
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Whether the group type is publicly visible.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "group_specs": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "A set of key and value pairs that contains the\nspecifications for a group type."
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_type"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

GET

/v3/{project_id}/group_types/{id}

Return a single group type item.

Responses

200

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

PUT

/v3/{project_id}/group_types/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_types/{id} API
  id	path	string	id parameter for /v3/group_types/{id} API
  group_type	body	object
  group_type.name	body	[‘string’, ‘null’]
  group_type.description	body	[‘string’, ‘null’]
  group_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "group_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_type"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

DELETE

/v3/{project_id}/group_types/{id}

Deletes an existing group type.

Responses

204

Ok

404

Error

GET

/v3/group_types

Returns the list of group types.

Responses

200

Ok

404

Error

POST

/v3/group_types

Creates a new group type.

Request

• Description

  Name	Location	Type	Description
  group_type	body	object	A group_type object.
  group_type.name	body	string	The group type name.
  group_type.description	body	[‘string’, ‘null’]	The group type description.
  group_type.is_public	body	[‘boolean’, ‘string’]	Whether the group type is publicly visible. See valid boolean values
  group_type.group_specs	body	[‘object’, ‘null’]	A set of key and value pairs that contains the specifications for a group type.

• Schema

  {
    "type": "object",
    "properties": {
      "group_type": {
        "type": "object",
        "description": "A `group_type` object.",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name",
            "description": "The group type name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group type description."
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Whether the group type is publicly visible.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "group_specs": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "A set of key and value pairs that contains the\nspecifications for a group type."
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_type"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

GET

/v3/group_types/{id}

Return a single group type item.

Responses

200

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

PUT

/v3/group_types/{id}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/group_types/{id} API
  group_type	body	object
  group_type.name	body	[‘string’, ‘null’]
  group_type.description	body	[‘string’, ‘null’]
  group_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "group_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_type"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
group_type	body	object	A group_type object.
group_type.name	body	[‘string’, ‘null’]	The group type name.
group_type.id	body	string	The group type ID.
group_type.description	body	string	The group type description.
group_type.is_public	body	boolean	Whether the group type is publicly visible.
group_type.group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

DELETE

/v3/group_types/{id}

Deletes an existing group type.

Responses

204

Ok

404

Error

GET

/v3/{project_id}/group_types/{group_type_id}/group_specs

List group specs for a group type

List all the group specs for a group type,

Responses

200

Ok

Name	Location	Type	Description
group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

POST

/v3/{project_id}/group_types/{group_type_id}/group_specs

Create or update group specs for a group type

Create group specs for a group type, if the specification key already exists in group specs, this API will update the specification as well.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_types/{group_type_id}/group_specs/{id} API
  group_type_id	path	string	group_type_id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API
  group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

• Schema

  {
    "type": "object",
    "properties": {
      "group_specs": {
        "type": "object",
        "description": "A set of key and value pairs that contains the\nspecifications for a group type.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:.]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_specs"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

GET

/v3/{project_id}/group_types/{group_type_id}/group_specs/{id}

Return a single extra spec item.

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/group_types/{group_type_id}/group_specs/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/group_types/{group_type_id}/group_specs/{id} API
  group_type_id	path	string	group_type_id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API
  id	path	string	id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API

• Schema

  {
    "type": "object",
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "patternProperties": {
      "^[a-zA-Z0-9-_:.]{1,255}$": {
        "type": [
          "string",
          "null"
        ],
        "maxLength": 255
      }
    },
    "minProperties": 1,
    "maxProperties": 1
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/group_types/{group_type_id}/group_specs/{id}

Deletes an existing group spec.

Responses

204

Ok

404

Error

GET

/v3/group_types/{group_type_id}/group_specs

Returns the list of group specs for a given group type.

Responses

200

Ok

Name	Location	Type	Description
group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

POST

/v3/group_types/{group_type_id}/group_specs

Request

• Description

  Name	Location	Type	Description
  group_type_id	path	string	group_type_id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API
  group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

• Schema

  {
    "type": "object",
    "properties": {
      "group_specs": {
        "type": "object",
        "description": "A set of key and value pairs that contains the\nspecifications for a group type.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:.]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "required": [
      "group_specs"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group_specs	body	object	A set of key and value pairs that contains the specifications for a group type.

404

Error

GET

/v3/group_types/{group_type_id}/group_specs/{id}

Return a single extra spec item.

Responses

200

Ok

404

Error

PUT

/v3/group_types/{group_type_id}/group_specs/{id}

Request

• Description

  Name	Location	Type	Description
  group_type_id	path	string	group_type_id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API
  id	path	string	id parameter for /v3/group_types/{group_type_id}/group_specs/{id} API

• Schema

  {
    "type": "object",
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.11"
    },
    "patternProperties": {
      "^[a-zA-Z0-9-_:.]{1,255}$": {
        "type": [
          "string",
          "null"
        ],
        "maxLength": 255
      }
    },
    "minProperties": 1,
    "maxProperties": 1
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/group_types/{group_type_id}/group_specs/{id}

Deletes an existing group spec.

Responses

204

Ok

404

Error

groups

Generic volume groups enable you to create a group of volumes and manage them together.

How is generic volume groups different from consistency groups? Currently consistency groups in cinder only support consistent group snapshot. It cannot be extended easily to serve other purposes. A project may want to put volumes used in the same application together in a group so that it is easier to manage them together, and this group of volumes may or may not support consistent group snapshot. Generic volume group is introduced to solve this problem. By decoupling the tight relationship between the group construct and the consistency concept, generic volume groups can be extended to support other features in the future.

GET

/v3/{project_id}/groups/detail

List groups with details

Lists groups with details, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/groups

List groups

Lists groups. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/groups

Create group

Creates a group.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/{id} API
  group	body	object	A group object.
  group.description	body	[‘string’, ‘null’]	The group description.
  group.group_type	body	string	The group type ID.
  group.name	body	[‘string’, ‘null’]	The group name.
  group.availability_zone	body	[‘string’, ‘null’]	The name of the availability zone.

• Schema

  {
    "type": "object",
    "properties": {
      "group": {
        "type": "object",
        "description": "A group object.",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group description."
          },
          "group_type": {
            "type": "string",
            "format": "group_type",
            "description": "The group type ID."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The group name."
          },
          "volume_types": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "maxLength": 255
            },
            "uniqueItems": true,
            "description": "The list of volume types. In an environment with\nmultiple-storage back ends, the scheduler determines where to send\nthe volume based on the volume type. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
          },
          "availability_zone": {
            "type": [
              "string",
              "null"
            ],
            "format": "availability_zone",
            "description": "The name of the availability zone."
          }
        },
        "additionalProperties": false,
        "required": [
          "group_type",
          "volume_types"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13"
    },
    "required": [
      "group"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group	body	object	A group object.
group.status	body	string	The status of the generic group.
group.description	body	[‘string’, ‘null’]	The group description.
group.availability_zone	body	string	The name of the availability zone.
group.created_at	body	string	The date and time when the resource was created.
group.group_type	body	string	The group type ID.
group.group_snapshot_id	body	[‘string’, ‘null’]	The ID of the group snapshot.
group.source_group_id	body	[‘string’, ‘null’]	The UUID of the source group.
group.replication_status	body	[‘string’, ‘null’]	The group replication status. New in version 3.38
group.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group.name	body	[‘string’, ‘null’]	The group name.
group.id	body	string	The UUID of the group.

404

Error

POST

/v3/{project_id}/groups/{id}/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.20",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`delete` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  delete	body	object
  delete.delete-volumes	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "delete": {
        "type": "object",
        "properties": {
          "delete-volumes": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13",
      "action-name": "delete"
    },
    "required": [
      "delete"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`create-from-src` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  create-from-src	body	object
  create-from-src.description	body	[‘string’, ‘null’]
  create-from-src.name	body	[‘string’, ‘null’]
  create-from-src.source_group_id	body	string
  create-from-src.group_snapshot_id	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "create-from-src": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "source_group_id": {
            "type": "string",
            "format": "uuid"
          },
          "group_snapshot_id": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "oneOf": [
          {
            "required": [
              "group_snapshot_id"
            ]
          },
          {
            "required": [
              "source_group_id"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14",
      "action-name": "create-from-src"
    },
    "required": [
      "create-from-src"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`enable_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  enable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "enable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "enable_replication"
    },
    "required": [
      "enable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`disable_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  disable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "disable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "disable_replication"
    },
    "required": [
      "disable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`failover_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  failover_replication	body	object
  failover_replication.allow_attached_volume	body	[‘boolean’, ‘string’]
  failover_replication.secondary_backend_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "failover_replication": {
        "type": "object",
        "properties": {
          "allow_attached_volume": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          },
          "secondary_backend_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "failover_replication"
    },
    "required": [
      "failover_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/{id}/action

`list_replication_targets` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  id	path	string	id parameter for /v3/groups/{id}/action API
  list_replication_targets	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "list_replication_targets": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "list_replication_targets"
    },
    "required": [
      "list_replication_targets"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

GET

/v3/{project_id}/groups/{id}

Return data about the given group.

Responses

200

Ok

Name	Location	Type	Description
group	body	object	A group object.
group.status	body	string	The status of the generic group.
group.description	body	[‘string’, ‘null’]	The group description.
group.availability_zone	body	string	The name of the availability zone.
group.created_at	body	string	The date and time when the resource was created.
group.group_type	body	string	The group type ID.
group.group_snapshot_id	body	[‘string’, ‘null’]	The ID of the group snapshot.
group.source_group_id	body	[‘string’, ‘null’]	The UUID of the source group.
group.replication_status	body	[‘string’, ‘null’]	The group replication status. New in version 3.38
group.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group.name	body	[‘string’, ‘null’]	The group name.
group.id	body	string	The UUID of the group.

404

Error

PUT

/v3/{project_id}/groups/{id}

Update the group.

Expected format of the input parameter ‘body’:

{
    "group":
    {
        "name": "my_group",
        "description": "My group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/{id} API
  id	path	string	id parameter for /v3/groups/{id} API
  group	body	object
  group.description	body	[‘string’, ‘null’]
  group.name	body	[‘string’, ‘null’]
  group.add_volumes	body	[‘string’, ‘null’]
  group.remove_volumes	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "group": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "add_volumes": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "remove_volumes": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "name"
            ]
          },
          {
            "required": [
              "description"
            ]
          },
          {
            "required": [
              "add_volumes"
            ]
          },
          {
            "required": [
              "remove_volumes"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13"
    },
    "required": [
      "group"
    ]
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/groups/{id}

Select and call the matching version of the specified method.

Look for the method which matches the name supplied and version constraints and calls it with the supplied arguments.

returns:	Returns the result of the method called
raises VersionNotFoundForAPIMethod:
	if there is no method which matches the name and version constraints

Responses

204

Ok

404

Error

GET

/v3/groups/detail

Returns a detailed list of groups.

Responses

200

Ok

404

Error

GET

/v3/groups

Returns a summary list of groups.

Responses

200

Ok

404

Error

POST

/v3/groups

Create a new group.

Request

• Description

  Name	Location	Type	Description
  group	body	object	A group object.
  group.description	body	[‘string’, ‘null’]	The group description.
  group.group_type	body	string	The group type ID.
  group.name	body	[‘string’, ‘null’]	The group name.
  group.availability_zone	body	[‘string’, ‘null’]	The name of the availability zone.

• Schema

  {
    "type": "object",
    "properties": {
      "group": {
        "type": "object",
        "description": "A group object.",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The group description."
          },
          "group_type": {
            "type": "string",
            "format": "group_type",
            "description": "The group type ID."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The group name."
          },
          "volume_types": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "maxLength": 255
            },
            "uniqueItems": true,
            "description": "The list of volume types. In an environment with\nmultiple-storage back ends, the scheduler determines where to send\nthe volume based on the volume type. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
          },
          "availability_zone": {
            "type": [
              "string",
              "null"
            ],
            "format": "availability_zone",
            "description": "The name of the availability zone."
          }
        },
        "additionalProperties": false,
        "required": [
          "group_type",
          "volume_types"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13"
    },
    "required": [
      "group"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
group	body	object	A group object.
group.status	body	string	The status of the generic group.
group.description	body	[‘string’, ‘null’]	The group description.
group.availability_zone	body	string	The name of the availability zone.
group.created_at	body	string	The date and time when the resource was created.
group.group_type	body	string	The group type ID.
group.group_snapshot_id	body	[‘string’, ‘null’]	The ID of the group snapshot.
group.source_group_id	body	[‘string’, ‘null’]	The UUID of the source group.
group.replication_status	body	[‘string’, ‘null’]	The group replication status. New in version 3.38
group.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group.name	body	[‘string’, ‘null’]	The group name.
group.id	body	string	The UUID of the group.

404

Error

POST

/v3/groups/{id}/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.20",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`delete` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  delete	body	object
  delete.delete-volumes	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "delete": {
        "type": "object",
        "properties": {
          "delete-volumes": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13",
      "action-name": "delete"
    },
    "required": [
      "delete"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`create-from-src` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  create-from-src	body	object
  create-from-src.description	body	[‘string’, ‘null’]
  create-from-src.name	body	[‘string’, ‘null’]
  create-from-src.source_group_id	body	string
  create-from-src.group_snapshot_id	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "create-from-src": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "source_group_id": {
            "type": "string",
            "format": "uuid"
          },
          "group_snapshot_id": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "oneOf": [
          {
            "required": [
              "group_snapshot_id"
            ]
          },
          {
            "required": [
              "source_group_id"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14",
      "action-name": "create-from-src"
    },
    "required": [
      "create-from-src"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`enable_replication` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  enable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "enable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "enable_replication"
    },
    "required": [
      "enable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`disable_replication` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  disable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "disable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "disable_replication"
    },
    "required": [
      "disable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`failover_replication` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  failover_replication	body	object
  failover_replication.allow_attached_volume	body	[‘boolean’, ‘string’]
  failover_replication.secondary_backend_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "failover_replication": {
        "type": "object",
        "properties": {
          "allow_attached_volume": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          },
          "secondary_backend_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "failover_replication"
    },
    "required": [
      "failover_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/{id}/action

`list_replication_targets` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id}/action API
  list_replication_targets	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "list_replication_targets": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "list_replication_targets"
    },
    "required": [
      "list_replication_targets"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

GET

/v3/groups/{id}

Return data about the given group.

Responses

200

Ok

Name	Location	Type	Description
group	body	object	A group object.
group.status	body	string	The status of the generic group.
group.description	body	[‘string’, ‘null’]	The group description.
group.availability_zone	body	string	The name of the availability zone.
group.created_at	body	string	The date and time when the resource was created.
group.group_type	body	string	The group type ID.
group.group_snapshot_id	body	[‘string’, ‘null’]	The ID of the group snapshot.
group.source_group_id	body	[‘string’, ‘null’]	The UUID of the source group.
group.replication_status	body	[‘string’, ‘null’]	The group replication status. New in version 3.38
group.project_id	body	[‘string’, ‘null’]	The UUID of the volume group project. New in version 3.58
group.name	body	[‘string’, ‘null’]	The group name.
group.id	body	string	The UUID of the group.

404

Error

PUT

/v3/groups/{id}

Update the group.

Expected format of the input parameter ‘body’:

{
    "group":
    {
        "name": "my_group",
        "description": "My group",
        "add_volumes": "volume-uuid-1,volume-uuid-2,...",
        "remove_volumes": "volume-uuid-8,volume-uuid-9,..."
    }
}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/groups/{id} API
  group	body	object
  group.description	body	[‘string’, ‘null’]
  group.name	body	[‘string’, ‘null’]
  group.add_volumes	body	[‘string’, ‘null’]
  group.remove_volumes	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "group": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "add_volumes": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "remove_volumes": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "name"
            ]
          },
          {
            "required": [
              "description"
            ]
          },
          {
            "required": [
              "add_volumes"
            ]
          },
          {
            "required": [
              "remove_volumes"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13"
    },
    "required": [
      "group"
    ]
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/groups/{id}

Select and call the matching version of the specified method.

Look for the method which matches the name supplied and version constraints and calls it with the supplied arguments.

returns:	Returns the result of the method called
raises VersionNotFoundForAPIMethod:
	if there is no method which matches the name and version constraints

Responses

204

Ok

404

Error

POST

/v3/{project_id}/groups/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.20",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`delete` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  delete	body	object
  delete.delete-volumes	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "delete": {
        "type": "object",
        "properties": {
          "delete-volumes": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13",
      "action-name": "delete"
    },
    "required": [
      "delete"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`create-from-src` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  create-from-src	body	object
  create-from-src.description	body	[‘string’, ‘null’]
  create-from-src.name	body	[‘string’, ‘null’]
  create-from-src.source_group_id	body	string
  create-from-src.group_snapshot_id	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "create-from-src": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "source_group_id": {
            "type": "string",
            "format": "uuid"
          },
          "group_snapshot_id": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "oneOf": [
          {
            "required": [
              "group_snapshot_id"
            ]
          },
          {
            "required": [
              "source_group_id"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14",
      "action-name": "create-from-src"
    },
    "required": [
      "create-from-src"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`enable_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  enable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "enable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "enable_replication"
    },
    "required": [
      "enable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`disable_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  disable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "disable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "disable_replication"
    },
    "required": [
      "disable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`failover_replication` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  failover_replication	body	object
  failover_replication.allow_attached_volume	body	[‘boolean’, ‘string’]
  failover_replication.secondary_backend_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "failover_replication": {
        "type": "object",
        "properties": {
          "allow_attached_volume": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          },
          "secondary_backend_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "failover_replication"
    },
    "required": [
      "failover_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/groups/action

`list_replication_targets` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/groups/action API
  list_replication_targets	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "list_replication_targets": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "list_replication_targets"
    },
    "required": [
      "list_replication_targets"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`reset_status` action

Request

• Description

  Name	Location	Type	Description
  reset_status	body	object
  reset_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "reset_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "format": "group_status"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.20",
      "action-name": "reset_status"
    },
    "required": [
      "reset_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`delete` action

Request

• Description

  Name	Location	Type	Description
  delete	body	object
  delete.delete-volumes	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "delete": {
        "type": "object",
        "properties": {
          "delete-volumes": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.13",
      "action-name": "delete"
    },
    "required": [
      "delete"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`create-from-src` action

Request

• Description

  Name	Location	Type	Description
  create-from-src	body	object
  create-from-src.description	body	[‘string’, ‘null’]
  create-from-src.name	body	[‘string’, ‘null’]
  create-from-src.source_group_id	body	string
  create-from-src.group_snapshot_id	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "create-from-src": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "source_group_id": {
            "type": "string",
            "format": "uuid"
          },
          "group_snapshot_id": {
            "type": "string",
            "format": "uuid"
          }
        },
        "additionalProperties": false,
        "oneOf": [
          {
            "required": [
              "group_snapshot_id"
            ]
          },
          {
            "required": [
              "source_group_id"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.14",
      "action-name": "create-from-src"
    },
    "required": [
      "create-from-src"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`enable_replication` action

Request

• Description

  Name	Location	Type	Description
  enable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "enable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "enable_replication"
    },
    "required": [
      "enable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`disable_replication` action

Request

• Description

  Name	Location	Type	Description
  disable_replication	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "disable_replication": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "disable_replication"
    },
    "required": [
      "disable_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`failover_replication` action

Request

• Description

  Name	Location	Type	Description
  failover_replication	body	object
  failover_replication.allow_attached_volume	body	[‘boolean’, ‘string’]
  failover_replication.secondary_backend_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "failover_replication": {
        "type": "object",
        "properties": {
          "allow_attached_volume": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          },
          "secondary_backend_id": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "failover_replication"
    },
    "required": [
      "failover_replication"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/groups/action

`list_replication_targets` action

Request

• Description

  Name	Location	Type	Description
  list_replication_targets	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "list_replication_targets": {
        "type": "object"
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.38",
      "action-name": "list_replication_targets"
    },
    "required": [
      "list_replication_targets"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

limits

Shows absolute limits for a project.

An absolute limit value of -1 indicates that the absolute limit for the item is infinite.

GET

/v3/{project_id}/limits

Show absolute limits for project

Shows absolute limits for a project.

An absolute limit value of -1 indicates that the absolute limit for the item is infinite.

Responses

200

Ok

Name	Location	Type	Description
limits	body	object	A list of limit objects.
limits.absolute	body	object	An absolute limits object.
limits.absolute.totalSnapshotsUsed	body	integer	The total number of snapshots used.
limits.absolute.maxTotalBackups	body	integer	The maximum number of backups.
limits.absolute.maxTotalVolumeGigabytes	body	integer	The maximum total amount of volumes, in gibibytes (GiB).
limits.absolute.maxTotalSnapshots	body	integer	The maximum number of snapshots.
limits.absolute.maxTotalBackupGigabytes	body	integer	The maximum total amount of backups, in gibibytes (GiB).
limits.absolute.totalBackupGigabytesUsed	body	integer	The total number of backups gibibytes (GiB) used.
limits.absolute.maxTotalVolumes	body	integer	The maximum number of volumes.
limits.absolute.totalVolumesUsed	body	integer	The total number of volumes used.
limits.absolute.totalBackupsUsed	body	integer	The total number of backups used.
limits.absolute.totalGigabytesUsed	body	integer	The total number of gibibytes (GiB) used.

404

Error

GET

/v3/limits

Return all global and rate limit information.

Responses

200

Ok

Name	Location	Type	Description
limits	body	object	A list of limit objects.
limits.absolute	body	object	An absolute limits object.
limits.absolute.totalSnapshotsUsed	body	integer	The total number of snapshots used.
limits.absolute.maxTotalBackups	body	integer	The maximum number of backups.
limits.absolute.maxTotalVolumeGigabytes	body	integer	The maximum total amount of volumes, in gibibytes (GiB).
limits.absolute.maxTotalSnapshots	body	integer	The maximum number of snapshots.
limits.absolute.maxTotalBackupGigabytes	body	integer	The maximum total amount of backups, in gibibytes (GiB).
limits.absolute.totalBackupGigabytesUsed	body	integer	The total number of backups gibibytes (GiB) used.
limits.absolute.maxTotalVolumes	body	integer	The maximum number of volumes.
limits.absolute.totalVolumesUsed	body	integer	The total number of volumes used.
limits.absolute.totalBackupsUsed	body	integer	The total number of backups used.
limits.absolute.totalGigabytesUsed	body	integer	The total number of gibibytes (GiB) used.

404

Error

manageable_snapshots

Creates or lists snapshots by using existing storage instead of allocating new storage.

GET

/v3/{project_id}/manageable_snapshots/detail

List detail of snapshots available to manage

Search a volume backend and list detail of snapshots which are available to manage.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/manageable_snapshots

List summary of snapshots available to manage

Search a volume backend and list summary of snapshots which are available to manage.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/manageable_snapshots

Manage an existing snapshot

Creates a snapshot by using existing storage rather than allocating new storage.

The caller must specify a reference to an existing storage volume in the ref parameter in the request. Although each storage driver might interpret this reference differently, the driver should accept a reference structure that contains either a source-id or source-name element, if possible.

The API chooses the size of the snapshot by rounding up the size of the existing snapshot to the next gibibyte (GiB).

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/manageable_snapshots/{id} API
  snapshot	body	object	A snapshot object.
  snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot. Default is None.
  snapshot.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs for the snapshot.
  snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
  snapshot.volume_id	body	string	The UUID of the volume.
  snapshot.ref	body	[‘object’, ‘null’, ‘string’]	A reference to the existing volume. The internal structure of this reference depends on the volume driver implementation. For details about the required elements in the structure, see the documentation for the volume driver.

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "A description for the snapshot. Default is\n`None`."
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs for the\nsnapshot."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot. Default is `None`."
          },
          "volume_id": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the volume."
          },
          "ref": {
            "type": [
              "object",
              "null",
              "string"
            ],
            "description": "A reference to the existing volume. The internal\nstructure of this reference depends on the volume driver\nimplementation. For details about the required elements in the\nstructure, see the documentation for the volume driver."
          }
        },
        "required": [
          "ref",
          "volume_id"
        ],
        "additionalProperties": false,
        "description": "A `snapshot` object."
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

GET

/v3/manageable_snapshots/detail

Returns a detailed list of volumes available to manage.

Responses

200

Ok

404

Error

GET

/v3/manageable_snapshots

Returns a summary list of volumes available to manage.

Responses

200

Ok

404

Error

POST

/v3/manageable_snapshots

Instruct Cinder to manage a storage snapshot object.

Manages an existing backend storage snapshot object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage snapshot object (driver dependent).

From an API perspective, this operation behaves very much like a snapshot creation operation.

Required HTTP Body:

{
  "snapshot":
  {
    "volume_id": "<Cinder volume already exists in volume backend>",
    "ref":
       "<Driver-specific reference to the existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_snapshot method to find out the accepted format of ‘ref’. For example,in LVM driver, it will be the logic volume name of snapshot which you want to manage.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘volume_id’ element refers to a cinder volume that could not be found.

The snapshot will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘snapshot’ are:

name           A name for the new snapshot.
description    A description for the new snapshot.
metadata       Key/value pairs to be associated with the new snapshot.

Request

• Description

  Name	Location	Type	Description
  snapshot	body	object	A snapshot object.
  snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot. Default is None.
  snapshot.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs for the snapshot.
  snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
  snapshot.volume_id	body	string	The UUID of the volume.
  snapshot.ref	body	[‘object’, ‘null’, ‘string’]	A reference to the existing volume. The internal structure of this reference depends on the volume driver implementation. For details about the required elements in the structure, see the documentation for the volume driver.

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "A description for the snapshot. Default is\n`None`."
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs for the\nsnapshot."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot. Default is `None`."
          },
          "volume_id": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the volume."
          },
          "ref": {
            "type": [
              "object",
              "null",
              "string"
            ],
            "description": "A reference to the existing volume. The internal\nstructure of this reference depends on the volume driver\nimplementation. For details about the required elements in the\nstructure, see the documentation for the volume driver."
          }
        },
        "required": [
          "ref",
          "volume_id"
        ],
        "additionalProperties": false,
        "description": "A `snapshot` object."
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

manageable_volumes

Creates or lists volumes by using existing storage instead of allocating new storage.

GET

/v3/{project_id}/manageable_volumes/detail

List detail of volumes available to manage

Search a volume backend and list detail of volumes which are available to manage.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/manageable_volumes

List summary of volumes available to manage

Search a volume backend and list summary of volumes which are available to manage.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/manageable_volumes

Manage an existing volume

Creates a Block Storage volume by using existing storage rather than allocating new storage.

The caller must specify a reference to an existing storage volume in the ref parameter in the request. Although each storage driver might interpret this reference differently, the driver should accept a reference structure that contains either a source-id or source-name element, if possible.

The API chooses the size of the volume by rounding up the size of the existing storage volume to the next gibibyte (GiB).

You cannot manage a volume to an encrypted volume type.

Prior to microversion 3.16 host field was required, with the possibility of defining the cluster it is no longer required, but we must have either a host or a cluster field but we cannot have them both with values.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/manageable_volumes/{id} API
  volume	body	object	A volume object.
  volume.description	body	[‘string’, ‘null’]	The volume description.
  volume.availability_zone	body	[‘string’, ‘null’]	The volume name.
  volume.bootable	body	[‘boolean’, ‘string’]	Enables or disables the bootable attribute. You can boot an instance from a bootable volume. See valid boolean values
  volume.volume_type	body	[‘string’, ‘null’]	The volume name.
  volume.name	body	[‘string’, ‘null’]	The volume name.
  volume.host	body	[‘string’, ‘null’]	The OpenStack Block Storage host where the existing resource resides. Optional only if cluster field is provided.
  volume.ref	body	[‘object’, ‘string’]	A reference to the existing volume. The internal structure of this reference depends on the volume driver implementation. For details about the required elements in the structure, see the documentation for the volume driver.
  volume.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs to be associated with the new volume.

• Schema

  {
    "type": "object",
    "properties": {
      "volume": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The volume description."
          },
          "availability_zone": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "bootable": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Enables or disables the bootable attribute. You\ncan boot an instance from a bootable volume.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "volume_type": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "host": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255,
            "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$",
            "description": "The OpenStack Block Storage host where the existing resource resides.\nOptional only if cluster field is provided."
          },
          "ref": {
            "type": [
              "object",
              "string"
            ],
            "description": "A reference to the existing volume. The internal\nstructure of this reference depends on the volume driver\nimplementation. For details about the required elements in the\nstructure, see the documentation for the volume driver."
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
          }
        },
        "required": [
          "ref"
        ],
        "additionalProperties": false,
        "description": "A `volume` object."
      }
    },
    "additionalProperties": false,
    "required": [
      "volume"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
name	body	[‘string’, ‘null’]	The volume name.
description	body	[‘string’, ‘null’]	The volume description.
volume_type	body	string	A volume_type object.
metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
consistencygroup_id	body	string	The UUID of the consistency group.
size	body	integer	The size of the volume, in gibibytes (GiB).
availability_zone	body	string	The name of the availability zone.
multiattach	body	boolean	If true, this volume can attach to more than one instance.
status	body	string	The volume status.
migration_status	body	string	The volume migration status. Admin only.
encrypted	body	boolean	If true, this volume is encrypted.
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
replication_status	body	string	The volume replication status.
id	body	string	The UUID of the volume.
user_id	body	string	The UUID of the user.
volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63
group_id	body	string	The ID of the group. New in version 3.63
provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21
service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48
shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.48
cluster_name	body	string	The cluster name of volume backend. New in version 3.61
consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65

404

Error

GET

/v3/manageable_volumes/detail

Returns a detailed list of volumes available to manage.

Responses

200

Ok

404

Error

GET

/v3/manageable_volumes

Returns a summary list of volumes available to manage.

Responses

200

Ok

404

Error

POST

/v3/manageable_volumes

Instruct Cinder to manage a storage object.

Manages an existing backend storage object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage object (driver dependent)

From an API perspective, this operation behaves very much like a volume creation operation, except that properties such as image, snapshot and volume references don’t make sense, because we are taking an existing storage object into Cinder management.

Required HTTP Body:

{
  "volume": {
    "host": "<Cinder host on which the existing storage resides>",
    "cluster": "<Cinder cluster on which the storage resides>",
    "ref": "<Driver-specific reference to existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_volume method to find out the accepted format of ‘ref’.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘host’ element refers to a cinder host that is not registered.

The volume will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘volume’ are:

name               A name for the new volume.
description        A description for the new volume.
volume_type        ID or name of a volume type to associate with
                   the new Cinder volume. Does not necessarily
                   guarantee that the managed volume will have the
                   properties described in the volume_type. The
                   driver may choose to fail if it identifies that
                   the specified volume_type is not compatible with
                   the backend storage object.
metadata           Key/value pairs to be associated with the new
                   volume.
availability_zone  The availability zone to associate with the new
                   volume.
bootable           If set to True, marks the volume as bootable.

Request

• Description

  Name	Location	Type	Description
  volume	body	object	A volume object.
  volume.description	body	[‘string’, ‘null’]	The volume description.
  volume.availability_zone	body	[‘string’, ‘null’]	The volume name.
  volume.bootable	body	[‘boolean’, ‘string’]	Enables or disables the bootable attribute. You can boot an instance from a bootable volume. See valid boolean values
  volume.volume_type	body	[‘string’, ‘null’]	The volume name.
  volume.name	body	[‘string’, ‘null’]	The volume name.
  volume.host	body	[‘string’, ‘null’]	The OpenStack Block Storage host where the existing resource resides. Optional only if cluster field is provided.
  volume.ref	body	[‘object’, ‘string’]	A reference to the existing volume. The internal structure of this reference depends on the volume driver implementation. For details about the required elements in the structure, see the documentation for the volume driver.
  volume.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs to be associated with the new volume.

• Schema

  {
    "type": "object",
    "properties": {
      "volume": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The volume description."
          },
          "availability_zone": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "bootable": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Enables or disables the bootable attribute. You\ncan boot an instance from a bootable volume.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "volume_type": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The volume name."
          },
          "host": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255,
            "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$",
            "description": "The OpenStack Block Storage host where the existing resource resides.\nOptional only if cluster field is provided."
          },
          "ref": {
            "type": [
              "object",
              "string"
            ],
            "description": "A reference to the existing volume. The internal\nstructure of this reference depends on the volume driver\nimplementation. For details about the required elements in the\nstructure, see the documentation for the volume driver."
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
          }
        },
        "required": [
          "ref"
        ],
        "additionalProperties": false,
        "description": "A `volume` object."
      }
    },
    "additionalProperties": false,
    "required": [
      "volume"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
name	body	[‘string’, ‘null’]	The volume name.
description	body	[‘string’, ‘null’]	The volume description.
volume_type	body	string	A volume_type object.
metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
consistencygroup_id	body	string	The UUID of the consistency group.
size	body	integer	The size of the volume, in gibibytes (GiB).
availability_zone	body	string	The name of the availability zone.
multiattach	body	boolean	If true, this volume can attach to more than one instance.
status	body	string	The volume status.
migration_status	body	string	The volume migration status. Admin only.
encrypted	body	boolean	If true, this volume is encrypted.
created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
replication_status	body	string	The volume replication status.
id	body	string	The UUID of the volume.
user_id	body	string	The UUID of the user.
volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63
group_id	body	string	The ID of the group. New in version 3.63
provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21
service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48
shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.48
cluster_name	body	string	The cluster name of volume backend. New in version 3.61
consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65

404

Error

messages

Lists all, shows, and deletes messages. These are error messages generated by failed operations as a way to find out what happened when an asynchronous operation failed.

GET

/v3/{project_id}/messages

List messages

Lists all messages, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/messages/{id}

Return the given message.

Responses

200

Ok

Name	Location	Type	Description
message	body	object
message.request_id	body	string	The id of the request during which the message was created.
message.message_level	body	string	The level of the message, possible value is only ‘ERROR’ now.
message.event_id	body	string	The id of the event to this message, this id could eventually be translated into user_message.
message.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
message.guaranteed_until	body	string	The expire time of the message, this message could be deleted after this time.
message.resource_uuid	body	string	The UUID of the resource during whose operation the message was created.
message.id	body	string	The UUID for the message.
message.resource_type	body	string	The resource type corresponding to resource_uuid.
message.user_message	body	string	The translated readable message corresponding to event_id.

404

Error

DELETE

/v3/{project_id}/messages/{id}

Delete a message.

Responses

204

Ok

404

Error

GET

/v3/messages

Returns a list of messages, transformed through view builder.

Responses

200

Ok

404

Error

GET

/v3/messages/{id}

Return the given message.

Responses

200

Ok

Name	Location	Type	Description
message	body	object
message.request_id	body	string	The id of the request during which the message was created.
message.message_level	body	string	The level of the message, possible value is only ‘ERROR’ now.
message.event_id	body	string	The id of the event to this message, this id could eventually be translated into user_message.
message.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
message.guaranteed_until	body	string	The expire time of the message, this message could be deleted after this time.
message.resource_uuid	body	string	The UUID of the resource during whose operation the message was created.
message.id	body	string	The UUID for the message.
message.resource_type	body	string	The resource type corresponding to resource_uuid.
message.user_message	body	string	The translated readable message corresponding to event_id.

404

Error

DELETE

/v3/messages/{id}

Delete a message.

Responses

204

Ok

404

Error

os-hosts

Administrators only, depending on policy settings.

Lists, shows hosts.

GET

/v3/{project_id}/os-hosts

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/os-hosts

Request of the project_id/os-hosts:put operation

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-hosts/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-hosts:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

GET

/v3/{project_id}/os-hosts/{id}

Shows the volume usage info given by hosts.

param req:	security context
param id:	hostname
returns:	dict – the host resources dictionary. ex.: {'host': [{'resource': D},..]} D: {'host': 'hostname','project': 'admin',     'volume_count': 1, 'total_volume_gb': 2048}

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/os-hosts/{id}

Request of the project_id/os-hosts/id:put operation

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-hosts/{id} API
  id	path	string	id parameter for /v3/os-hosts/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-hosts/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

GET

/v3/os-hosts

Responses

200

Ok

404

Error

PUT

/v3/os-hosts

Request of the project_id/os-hosts:put operation

Request

• Description

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-hosts:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

GET

/v3/os-hosts/{id}

Shows the volume usage info given by hosts.

param req:	security context
param id:	hostname
returns:	dict – the host resources dictionary. ex.: {'host': [{'resource': D},..]} D: {'host': 'hostname','project': 'admin',     'volume_count': 1, 'total_volume_gb': 2048}

Responses

200

Ok

404

Error

PUT

/v3/os-hosts/{id}

Request of the project_id/os-hosts/id:put operation

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/os-hosts/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-hosts/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

os-quota-class-sets

Administrators only, depending on policy settings.

Shows and updates quota classes for a project.

GET

/v3/{project_id}/os-quota-class-sets/{id}

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/os-quota-class-sets/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-quota-class-sets/{id} API
  id	path	string	id parameter for /v3/os-quota-class-sets/{id} API
  quota_class_set	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "quota_class_set": {
        "type": "object",
        "format": "quota_class_set",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. ]{1,255}$": {
            "type": [
              "integer",
              "string"
            ],
            "pattern": "^[0-9]*$",
            "minimum": -1,
            "minLength": 1,
            "maximum": 2147483647
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "quota_class_set"
    ]
  }
  

Responses

200

Ok

404

Error

GET

/v3/os-quota-class-sets/{id}

Responses

200

Ok

404

Error

PUT

/v3/os-quota-class-sets/{id}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/os-quota-class-sets/{id} API
  quota_class_set	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "quota_class_set": {
        "type": "object",
        "format": "quota_class_set",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. ]{1,255}$": {
            "type": [
              "integer",
              "string"
            ],
            "pattern": "^[0-9]*$",
            "minimum": -1,
            "minLength": 1,
            "maximum": 2147483647
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "quota_class_set"
    ]
  }
  

Responses

200

Ok

404

Error

os-quota-sets

Administrators only, depending on policy settings.

Shows and updates, and deletes quotas for a project.

GET

/v3/{project_id}/os-quota-sets/{id}/defaults

Responses

200

Ok

404

Error

GET

/v3/{project_id}/os-quota-sets/{id}

Show quota for a particular tenant

param req:	request
param id:	target project id that needs to be shown

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/os-quota-sets/{id}

Update Quota for a particular tenant

param req:	request
param id:	target project id that needs to be updated
param body:	key, value pair that will be applied to the resources if the update succeeds

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-quota-sets/{id} API
  id	path	string	id parameter for /v3/os-quota-sets/{id} API
  quota_set	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "quota_set": {
        "type": "object",
        "format": "quota_set",
        "minProperties": 1
      }
    },
    "additionalProperties": false,
    "required": [
      "quota_set"
    ]
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/os-quota-sets/{id}

Delete Quota for a particular tenant.

param req:	request
param id:	target project id that needs to be deleted

Responses

204

Ok

404

Error

GET

/v3/os-quota-sets/{id}/defaults

Responses

200

Ok

404

Error

GET

/v3/os-quota-sets/{id}

Show quota for a particular tenant

param req:	request
param id:	target project id that needs to be shown

Responses

200

Ok

404

Error

PUT

/v3/os-quota-sets/{id}

Update Quota for a particular tenant

param req:	request
param id:	target project id that needs to be updated
param body:	key, value pair that will be applied to the resources if the update succeeds

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/os-quota-sets/{id} API
  quota_set	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "quota_set": {
        "type": "object",
        "format": "quota_set",
        "minProperties": 1
      }
    },
    "additionalProperties": false,
    "required": [
      "quota_set"
    ]
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/os-quota-sets/{id}

Delete Quota for a particular tenant.

param req:	request
param id:	target project id that needs to be deleted

Responses

204

Ok

404

Error

os-services

Administrator only. Lists all Cinder services, enables or disables a Cinder service, freeze or thaw the specified cinder-volume host, failover a replicating cinder-volume host.

GET

/v3/{project_id}/os-services

List All Cinder Services

Lists all Cinder services. Provides details why any services were disabled.

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/os-services/{id}

Enable/Disable scheduling for a service.

Includes Freeze/Thaw which sends call down to drivers and allows volume.manager for the specified host to disable the service rather than accessing the service directly in this API layer.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-services/{id} API
  id	path	string	id parameter for /v3/os-services/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-services/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

GET

/v3/os-services

Return a list of all running services.

Filter by host & service name.

Responses

200

Ok

404

Error

PUT

/v3/os-services/{id}

Enable/Disable scheduling for a service.

Includes Freeze/Thaw which sends call down to drivers and allows volume.manager for the specified host to disable the service rather than accessing the service directly in this API layer.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/os-services/{id} API

• Schema

  {
    "type": "object",
    "description": "Request of the project_id/os-services/id:put operation",
    "x-openstack": {
      "action-name": "update"
    }
  }
  

Responses

200

Ok

404

Error

os-volume-transfer

Transfers a volume from one user to another user.

GET

/v3/{project_id}/os-volume-transfer/detail

List volume transfers and details

Lists volume transfers, with details.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/os-volume-transfer

List volume transfers for a project

Lists volume transfers.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/os-volume-transfer

Create a volume transfer

Creates a volume transfer.

Preconditions

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-volume-transfer/{id} API
  transfer	body	object	The volume transfer object.
  transfer.volume_id	body	string	The UUID of the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "transfer": {
        "type": "object",
        "description": "The volume transfer object.",
        "properties": {
          "volume_id": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the volume."
          },
          "name": {
            "oneOf": [
              {
                "type": "string",
                "format": "name_skip_leading_trailing_spaces"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name of the object."
          }
        },
        "additionalProperties": false,
        "required": [
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "transfer"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

POST

/v3/{project_id}/os-volume-transfer/{id}/accept

Accept a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-volume-transfer/{id}/accept API
  id	path	string	id parameter for /v3/os-volume-transfer/{id}/accept API
  accept	body	object
  accept.auth_key	body	[‘string’, ‘integer’]

• Schema

  {
    "type": "object",
    "properties": {
      "accept": {
        "type": "object",
        "properties": {
          "auth_key": {
            "type": [
              "string",
              "integer"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "auth_key"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "accept"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/{project_id}/os-volume-transfer/{id}

Return data about active transfers.

Responses

200

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/{project_id}/os-volume-transfer/{id}

Delete a transfer.

Responses

204

Ok

404

Error

GET

/v3/os-volume-transfer/detail

Returns a detailed list of transfers.

Responses

200

Ok

404

Error

GET

/v3/os-volume-transfer

Returns a summary list of transfers.

Responses

200

Ok

404

Error

POST

/v3/os-volume-transfer

Create a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  transfer	body	object	The volume transfer object.
  transfer.volume_id	body	string	The UUID of the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "transfer": {
        "type": "object",
        "description": "The volume transfer object.",
        "properties": {
          "volume_id": {
            "type": "string",
            "format": "uuid",
            "description": "The UUID of the volume."
          },
          "name": {
            "oneOf": [
              {
                "type": "string",
                "format": "name_skip_leading_trailing_spaces"
              },
              {
                "type": "null"
              }
            ],
            "description": "The name of the object."
          }
        },
        "additionalProperties": false,
        "required": [
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "transfer"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

POST

/v3/os-volume-transfer/{id}/accept

Accept a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/os-volume-transfer/{id}/accept API
  accept	body	object
  accept.auth_key	body	[‘string’, ‘integer’]

• Schema

  {
    "type": "object",
    "properties": {
      "accept": {
        "type": "object",
        "properties": {
          "auth_key": {
            "type": [
              "string",
              "integer"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "auth_key"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "accept"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/os-volume-transfer/{id}

Return data about active transfers.

Responses

200

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/os-volume-transfer/{id}

Delete a transfer.

Responses

204

Ok

404

Error

qos-specs

Administrators only, depending on policy settings.

Creates, lists, shows details for, associates, disassociates, sets keys, unsets keys, and deletes quality of service (QoS) specifications.

GET

/v3/{project_id}/qos-specs

List QoS Specifications

Lists quality of service (QoS) specifications.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/qos-specs

Create a QoS specification

Creates a QoS specification.

Specify one or more key and value pairs in the request body.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/qos-specs/{id} API
  qos_specs	body	object	A qos_specs object.
  qos_specs.name	body	string	The name of the QoS specification.

• Schema

  {
    "type": "object",
    "properties": {
      "qos_specs": {
        "type": "object",
        "description": "A `qos_specs` object.",
        "properties": {
          "name": {
            "type": "string",
            "format": "name_skip_leading_trailing_spaces",
            "description": "The name of the QoS specification."
          }
        },
        "additionalProperties": true,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "qos_specs"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

GET

/v3/{project_id}/qos-specs/{id}/associations

List all associations of given qos specs.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/qos-specs/{id}/associate

Associate a qos specs with a volume type.

Responses

202

Accepted

404

Error

GET

/v3/{project_id}/qos-specs/{id}/disassociate

Disassociate a qos specs from a volume type.

Responses

202

Accepted

404

Error

GET

/v3/{project_id}/qos-specs/{id}/disassociate_all

Disassociate a qos specs from all volume types.

Responses

202

Accepted

404

Error

PUT

/v3/{project_id}/qos-specs/{id}/delete_keys

Deletes specified keys in qos specs.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/qos-specs/{id}/delete_keys API
  id	path	string	id parameter for /v3/qos-specs/{id}/delete_keys API

• Schema

  {
    "type": "object",
    "properties": {
      "keys": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "uniqueItems": true
      }
    },
    "additionalProperties": false,
    "required": [
      "keys"
    ]
  }
  

Responses

200

Ok

404

Error

GET

/v3/{project_id}/qos-specs/{id}

Return a single qos spec item.

Responses

200

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

PUT

/v3/{project_id}/qos-specs/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/qos-specs/{id} API
  id	path	string	id parameter for /v3/qos-specs/{id} API
  qos_specs	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "qos_specs": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "qos_specs"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

DELETE

/v3/{project_id}/qos-specs/{id}

Deletes an existing qos specs.

Responses

204

Ok

404

Error

GET

/v3/qos-specs

Returns the list of qos_specs.

Responses

200

Ok

404

Error

POST

/v3/qos-specs

Request

• Description

  Name	Location	Type	Description
  qos_specs	body	object	A qos_specs object.
  qos_specs.name	body	string	The name of the QoS specification.

• Schema

  {
    "type": "object",
    "properties": {
      "qos_specs": {
        "type": "object",
        "description": "A `qos_specs` object.",
        "properties": {
          "name": {
            "type": "string",
            "format": "name_skip_leading_trailing_spaces",
            "description": "The name of the QoS specification."
          }
        },
        "additionalProperties": true,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "qos_specs"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

GET

/v3/qos-specs/{id}/associations

List all associations of given qos specs.

Responses

200

Ok

404

Error

GET

/v3/qos-specs/{id}/associate

Associate a qos specs with a volume type.

Responses

202

Accepted

404

Error

GET

/v3/qos-specs/{id}/disassociate

Disassociate a qos specs from a volume type.

Responses

202

Accepted

404

Error

GET

/v3/qos-specs/{id}/disassociate_all

Disassociate a qos specs from all volume types.

Responses

202

Accepted

404

Error

PUT

/v3/qos-specs/{id}/delete_keys

Deletes specified keys in qos specs.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/qos-specs/{id}/delete_keys API

• Schema

  {
    "type": "object",
    "properties": {
      "keys": {
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        },
        "uniqueItems": true
      }
    },
    "additionalProperties": false,
    "required": [
      "keys"
    ]
  }
  

Responses

200

Ok

404

Error

GET

/v3/qos-specs/{id}

Return a single qos spec item.

Responses

200

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

PUT

/v3/qos-specs/{id}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/qos-specs/{id} API
  qos_specs	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "qos_specs": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "qos_specs"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
qos_specs	body	object	A qos_specs object.
qos_specs.consumer	body	string	The consumer type.
qos_specs.specs	body	object	A specs object.
qos_specs.id	body	string	The generated ID for the QoS specification.
qos_specs.name	body	string	The name of the QoS specification.

404

Error

DELETE

/v3/qos-specs/{id}

Deletes an existing qos specs.

Responses

204

Ok

404

Error

resource_filters

Lists all resource filters, available since microversion 3.33.

GET

/v3/{project_id}/resource_filters

List resource filters

List filters.

Responses

200

Ok

404

Error

GET

/v3/resource_filters

Return a list of resource filters.

Responses

200

Ok

404

Error

scheduler-stats

Administrator only. Lists all back-end storage pools that are known to the scheduler service.

GET

/v3/{project_id}/scheduler-stats/get_pools

List all back-end storage pools

Lists all back-end storage pools. Since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/scheduler-stats/get_pools

List all active pools in scheduler.

Responses

200

Ok

404

Error

snapshots

A snapshot is a point-in-time copy of the data that a volume contains.

When you create, list, or delete snapshots, these status values are possible:

• creating: The snapshot is being created.

• available: The snapshot is ready to use.

• backing-up: The snapshot is being backed up.

• deleting: The snapshot is being deleted.

• error: A snapshot creation error occurred.

• deleted: The snapshot has been deleted.

• unmanaging: The snapshot is being unmanaged.

• restoring: The snapshot is being restored to a volume.

• error_deleting: A snapshot deletion error occurred.

GET

/v3/{project_id}/snapshots/detail

List snapshots and details

Lists all Block Storage snapshots, with details, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/snapshots

List accessible snapshots

Lists all Block Storage snapshots, with summary information, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/snapshots

Create a snapshot

Creates a volume snapshot, which is a point-in-time, complete copy of a volume. You can create a volume from a snapshot.

Prior to API version 3.66, a ‘force’ flag was required to create a snapshot of an in-use volume, but this is no longer the case. From API version 3.66, the ‘force’ flag is invalid when passed in a volume snapshot request. (For backward compatibility, however, a ‘force’ flag with a value evaluating to True is silently ignored.)

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id} API
  snapshot	body	object	A snapshot object.
  snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot.
  snapshot.display_name	body	[‘string’, ‘null’]	The name of the snapshot.
  snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot. Default is None.
  snapshot.force	body	[‘boolean’, ‘string’]	Indicates whether to snapshot, even if the volume is attached. Default is false. See valid boolean values
  snapshot.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs for the snapshot.

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "description": "A `snapshot` object.",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot."
          },
          "display_name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "A description for the snapshot. Default is\n`None`."
          },
          "volume_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ],
            "description": "The UUID of the volume."
          },
          "force": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Indicates whether to snapshot, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs for the\nsnapshot."
          }
        },
        "additionalProperties": false,
        "required": [
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

POST

/v3/{project_id}/snapshots/{id}/action

`os-reset_status` action

Empty body for os-reset_status action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id}/action API
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-reset_status	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reset_status action",
    "properties": {
      "os-reset_status": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reset_status"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/snapshots/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id}/action API
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/snapshots/{id}/action

`os-update_snapshot_status` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id}/action API
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-update_snapshot_status	body	object
  os-update_snapshot_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-update_snapshot_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "progress": {
            "format": "progress"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-update_snapshot_status"
    },
    "required": [
      "os-update_snapshot_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/snapshots/{id}/action

`os-unmanage` action

Empty body for os-unmanage action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id}/action API
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-unmanage	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unmanage action",
    "properties": {
      "os-unmanage": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unmanage"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

GET

/v3/{project_id}/snapshots/{id}

Return data about the given snapshot.

Responses

200

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

PUT

/v3/{project_id}/snapshots/{id}

Update a snapshot.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{id} API
  id	path	string	id parameter for /v3/snapshots/{id} API
  snapshot	body	object
  snapshot.name	body	[‘string’, ‘null’]
  snapshot.description	body	[‘string’, ‘null’]
  snapshot.display_name	body	[‘string’, ‘null’]
  snapshot.display_description	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "display_name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "display_description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "name"
            ]
          },
          {
            "required": [
              "description"
            ]
          },
          {
            "required": [
              "display_name"
            ]
          },
          {
            "required": [
              "display_description"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

DELETE

/v3/{project_id}/snapshots/{id}

Delete a snapshot.

Responses

204

Ok

404

Error

GET

/v3/snapshots/detail

Returns a detailed list of snapshots.

Responses

200

Ok

404

Error

GET

/v3/snapshots

Returns a summary list of snapshots.

Responses

200

Ok

404

Error

POST

/v3/snapshots

Creates a new snapshot.

Request

• Description

  Name	Location	Type	Description
  snapshot	body	object	A snapshot object.
  snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot.
  snapshot.display_name	body	[‘string’, ‘null’]	The name of the snapshot.
  snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot. Default is None.
  snapshot.force	body	[‘boolean’, ‘string’]	Indicates whether to snapshot, even if the volume is attached. Default is false. See valid boolean values
  snapshot.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs for the snapshot.

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "description": "A `snapshot` object.",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot."
          },
          "display_name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "description": "The name of the snapshot."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "A description for the snapshot. Default is\n`None`."
          },
          "volume_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ],
            "description": "The UUID of the volume."
          },
          "force": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Indicates whether to snapshot, even if the volume\nis attached. Default is `false`.\nSee [valid boolean values](#valid-boolean-values)"
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "description": "One or more metadata key and value pairs for the\nsnapshot."
          }
        },
        "additionalProperties": false,
        "required": [
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

POST

/v3/snapshots/{id}/action

`os-reset_status` action

Empty body for os-reset_status action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-reset_status	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reset_status action",
    "properties": {
      "os-reset_status": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reset_status"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/snapshots/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/snapshots/{id}/action

`os-update_snapshot_status` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-update_snapshot_status	body	object
  os-update_snapshot_status.status	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-update_snapshot_status": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string"
          },
          "progress": {
            "format": "progress"
          }
        },
        "additionalProperties": false,
        "required": [
          "status"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-update_snapshot_status"
    },
    "required": [
      "os-update_snapshot_status"
    ]
  }
  

Responses

201

Ok

202

Ok

404

Error

POST

/v3/snapshots/{id}/action

`os-unmanage` action

Empty body for os-unmanage action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/snapshots/{id}/action API
  os-unmanage	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unmanage action",
    "properties": {
      "os-unmanage": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unmanage"
    }
  }
  

Responses

201

Ok

202

Ok

404

Error

GET

/v3/snapshots/{id}

Return data about the given snapshot.

Responses

200

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

PUT

/v3/snapshots/{id}

Update a snapshot.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/snapshots/{id} API
  snapshot	body	object
  snapshot.name	body	[‘string’, ‘null’]
  snapshot.description	body	[‘string’, ‘null’]
  snapshot.display_name	body	[‘string’, ‘null’]
  snapshot.display_description	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "display_name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "display_description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "name"
            ]
          },
          {
            "required": [
              "description"
            ]
          },
          {
            "required": [
              "display_name"
            ]
          },
          {
            "required": [
              "display_description"
            ]
          }
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
snapshot	body	object	A snapshot object.
snapshot.os-extended-snapshot-attributes:progress	body	string	A percentage value for the build progress.
snapshot.os-extended-snapshot-attributes:project_id	body	string	The UUID of the owning project.
snapshot.group_snapshot_id	body	string	The ID of the group snapshot. New in version 3.14 New in version 3.14
snapshot.consumes_quota	body	[‘boolean’, ‘null’]	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65
snapshot.status	body	string	The status for the snapshot.
snapshot.description	body	[‘string’, ‘null’]	A description for the snapshot.
snapshot.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
snapshot.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
snapshot.name	body	[‘string’, ‘null’]	The name of the snapshot. Default is None.
snapshot.volume_id	body	string	The UUID of the volume.
snapshot.metadata	body	object	One or more metadata key and value pairs for the snapshot.
snapshot.id	body	string	The UUID of the object.
snapshot.size	body	integer	The size of the volume, in gibibytes (GiB).
snapshot.count	body	[‘integer’, ‘null’]	The total count of requested resource before pagination is applied. New in version 3.45

404

Error

DELETE

/v3/snapshots/{id}

Delete a snapshot.

Responses

204

Ok

404

Error

GET

/v3/{project_id}/snapshots/{snapshot_id}/metadata

Show a snapshot’s metadata

Shows metadata for a snapshot.

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

POST

/v3/{project_id}/snapshots/{snapshot_id}/metadata

Create a snapshot’s metadata

Updates metadata for a snapshot.

Creates or replaces metadata items that match keys. Does not modify items that are not in the request.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{snapshot_id}/metadata API
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "metadata": {
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "One or more metadata key and value pairs for the\nsnapshot, if any."
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

PUT

/v3/{project_id}/snapshots/{snapshot_id}/metadata

Update a snapshot’s metadata

Replaces all the snapshot’s metadata with the key-value pairs in the request.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{snapshot_id}/metadata API
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "metadata": {
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "One or more metadata key and value pairs for the\nsnapshot, if any."
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

GET

/v3/{project_id}/snapshots/{snapshot_id}/metadata/{id}

Return a single metadata item.

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

PUT

/v3/{project_id}/snapshots/{snapshot_id}/metadata/{id}

Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/snapshots/{snapshot_id}/metadata API
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  id	path	string	id parameter for /v3/snapshots/{snapshot_id}/metadata/{id} API
  meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "meta": {
        "maxProperties": 1,
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "A metadata object. Contains one or more metadata key and value pairs that are associated with the resource."
      }
    },
    "additionalProperties": false,
    "required": [
      "meta"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

DELETE

/v3/{project_id}/snapshots/{snapshot_id}/metadata/{id}

Deletes an existing metadata.

Responses

204

Ok

404

Error

GET

/v3/snapshots/{snapshot_id}/metadata

Returns the list of metadata for a given snapshot.

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

POST

/v3/snapshots/{snapshot_id}/metadata

Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.

Request

• Description

  Name	Location	Type	Description
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "metadata": {
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "One or more metadata key and value pairs for the\nsnapshot, if any."
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

PUT

/v3/snapshots/{snapshot_id}/metadata

Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.

Request

• Description

  Name	Location	Type	Description
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "metadata": {
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "One or more metadata key and value pairs for the\nsnapshot, if any."
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

GET

/v3/snapshots/{snapshot_id}/metadata/{id}

Return a single metadata item.

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

PUT

/v3/snapshots/{snapshot_id}/metadata/{id}

Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.

Request

• Description

  Name	Location	Type	Description
  snapshot_id	path	string	snapshot_id parameter for /v3/snapshots/{snapshot_id}/metadata API
  id	path	string	id parameter for /v3/snapshots/{snapshot_id}/metadata/{id} API
  meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

• Schema

  {
    "type": "object",
    "description": "Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes.",
    "properties": {
      "meta": {
        "maxProperties": 1,
        "type": "object",
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "description": "A metadata object. Contains one or more metadata key and value pairs that are associated with the resource."
      }
    },
    "additionalProperties": false,
    "required": [
      "meta"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

DELETE

/v3/snapshots/{snapshot_id}/metadata/{id}

Deletes an existing metadata.

Responses

204

Ok

404

Error

types

To create an environment with multiple-storage back ends, you must specify a volume type. The API spawns Block Storage volume back ends as children to cinder-volume, and keys them from a unique queue. The API names the back ends cinder-volume.HOST.BACKEND. For example, cinder-volume.ubuntu.lvmdriver. When you create a volume, the scheduler chooses an appropriate back end for the volume type to handle the request.

GET

/v3/{project_id}/types

List all volume types

Lists volume types.

To determine which of these is the default type that will be used if you do not specify one in the Create a volume request, use the Show default volume type request.

Note to users: There may be a volume type named __DEFAULT__ in the list. Try not to use this volume type, unless necessary or instructed by the operator, in a Create a volume request. If you wish to create a volume of your default volume type, simply omit the volume_type parameter in your Create a volume request.

Note to operators: The __DEFAULT__ volume type was introduced in the Train release as a placeholder to prevent the creation of untyped volumes. Under the proper conditions, it may be removed from your deployment. Consult the Default Volume Types section in Cinder Administration Guide for details.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/types

Create a volume type

Creates a volume type.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id} API
  volume_type	body	object	A volume_type object.
  volume_type.name	body	string	The name of the volume type.
  volume_type.description	body	[‘string’, ‘null’]	The volume type description.
  volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
  volume_type.os-volume-type-access:is_public	body	[‘boolean’, ‘string’]	Whether the volume type is publicly visible. See valid boolean values

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "description": "A `volume_type` object.",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name",
            "description": "The name of the volume type."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The volume type description."
          },
          "extra_specs": {
            "type": "object",
            "description": "A key and value pair that contains additional\nspecifications that are associated with the volume type. Examples\ninclude capabilities, capacity, compression, and so on, depending\non the storage driver in use.",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              }
            }
          },
          "os-volume-type-access:is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Whether the volume type is publicly visible.\nSee [valid boolean values](#valid-boolean-values)"
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

POST

/v3/{project_id}/types/{id}/action

`create` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id}/action API
  id	path	string	id parameter for /v3/types/{id}/action API
  volume_type	body	object
  volume_type.name	body	string
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.extra_specs	body	object
  volume_type.os-volume-type-access:is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "extra_specs": {
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              }
            }
          },
          "os-volume-type-access:is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "create"
    },
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/{project_id}/types/{id}/action

`update` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id}/action API
  id	path	string	id parameter for /v3/types/{id}/action API
  volume_type	body	object
  volume_type.name	body	[‘string’, ‘null’]
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "update"
    },
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/{project_id}/types/{id}/action

`delete` action

Empty body for delete action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id}/action API
  id	path	string	id parameter for /v3/types/{id}/action API
  delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for delete action",
    "properties": {
      "delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "delete"
    }
  }
  

Responses

201

Ok

404

Error

POST

/v3/{project_id}/types/{id}/action

`addProjectAccess` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id}/action API
  id	path	string	id parameter for /v3/types/{id}/action API
  addProjectAccess	body	object
  addProjectAccess.project	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "addProjectAccess": {
        "type": "object",
        "properties": {
          "project": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "project"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "addProjectAccess"
    },
    "required": [
      "addProjectAccess"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/{project_id}/types/{id}/action

`removeProjectAccess` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id}/action API
  id	path	string	id parameter for /v3/types/{id}/action API
  removeProjectAccess	body	object
  removeProjectAccess.project	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "removeProjectAccess": {
        "type": "object",
        "properties": {
          "project": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "project"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "removeProjectAccess"
    },
    "required": [
      "removeProjectAccess"
    ]
  }
  

Responses

201

Ok

404

Error

GET

/v3/{project_id}/types/{id}

Return a single volume type item.

Responses

200

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

PUT

/v3/{project_id}/types/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{id} API
  id	path	string	id parameter for /v3/types/{id} API
  volume_type	body	object
  volume_type.name	body	[‘string’, ‘null’]
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "required": [
      "volume_type"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

DELETE

/v3/{project_id}/types/{id}

Deletes an existing volume type.

Responses

204

Ok

404

Error

GET

/v3/types

Returns the list of volume types.

Responses

200

Ok

404

Error

POST

/v3/types

Creates a new volume type.

Request

• Description

  Name	Location	Type	Description
  volume_type	body	object	A volume_type object.
  volume_type.name	body	string	The name of the volume type.
  volume_type.description	body	[‘string’, ‘null’]	The volume type description.
  volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
  volume_type.os-volume-type-access:is_public	body	[‘boolean’, ‘string’]	Whether the volume type is publicly visible. See valid boolean values

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "description": "A `volume_type` object.",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name",
            "description": "The name of the volume type."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$",
            "description": "The volume type description."
          },
          "extra_specs": {
            "type": "object",
            "description": "A key and value pair that contains additional\nspecifications that are associated with the volume type. Examples\ninclude capabilities, capacity, compression, and so on, depending\non the storage driver in use.",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              }
            }
          },
          "os-volume-type-access:is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ],
            "description": "Whether the volume type is publicly visible.\nSee [valid boolean values](#valid-boolean-values)"
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

POST

/v3/types/{id}/action

`create` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id}/action API
  volume_type	body	object
  volume_type.name	body	string
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.extra_specs	body	object
  volume_type.os-volume-type-access:is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255,
            "format": "name"
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "extra_specs": {
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              }
            }
          },
          "os-volume-type-access:is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "name"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "create"
    },
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/types/{id}/action

`update` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id}/action API
  volume_type	body	object
  volume_type.name	body	[‘string’, ‘null’]
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "update"
    },
    "required": [
      "volume_type"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/types/{id}/action

`delete` action

Empty body for delete action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id}/action API
  delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for delete action",
    "properties": {
      "delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "delete"
    }
  }
  

Responses

201

Ok

404

Error

POST

/v3/types/{id}/action

`addProjectAccess` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id}/action API
  addProjectAccess	body	object
  addProjectAccess.project	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "addProjectAccess": {
        "type": "object",
        "properties": {
          "project": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "project"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "addProjectAccess"
    },
    "required": [
      "addProjectAccess"
    ]
  }
  

Responses

201

Ok

404

Error

POST

/v3/types/{id}/action

`removeProjectAccess` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id}/action API
  removeProjectAccess	body	object
  removeProjectAccess.project	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "removeProjectAccess": {
        "type": "object",
        "properties": {
          "project": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "project"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "removeProjectAccess"
    },
    "required": [
      "removeProjectAccess"
    ]
  }
  

Responses

201

Ok

404

Error

GET

/v3/types/{id}

Return a single volume type item.

Responses

200

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

PUT

/v3/types/{id}

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/types/{id} API
  volume_type	body	object
  volume_type.name	body	[‘string’, ‘null’]
  volume_type.description	body	[‘string’, ‘null’]
  volume_type.is_public	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "volume_type": {
        "type": "object",
        "properties": {
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "is_public": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "required": [
      "volume_type"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
volume_type	body	object	A volume_type object.
volume_type.description	body	string	The volume type description.
volume_type.extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.
volume_type.id	body	string	The UUID of the volume type.
volume_type.is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.name	body	string	The name of the volume type.
volume_type.os-volume-type-access:is_public	body	boolean	Whether the volume type is publicly visible.
volume_type.qos_specs_id	body	string	The QoS specifications ID.

404

Error

DELETE

/v3/types/{id}

Deletes an existing volume type.

Responses

204

Ok

404

Error

GET

/v3/{project_id}/types/{type_id}/extra_specs

Returns the list of extra specs for a given volume type.

Responses

200

Ok

Name	Location	Type	Description
extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.

404

Error

POST

/v3/{project_id}/types/{type_id}/extra_specs

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{type_id}/extra_specs/{id} API
  type_id	path	string	type_id parameter for /v3/types/{type_id}/extra_specs/{id} API
  extra_specs	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "extra_specs": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:.]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "extra_specs"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.

404

Error

GET

/v3/{project_id}/types/{type_id}/extra_specs/{id}

Return a single extra spec item.

Responses

200

Ok

404

Error

PUT

/v3/{project_id}/types/{type_id}/extra_specs/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{type_id}/extra_specs/{id} API
  type_id	path	string	type_id parameter for /v3/types/{type_id}/extra_specs/{id} API
  id	path	string	id parameter for /v3/types/{type_id}/extra_specs/{id} API

• Schema

  {
    "type": "object",
    "additionalProperties": false,
    "patternProperties": {
      "^[a-zA-Z0-9-_:.]{1,255}$": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 255
      }
    },
    "minProperties": 1,
    "maxProperties": 1
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/{project_id}/types/{type_id}/extra_specs/{id}

Deletes an existing extra spec.

Responses

202

Ok

404

Error

GET

/v3/types/{type_id}/extra_specs

Returns the list of extra specs for a given volume type.

Responses

200

Ok

Name	Location	Type	Description
extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.

404

Error

POST

/v3/types/{type_id}/extra_specs

Request

• Description

  Name	Location	Type	Description
  type_id	path	string	type_id parameter for /v3/types/{type_id}/extra_specs/{id} API
  extra_specs	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "extra_specs": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:.]{1,255}$": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "extra_specs"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
extra_specs	body	object	A key and value pair that contains additional specifications that are associated with the volume type. Examples include capabilities, capacity, compression, and so on, depending on the storage driver in use.

404

Error

GET

/v3/types/{type_id}/extra_specs/{id}

Return a single extra spec item.

Responses

200

Ok

404

Error

PUT

/v3/types/{type_id}/extra_specs/{id}

Request

• Description

  Name	Location	Type	Description
  type_id	path	string	type_id parameter for /v3/types/{type_id}/extra_specs/{id} API
  id	path	string	id parameter for /v3/types/{type_id}/extra_specs/{id} API

• Schema

  {
    "type": "object",
    "additionalProperties": false,
    "patternProperties": {
      "^[a-zA-Z0-9-_:.]{1,255}$": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 255
      }
    },
    "minProperties": 1,
    "maxProperties": 1
  }
  

Responses

200

Ok

404

Error

DELETE

/v3/types/{type_id}/extra_specs/{id}

Deletes an existing extra spec.

Responses

202

Ok

404

Error

GET

/v3/{project_id}/types/{type_id}/os-volume-type-access

Responses

200

Ok

404

Error

GET

/v3/types/{type_id}/os-volume-type-access

Responses

200

Ok

404

Error

GET

/v3/{project_id}/types/{type_id}/encryption

Returns the encryption specs for a given volume type.

Responses

200

Ok

Name	Location	Type	Description
cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
created_at	body	string	The date and time when the resource was created.
deleted	body	boolean	The resource is deleted or not.
deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption_id	body	string	The UUID of the encryption.
key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
provider	body	string	The class that provides encryption support.
updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

POST

/v3/{project_id}/types/{type_id}/encryption

Create encryption specs for an existing volume type.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{type_id}/encryption/{id} API
  type_id	path	string	type_id parameter for /v3/types/{type_id}/encryption/{id} API
  encryption	body	object
  encryption.key_size	body	[‘string’, ‘integer’, ‘null’]
  encryption.provider	body	string
  encryption.cipher	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "encryption": {
        "type": "object",
        "properties": {
          "key_size": {
            "type": [
              "string",
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 2147483647,
            "format": "key_size"
          },
          "provider": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255
          },
          "control_location": {
            "enum": [
              "front-end",
              "back-end"
            ]
          },
          "cipher": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": true,
        "required": [
          "provider",
          "control_location"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "encryption"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
encryption	body	object
encryption.cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
encryption.control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
encryption.created_at	body	string	The date and time when the resource was created.
encryption.deleted	body	boolean	The resource is deleted or not.
encryption.deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption.encryption_id	body	string	The UUID of the encryption.
encryption.key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
encryption.provider	body	string	The class that provides encryption support.
encryption.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

GET

/v3/{project_id}/types/{type_id}/encryption/{id}

Return a single encryption item.

Responses

200

Ok

Name	Location	Type	Description
cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.

404

Error

PUT

/v3/{project_id}/types/{type_id}/encryption/{id}

Update encryption specs for a given volume type.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/types/{type_id}/encryption/{id} API
  type_id	path	string	type_id parameter for /v3/types/{type_id}/encryption/{id} API
  id	path	string	id parameter for /v3/types/{type_id}/encryption/{id} API
  encryption	body	object
  encryption.key_size	body	[‘string’, ‘integer’, ‘null’]
  encryption.provider	body	string
  encryption.cipher	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "encryption": {
        "type": "object",
        "properties": {
          "key_size": {
            "type": [
              "string",
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 2147483647,
            "format": "key_size"
          },
          "provider": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255
          },
          "control_location": {
            "enum": [
              "front-end",
              "back-end"
            ]
          },
          "cipher": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": true,
        "required": []
      }
    },
    "additionalProperties": false,
    "required": [
      "encryption"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
encryption	body	object
encryption.cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
encryption.control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
encryption.created_at	body	string	The date and time when the resource was created.
encryption.deleted	body	boolean	The resource is deleted or not.
encryption.deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption.encryption_id	body	string	The UUID of the encryption.
encryption.key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
encryption.provider	body	string	The class that provides encryption support.
encryption.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

DELETE

/v3/{project_id}/types/{type_id}/encryption/{id}

Delete encryption specs for a given volume type.

Responses

204

Ok

404

Error

GET

/v3/types/{type_id}/encryption

Returns the encryption specs for a given volume type.

Responses

200

Ok

Name	Location	Type	Description
cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
created_at	body	string	The date and time when the resource was created.
deleted	body	boolean	The resource is deleted or not.
deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption_id	body	string	The UUID of the encryption.
key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
provider	body	string	The class that provides encryption support.
updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

POST

/v3/types/{type_id}/encryption

Create encryption specs for an existing volume type.

Request

• Description

  Name	Location	Type	Description
  type_id	path	string	type_id parameter for /v3/types/{type_id}/encryption/{id} API
  encryption	body	object
  encryption.key_size	body	[‘string’, ‘integer’, ‘null’]
  encryption.provider	body	string
  encryption.cipher	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "encryption": {
        "type": "object",
        "properties": {
          "key_size": {
            "type": [
              "string",
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 2147483647,
            "format": "key_size"
          },
          "provider": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255
          },
          "control_location": {
            "enum": [
              "front-end",
              "back-end"
            ]
          },
          "cipher": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": true,
        "required": [
          "provider",
          "control_location"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "encryption"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
encryption	body	object
encryption.cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
encryption.control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
encryption.created_at	body	string	The date and time when the resource was created.
encryption.deleted	body	boolean	The resource is deleted or not.
encryption.deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption.encryption_id	body	string	The UUID of the encryption.
encryption.key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
encryption.provider	body	string	The class that provides encryption support.
encryption.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

GET

/v3/types/{type_id}/encryption/{id}

Return a single encryption item.

Responses

200

Ok

Name	Location	Type	Description
cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.

404

Error

PUT

/v3/types/{type_id}/encryption/{id}

Update encryption specs for a given volume type.

Request

• Description

  Name	Location	Type	Description
  type_id	path	string	type_id parameter for /v3/types/{type_id}/encryption/{id} API
  id	path	string	id parameter for /v3/types/{type_id}/encryption/{id} API
  encryption	body	object
  encryption.key_size	body	[‘string’, ‘integer’, ‘null’]
  encryption.provider	body	string
  encryption.cipher	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "encryption": {
        "type": "object",
        "properties": {
          "key_size": {
            "type": [
              "string",
              "integer",
              "null"
            ],
            "minimum": 0,
            "maximum": 2147483647,
            "format": "key_size"
          },
          "provider": {
            "type": "string",
            "minLength": 0,
            "maxLength": 255
          },
          "control_location": {
            "enum": [
              "front-end",
              "back-end"
            ]
          },
          "cipher": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          }
        },
        "additionalProperties": true,
        "required": []
      }
    },
    "additionalProperties": false,
    "required": [
      "encryption"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
encryption	body	object
encryption.cipher	body	string	The encryption algorithm or mode. For example, aes-xts-plain64. The default value is None.
encryption.control_location	body	string	Notional service where encryption is performed. Valid values are “front-end” or “back-end”. The default value is “front-end”.
encryption.created_at	body	string	The date and time when the resource was created.
encryption.deleted	body	boolean	The resource is deleted or not.
encryption.deleted_at	body	[‘string’, ‘null’]	The date and time when the resource was deleted.
encryption.encryption_id	body	string	The UUID of the encryption.
encryption.key_size	body	integer	Size of encryption key, in bits. This is usually 256. The default value is None.
encryption.provider	body	string	The class that provides encryption support.
encryption.updated_at	body	[‘string’, ‘null’]	The date and time when the resource was updated.

404

Error

DELETE

/v3/types/{type_id}/encryption/{id}

Delete encryption specs for a given volume type.

Responses

204

Ok

404

Error

volume-transfers

Transfers a volume from one user to another user. This is the new transfer APIs with microversion 3.55.

GET

/v3/{project_id}/volume-transfers/detail

List volume transfers and details

Lists volume transfers, with details.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/volume-transfers

List volume transfers for a project

Lists volume transfers.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/volume-transfers

Create a volume transfer

Creates a volume transfer.

Preconditions

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volume-transfers/{id} API
  transfer	body	object	The volume transfer object.
  transfer.volume_id	body	string	The UUID of the volume.
  transfer.no_snapshots	body	[‘boolean’, ‘string’]	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "transfer": {
            "type": "object",
            "description": "The volume transfer object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume."
              },
              "name": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "name_skip_leading_trailing_spaces"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The name of the object."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.54"
        },
        "required": [
          "transfer"
        ]
      },
      {
        "type": "object",
        "properties": {
          "transfer": {
            "type": "object",
            "description": "The volume transfer object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume."
              },
              "name": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "name_skip_leading_trailing_spaces"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The name of the object."
              },
              "no_snapshots": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Transfer volume without snapshots. Defaults to False if not specified.\n\n\n**New in version 3.55**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.55"
        },
        "required": [
          "transfer"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

POST

/v3/{project_id}/volume-transfers/{id}/accept

Accept a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volume-transfers/{id}/accept API
  id	path	string	id parameter for /v3/volume-transfers/{id}/accept API
  accept	body	object
  accept.auth_key	body	[‘string’, ‘integer’]

• Schema

  {
    "type": "object",
    "properties": {
      "accept": {
        "type": "object",
        "properties": {
          "auth_key": {
            "type": [
              "string",
              "integer"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "auth_key"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "accept"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/{project_id}/volume-transfers/{id}

Return data about active transfers.

Responses

200

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/{project_id}/volume-transfers/{id}

Delete a transfer.

Responses

204

Ok

404

Error

GET

/v3/volume-transfers/detail

Returns a detailed list of transfers.

Responses

200

Ok

404

Error

GET

/v3/volume-transfers

Returns a summary list of transfers.

Responses

200

Ok

404

Error

POST

/v3/volume-transfers

Create a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  transfer	body	object	The volume transfer object.
  transfer.volume_id	body	string	The UUID of the volume.
  transfer.no_snapshots	body	[‘boolean’, ‘string’]	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "transfer": {
            "type": "object",
            "description": "The volume transfer object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume."
              },
              "name": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "name_skip_leading_trailing_spaces"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The name of the object."
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.54"
        },
        "required": [
          "transfer"
        ]
      },
      {
        "type": "object",
        "properties": {
          "transfer": {
            "type": "object",
            "description": "The volume transfer object.",
            "properties": {
              "volume_id": {
                "type": "string",
                "format": "uuid",
                "description": "The UUID of the volume."
              },
              "name": {
                "oneOf": [
                  {
                    "type": "string",
                    "format": "name_skip_leading_trailing_spaces"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The name of the object."
              },
              "no_snapshots": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ],
                "description": "Transfer volume without snapshots. Defaults to False if not specified.\n\n\n**New in version 3.55**"
              }
            },
            "additionalProperties": false,
            "required": [
              "volume_id"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.55"
        },
        "required": [
          "transfer"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

POST

/v3/volume-transfers/{id}/accept

Accept a new volume transfer.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volume-transfers/{id}/accept API
  accept	body	object
  accept.auth_key	body	[‘string’, ‘integer’]

• Schema

  {
    "type": "object",
    "properties": {
      "accept": {
        "type": "object",
        "properties": {
          "auth_key": {
            "type": [
              "string",
              "integer"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "auth_key"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "accept"
    ]
  }
  

Responses

202

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

GET

/v3/volume-transfers/{id}

Return data about active transfers.

Responses

200

Ok

Name	Location	Type	Description
transfer	body	object
transfer.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
transfer.destination_project_id	body	string	Records the destination project_id after volume transfer. New in version 3.57 New in version 3.57
transfer.source_project_id	body	string	Records the source project_id before volume transfer. New in version 3.57 New in version 3.57
transfer.accepted	body	boolean	Records if this transfer was accepted or not. New in version 3.57 New in version 3.57
transfer.no_snapshots	body	boolean	Transfer volume without snapshots. Defaults to False if not specified. New in version 3.55 New in version 3.55
transfer.id	body	string	The UUID of the object.
transfer.name	body	[‘string’, ‘null’]	The name of the object.
transfer.volume_id	body	string	The UUID of the volume.

404

Error

DELETE

/v3/volume-transfers/{id}

Delete a transfer.

Responses

204

Ok

404

Error

volumes

A volume is a detachable block storage device similar to a USB hard drive. You can attach a volume to an instance, and if the volume is of an appropriate volume type, a volume can be attached to multiple instances.

The snapshot_id and source_volid parameters specify the ID of the snapshot or volume from which this volume originates. If the volume was not created from a snapshot or source volume, these values are null.

When you create, list, update, or delete volumes, the possible status values are:

• creating: The volume is being created.

• available: The volume is ready to attach to an instance.

• reserved: The volume is reserved for attaching or shelved.

• attaching: The volume is attaching to an instance.

• detaching: The volume is detaching from an instance.

• in-use: The volume is attached to an instance.

• maintenance: The volume is locked and being migrated.

• deleting: The volume is being deleted.

• awaiting-transfer: The volume is awaiting for transfer.

• error: A volume creation error occurred.

• error_deleting: A volume deletion error occurred.

• backing-up: The volume is being backed up.

• restoring-backup: A backup is being restored to the volume.

• error_backing-up: A backup error occurred.

• error_restoring: A backup restoration error occurred.

• error_extending: An error occurred while attempting to extend a volume.

• downloading: The volume is downloading an image.

• uploading: The volume is being uploaded to an image.

• retyping: The volume is changing type to another volume type.

• extending: The volume is being extended.

GET

/v3/{project_id}/volumes/detail

List accessible volumes with details

Lists all Block Storage volumes, with details, that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/volumes/summary

Get volumes summary

Display volumes summary with total number of volumes and total size in GB. Available since API microversion 3.12.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/volumes

List accessible volumes

Lists summary information for all Block Storage volumes that the project can access, since v3.31 if non-admin users specify invalid filters in the url, API will return bad request.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/volumes

Create a volume

Creates a volume.

To create a bootable volume, include the UUID of the image from which you want to create the volume in the imageRef attribute in the request body.

Since the Train release, every volume must have a volume type. It is optional to specify a volume type as part of your Create a volume request. If you do not specify one, a default volume type will be supplied for you. This type may vary according to what project you are in and how the operator has configured the Block Storage service. Use the Show default volume type request to determine your effective default volume type.

Preconditions

Asynchronous Postconditions

Troubleshooting

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id} API
  volume	body	object	A volume object.
  volume.name	body	[‘string’, ‘null’]	The volume name.
  volume.description	body	[‘string’, ‘null’]	The volume description.
  volume.display_name	body	[‘string’, ‘null’]
  volume.display_description	body	[‘string’, ‘null’]
  volume.volume_type	body	[‘string’, ‘null’]	The volume type (either name or ID). To create an environment with multiple-storage back ends, you must specify a volume type. Block Storage volume back ends are spawned as children to cinder- volume, and they are keyed from a unique queue. They are named cinder- volume.HOST.BACKEND. For example, cinder- volume.ubuntu.lvmdriver. When a volume is created, the scheduler chooses an appropriate back end to handle the request based on the volume type. Default is None. For information about how to use volume types to create multiple- storage back ends, see Configure multiple-storage back ends.
  volume.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs to be associated with the new volume.
  volume.size	body	[‘integer’, ‘string’, ‘null’]	The size of the volume, in gibibytes (GiB).
  volume.availability_zone	body	[‘string’, ‘null’]	The name of the availability zone.
  volume.image_id	body	[‘string’, ‘null’]
  volume.imageRef	body	[‘string’, ‘null’]	The UUID of the image from which you want to create the volume. Required to create a bootable volume.
  OS-SCH-HNT:scheduler_hints	body	[‘object’, ‘null’]	The dictionary of data to send to the scheduler.
  volume.group_id	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.12"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.13",
          "max-ver": "3.46"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "backup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the backup.\n\n\n**New in version 3.47**"
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.47",
          "max-ver": "3.52"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "backup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the backup.\n\n\n**New in version 3.47**"
              }
            },
            "additionalProperties": false
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.53"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`revert` action

Empty body for revert action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  revert	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for revert action",
    "properties": {
      "revert": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "revert"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-reset_status` action

Empty body for os-reset_status action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reset_status	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reset_status action",
    "properties": {
      "os-reset_status": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reset_status"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-force_detach` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-force_detach	body	object
  os-force_detach.connector	body	[‘string’, ‘object’, ‘null’]
  os-force_detach.attachment_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-force_detach": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "string",
              "object",
              "null"
            ]
          },
          "attachment_id": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-force_detach"
    },
    "required": [
      "os-force_detach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-migrate_volume` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-migrate_volume	body	object
  os-migrate_volume.host	body	string
  os-migrate_volume.force_host_copy	body	[‘boolean’, ‘string’]
  os-migrate_volume.lock_volume	body	[‘boolean’, ‘string’]
  os-migrate_volume.cluster	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "os-migrate_volume": {
            "type": "object",
            "properties": {
              "host": {
                "type": "string",
                "maxLength": 255
              },
              "force_host_copy": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "lock_volume": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "host"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.15",
          "action-name": "os-migrate_volume"
        },
        "required": [
          "os-migrate_volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "os-migrate_volume": {
            "type": "object",
            "properties": {
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              },
              "force_host_copy": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "lock_volume": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "cluster": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.16",
          "action-name": "os-migrate_volume"
        },
        "required": [
          "os-migrate_volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion",
      "action-name": "os-migrate_volume"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-migrate_volume_completion` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-migrate_volume_completion	body	object
  os-migrate_volume_completion.new_volume	body	string
  os-migrate_volume_completion.error	body	[‘string’, ‘null’, ‘boolean’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-migrate_volume_completion": {
        "type": "object",
        "properties": {
          "new_volume": {
            "type": "string",
            "format": "uuid"
          },
          "error": {
            "type": [
              "string",
              "null",
              "boolean"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "new_volume"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-migrate_volume_completion"
    },
    "required": [
      "os-migrate_volume_completion"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-attach` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-attach	body	object
  os-attach.instance_uuid	body	string
  os-attach.mountpoint	body	string
  os-attach.host_name	body	string
  os-attach.mode	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-attach": {
        "type": "object",
        "properties": {
          "instance_uuid": {
            "type": "string",
            "format": "uuid"
          },
          "mountpoint": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "host_name": {
            "type": "string",
            "maxLength": 255
          },
          "mode": {
            "type": "string",
            "enum": [
              "rw",
              "ro"
            ]
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "instance_uuid"
            ]
          },
          {
            "required": [
              "host_name"
            ]
          }
        ],
        "required": [
          "mountpoint"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-attach"
    },
    "required": [
      "os-attach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-detach` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-detach	body	[‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-detach": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "attachment_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-detach"
    },
    "required": [
      "os-detach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-reserve` action

Empty body for os-reserve action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reserve	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reserve action",
    "properties": {
      "os-reserve": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reserve"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-unreserve` action

Empty body for os-unreserve action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unreserve	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unreserve action",
    "properties": {
      "os-unreserve": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unreserve"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-begin_detaching` action

Empty body for os-begin_detaching action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-begin_detaching	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-begin_detaching action",
    "properties": {
      "os-begin_detaching": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-begin_detaching"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-roll_detaching` action

Empty body for os-roll_detaching action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-roll_detaching	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-roll_detaching action",
    "properties": {
      "os-roll_detaching": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-roll_detaching"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-initialize_connection` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-initialize_connection	body	object
  os-initialize_connection.connector	body	[‘object’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-initialize_connection": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "object",
              "string"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-initialize_connection"
    },
    "required": [
      "os-initialize_connection"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-terminate_connection` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-terminate_connection	body	object
  os-terminate_connection.connector	body	[‘string’, ‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-terminate_connection": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "string",
              "object",
              "null"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-terminate_connection"
    },
    "required": [
      "os-terminate_connection"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-volume_upload_image` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-volume_upload_image	body	object
  os-volume_upload_image.image_name	body	string
  os-volume_upload_image.force	body	[‘boolean’, ‘string’]
  os-volume_upload_image.disk_format	body	string
  os-volume_upload_image.container_format	body	[‘string’, ‘null’]
  os-volume_upload_image.visibility	body	string
  os-volume_upload_image.protected	body	[‘boolean’, ‘string’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "os-volume_upload_image": {
            "type": "object",
            "properties": {
              "image_name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "disk_format": {
                "type": "string",
                "enum": [
                  "raw",
                  "vmdk",
                  "vdi",
                  "qcow2",
                  "vhd",
                  "vhdx",
                  "ploop"
                ]
              },
              "container_format": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              }
            },
            "additionalProperties": false,
            "required": [
              "image_name"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.0",
          "action-name": "os-volume_upload_image"
        },
        "required": [
          "os-volume_upload_image"
        ]
      },
      {
        "type": "object",
        "properties": {
          "os-volume_upload_image": {
            "type": "object",
            "properties": {
              "image_name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "disk_format": {
                "type": "string",
                "enum": [
                  "raw",
                  "vmdk",
                  "vdi",
                  "qcow2",
                  "vhd",
                  "vhdx",
                  "ploop"
                ]
              },
              "container_format": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "visibility": {
                "type": "string",
                "enum": [
                  "community",
                  "public",
                  "private",
                  "shared"
                ]
              },
              "protected": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "image_name"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.1",
          "action-name": "os-volume_upload_image"
        },
        "required": [
          "os-volume_upload_image"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion",
      "action-name": "os-volume_upload_image"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-extend` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-extend	body	object
  os-extend.new_size	body	[‘integer’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-extend": {
        "type": "object",
        "properties": {
          "new_size": {
            "type": [
              "integer",
              "string"
            ],
            "pattern": "^[0-9]+$",
            "minimum": 1,
            "maximum": 2147483647
          }
        },
        "additionalProperties": false,
        "required": [
          "new_size"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-extend"
    },
    "required": [
      "os-extend"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-update_readonly_flag` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-update_readonly_flag	body	object
  os-update_readonly_flag.readonly	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-update_readonly_flag": {
        "type": "object",
        "properties": {
          "readonly": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "readonly"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-update_readonly_flag"
    },
    "required": [
      "os-update_readonly_flag"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-retype` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-retype	body	object
  os-retype.new_type	body	string
  os-retype.migration_policy	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-retype": {
        "type": "object",
        "properties": {
          "new_type": {
            "type": "string"
          },
          "migration_policy": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "on-demand",
              "never"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "new_type"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-retype"
    },
    "required": [
      "os-retype"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-set_bootable` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-set_bootable	body	object
  os-set_bootable.bootable	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-set_bootable": {
        "type": "object",
        "properties": {
          "bootable": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "bootable"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-set_bootable"
    },
    "required": [
      "os-set_bootable"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-reimage` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reimage	body	object
  os-reimage.image_id	body	string
  os-reimage.reimage_reserved	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-reimage": {
        "type": "object",
        "properties": {
          "image_id": {
            "type": "string",
            "format": "uuid"
          },
          "reimage_reserved": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "image_id"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.68",
      "action-name": "os-reimage"
    },
    "required": [
      "os-reimage"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-set_image_metadata` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-set_image_metadata	body	object
  os-set_image_metadata.metadata	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "os-set_image_metadata": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "metadata"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-set_image_metadata"
    },
    "required": [
      "os-set_image_metadata"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-show_image_metadata` action

Empty body for os-show_image_metadata action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-show_image_metadata	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-show_image_metadata action",
    "properties": {
      "os-show_image_metadata": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-show_image_metadata"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-unset_image_metadata` action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unset_image_metadata	body	object
  os-unset_image_metadata.key	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-unset_image_metadata": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "key"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-unset_image_metadata"
    },
    "required": [
      "os-unset_image_metadata"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/{project_id}/volumes/{id}/action

`os-unmanage` action

Empty body for os-unmanage action

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id}/action API
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unmanage	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unmanage action",
    "properties": {
      "os-unmanage": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unmanage"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

GET

/v3/{project_id}/volumes/{id}

Return data about the given volume.

Responses

200

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

PUT

/v3/{project_id}/volumes/{id}

Update a volume.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{id} API
  id	path	string	id parameter for /v3/volumes/{id} API
  volume	body	object
  volume.name	body	[‘string’, ‘null’]
  volume.description	body	[‘string’, ‘null’]
  volume.display_name	body	[‘string’, ‘null’]
  volume.display_description	body	[‘string’, ‘null’]
  volume.metadata	body	object

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "metadata": {
                "type": "object",
                "additionalProperties": false,
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.52"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "metadata": {
                "type": "object",
                "additionalProperties": false,
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            },
            "additionalProperties": false,
            "anyOf": [
              {
                "required": [
                  "name"
                ]
              },
              {
                "required": [
                  "description"
                ]
              },
              {
                "required": [
                  "display_name"
                ]
              },
              {
                "required": [
                  "display_description"
                ]
              },
              {
                "required": [
                  "metadata"
                ]
              }
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.53"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

DELETE

/v3/{project_id}/volumes/{id}

Delete a volume.

Responses

204

Ok

404

Error

GET

/v3/volumes/detail

Returns a detailed list of volumes.

Responses

200

Ok

404

Error

GET

/v3/volumes/summary

Return summary of volumes.

Responses

200

Ok

404

Error

GET

/v3/volumes

Returns a summary list of volumes.

Responses

200

Ok

404

Error

POST

/v3/volumes

Creates a new volume.

param req:	the request
param body:	the request body
returns:	dict – the new volume dictionary
raises HTTPNotFound, HTTPBadRequest:

Request

• Description

  Name	Location	Type	Description
  volume	body	object	A volume object.
  volume.name	body	[‘string’, ‘null’]	The volume name.
  volume.description	body	[‘string’, ‘null’]	The volume description.
  volume.display_name	body	[‘string’, ‘null’]
  volume.display_description	body	[‘string’, ‘null’]
  volume.volume_type	body	[‘string’, ‘null’]	The volume type (either name or ID). To create an environment with multiple-storage back ends, you must specify a volume type. Block Storage volume back ends are spawned as children to cinder- volume, and they are keyed from a unique queue. They are named cinder- volume.HOST.BACKEND. For example, cinder- volume.ubuntu.lvmdriver. When a volume is created, the scheduler chooses an appropriate back end to handle the request based on the volume type. Default is None. For information about how to use volume types to create multiple- storage back ends, see Configure multiple-storage back ends.
  volume.metadata	body	[‘object’, ‘null’]	One or more metadata key and value pairs to be associated with the new volume.
  volume.size	body	[‘integer’, ‘string’, ‘null’]	The size of the volume, in gibibytes (GiB).
  volume.availability_zone	body	[‘string’, ‘null’]	The name of the availability zone.
  volume.image_id	body	[‘string’, ‘null’]
  volume.imageRef	body	[‘string’, ‘null’]	The UUID of the image from which you want to create the volume. Required to create a bootable volume.
  OS-SCH-HNT:scheduler_hints	body	[‘object’, ‘null’]	The dictionary of data to send to the scheduler.
  volume.group_id	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.12"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.13",
          "max-ver": "3.46"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "backup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the backup.\n\n\n**New in version 3.47**"
              }
            },
            "additionalProperties": true
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.47",
          "max-ver": "3.52"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "description": "A `volume` object.",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces",
                "description": "The volume name."
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces",
                "description": "The volume description."
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The volume type (either name or ID). To create an environment with\nmultiple-storage back ends, you must specify a volume type. Block\nStorage volume back ends are spawned as children to `cinder-\nvolume`, and they are keyed from a unique queue. They are named\n`cinder- volume.HOST.BACKEND`. For example, `cinder-\nvolume.ubuntu.lvmdriver`. When a volume is created, the scheduler\nchooses an appropriate back end to handle the request based on the\nvolume type. Default is `None`. For information about how to\nuse volume types to create multiple- storage back ends, see\n[Configure multiple-storage back ends](https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html)."
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false,
                "description": "One or more metadata key and value pairs to be associated\nwith the new volume."
              },
              "snapshot_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "source_volid": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "consistencygroup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the consistency group."
              },
              "size": {
                "type": [
                  "integer",
                  "string",
                  "null"
                ],
                "pattern": "^[0-9]+$",
                "minimum": 1,
                "maximum": 2147483647,
                "description": "The size of the volume, in gibibytes (GiB)."
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "description": "The name of the availability zone."
              },
              "multiattach": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": [
                      "boolean",
                      "string"
                    ],
                    "enum": [
                      true,
                      "True",
                      "TRUE",
                      "true",
                      "1",
                      "ON",
                      "On",
                      "on",
                      "YES",
                      "Yes",
                      "yes",
                      "y",
                      "t",
                      false,
                      "False",
                      "FALSE",
                      "false",
                      "0",
                      "OFF",
                      "Off",
                      "off",
                      "NO",
                      "No",
                      "no",
                      "n",
                      "f"
                    ]
                  }
                ]
              },
              "image_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "imageRef": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "description": "The UUID of the image from which you want to\ncreate the volume. Required to create a bootable volume."
              },
              "group_id": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "backup_id": {
                "oneOf": [
                  {
                    "type": "null"
                  },
                  {
                    "type": "string",
                    "format": "uuid"
                  }
                ],
                "description": "The UUID of the backup.\n\n\n**New in version 3.47**"
              }
            },
            "additionalProperties": false
          },
          "OS-SCH-HNT:scheduler_hints": {
            "type": [
              "object",
              "null"
            ],
            "description": "The dictionary of data to send to the scheduler."
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.53"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

POST

/v3/volumes/{id}/action

`revert` action

Empty body for revert action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  revert	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for revert action",
    "properties": {
      "revert": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "revert"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-reset_status` action

Empty body for os-reset_status action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reset_status	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reset_status action",
    "properties": {
      "os-reset_status": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reset_status"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-force_delete` action

Empty body for os-force_delete action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-force_delete	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-force_delete action",
    "properties": {
      "os-force_delete": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-force_delete"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-force_detach` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-force_detach	body	object
  os-force_detach.connector	body	[‘string’, ‘object’, ‘null’]
  os-force_detach.attachment_id	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-force_detach": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "string",
              "object",
              "null"
            ]
          },
          "attachment_id": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-force_detach"
    },
    "required": [
      "os-force_detach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-migrate_volume` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-migrate_volume	body	object
  os-migrate_volume.host	body	string
  os-migrate_volume.force_host_copy	body	[‘boolean’, ‘string’]
  os-migrate_volume.lock_volume	body	[‘boolean’, ‘string’]
  os-migrate_volume.cluster	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "os-migrate_volume": {
            "type": "object",
            "properties": {
              "host": {
                "type": "string",
                "maxLength": 255
              },
              "force_host_copy": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "lock_volume": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "host"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.15",
          "action-name": "os-migrate_volume"
        },
        "required": [
          "os-migrate_volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "os-migrate_volume": {
            "type": "object",
            "properties": {
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "maxLength": 255
              },
              "force_host_copy": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "lock_volume": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "cluster": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.16",
          "action-name": "os-migrate_volume"
        },
        "required": [
          "os-migrate_volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion",
      "action-name": "os-migrate_volume"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-migrate_volume_completion` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-migrate_volume_completion	body	object
  os-migrate_volume_completion.new_volume	body	string
  os-migrate_volume_completion.error	body	[‘string’, ‘null’, ‘boolean’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-migrate_volume_completion": {
        "type": "object",
        "properties": {
          "new_volume": {
            "type": "string",
            "format": "uuid"
          },
          "error": {
            "type": [
              "string",
              "null",
              "boolean"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "new_volume"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-migrate_volume_completion"
    },
    "required": [
      "os-migrate_volume_completion"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-attach` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-attach	body	object
  os-attach.instance_uuid	body	string
  os-attach.mountpoint	body	string
  os-attach.host_name	body	string
  os-attach.mode	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-attach": {
        "type": "object",
        "properties": {
          "instance_uuid": {
            "type": "string",
            "format": "uuid"
          },
          "mountpoint": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          },
          "host_name": {
            "type": "string",
            "maxLength": 255
          },
          "mode": {
            "type": "string",
            "enum": [
              "rw",
              "ro"
            ]
          }
        },
        "additionalProperties": false,
        "anyOf": [
          {
            "required": [
              "instance_uuid"
            ]
          },
          {
            "required": [
              "host_name"
            ]
          }
        ],
        "required": [
          "mountpoint"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-attach"
    },
    "required": [
      "os-attach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-detach` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-detach	body	[‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-detach": {
        "type": [
          "object",
          "null"
        ],
        "properties": {
          "attachment_id": {
            "oneOf": [
              {
                "type": "string",
                "format": "uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-detach"
    },
    "required": [
      "os-detach"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-reserve` action

Empty body for os-reserve action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reserve	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-reserve action",
    "properties": {
      "os-reserve": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-reserve"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-unreserve` action

Empty body for os-unreserve action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unreserve	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unreserve action",
    "properties": {
      "os-unreserve": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unreserve"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-begin_detaching` action

Empty body for os-begin_detaching action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-begin_detaching	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-begin_detaching action",
    "properties": {
      "os-begin_detaching": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-begin_detaching"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-roll_detaching` action

Empty body for os-roll_detaching action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-roll_detaching	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-roll_detaching action",
    "properties": {
      "os-roll_detaching": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-roll_detaching"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-initialize_connection` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-initialize_connection	body	object
  os-initialize_connection.connector	body	[‘object’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-initialize_connection": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "object",
              "string"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-initialize_connection"
    },
    "required": [
      "os-initialize_connection"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-terminate_connection` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-terminate_connection	body	object
  os-terminate_connection.connector	body	[‘string’, ‘object’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-terminate_connection": {
        "type": "object",
        "properties": {
          "connector": {
            "type": [
              "string",
              "object",
              "null"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "connector"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-terminate_connection"
    },
    "required": [
      "os-terminate_connection"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-volume_upload_image` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-volume_upload_image	body	object
  os-volume_upload_image.image_name	body	string
  os-volume_upload_image.force	body	[‘boolean’, ‘string’]
  os-volume_upload_image.disk_format	body	string
  os-volume_upload_image.container_format	body	[‘string’, ‘null’]
  os-volume_upload_image.visibility	body	string
  os-volume_upload_image.protected	body	[‘boolean’, ‘string’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "os-volume_upload_image": {
            "type": "object",
            "properties": {
              "image_name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "disk_format": {
                "type": "string",
                "enum": [
                  "raw",
                  "vmdk",
                  "vdi",
                  "qcow2",
                  "vhd",
                  "vhdx",
                  "ploop"
                ]
              },
              "container_format": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              }
            },
            "additionalProperties": false,
            "required": [
              "image_name"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.0",
          "action-name": "os-volume_upload_image"
        },
        "required": [
          "os-volume_upload_image"
        ]
      },
      {
        "type": "object",
        "properties": {
          "os-volume_upload_image": {
            "type": "object",
            "properties": {
              "image_name": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
              },
              "force": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "disk_format": {
                "type": "string",
                "enum": [
                  "raw",
                  "vmdk",
                  "vdi",
                  "qcow2",
                  "vhd",
                  "vhdx",
                  "ploop"
                ]
              },
              "container_format": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "visibility": {
                "type": "string",
                "enum": [
                  "community",
                  "public",
                  "private",
                  "shared"
                ]
              },
              "protected": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              }
            },
            "additionalProperties": false,
            "required": [
              "image_name"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.1",
          "action-name": "os-volume_upload_image"
        },
        "required": [
          "os-volume_upload_image"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion",
      "action-name": "os-volume_upload_image"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-extend` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-extend	body	object
  os-extend.new_size	body	[‘integer’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-extend": {
        "type": "object",
        "properties": {
          "new_size": {
            "type": [
              "integer",
              "string"
            ],
            "pattern": "^[0-9]+$",
            "minimum": 1,
            "maximum": 2147483647
          }
        },
        "additionalProperties": false,
        "required": [
          "new_size"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-extend"
    },
    "required": [
      "os-extend"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-update_readonly_flag` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-update_readonly_flag	body	object
  os-update_readonly_flag.readonly	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-update_readonly_flag": {
        "type": "object",
        "properties": {
          "readonly": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "readonly"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-update_readonly_flag"
    },
    "required": [
      "os-update_readonly_flag"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-retype` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-retype	body	object
  os-retype.new_type	body	string
  os-retype.migration_policy	body	[‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-retype": {
        "type": "object",
        "properties": {
          "new_type": {
            "type": "string"
          },
          "migration_policy": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "on-demand",
              "never"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "new_type"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-retype"
    },
    "required": [
      "os-retype"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-set_bootable` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-set_bootable	body	object
  os-set_bootable.bootable	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-set_bootable": {
        "type": "object",
        "properties": {
          "bootable": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "bootable"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-set_bootable"
    },
    "required": [
      "os-set_bootable"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-reimage` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-reimage	body	object
  os-reimage.image_id	body	string
  os-reimage.reimage_reserved	body	[‘boolean’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "os-reimage": {
        "type": "object",
        "properties": {
          "image_id": {
            "type": "string",
            "format": "uuid"
          },
          "reimage_reserved": {
            "type": [
              "boolean",
              "string"
            ],
            "enum": [
              true,
              "True",
              "TRUE",
              "true",
              "1",
              "ON",
              "On",
              "on",
              "YES",
              "Yes",
              "yes",
              "y",
              "t",
              false,
              "False",
              "FALSE",
              "false",
              "0",
              "OFF",
              "Off",
              "off",
              "NO",
              "No",
              "no",
              "n",
              "f"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "image_id"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.68",
      "action-name": "os-reimage"
    },
    "required": [
      "os-reimage"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-set_image_metadata` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-set_image_metadata	body	object
  os-set_image_metadata.metadata	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "os-set_image_metadata": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "additionalProperties": false,
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "metadata"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-set_image_metadata"
    },
    "required": [
      "os-set_image_metadata"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-show_image_metadata` action

Empty body for os-show_image_metadata action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-show_image_metadata	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-show_image_metadata action",
    "properties": {
      "os-show_image_metadata": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-show_image_metadata"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-unset_image_metadata` action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unset_image_metadata	body	object
  os-unset_image_metadata.key	body	string

• Schema

  {
    "type": "object",
    "properties": {
      "os-unset_image_metadata": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 255
          }
        },
        "additionalProperties": false,
        "required": [
          "key"
        ]
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "action-name": "os-unset_image_metadata"
    },
    "required": [
      "os-unset_image_metadata"
    ]
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

POST

/v3/volumes/{id}/action

`os-unmanage` action

Empty body for os-unmanage action

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id}/action API
  os-unmanage	body	null

• Schema

  {
    "type": "object",
    "description": "Empty body for os-unmanage action",
    "properties": {
      "os-unmanage": {
        "type": "null"
      }
    },
    "x-openstack": {
      "action-name": "os-unmanage"
    }
  }
  

Responses

200

Ok

201

Ok

202

Ok

404

Error

GET

/v3/volumes/{id}

Return data about the given volume.

Responses

200

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

PUT

/v3/volumes/{id}

Update a volume.

Request

• Description

  Name	Location	Type	Description
  id	path	string	id parameter for /v3/volumes/{id} API
  volume	body	object
  volume.name	body	[‘string’, ‘null’]
  volume.description	body	[‘string’, ‘null’]
  volume.display_name	body	[‘string’, ‘null’]
  volume.display_description	body	[‘string’, ‘null’]
  volume.metadata	body	object

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "metadata": {
                "type": "object",
                "additionalProperties": false,
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.52"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "display_name": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "name_non_mandatory_remove_white_spaces"
              },
              "display_description": {
                "type": [
                  "string",
                  "null"
                ],
                "format": "description_non_mandatory_remove_white_spaces"
              },
              "metadata": {
                "type": "object",
                "additionalProperties": false,
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            },
            "additionalProperties": false,
            "anyOf": [
              {
                "required": [
                  "name"
                ]
              },
              {
                "required": [
                  "description"
                ]
              },
              {
                "required": [
                  "display_name"
                ]
              },
              {
                "required": [
                  "display_description"
                ]
              },
              {
                "required": [
                  "metadata"
                ]
              }
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.53"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

200

Ok

Name	Location	Type	Description
volume	body	object	A volume object.
volume.name	body	[‘string’, ‘null’]	The volume name.
volume.description	body	[‘string’, ‘null’]	The volume description.
volume.volume_type	body	string	The associated volume type name for the volume.
volume.metadata	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the volume.
volume.snapshot_id	body	string	To create a volume from an existing snapshot, specify the UUID of the volume snapshot. The volume is created in same availability zone and with same size as the snapshot.
volume.source_volid	body	string	The UUID of the source volume. The API creates a new volume with the same size as the source volume unless a larger size is requested.
volume.consistencygroup_id	body	string	The UUID of the consistency group.
volume.size	body	integer	The size of the volume, in gibibytes (GiB).
volume.availability_zone	body	string	The name of the availability zone.
volume.multiattach	body	boolean	If true, this volume can attach to more than one instance.
volume.status	body	string	The volume status.
volume.migration_status	body	string	The volume migration status. Admin only.
volume.encrypted	body	boolean	If true, this volume is encrypted.
volume.created_at	body	string	The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
volume.updated_at	body	string	The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is -05:00. If the updated_at date and time stamp is not set, its value is null.
volume.replication_status	body	string	The volume replication status.
volume.id	body	string	The UUID of the volume.
volume.user_id	body	string	The UUID of the user.
volume.volume_type_id	body	string	The associated volume type ID for the volume. New in version 3.63 New in version 3.63
volume.group_id	body	string	The ID of the group. New in version 3.13 New in version 3.63
volume.provider_id	body	[‘string’, ‘null’]	The provider ID for the volume. The value is either a string set by the driver or null if the driver doesn’t use the field or if it hasn’t created it yet. Only returned for administrators. New in version 3.21 New in version 3.21
volume.service_uuid	body	string	A unique identifier that’s used to indicate what node the volume-service for a particular volume is being serviced by. New in version 3.48 New in version 3.48
volume.shared_targets	body	boolean	An indicator whether the host connecting the volume should lock for the whole attach/detach process or not. true means only is iSCSI initiator running on host doesn’t support manual scans, false means never use locks, and null means to always use locks. Look at os-brick’s guard_connection context manager. Default=True. New in version 3.69 New in version 3.48
volume.cluster_name	body	string	The cluster name of volume backend. New in version 3.61 New in version 3.61
volume.consumes_quota	body	boolean	Whether this resource consumes quota or not. Resources that not counted for quota usage are usually temporary internal resources created to perform an operation. New in version 3.65 New in version 3.65

404

Error

DELETE

/v3/volumes/{id}

Delete a volume.

Responses

204

Ok

404

Error

GET

/v3/{project_id}/volumes/{volume_id}/metadata

Show a volume’s metadata

Shows metadata for a volume.

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

POST

/v3/{project_id}/volumes/{volume_id}/metadata

Create metadata for volume

Creates or replaces metadata for a volume. Does not modify items that are not in the request.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{volume_id}/metadata API
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs that are associated with the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "metadata": {
        "type": "object",
        "description": "One or more metadata key and value pairs that are\nassociated with the volume.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

PUT

/v3/{project_id}/volumes/{volume_id}/metadata

Update a volume’s metadata

Replaces all the volume’s metadata with the key-value pairs in the request.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{volume_id}/metadata API
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs that are associated with the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "metadata": {
        "type": "object",
        "description": "One or more metadata key and value pairs that are\nassociated with the volume.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

GET

/v3/{project_id}/volumes/{volume_id}/metadata/{id}

Return a single metadata item.

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

PUT

/v3/{project_id}/volumes/{volume_id}/metadata/{id}

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/volumes/{volume_id}/metadata API
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  id	path	string	id parameter for /v3/volumes/{volume_id}/metadata/{id} API
  meta	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "meta": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "minProperties": 1,
        "maxProperties": 1
      }
    },
    "additionalProperties": false,
    "required": [
      "meta"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

DELETE

/v3/{project_id}/volumes/{volume_id}/metadata/{id}

Deletes an existing metadata.

Responses

204

Ok

404

Error

GET

/v3/volumes/{volume_id}/metadata

Returns the list of metadata for a given volume.

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

POST

/v3/volumes/{volume_id}/metadata

Request

• Description

  Name	Location	Type	Description
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs that are associated with the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "metadata": {
        "type": "object",
        "description": "One or more metadata key and value pairs that are\nassociated with the volume.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

201

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

PUT

/v3/volumes/{volume_id}/metadata

Request

• Description

  Name	Location	Type	Description
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  metadata	body	object	One or more metadata key and value pairs that are associated with the volume.

• Schema

  {
    "type": "object",
    "properties": {
      "metadata": {
        "type": "object",
        "description": "One or more metadata key and value pairs that are\nassociated with the volume.",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        }
      }
    },
    "additionalProperties": false,
    "required": [
      "metadata"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
metadata	body	object	One or more metadata key and value pairs for the snapshot, if any.

404

Error

GET

/v3/volumes/{volume_id}/metadata/{id}

Return a single metadata item.

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

PUT

/v3/volumes/{volume_id}/metadata/{id}

Request

• Description

  Name	Location	Type	Description
  volume_id	path	string	volume_id parameter for /v3/volumes/{volume_id}/metadata API
  id	path	string	id parameter for /v3/volumes/{volume_id}/metadata/{id} API
  meta	body	object

• Schema

  {
    "type": "object",
    "properties": {
      "meta": {
        "type": "object",
        "additionalProperties": false,
        "patternProperties": {
          "^[a-zA-Z0-9-_:. /]{1,255}$": {
            "type": "string",
            "maxLength": 255
          }
        },
        "minProperties": 1,
        "maxProperties": 1
      }
    },
    "additionalProperties": false,
    "required": [
      "meta"
    ]
  }
  

Responses

200

Ok

Name	Location	Type	Description
meta	body	object	A metadata object. Contains one or more metadata key and value pairs that are associated with the resource.

404

Error

DELETE

/v3/volumes/{volume_id}/metadata/{id}

Deletes an existing metadata.

Responses

204

Ok

404

Error

GET

/v3/{project_id}/volumes/{volume_id}/encryption

Returns the encryption metadata for a given volume.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/volumes/{volume_id}/encryption/{id}

Return a single encryption item.

Responses

200

Ok

404

Error

GET

/v3/volumes/{volume_id}/encryption

Returns the encryption metadata for a given volume.

Responses

200

Ok

404

Error

GET

/v3/volumes/{volume_id}/encryption/{id}

Return a single encryption item.

Responses

200

Ok

404

Error

version

GET

/v3

Show API v3 details

Shows details for Block Storage API v3.

Responses

200

Ok

404

Error

workers

POST

/v3/{project_id}/workers/cleanup

Do the cleanup on resources from a specific service/host/node.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/workers/cleanup API
  cluster_name	body	[‘string’, ‘null’]
  disabled	body	[‘boolean’, ‘string’]
  host	body	[‘string’, ‘null’]
  is_up	body	[‘boolean’, ‘string’]
  resource_type	body	[‘string’, ‘null’]
  service_id	body	[‘integer’, ‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "cluster_name": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[a-zA-Z0-9-._#@:/+]*$"
      },
      "disabled": {
        "type": [
          "boolean",
          "string"
        ],
        "enum": [
          true,
          "True",
          "TRUE",
          "true",
          "1",
          "ON",
          "On",
          "on",
          "YES",
          "Yes",
          "yes",
          "y",
          "t",
          false,
          "False",
          "FALSE",
          "false",
          "0",
          "OFF",
          "Off",
          "off",
          "NO",
          "No",
          "no",
          "n",
          "f"
        ]
      },
      "host": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[a-zA-Z0-9-._#@:/+]*$"
      },
      "is_up": {
        "type": [
          "boolean",
          "string"
        ],
        "enum": [
          true,
          "True",
          "TRUE",
          "true",
          "1",
          "ON",
          "On",
          "on",
          "YES",
          "Yes",
          "yes",
          "y",
          "t",
          false,
          "False",
          "FALSE",
          "false",
          "0",
          "OFF",
          "Off",
          "off",
          "NO",
          "No",
          "no",
          "n",
          "f"
        ]
      },
      "binary": {
        "enum": [
          "cinder-volume",
          "cinder-scheduler"
        ]
      },
      "resource_id": {
        "oneOf": [
          {
            "type": "null"
          },
          {
            "type": "string",
            "format": "uuid"
          }
        ]
      },
      "resource_type": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 40
      },
      "service_id": {
        "type": [
          "integer",
          "string",
          "null"
        ],
        "pattern": "^[0-9]*$",
        "maxLength": 11
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.24"
    }
  }
  

Responses

202

Ok

404

Error

POST

/v3/workers/cleanup

Do the cleanup on resources from a specific service/host/node.

Request

• Description

  Name	Location	Type	Description
  cluster_name	body	[‘string’, ‘null’]
  disabled	body	[‘boolean’, ‘string’]
  host	body	[‘string’, ‘null’]
  is_up	body	[‘boolean’, ‘string’]
  resource_type	body	[‘string’, ‘null’]
  service_id	body	[‘integer’, ‘string’, ‘null’]

• Schema

  {
    "type": "object",
    "properties": {
      "cluster_name": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[a-zA-Z0-9-._#@:/+]*$"
      },
      "disabled": {
        "type": [
          "boolean",
          "string"
        ],
        "enum": [
          true,
          "True",
          "TRUE",
          "true",
          "1",
          "ON",
          "On",
          "on",
          "YES",
          "Yes",
          "yes",
          "y",
          "t",
          false,
          "False",
          "FALSE",
          "false",
          "0",
          "OFF",
          "Off",
          "off",
          "NO",
          "No",
          "no",
          "n",
          "f"
        ]
      },
      "host": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[a-zA-Z0-9-._#@:/+]*$"
      },
      "is_up": {
        "type": [
          "boolean",
          "string"
        ],
        "enum": [
          true,
          "True",
          "TRUE",
          "true",
          "1",
          "ON",
          "On",
          "on",
          "YES",
          "Yes",
          "yes",
          "y",
          "t",
          false,
          "False",
          "FALSE",
          "false",
          "0",
          "OFF",
          "Off",
          "off",
          "NO",
          "No",
          "no",
          "n",
          "f"
        ]
      },
      "binary": {
        "enum": [
          "cinder-volume",
          "cinder-scheduler"
        ]
      },
      "resource_id": {
        "oneOf": [
          {
            "type": "null"
          },
          {
            "type": "string",
            "format": "uuid"
          }
        ]
      },
      "resource_type": {
        "type": [
          "string",
          "null"
        ],
        "minLength": 0,
        "maxLength": 40
      },
      "service_id": {
        "type": [
          "integer",
          "string",
          "null"
        ],
        "pattern": "^[0-9]*$",
        "maxLength": 11
      }
    },
    "additionalProperties": false,
    "x-openstack": {
      "min-ver": "3.24"
    }
  }
  

Responses

202

Ok

404

Error

extensions

GET

/v3/{project_id}/extensions

List Known API extensions

Lists Block Storage API extensions.

Responses

200

Ok

404

Error

GET

/v3/extensions

Responses

200

Ok

404

Error

os-availability-zone

GET

/v3/{project_id}/os-availability-zone

Describe all known availability zones.

Responses

200

Ok

404

Error

GET

/v3/os-availability-zone

Describe all known availability zones.

Responses

200

Ok

404

Error

os-snapshot-manage

GET

/v3/{project_id}/os-snapshot-manage/detail

Returns a detailed list of snapshots available to manage.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/os-snapshot-manage

Returns a summary list of snapshots available to manage.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/os-snapshot-manage

Instruct Cinder to manage a storage snapshot object.

Manages an existing backend storage snapshot object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage snapshot object (driver dependent).

From an API perspective, this operation behaves very much like a snapshot creation operation.

Required HTTP Body:

{
  "snapshot":
  {
    "volume_id": "<Cinder volume already exists in volume backend>",
    "ref":
       "<Driver-specific reference to the existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_snapshot method to find out the accepted format of ‘ref’. For example,in LVM driver, it will be the logic volume name of snapshot which you want to manage.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘volume_id’ element refers to a cinder volume that could not be found.

The snapshot will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘snapshot’ are:

name           A name for the new snapshot.
description    A description for the new snapshot.
metadata       Key/value pairs to be associated with the new snapshot.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-snapshot-manage/{id} API
  snapshot	body	object
  snapshot.description	body	[‘string’, ‘null’]
  snapshot.metadata	body	[‘object’, ‘null’]
  snapshot.name	body	[‘string’, ‘null’]
  snapshot.volume_id	body	string
  snapshot.ref	body	[‘object’, ‘null’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "volume_id": {
            "type": "string",
            "format": "uuid"
          },
          "ref": {
            "type": [
              "object",
              "null",
              "string"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "ref",
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

404

Error

GET

/v3/os-snapshot-manage/detail

Returns a detailed list of snapshots available to manage.

Responses

200

Ok

404

Error

GET

/v3/os-snapshot-manage

Returns a summary list of snapshots available to manage.

Responses

200

Ok

404

Error

POST

/v3/os-snapshot-manage

Instruct Cinder to manage a storage snapshot object.

Manages an existing backend storage snapshot object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage snapshot object (driver dependent).

From an API perspective, this operation behaves very much like a snapshot creation operation.

Required HTTP Body:

{
  "snapshot":
  {
    "volume_id": "<Cinder volume already exists in volume backend>",
    "ref":
       "<Driver-specific reference to the existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_snapshot method to find out the accepted format of ‘ref’. For example,in LVM driver, it will be the logic volume name of snapshot which you want to manage.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘volume_id’ element refers to a cinder volume that could not be found.

The snapshot will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘snapshot’ are:

name           A name for the new snapshot.
description    A description for the new snapshot.
metadata       Key/value pairs to be associated with the new snapshot.

Request

• Description

  Name	Location	Type	Description
  snapshot	body	object
  snapshot.description	body	[‘string’, ‘null’]
  snapshot.metadata	body	[‘object’, ‘null’]
  snapshot.name	body	[‘string’, ‘null’]
  snapshot.volume_id	body	string
  snapshot.ref	body	[‘object’, ‘null’, ‘string’]

• Schema

  {
    "type": "object",
    "properties": {
      "snapshot": {
        "type": "object",
        "properties": {
          "description": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255,
            "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
          },
          "metadata": {
            "type": [
              "object",
              "null"
            ],
            "patternProperties": {
              "^[a-zA-Z0-9-_:. /]{1,255}$": {
                "type": "string",
                "maxLength": 255
              }
            },
            "additionalProperties": false
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 0,
            "maxLength": 255
          },
          "volume_id": {
            "type": "string",
            "format": "uuid"
          },
          "ref": {
            "type": [
              "object",
              "null",
              "string"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "ref",
          "volume_id"
        ]
      }
    },
    "additionalProperties": false,
    "required": [
      "snapshot"
    ]
  }
  

Responses

202

Ok

404

Error

os-volume-manage

GET

/v3/{project_id}/os-volume-manage/detail

Returns a detailed list of volumes available to manage.

Responses

200

Ok

404

Error

GET

/v3/{project_id}/os-volume-manage

Returns a summary list of volumes available to manage.

Responses

200

Ok

404

Error

POST

/v3/{project_id}/os-volume-manage

Instruct Cinder to manage a storage object.

Manages an existing backend storage object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage object (driver dependent)

From an API perspective, this operation behaves very much like a volume creation operation, except that properties such as image, snapshot and volume references don’t make sense, because we are taking an existing storage object into Cinder management.

Required HTTP Body:

{
  "volume": {
    "host": "<Cinder host on which the existing storage resides>",
    "cluster": "<Cinder cluster on which the storage resides>",
    "ref": "<Driver-specific reference to existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_volume method to find out the accepted format of ‘ref’.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘host’ element refers to a cinder host that is not registered.

The volume will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘volume’ are:

name               A name for the new volume.
description        A description for the new volume.
volume_type        ID or name of a volume type to associate with
                   the new Cinder volume. Does not necessarily
                   guarantee that the managed volume will have the
                   properties described in the volume_type. The
                   driver may choose to fail if it identifies that
                   the specified volume_type is not compatible with
                   the backend storage object.
metadata           Key/value pairs to be associated with the new
                   volume.
availability_zone  The availability zone to associate with the new
                   volume.
bootable           If set to True, marks the volume as bootable.

Request

• Description

  Name	Location	Type	Description
  project_id	path	string	project_id parameter for /v3/{project_id}/os-volume-manage/{id} API
  volume	body	object
  volume.description	body	[‘string’, ‘null’]
  volume.availability_zone	body	[‘string’, ‘null’]
  volume.bootable	body	[‘boolean’, ‘string’]
  volume.volume_type	body	[‘string’, ‘null’]
  volume.name	body	[‘string’, ‘null’]
  volume.host	body	[‘string’, ‘null’]
  volume.ref	body	[‘object’, ‘string’]
  volume.metadata	body	[‘object’, ‘null’]
  volume.cluster	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "bootable": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$"
              },
              "ref": {
                "type": [
                  "object",
                  "string"
                ]
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false,
            "required": [
              "ref"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.15"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "bootable": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$"
              },
              "ref": {
                "type": [
                  "object",
                  "string"
                ]
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              },
              "cluster": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "required": [
              "ref"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.16"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

404

Error

GET

/v3/os-volume-manage/detail

Returns a detailed list of volumes available to manage.

Responses

200

Ok

404

Error

GET

/v3/os-volume-manage

Returns a summary list of volumes available to manage.

Responses

200

Ok

404

Error

POST

/v3/os-volume-manage

Instruct Cinder to manage a storage object.

Manages an existing backend storage object (e.g. a Linux logical volume or a SAN disk) by creating the Cinder objects required to manage it, and possibly renaming the backend storage object (driver dependent)

From an API perspective, this operation behaves very much like a volume creation operation, except that properties such as image, snapshot and volume references don’t make sense, because we are taking an existing storage object into Cinder management.

Required HTTP Body:

{
  "volume": {
    "host": "<Cinder host on which the existing storage resides>",
    "cluster": "<Cinder cluster on which the storage resides>",
    "ref": "<Driver-specific reference to existing storage object>"
  }
}

See the appropriate Cinder drivers’ implementations of the manage_volume method to find out the accepted format of ‘ref’.

This API call will return with an error if any of the above elements are missing from the request, or if the ‘host’ element refers to a cinder host that is not registered.

The volume will later enter the error state if it is discovered that ‘ref’ is bad.

Optional elements to ‘volume’ are:

name               A name for the new volume.
description        A description for the new volume.
volume_type        ID or name of a volume type to associate with
                   the new Cinder volume. Does not necessarily
                   guarantee that the managed volume will have the
                   properties described in the volume_type. The
                   driver may choose to fail if it identifies that
                   the specified volume_type is not compatible with
                   the backend storage object.
metadata           Key/value pairs to be associated with the new
                   volume.
availability_zone  The availability zone to associate with the new
                   volume.
bootable           If set to True, marks the volume as bootable.

Request

• Description

  Name	Location	Type	Description
  volume	body	object
  volume.description	body	[‘string’, ‘null’]
  volume.availability_zone	body	[‘string’, ‘null’]
  volume.bootable	body	[‘boolean’, ‘string’]
  volume.volume_type	body	[‘string’, ‘null’]
  volume.name	body	[‘string’, ‘null’]
  volume.host	body	[‘string’, ‘null’]
  volume.ref	body	[‘object’, ‘string’]
  volume.metadata	body	[‘object’, ‘null’]
  volume.cluster	body	[‘string’, ‘null’]

• Schema

  {
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "bootable": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$"
              },
              "ref": {
                "type": [
                  "object",
                  "string"
                ]
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false,
            "required": [
              "ref"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.0",
          "max-ver": "3.15"
        },
        "required": [
          "volume"
        ]
      },
      {
        "type": "object",
        "properties": {
          "volume": {
            "type": "object",
            "properties": {
              "description": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255,
                "pattern": "^[\\ -\\~\u00a0-\u00ac\u00ae-\u0377\u037a-\u037f\u0384-\u038a\u038c\u038e-\u03a1\u03a3-\u052f\u0531-\u0556\u0559-\u058a\u058d-\u058f\u0591-\u05c7\u05d0-\u05ea\u05ef-\u05f4\u0606-\u061b\u061d-\u06dc\u06de-\u070d\u0710-\u074a\u074d-\u07b1\u07c0-\u07fa\u07fd-\u082d\u0830-\u083e\u0840-\u085b\u085e\u0860-\u086a\u0870-\u088e\u0898-\u08e1\u08e3-\u0983\u0985-\u098c\u098f-\u0990\u0993-\u09a8\u09aa-\u09b0\u09b2\u09b6-\u09b9\u09bc-\u09c4\u09c7-\u09c8\u09cb-\u09ce\u09d7\u09dc-\u09dd\u09df-\u09e3\u09e6-\u09fe\u0a01-\u0a03\u0a05-\u0a0a\u0a0f-\u0a10\u0a13-\u0a28\u0a2a-\u0a30\u0a32-\u0a33\u0a35-\u0a36\u0a38-\u0a39\u0a3c\u0a3e-\u0a42\u0a47-\u0a48\u0a4b-\u0a4d\u0a51\u0a59-\u0a5c\u0a5e\u0a66-\u0a76\u0a81-\u0a83\u0a85-\u0a8d\u0a8f-\u0a91\u0a93-\u0aa8\u0aaa-\u0ab0\u0ab2-\u0ab3\u0ab5-\u0ab9\u0abc-\u0ac5\u0ac7-\u0ac9\u0acb-\u0acd\u0ad0\u0ae0-\u0ae3\u0ae6-\u0af1\u0af9-\u0aff\u0b01-\u0b03\u0b05-\u0b0c\u0b0f-\u0b10\u0b13-\u0b28\u0b2a-\u0b30\u0b32-\u0b33\u0b35-\u0b39\u0b3c-\u0b44\u0b47-\u0b48\u0b4b-\u0b4d\u0b55-\u0b57\u0b5c-\u0b5d\u0b5f-\u0b63\u0b66-\u0b77\u0b82-\u0b83\u0b85-\u0b8a\u0b8e-\u0b90\u0b92-\u0b95\u0b99-\u0b9a\u0b9c\u0b9e-\u0b9f\u0ba3-\u0ba4\u0ba8-\u0baa\u0bae-\u0bb9\u0bbe-\u0bc2\u0bc6-\u0bc8\u0bca-\u0bcd\u0bd0\u0bd7\u0be6-\u0bfa\u0c00-\u0c0c\u0c0e-\u0c10\u0c12-\u0c28\u0c2a-\u0c39\u0c3c-\u0c44\u0c46-\u0c48\u0c4a-\u0c4d\u0c55-\u0c56\u0c58-\u0c5a\u0c5d\u0c60-\u0c63\u0c66-\u0c6f\u0c77-\u0c8c\u0c8e-\u0c90\u0c92-\u0ca8\u0caa-\u0cb3\u0cb5-\u0cb9\u0cbc-\u0cc4\u0cc6-\u0cc8\u0cca-\u0ccd\u0cd5-\u0cd6\u0cdd-\u0cde\u0ce0-\u0ce3\u0ce6-\u0cef\u0cf1-\u0cf2\u0d00-\u0d0c\u0d0e-\u0d10\u0d12-\u0d44\u0d46-\u0d48\u0d4a-\u0d4f\u0d54-\u0d63\u0d66-\u0d7f\u0d81-\u0d83\u0d85-\u0d96\u0d9a-\u0db1\u0db3-\u0dbb\u0dbd\u0dc0-\u0dc6\u0dca\u0dcf-\u0dd4\u0dd6\u0dd8-\u0ddf\u0de6-\u0def\u0df2-\u0df4\u0e01-\u0e3a\u0e3f-\u0e5b\u0e81-\u0e82\u0e84\u0e86-\u0e8a\u0e8c-\u0ea3\u0ea5\u0ea7-\u0ebd\u0ec0-\u0ec4\u0ec6\u0ec8-\u0ecd\u0ed0-\u0ed9\u0edc-\u0edf\u0f00-\u0f47\u0f49-\u0f6c\u0f71-\u0f97\u0f99-\u0fbc\u0fbe-\u0fcc\u0fce-\u0fda\u1000-\u10c5\u10c7\u10cd\u10d0-\u1248\u124a-\u124d\u1250-\u1256\u1258\u125a-\u125d\u1260-\u1288\u128a-\u128d\u1290-\u12b0\u12b2-\u12b5\u12b8-\u12be\u12c0\u12c2-\u12c5\u12c8-\u12d6\u12d8-\u1310\u1312-\u1315\u1318-\u135a\u135d-\u137c\u1380-\u1399\u13a0-\u13f5\u13f8-\u13fd\u1400-\u169c\u16a0-\u16f8\u1700-\u1715\u171f-\u1736\u1740-\u1753\u1760-\u176c\u176e-\u1770\u1772-\u1773\u1780-\u17dd\u17e0-\u17e9\u17f0-\u17f9\u1800-\u180d\u180f-\u1819\u1820-\u1878\u1880-\u18aa\u18b0-\u18f5\u1900-\u191e\u1920-\u192b\u1930-\u193b\u1940\u1944-\u196d\u1970-\u1974\u1980-\u19ab\u19b0-\u19c9\u19d0-\u19da\u19de-\u1a1b\u1a1e-\u1a5e\u1a60-\u1a7c\u1a7f-\u1a89\u1a90-\u1a99\u1aa0-\u1aad\u1ab0-\u1ace\u1b00-\u1b4c\u1b50-\u1b7e\u1b80-\u1bf3\u1bfc-\u1c37\u1c3b-\u1c49\u1c4d-\u1c88\u1c90-\u1cba\u1cbd-\u1cc7\u1cd0-\u1cfa\u1d00-\u1f15\u1f18-\u1f1d\u1f20-\u1f45\u1f48-\u1f4d\u1f50-\u1f57\u1f59\u1f5b\u1f5d\u1f5f-\u1f7d\u1f80-\u1fb4\u1fb6-\u1fc4\u1fc6-\u1fd3\u1fd6-\u1fdb\u1fdd-\u1fef\u1ff2-\u1ff4\u1ff6-\u1ffe\u2000-\u200a\u2010-\u2027\u202f-\u205f\u2070-\u2071\u2074-\u208e\u2090-\u209c\u20a0-\u20c0\u20d0-\u20f0\u2100-\u218b\u2190-\u2426\u2440-\u244a\u2460-\u2b73\u2b76-\u2b95\u2b97-\u2cf3\u2cf9-\u2d25\u2d27\u2d2d\u2d30-\u2d67\u2d6f-\u2d70\u2d7f-\u2d96\u2da0-\u2da6\u2da8-\u2dae\u2db0-\u2db6\u2db8-\u2dbe\u2dc0-\u2dc6\u2dc8-\u2dce\u2dd0-\u2dd6\u2dd8-\u2dde\u2de0-\u2e5d\u2e80-\u2e99\u2e9b-\u2ef3\u2f00-\u2fd5\u2ff0-\u2ffb\u3000-\u303f\u3041-\u3096\u3099-\u30ff\u3105-\u312f\u3131-\u318e\u3190-\u31e3\u31f0-\u321e\u3220-\ua48c\ua490-\ua4c6\ua4d0-\ua62b\ua640-\ua6f7\ua700-\ua7ca\ua7d0-\ua7d1\ua7d3\ua7d5-\ua7d9\ua7f2-\ua82c\ua830-\ua839\ua840-\ua877\ua880-\ua8c5\ua8ce-\ua8d9\ua8e0-\ua953\ua95f-\ua97c\ua980-\ua9cd\ua9cf-\ua9d9\ua9de-\ua9fe\uaa00-\uaa36\uaa40-\uaa4d\uaa50-\uaa59\uaa5c-\uaac2\uaadb-\uaaf6\uab01-\uab06\uab09-\uab0e\uab11-\uab16\uab20-\uab26\uab28-\uab2e\uab30-\uab6b\uab70-\uabed\uabf0-\uabf9\uac00-\ud7a3\ud7b0-\ud7c6\ud7cb-\ud7fb\uf900-\ufa6d\ufa70-\ufad9\ufb00-\ufb06\ufb13-\ufb17\ufb1d-\ufb36\ufb38-\ufb3c\ufb3e\ufb40-\ufb41\ufb43-\ufb44\ufb46-\ufbc2\ufbd3-\ufd8f\ufd92-\ufdc7\ufdcf\ufdf0-\ufe19\ufe20-\ufe52\ufe54-\ufe66\ufe68-\ufe6b\ufe70-\ufe74\ufe76-\ufefc\uff01-\uffbe\uffc2-\uffc7\uffca-\uffcf\uffd2-\uffd7\uffda-\uffdc\uffe0-\uffe6\uffe8-\uffee\ufffc-\ufffd]*$"
              },
              "availability_zone": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "bootable": {
                "type": [
                  "boolean",
                  "string"
                ],
                "enum": [
                  true,
                  "True",
                  "TRUE",
                  "true",
                  "1",
                  "ON",
                  "On",
                  "on",
                  "YES",
                  "Yes",
                  "yes",
                  "y",
                  "t",
                  false,
                  "False",
                  "FALSE",
                  "false",
                  "0",
                  "OFF",
                  "Off",
                  "off",
                  "NO",
                  "No",
                  "no",
                  "n",
                  "f"
                ]
              },
              "volume_type": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              },
              "host": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 255,
                "pattern": "^[a-zA-Z0-9-._#@:/+\\[\\]]*$"
              },
              "ref": {
                "type": [
                  "object",
                  "string"
                ]
              },
              "metadata": {
                "type": [
                  "object",
                  "null"
                ],
                "patternProperties": {
                  "^[a-zA-Z0-9-_:. /]{1,255}$": {
                    "type": "string",
                    "maxLength": 255
                  }
                },
                "additionalProperties": false
              },
              "cluster": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 0,
                "maxLength": 255
              }
            },
            "additionalProperties": false,
            "required": [
              "ref"
            ]
          }
        },
        "additionalProperties": false,
        "x-openstack": {
          "min-ver": "3.16"
        },
        "required": [
          "volume"
        ]
      }
    ],
    "x-openstack": {
      "discriminator": "microversion"
    }
  }
  

Responses

202

Ok

404

Error