Skip to main content
ZStack
Resource Center/Resource Pool/Image Operations

AddImage

AddImage

POST/zstack/v1/images

Operation ID

AddImage

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • name
      StringRequired

      The image name.

    • description
      String

      Optional. The detailed description of the image.

    • url
      StringRequired

      The URL of the image to be added.

    • mediaType
      String

      Optional. The image type.

    • guestOsType
      String

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

    • system
      boolean

      Optional. Whether the image is a system image, for example, vRouter image.

    • format
      String

      Optional. The image format, for example, raw.

    • platform
      String

      Optional. The system platform of the image.

    • backupStorageUuids
      ListRequired

      The UUID list of the backup storages on which the image is to be added.

    • type
      String

      Optional. The reserved field for internal use.

    • resourceUuid
      String

      Optional. The resource UUID. If specified, the image will use the specified value as UUID.

    • architecture
      String

      Optional.

    • tagUuids
      List

      Optional. The tag UUIDs.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventory
    ImageInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • name
      StringRequired

      The resource name.

    • description
      StringRequired

      The detailed description of the resource.

    • state
      StringRequired

      The state of the image.

    • status
      StringRequired

      The status of the image.

    • size
      LongRequired

      The image size.

    • actualSize
      LongRequired

      The actual size of the image.

    • md5Sum
      StringRequired

      The MD5 checksum of the image.

    • url
      StringRequired

      The URL of the image.

    • mediaType
      StringRequired

      The image type.

    • guestOsType
      StringRequired

      The guest operating system type of the image.

    • type
      StringRequired

      The reserved field.

    • platform
      StringRequired

      The system platform of the image.

    • architecture
      StringRequired

      The image architecture.

    • format
      StringRequired

      The image format, for example, raw.

    • system
      BooleanRequired

      Whether the image is a system image.

    • virtio
      BooleanRequired

      Whether virtio is supported or not.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • backupStorageRefs
      ListRequired

      See backupStorageRefs.

      • imageUuid
        StringRequired

        The image UUID.

      • backupStorageUuid
        StringRequired

        The backup storage UUID.

      • installPath
        StringRequired

        The installation path.

      • exportUrl
        StringRequired

        The export URL.

      • exportMd5Sum
        StringRequired

        The export MD5 sum.

      • status
        StringRequired

        The resource status.

      • createDate
        TimestampRequired

        The creation date.

      • lastOpDate
        TimestampRequired

        The last operation date.