Managing Image Lists

Machine images must be added to an image list to create a versioned instance template. When defining the launch plan for an orchestration to create an instance, an image list must be selected. You may also optionally select the version of the member machine image for launch. If no version is selected, then the default entry defined for the image list is launched. For example, you might want to set up an image list containing a selection of machine images of various Oracle Linux releases.

Topics:

Add Image List

This API enables you to add an image list.

Note:

You can add only private image lists to the system. To add public image lists, contact your Oracle Cloud Administrator.

Method

POST

REST Resource

/imagelist/

URI

https://api_endpoint/imagelist/

Request Body Parameters

Parameter Description
name A unique hierarchical name for the image list. For example, /mytenant/public/myimagelist .

Object names can contain only alphanumeric characters, hyphens, and periods. Object names are case-sensitive.
description A description of this image list
default (Optional) This is the version of the image in the list that should be considered the default. The default is used on instance launch if a specific version has not been given.

Example URI

https://api.oc.example.com/imagelist

Example Request Body

{
 "default": 1, 
 "description": "ol 6", 
 "name": "/mytenant/public/ol6"
}

Example Response Body

{
 "default": 1, 
 "description": "ol 6", 
 "entries": [], 
 "uri": "https://api.oc.example.com/imagelist/mytenant/public/ol6",
 "name": "/mytenant/public/ol6"
}

Delete Image List

This API enables you to delete a specific image list.

Note:

You can only delete private image lists in your tenancy.

Method

DELETE

REST Resource

/imagelist/name

URI

https://api_endpoint/imagelist/name

URI Parameter

Parameter Description
name A unique hierarchical name for the image list. For example, /mytenant/public/myimagelist.

Example URI

https://api.oc.example.com/imagelist/mytenant/public/oel59_20GB

Update Image List

This API enables you to update image list information.

Note:

You can update only private image lists that you have created.

Method

PUT

REST Resource

/imagelist/name

URI

https://api_endpoint/imagelist/name

URI Parameter

Parameter Description
name A unique hierarchical name for the image list. For example, /mytenant/public/myimagelist

Request Body Parameters

Parameter Description
description (Optional) A description of this image list.
default (Optional) This is the version of the image in the list that should be considered the default. The default is used on instance launch if a specific version has not been given.

Example URI

https://api.oc.example.com/imagelist/mytenant/public/ol66_40GB

Example Request Body

{
  "default": 2,
  "description": "OL 6.6 40 GB",
  "uri": "imagelist/mytenant/public/ol66_40GB",
  "name": "/mytenant/public/ol66_40GB"
}

Example Response Body

{
  "default": 2,
  "description": "OL 6.6 40 GB",
  "entries": [],
  "uri": "https://api.oc.example.com/imagelist/mytenant/public/ol66_40GB",
  "name": "/mytenant/public/ol66_40GB"
}

Retrieve Image List Details

You can retrieve image list details by using the REST API.

Topics:

Discover Image Lists

This API enables you to discover image list names in a specific container.

Note:

The discover API calls display the names of the objects in the specified container, not the details about the objects. To list the names of the objects, you must set the Accept header to application/oracle-compute-v3+directory+json. For all other purposes, you must set the Accept header to application/oracle-compute-v3+json.

Method

GET

REST Resource

/imagelist/container/

URI

https://api_endpoint/imagelist/container/

URI Parameter

Parameter Description
container Hierarchical name-space for image list.

Example URI

https://api.oc.example.com/imagelist/mytenant/public/

Example Response Body

{"result": ["/mytenant/public/oel59_20G", "/mytenant/public/ol66_40GB"]}

Get Image List

This API enables you to retrieve details of a specific image list.

Method

GET

REST Resource

/imagelist/name

URI

https://api_endpoint/imagelist/name

URI Parameter

Parameter Description
name A unique hierarchical name for the image list. For example, /mytenant/public/myimagelist

Example URI

http://api/imagelist/oracle/public/linux5_16.1.2_64

Example Response Body

{
"default": 1, 
"description": "A default public image.", 
"entries": [{"attributes": {}, 
"version": 1, "machineimages": ["/oracle/public/linux5_16.1.2_64"], 
"uri": "https://api/imagelist/oracle/public/linux5_16.1.2_64/entry/1"}], 
"uri": "https://api/imagelist/oracle/public/linux5_16.1.2_64", 
"name": "/oracle/public/linux5_16.1.2_64"
}

List Image Lists

This API enables you to retrieve information of all image lists present in a specific container.

Method

GET

REST Resource

/imagelist/container/

URI

https://api_endpoint/imagelist/container/

URI Parameter

Parameter Description
container Hierarchical name-space for image list.

Example URI

https://api.oc.example.com/imagelist/oracle/public/

Example Response Body


{
{
        "default": 1, 
        "description": "A default public image.", 
        "entries": [{"attributes": {}, "version": 1, "machineimages": ["/oracle/public/linux6_16.1.2_64"], 
       "uri": "https://api/imagelist/oracle/public/linux6_16.1.2_64/entry/1"}], 
        "uri": "https://api/imagelist/oracle/public/linux6_16.1.2_64", 
        "name": "/oracle/public/linux6_16.1.2_64"
}, 
{
        "default": 1, 
        "description": "A default public image.", 
        "entries": [{"attributes": {}, "version": 1, "machineimages": ["/oracle/public/linux5_16.1.2_64"], 
       "uri": "https://api/imagelist/oracle/public/linux5_16.1.2_64/entry/1"}], 
        "uri": "https://api/imagelist/oracle/public/linux5_16.1.2_64", 
        "name": "/oracle/public/linux5_16.1.2_64"
}}