Chilkat Online Tools

Mono / Core Services API / CreateInstanceConsoleConnection

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "instanceId": "voluptate nulla qui in quis",
//   "publicKey": "pariatur velit",
//   "definedTags": {},
//   "freeformTags": {}
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("instanceId","voluptate nulla qui in quis");
json.UpdateString("publicKey","pariatur velit");
json.UpdateNewObject("definedTags");
json.UpdateNewObject("freeformTags");

http.SetRequestHeader("opc-retry-token","aliqua enim i");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("x-content-sha256","{{content_sha256}}");
http.SetRequestHeader("Authorization","{{signature}}");
http.SetRequestHeader("Date","{{date}}");

Chilkat.HttpResponse resp = http.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections","application/json",json);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// 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

string compartmentId = jResp.StringOf("compartmentId");
string connectionString = jResp.StringOf("connectionString");
string fingerprint = jResp.StringOf("fingerprint");
string id = jResp.StringOf("id");
string instanceId = jResp.StringOf("instanceId");
string lifecycleState = jResp.StringOf("lifecycleState");
string serviceHostKeyFingerprint = jResp.StringOf("serviceHostKeyFingerprint");
string vncConnectionString = jResp.StringOf("vncConnectionString");

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "instanceId": "voluptate nulla qui in quis",
    "publicKey": "pariatur velit",
    "definedTags": {},
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections

Postman Collection Item JSON

{
  "name": "CreateInstanceConsoleConnection",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/instanceConsoleConnections",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "instanceConsoleConnections"
      ]
    },
    "description": "Creates a new console connection to the specified instance.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n"
  },
  "response": [
    {
      "name": "The instance console connection is being configured.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"voluptate nulla qui in quis\",\n    \"publicKey\": \"pariatur velit\",\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections"
          ]
        }
      },
      "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}"
    }
  ]
}