Skip to main content
API Explorer|API Explorer
Resource Center/Resource Pool/Image Operations
POSTImage OperationsSince 0.6SynchronousAuth Required

CreateDataVolumeTemplateFromVolumeSnapshot

CreateDataVolumeTemplateFromVolumeSnapshot

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

    The snapshot UUID.

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      The name of the data volume image.

    • descriptionString

      Optional. The detailed description of the data volume image.

    • backupStorageUuidsListRequired

      The backup storage UUID list.

    • resourceUuidString

      Optional. The UUID of the data volume image. If specified, the data volume image will use the specified value as UUID.

    • tagUuidsList

      The tag UUID list.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The system tags.

Responses

200 OK

On success, this API returns the following response structure.

  • errorErrorCodeRequired

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

    • codeStringRequired

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

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

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

  • inventoryImageInventoryRequired

    See inventory.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • descriptionStringRequired

      The detailed description of the resource.

    • stateStringRequired

      The state of the image.

    • statusStringRequired

      The status of the image.

    • sizeLongRequired

      The size of the image.

    • actualSizeLongRequired

      The actual size of the image.

    • md5SumStringRequired

      The MD5 checksum value of the image.

    • urlStringRequired

      The URL of the image.

    • mediaTypeStringRequired

      The type of the image.

    • guestOsTypeStringRequired

      The type of the guest operating system that corresponds to the image.

    • typeStringRequired

      The reserved field for internal use.

    • platformStringRequired

      The operating system platform of the image.

    • architectureStringRequired

      The image architecture.

    • formatStringRequired

      The image format, for example, raw.

    • systemBooleanRequired

      Whether the image is a system image.

    • virtioBooleanRequired

      Whether virtio is supported or not.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • backupStorageRefsListRequired

      See backupStorageRefs.

      • imageUuidStringRequired

        The image UUID.

      • backupStorageUuidStringRequired

        The backup storage UUID.

      • installPathStringRequired

        The path to install the image on the backup storage.

      • exportUrlStringRequired

        The URL of the exported image.

      • exportMd5SumStringRequired

        The MD5 checksum value of the exported image.

      • statusStringRequired

        The status of the image.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

  • failuresListRequired

    See failures.

    • backupStorageUuidStringRequired

      The backup storage UUID.

    • errorErrorCodeRequired

      See error.

      • codeStringRequired

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

      • descriptionStringRequired

        The brief description of the error.

      • detailsStringRequired

        The details about the error.

      • elaborationStringRequired

        The reserved field. Default value: null.

      • opaqueLinkedHashMapRequired

        The reserved field. Default value: null.

      • causeErrorCodeRequired

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

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