Image Service API v1 (DEPRECATED)¶

Creates a metadata record of a virtual machine (VM) image and optionally stores the image data.

Image metadata fields are passed as HTTP headers prefixed with one of the strings x-image-meta- or x-image-meta-property-. See the API documentation for details.

If there is no request body, an image record will be created in status queued. This is called reserving an image. The image data can be uploaded later using the Update image call.

If image data will be uploaded as part of this request, then the following image metadata must be included among the request headers:

• name
• disk_format
• container_format

Additionally, if image data is uploaded as part of this request, the API will return a 400 under the following circumstances:

• The x-image-meta-size header is present and the length in bytes of the request body does not match the value of this header.
• The x-image-meta-checksum header is present and MD5 checksum generated by the backend store while storing the data does not match the value of this header.

Normal response codes: 201

Error response codes: 400, 409

{
    "image": {
        "checksum": "7b1b10607acc1319506185e7227ca30d",
        "container_format": "bare",
        "created_at": "2016-05-10T21:41:41.000000",
        "deleted": false,
        "deleted_at": null,
        "disk_format": "raw",
        "id": "de2f2211-3ac7-4260-9142-41db0ecfb425",
        "is_public": false,
        "min_disk": 0,
        "min_ram": 0,
        "name": "Fake Image",
        "owner": "c60b1d57c5034e0d86902aedf8c49be0",
        "properties": {},
        "protected": false,
        "size": 3908,
        "status": "active",
        "updated_at": "2016-05-10T21:41:41.000000",
        "virtual_size": null
    }
}

{
    "image": {
        "checksum": null,
        "container_format": null,
        "created_at": "2016-05-10T21:35:15.000000",
        "deleted": false,
        "deleted_at": null,
        "disk_format": null,
        "id": "6b3ecfca-d445-4946-a8d1-c4938352b251",
        "is_public": false,
        "min_disk": 0,
        "min_ram": 0,
        "name": null,
        "owner": "c60b1d57c5034e0d86902aedf8c49be0",
        "properties": {},
        "protected": false,
        "size": 0,
        "status": "queued",
        "updated_at": "2016-05-10T21:35:15.000000",
        "virtual_size": null
    }
}

Lists all VM images available to the user making the call. This list will include all public images, any images owned by the requestor, and any images shared with the requestor.

Various query filters can be applied to the URL to restrict the content of the response.

Normal response codes: 200

Error response codes: 400, 403

{
    "images": [
        {
            "checksum": "eb9139e4942121f22bbc2afc0400b2a4",
            "container_format": "ovf",
            "disk_format": "vmdk",
            "id": "008cc101-c3ee-40dd-8477-cd8d99dcbf3d",
            "name": "Harry",
            "size": 25165824
        },
        {
            "...": "..."
        }
    ]
}

Lists all available images with details.

Various query filters can be applied to the URL to restrict the content of the response.

Normal response codes: 200

Error response codes: 400, 403

{
    "images": [
        {
            "checksum": "eb9139e4942121f22bbc2afc0400b2a4",
            "container_format": "bare",
            "created_at": "2016-03-15T15:09:07.000000",
            "deleted": false,
            "deleted_at": null,
            "disk_format": "vmdk",
            "id": "1086fa65-8c63-4081-9a0a-ddf7e88e485b",
            "is_public": false,
            "min_disk": 22,
            "min_ram": 11,
            "name": "Silas Marner",
            "owner": "c60b1d57c5034e0d86902aedf8c49be0",
            "properties": {
                "foo": "bar",
                "qe_status": "approved"
            },
            "protected": false,
            "size": 25165824,
            "status": "active",
            "updated_at": "2016-05-10T21:14:04.000000",
            "virtual_size": null
        },
        {
            "...": "..."
        }
    ]
}

Updates the metadata for an image or uploads an image file.

Image metadata is updated by passing HTTP headers prefixed with one of the strings x-image-meta- or x-image-meta-property-. See the API documentation for details.

If the image is in queued status, image data may be added by including it in the request body. Otherwise, attempting to add data will result in a 409 Conflict response.

If the request contains a body, the API will return a 400 under the following circumstances:

• The x-image-meta-size header is present and the length in bytes of the request body does not match the value of this header.
• The x-image-meta-checksum header is present and MD5 checksum generated by the backend store while storing the data does not match the value of this header.

Normal response codes: 200

Error response codes: 400, 404, 409

{
    "image": {
        "checksum": "eb9139e4942121f22bbc2afc0400b2a4",
        "container_format": "bare",
        "created_at": "2016-03-15T15:09:07.000000",
        "deleted": false,
        "deleted_at": null,
        "disk_format": "vmdk",
        "id": "1086fa65-8c63-4081-9a0a-ddf7e88e485b",
        "is_public": false,
        "min_disk": 22,
        "min_ram": 11,
        "name": "Silas Marner",
        "owner": "c60b1d57c5034e0d86902aedf8c49be0",
        "properties": {
            "foo": "bar",
            "qe_status": "approved"
        },
        "protected": false,
        "size": 25165824,
        "status": "active",
        "updated_at": "2016-05-10T21:14:04.000000",
        "virtual_size": null
    }
}

Returns the image metadata as headers; the image data is returned in the body of the response.

Standard image properties are returned in headers prefixed by x-image-meta- (for example, x-image-meta-name). Custom image properties are returned in headers prefixed by the string x-image-meta-property- (for example, x-image-meta-property-foo).

Normal response codes: 200

Error response codes: 404, 403

Returns the image metadata information as response headers.

The Image system does not return a response body for the HEAD operation.

If the request succeeds, the operation returns the 200 response code.

Normal response codes: 200

Error response codes: 404, 409

Deletes an image.

Normal response codes: 204

Error response codes: 404, 403

Adds the tenant whose tenant ID is member_id as a member of the image denoted by image_id.

By default, an image member cannot further share the image with other tenants. This behavior can be overridden by supplying a request body with the call that specifies can_share as true.

Thus:

• If you omit the request body, this call adds the specified tenant as a member of the image with the can_share attribute set to false.
• If you include a request body, the can_share attribute will be set to the appropriate boolean value you have supplied in the request body.
• If the specified tenant is already a member, and there is no request body, the membership (including the can_share attribute) remains unmodified.
• If the specified tenant is already a member and the request includes a body, the can_share attribute of the tenant will be set to whatever value is specified in the request body.

Normal response codes: 204

Error response codes: 404

{
    "member_id": "eb5d80bd5f1e49f1818988148c70eabf",
    "can_share": false
}

Replaces the membership list for an image so that the tenants whose tenant IDs are listed in the member objects comprising the request body become all and only the members of the image denoted by image_id.

If the can_share attribute is omitted for in any member object:

• If the member already exists on the image, that member’s can_share setting remains unchanged.
• If the member did not already exist on the image, that member’s can_share attribute is set to false.

Normal response codes: 204

Error response codes: 404

{
    "memberships": [
        {
            "member_id": "eb5d80bd5f1e49f1818988148c70eabf",
            "can_share": false
        },
        {
            "member_id": "8f450f44647d4080a0e7ca505057b5ca",
            "can_share": false
        }
    ]
}

Removes a member from an image.

Normal response codes: 204

Error response codes: 404

Lists the VM images that an owner shares. The owner_id is the tenant ID of the image owner.

Normal response codes: 200

Error response codes: 404

{
    "shared_images": [
        {
            "can_share": false,
            "image_id": "008cc101-c3ee-40dd-8477-cd8d99dcbf3d"
        },
        {
            "can_share": true,
            "image_id": "de2f2211-3ac7-4260-9142-41db0ecfb425"
        },
        {
            "...": "..."
        }
    ]
}