TCL / Core Services API / CreateInstanceConsoleConnection
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# 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": {}
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "instanceId" "voluptate nulla qui in quis"
CkJsonObject_UpdateString $json "publicKey" "pariatur velit"
CkJsonObject_UpdateNewObject $json "definedTags"
CkJsonObject_UpdateNewObject $json "freeformTags"
CkHttp_SetRequestHeader $http "opc-retry-token" "aliqua enim i"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set connectionString [CkJsonObject_stringOf $jResp "connectionString"]
set fingerprint [CkJsonObject_stringOf $jResp "fingerprint"]
set id [CkJsonObject_stringOf $jResp "id"]
set instanceId [CkJsonObject_stringOf $jResp "instanceId"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set serviceHostKeyFingerprint [CkJsonObject_stringOf $jResp "serviceHostKeyFingerprint"]
set vncConnectionString [CkJsonObject_stringOf $jResp "vncConnectionString"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
