REST API for Oracle Cloud Infrastructure Compute Classic

Retrieve Details of an Image List Entry

get

/imagelist/{name}/entry/{version}

Retrieves details of the specified image list entry.

Required Role: To complete this task, you must have the Compute_Monitor or Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

application/oracle-compute-v3+json

Path Parameters

name: string

Three-part name of the image list in one of the following formats: /Compute-identity_domain/user/object or /oracle/public/object.
version: string

The unique version of this entry in the image list.

Header Parameters

Cookie: string

The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Response

Supported Media Types

application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

set-cookie: string

The cookie value is returned if the session is extended

Root Schema : ImageListEntry-response

Type: object

Show Source

attributes(optional): object attributes

Additional Properties Allowed: additionalProperties

User-defined parameters, in JSON format, that can be passed to an instance of this machine image when it is launched. This field can be used, for example, to specify a user-friendly name for the image list in the displayName attribute. The name you specify is displayed as the name of the image list in the Compute Classic web console. Instance metadata, including user-defined data is available at http://192.0.0.192/ within an instance. See Retrieving User-Defined Instance Attributes in Using Oracle Cloud Infrastructure Compute Classic.
imagelist(optional): string

Name of the imagelist.
machineimages(optional): array machineimages

A list of machine images. Specify the three-part name of each machine image.
uri(optional): string

Uniform Resource Identifier
version(optional): integer

Version number of these machineImages in the imagelist.

{
    "properties":{
        "attributes":{
            "additionalProperties":{
                "type":"object"
            },
            "type":"object",
            "description":"<p>User-defined parameters, in JSON format, that can be passed to an instance of this machine image when it is launched. This field can be used, for example, to specify a user-friendly name for the image list in the displayName attribute. The name you specify is displayed as the name of the image list in the Compute Classic web console.  Instance metadata, including user-defined data is available at http://192.0.0.192/ within an instance. See <a target=\"_blank\" href=\"http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=STCSG-GUID-79AE6910-E6E3-4960-A9A7-368E26D894F6\">Retrieving User-Defined Instance Attributes</a> in <em>Using Oracle Cloud Infrastructure Compute Classic</em>."
        },
        "imagelist":{
            "type":"string",
            "description":"Name of the imagelist."
        },
        "machineimages":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"<p>A list of machine images. Specify the three-part name of each machine image."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        },
        "version":{
            "type":"integer",
            "description":"Version number of these machineImages in the imagelist."
        }
    }
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "additionalProperties":{
        "type":"object"
    },
    "type":"object",
    "description":"<p>User-defined parameters, in JSON format, that can be passed to an instance of this machine image when it is launched. This field can be used, for example, to specify a user-friendly name for the image list in the displayName attribute. The name you specify is displayed as the name of the image list in the Compute Classic web console.  Instance metadata, including user-defined data is available at http://192.0.0.192/ within an instance. See <a target=\"_blank\" href=\"http://www.oracle.com/pls/topic/lookup?ctx=cloud&id=STCSG-GUID-79AE6910-E6E3-4960-A9A7-368E26D894F6\">Retrieving User-Defined Instance Attributes</a> in <em>Using Oracle Cloud Infrastructure Compute Classic</em>."
}

User-defined parameters, in JSON format, that can be passed to an instance of this machine image when it is launched. This field can be used, for example, to specify a user-friendly name for the image list in the displayName attribute. The name you specify is displayed as the name of the image list in the Compute Classic web console. Instance metadata, including user-defined data is available at http://192.0.0.192/ within an instance. See Retrieving User-Defined Instance Attributes in Using Oracle Cloud Infrastructure Compute Classic.

Nested Schema : machineimages

Type: array

A list of machine images. Specify the three-part name of each machine image.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"<p>A list of machine images. Specify the three-part name of each machine image."
}

Nested Schema : additionalProperties

Type: object

Examples

cURL Command

The following example shows how to retrieve details of an image list entry by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Accept: application/oracle-compute-v3+json"
        https://api-z999.compute.us0.oraclecloud.com/imagelist/Compute-acme/jack.jones@example.com/prodimages/entry/2

COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.
api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.
acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Response Body

The following example shows the response body in JSON format.

{
  "attributes": {},
  "version": 2,
  "machineimages": ["/oracle/public/oel_6.4_2GB_v2"],
  "uri": "https://api-z999.compute.us0.oraclecloud.com/imagelist/Compute-acme/jack.jones@example.com/prodimages/entry/2"
}