Skip to main content
ZStack
Platform O&M/Backup Management/Backup Service (Plus)/Backup Service Operations

CreateVolumeBackup

CreateVolumeBackup

POST/zstack/v1/volumes/{volumeUuid}/volume-backups

Operation ID

CreateVolumeBackup

Since

2.6.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • volumeUuid
    StringRequired

    Path parameter.

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • volumeUuid
      StringRequired

      The UUID of the volume.

    • backupStorageUuid
      StringRequired

      The UUID of the backup storage.

    • name
      StringRequired

      The name of the backup.

    • description
      String

      Optional. The detailed description of the backup.

    • resourceUuid
      String

      Optional. Specify a UUID of the backup.

    • volumeReadBandwidth
      Long

      Optional. The maximum speed at which data from the volume is read.

    • volumeWriteBandwidth
      Long

      Optional. The maximum speed at which data is written to the volume.

    • networkReadBandwidth
      Long

      Optional. The network bandwidth for data reads.

    • networkWriteBandwidth
      Long

      Optional. The network bandwidth for data writes.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    VolumeBackupInventoryRequired

    See inventory

    • uuid
      StringRequired

      The UUID of the volume backup.

    • volumeUuid
      StringRequired

      The UUID of the volume.

    • name
      StringRequired

      The name of the volume backup.

    • description
      StringRequired

      The detailed description of the backup.

    • type
      StringRequired

      The type of the volume.

    • state
      StringRequired

      The status of the backup.

    • status
      StringRequired

      The availability status of the backup.

    • size
      LongRequired

      The size of the backup.

    • metadata
      StringRequired

      The metadata of the backup.

    • createDate
      TimestampRequired

      The time when the backup was created.

    • lastOpDate
      TimestampRequired

      The time when the backup was last modified.

    • backupStorageRefs
      ListRequired

      See backupStorageRefs

      • volumeBackupUuid
        StringRequired

        The UUID of the volume backup.

      • backupStorageUuid
        StringRequired

        The UUID of the backup storage.

      • installPath
        StringRequired

        The storage path of the backup.

      • status
        StringRequired

        The status of the backup in the backup storage.

      • createDate
        TimestampRequired

        The time when the backup was created.

      • lastOpDate
        TimestampRequired

        The time when the backup was last modified.