Skip to main content
API Explorer|API Explorer
Compute Management/Image Storage Related Interfaces/Image Related Interfaces
POSTImage Related InterfacesSince 0.6SynchronousAuth Required

Create Data Volume Template from Volume Snapshot

Create Data Volume Template from Volume Snapshot

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • snapshotUuidStringRequired

    Snapshot UUID

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      Data Volume Image name

    • descriptionString

      Detailed description of the Data Volume Image

    • backupStorageUuidsListRequired

      Image Storage UUID List

    • resourceUuidString

      Data Volume Image UUID. If specified, the Data Volume Image will use this field value as its UUID

    • tagUuidsList

      Tag UUID List

  • systemTagsList

    System Tags

  • userTagsList

    User Tags

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. This field is null when the operation succeeds. See error

    • codeStringRequired

      Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause. The source error that triggered the current error. This field is null if there is no original error

  • inventoryImageInventoryRequired

    See inventory

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • descriptionStringRequired

      Detailed description of the resource

    • stateStringRequired

      Image boot state

    • statusStringRequired

      Image ready state

    • sizeLongRequired

      Image size

    • actualSizeLongRequired

      Image actual capacity

    • md5SumStringRequired

      Image md5 value

    • urlStringRequired

      Image URL address

    • mediaTypeStringRequired

      Image type

    • guestOsTypeStringRequired

      Guest Operating System type corresponding to the Image

    • typeStringRequired

      Internal use field

    • platformStringRequired

      Image system platform

    • formatStringRequired

      Image format, for example: raw

    • systemBooleanRequired

      Indicates whether it is a system Image

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • backupStorageRefsListRequired

      See backupStorageRefs

      • imageUuidStringRequired

        Image UUID

      • backupStorageUuidStringRequired

        Image Storage UUID

      • installPathStringRequired

        Installation path on the Image Storage

      • exportUrlStringRequired

        Export Image URL

      • exportMd5SumStringRequired

        Export Image md5 value

      • statusStringRequired

        Image ready state

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

  • failuresListRequired

    See failures

    • backupStorageUuidStringRequired

      Image Storage UUID

    • errorErrorCodeRequired

      See error

      • codeStringRequired

        Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001

      • descriptionStringRequired

        Brief description of the error

      • detailsStringRequired

        Detailed error information

      • elaborationStringRequired

        Reserved field, defaults to null

      • opaqueLinkedHashMapRequired

        Reserved field, defaults to null

      • causeErrorCodeRequired

        Root cause. The source error that triggered the current error. This field is null if there is no original error

Endpoint

POST/zstack/v1/images/data-volume-templates/from/volume-snapshots/{snapshotUuid}

/zstack/v1/images/data-volume-templates/from/volume-snapshots/{snapshotUuid}

Operation ID

CreateDataVolumeTemplateFromVolumeSnapshot

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/images/data-volume-templates/from/volume-snapshots/{snapshotUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","backupStorageUuids":["<backupStorageUuids>"],"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "314d80c2feb5352c984b3ffd36108c32", "name": "My Data Volume Template", "mediaType": "DataVolumeTemplate", "platform": "Linux", "format": "raw", "backupStorageRefs": [ { "id": 0.0, "imageUuid": "314d80c2feb5352c984b3ffd36108c32", "backupStorageUuid": "d861144baadf31e3b1cbbb282242adcf", "installPath": "ceph://zs-images/0cd599ec519249489475112a058bb93a", "status": "Ready" } ] } }

Change History

This API has no change history records yet.

View all change history