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

Update Image

Update Image

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Image UUID, uniquely identifies the Image

Body Fields

  • paramsObjectRequired

    Request body parameter object.

    • nameString

      Image name

    • descriptionString

      Detailed description of the Image

    • guestOsTypeString

      Guest Operating System type corresponding to the Image

    • mediaTypeString

      Image type

    • formatString

      Image format

    • systemBoolean

      Indicates whether it is a system Image

    • platformString

      Image system platform

  • updateimageObjectRequired

    updateimage request body object.

    • architectureString

      No description provided.

  • 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

Endpoint

PUT/zstack/v1/images/{uuid}/actions

/zstack/v1/images/{uuid}/actions

Operation ID

UpdateImage

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/images/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","guestOsType":"<guestOsType>","mediaType":"<mediaType>","format":"<format>","system":true,"platform":"<platform>"},"updateimage":{"architecture":"<architecture>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "fadea0efc22e3e6fa43f537f1af6ee6b", "name": "TinyLinux", "url": "http://192.168.1.20/share/images/tinylinux.qcow2", "mediaType": "RootVolumeTemplate", "platform": "Windows", "architecture": "x86_64", "format": "qcow2", "backupStorageRefs": [ { "id": 0.0, "imageUuid": "fadea0efc22e3e6fa43f537f1af6ee6b", "backupStorageUuid": "b94ff32725d133fea53e8ada5ea7f0fc", "installPath": "ceph://zs-images/f0b149e053b34c7eb7fe694b182ebffd", "status": "Ready" } ] } }

Change History

This API has no change history records yet.

View all change history