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

CreateDataVolumeTemplateFromVolumeBackup

CreateDataVolumeTemplateFromVolumeBackup

POST/zstack/v1/images/data-volume-templates/from/volume-template/{backupUuid}

Operation ID

CreateDataVolumeTemplateFromVolumeBackup

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

  • backupUuid
    StringRequired

    The UUID of the volume backup.

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • backupStorageUuid
      StringRequired

      The UUID of the backup storage.

    • name
      StringRequired

      The name of the volume image.

    • description
      String

      Optional. The detailed description of the volume image.

    • guestOsType
      String

      Optional. The type of the guest operating system.

    • platform
      String

      Optional. The platform type of the guest.

    • system
      boolean

      Optional. Specify whether to create a system image.

    • resourceUuid
      String

      Optional. Specify a UUID for the image.

    • architecture
      String

      Optional.

    • tagUuids
      List

      Optional. The tag UUIDs.

  • 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
    ImageInventoryRequired

    See inventory

    • uuid
      StringRequired

      The UUID of the volume image.

    • name
      StringRequired

      The name of the volume image.

    • description
      StringRequired

      The detailed description of the volume image.

    • state
      StringRequired

      The resource state.

    • status
      StringRequired

      The resource status.

    • size
      LongRequired

      The size.

    • actualSize
      LongRequired

      The actual size.

    • md5Sum
      StringRequired

      The MD5 sum.

    • url
      StringRequired

      The URL.

    • mediaType
      StringRequired

      The media type.

    • guestOsType
      StringRequired

      The guest OS type.

    • type
      StringRequired

      The resource type.

    • platform
      StringRequired

      The platform.

    • format
      StringRequired

      The format.

    • system
      BooleanRequired

      The system.

    • createDate
      TimestampRequired

      The time when the volume image was created.

    • lastOpDate
      TimestampRequired

      The time when the volume image was last modified.

    • backupStorageRefs
      ListRequired

      See backupStorageRefs

      • imageUuid
        StringRequired

        The UUID of the volume image.

      • backupStorageUuid
        StringRequired

        The UUID of the backup storage.

      • installPath
        StringRequired

        The installation path.

      • exportUrl
        StringRequired

        The export URL.

      • exportMd5Sum
        StringRequired

        The export MD5 sum.

      • status
        StringRequired

        The resource status.

      • createDate
        TimestampRequired

        The time when the volume image was created.

      • lastOpDate
        TimestampRequired

        The time when the volume image was last modified.