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

Create Data Volume Template from Volume

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameStringRequired

      Data Volume Image name

    • descriptionString

      Detailed description of the Data Volume Image

    • volumeUuidStringRequired

      Source Volume UUID

    • backupStorageUuidsList

      Image Storage UUID List

    • resourceUuidString

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

  • 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

      当前状态。

    • statusStringRequired

      状态信息。

    • sizeLongRequired

      返回记录数。

    • actualSizeLongRequired

      实际大小。

    • md5SumStringRequired

      No description provided.

    • urlStringRequired

      地址。

    • mediaTypeStringRequired

      No description provided.

    • guestOsTypeStringRequired

      No description provided.

    • typeStringRequired

      类型。

    • platformStringRequired

      平台。

    • formatStringRequired

      数据格式或导出格式。

    • systemBooleanRequired

      系统。

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • backupStorageRefsListRequired

      See backupStorageRefs

      • imageUuidStringRequired

        Image UUID

      • backupStorageUuidStringRequired

        Image Storage UUID

      • installPathStringRequired

        安装路径。

      • exportUrlStringRequired

        导出地址。

      • exportMd5SumStringRequired

        No description provided.

      • statusStringRequired

        状态信息。

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

Endpoint

POST/zstack/v1/images/data-volume-templates/from/volumes/{volumeUuid}

/zstack/v1/images/data-volume-templates/from/volumes/{volumeUuid}

Operation ID

CreateDataVolumeTemplateFromVolume

Permalink

Request Example

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

Response Example

200
{ "inventory": { "uuid": "7247cf569e2b4104832071822cf845c5", "name": "My Data Volume Template", "mediaType": "DataVolumeTemplate", "platform": "Linux", "format": "raw", "backupStorageRefs": [ { "id": 0.0, "imageUuid": "7247cf569e2b4104832071822cf845c5", "backupStorageUuid": "1b8ab68b7e224a30aa31f00f1db2b5a6", "installPath": "ceph://zs-data-volume/0cd599ec519249489475112a058bb93a", "status": "Ready" } ] } }

Change History

This API has no change history records yet.

View all change history