Jump to

• Request
• Response
• Examples

Retrieve Details of an Instance Console

get

/instanceconsole/{name}

Retrieves the messages that appear when an instance boots. Use these messages to diagnose unresponsive instances and failures in the boot up process.

Request

Supported Media Types

• application/oracle-compute-v3+json

Path Parameters

• name: string
  Name of the instance in one of the following format: /Compute-identityDomain/user/id or /Compute-identityDomain/user/provided_name/id, where id is an autogenerated ID.

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.

Back to Top

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

Body ()

Root Schema : InstanceConsole-response

Type: object

Show Source

• name(optional): string
  Name of the instance for which the console output is displayed.
• output(optional): string
  Serial console output of the instance.
• timestamp(optional): string
  Time when the console output was created.
• uri(optional): string
  Uniform Resource Identifier

{
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the instance for which the console output is displayed."
        },
        "output":{
            "type":"string",
            "description":"Serial console output of the instance."
        },
        "timestamp":{
            "type":"string",
            "description":"Time when the console output was created."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier"
        }
    }
}

Back to Top

Examples

cURL Command

The following example shows how to retrieve console output for an instance 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/instanceconsole/Compute-acme/[e-mail]/68a3c40c-466e-41df-a7f2-00fbfbd590e5

• 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 [e-mail] are example values. Replace acme with the identity domain ID of your Compute Classic account, and [e-mail] with your user name.

Example of Response Body

The following example shows the response body in JSON format.

Some lines may be truncated with ellipses (...) for readability.

{
	"timestamp": "2016-06-17T09:21:19.662570",
	"output": "k [LNKD] (IRQs *5 10 11)\r\nvgaarb: device added: ... login: ",
	"uri": "https://api-z999.compute.us0.oraclecloud.com/instanceconsole/Compute-acme/[e-mail]/68a3c40c-466e-41df-a7f2-00fbfbd590e5",
	"name": "/Compute-acme/[e-mail]/68a3c40c-466e-41df-a7f2-00fbfbd590e5"
}

Back to Top