Chilkat Online Tools

phpAx / Core Services API / GetInstanceConsoleConnection

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new COM("Chilkat_9_5_0.Http");

$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections/:instanceConsoleConnectionId',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "compartmentId": "esse",
//   "connectionString": "sunt exercitation proident anim elit",
//   "definedTags": {},
//   "fingerprint": "ut dolor in Duis ullamco",
//   "freeformTags": {},
//   "id": "ea ut aute Lorem",
//   "instanceId": "dolor ",
//   "lifecycleState": "ACTIVE",
//   "serviceHostKeyFingerprint": "est Lorem quis et",
//   "vncConnectionString": "amet consequat ut quis"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$compartmentId = $jResp->stringOf('compartmentId');
$connectionString = $jResp->stringOf('connectionString');
$fingerprint = $jResp->stringOf('fingerprint');
$id = $jResp->stringOf('id');
$instanceId = $jResp->stringOf('instanceId');
$lifecycleState = $jResp->stringOf('lifecycleState');
$serviceHostKeyFingerprint = $jResp->stringOf('serviceHostKeyFingerprint');
$vncConnectionString = $jResp->stringOf('vncConnectionString');

?>

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections/:instanceConsoleConnectionId

Postman Collection Item JSON

{
  "name": "GetInstanceConsoleConnection",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instanceConsoleConnections",
        ":instanceConsoleConnectionId"
      ],
      "variable": [
        {
          "key": "instanceConsoleConnectionId",
          "value": "officia sed",
          "description": "(Required) The OCID of the instance console connection."
        }
      ]
    },
    "description": "Gets the specified instance console connection's information."
  },
  "response": [
    {
      "name": "The instance console connection was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"compartmentId\": \"esse\",\n \"connectionString\": \"sunt exercitation proident anim elit\",\n \"definedTags\": {},\n \"fingerprint\": \"ut dolor in Duis ullamco\",\n \"freeformTags\": {},\n \"id\": \"ea ut aute Lorem\",\n \"instanceId\": \"dolor \",\n \"lifecycleState\": \"ACTIVE\",\n \"serviceHostKeyFingerprint\": \"est Lorem quis et\",\n \"vncConnectionString\": \"amet consequat ut quis\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}