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

CreateRootVolumeTemplateFromVolumeBackup

CreateRootVolumeTemplateFromVolumeBackup

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

Operation ID

CreateRootVolumeTemplateFromVolumeBackup

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 root volume image.

    • description
      String

      Optional. The detailed description of the 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 root volume image.

    • name
      StringRequired

      The name of the image.

    • description
      StringRequired

      The detailed description of the image.

    • state
      StringRequired

      The state of the image.

    • status
      StringRequired

      The readiness of the image.

    • size
      LongRequired

      The size of the image.

    • actualSize
      LongRequired

      The actual storage space used by the image.

    • md5Sum
      StringRequired

      The MD5 value of the image.

    • url
      StringRequired

      The URL of the image.

    • mediaType
      StringRequired

      The type of the image.

    • guestOsType
      StringRequired

      The type of the guest OS.

    • type
      StringRequired

      The interval used field.

    • platform
      StringRequired

      The system platform of the image.

    • format
      StringRequired

      The format of the image, for example, raw.

    • system
      BooleanRequired

      Specifies whether the image is a system image.

    • createDate
      TimestampRequired

      The time when the image was created.

    • lastOpDate
      TimestampRequired

      The time when the image was last modified.

    • backupStorageRefs
      ListRequired

      See backupStorageRefs

      • imageUuid
        StringRequired

        The UUID of the root volume image.

      • backupStorageUuid
        StringRequired

        The UUID of the backup storage.

      • installPath
        StringRequired

        The installation path of the image on the backup storage.

      • exportUrl
        StringRequired

        The exported URL of the image.

      • exportMd5Sum
        StringRequired

        The MD5 value of the exported image.

      • status
        StringRequired

        The readiness of the image.

      • createDate
        TimestampRequired

        The time when the image was created.

      • lastOpDate
        TimestampRequired

        The time when the image was last modified.