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

UpdateImage

UpdateImage

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

    The image UUID.

Body Fields

  • updateimageObjectRequired

    updateimage request body object.

    • nameString

      Optional. The image name.

    • descriptionString

      Optional. The detailed description of the image.

    • guestOsTypeString

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

    • mediaTypeString

      Optional. The image type.

    • architectureString

      Optional.

    • formatString

      Optional. The image format.

    • systemBoolean

      Optional. Specifies whether the image is a system image.

    • platformString

      Optional. The system platform of the image.

    • virtioBoolean

      No description provided.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • 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 image size.

    • actualSizeLongRequired

      The actual size of the image.

    • md5SumStringRequired

      The MD5 checksum of the image.

    • urlStringRequired

      The URL of the image.

    • mediaTypeStringRequired

      The image type.

    • guestOsTypeStringRequired

      The guest operating system type of the image.

    • typeStringRequired

      The reserved field.

    • platformStringRequired

      The 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

        在镜像服务器上的安装路径

      • exportUrlStringRequired

        导出镜像的url

      • exportMd5SumStringRequired

        导出镜像的md5值

      • statusStringRequired

        镜像就绪状态

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

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 '{"updateimage":{"name":"<name>","description":"<description>","guestOsType":"<guestOsType>","mediaType":"<mediaType>","architecture":"<architecture>","format":"<format>","system":true,"platform":"<platform>","virtio":true},"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