Revision as of 09:24, 24 May 2013

This operation will list all images including their details.

GET /images/detail?name=imageName&status=imageStatus&type=imageType&zone=zoneTextKey

Parameters

name - string

Optional image name to search for.

status - string

Optional Image status to search for. Values: ACTIVE, SAVING, DELETED

type - string

Optional type of the image to search for. Values: BASE, SERVER

zone - string

Optional Zone textkey of the image to search for.

Result

JSON

{
   "images":[
      {
         "status":"{status}",
         "updated":null,
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            },
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"bookmark"
            }
         ],
         "created":"2011-09-30T02:38:57",
         "id":"{image_id}",
         "zones": ["{zone_textkey}"]
      },
      {
         "status":"{status}",
         "updated":null,
         "name":"{display_image_name}",
         "links":[
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"self"
            },
            {
               "href":"http://{api_server}/images/{image_id}/",
               "rel":"bookmark"
            }
         ],
         "created":"2011-12-27T02:59:27",
         "id":"{image_id}",
         "zones": ["{zone_textkey}", "{zone_textkey2}"]
      }
   ]
}

id - string

Unique identifier for this image.

links - array

Hypermedia for this resource.

name - string

Display name for this image.

status - string

Current state of this image. Valid values are ACTIVE, SAVING, DELETED.

ACTIVE - Image is ready to be used.

SAVING - Image is being uploaded or saved from a running Server instance.

DELETED - Image was recently deleted or is in the process of being deleted.

created - string

The date and time the image was created. ISO 8601 format, YYYY-MM-DDTHH:MM:SS.

updated

Unused always null.

zones

Zones textkeys

Response Codes

Success

HTTP/1.1 200 OK

Failure

HTTP/1.1 401 Unauthorized - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.

Examples

Successfully list image details

GET http://{api_server}/images/detail

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded username & password string

Response Code:

HTTP/1.1 200 OK

Response Body:

    {
       "images": [
          {
             "status": "ACTIVE", 
             "updated": null, 
             "name": "test_public_image", 
             "links": [
                {
                   "href": "http://{api_server}/images/123/", 
                   "rel": "self"
                }, 
                {
                   "href": "http://{api_server}/images/123/", 
                   "rel": "bookmark"
                }
              ], 
              "created": "2011-11-09T03:19:48", 
              "id": "123",
              "zones": ["AUS001"]
           },
           {
              "status": "SAVING", 
              "updated": null, 
              "name": "test_debian_image", 
              "links": [
                 {
                    "href": "http://{api_server}/images/233/", 
                    "rel": "self"
                 }, 
                 {
                    "href": "http://{api_server}/images/233/", 
                    "rel": "bookmark"
                 }
              ], 
              "created": "2011-09-30T02:38:57", 
              "id": "233",
              "zones": ["AUS001"]
           }, 
           {
              "status": "ACTIVE", 
              "updated": null, 
              "name": "test_private_image", 
              "links": [
                 {
                    "href": "http://{api_server}/images/145/", 
                    "rel": "self"
                 }, 
                 {
                    "href": "http://{api_server}/images/145/", 
                    "rel": "bookmark"
                 }
              ], 
              "created": "2011-11-09T03:19:01", 
              "id": "145",
              "zones": ["AUS001"]
            }
        ]
    }

Failure while trying to make an unauthorized request

GET http://{api_server}/images/detail

Request Headers:

   Content-Type:application/json
   Charset=UTF-8
   Authorization:Base64-encoded fake_authentication_string

Response Code:

HTTP/1.1 401 Unauthorized

Response Body:

    401 Unauthorized
    This server could not verify that you are authorized to
    access the document you requested.  Either you supplied the
    wrong credentials (e.g., bad password), or your browser
    does not understand how to supply the credentials required.