Chilkat Online Tools

C++ / Core Services API / UpdateInstanceConsoleConnection

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
#include <CkHttpResponse.h>

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

    CkHttp 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.

    // {
    //   "definedTags": {},
    //   "freeformTags": {}
    // }

    CkJsonObject json;
    json.UpdateNewObject("definedTags");
    json.UpdateNewObject("freeformTags");

    http.SetRequestHeader("opc-request-id","8wF");
    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("x-content-sha256","{{content_sha256}}");
    http.SetRequestHeader("Authorization","{{signature}}");
    http.SetRequestHeader("Date","{{date}}");
    http.SetRequestHeader("if-match","officia sed");

    CkStringBuilder sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponse *resp = http.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections/:instanceConsoleConnectionId",sbRequestBody,"utf-8","application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *compartmentId = jResp.stringOf("compartmentId");
    const char *connectionString = jResp.stringOf("connectionString");
    const char *fingerprint = jResp.stringOf("fingerprint");
    const char *id = jResp.stringOf("id");
    const char *instanceId = jResp.stringOf("instanceId");
    const char *lifecycleState = jResp.stringOf("lifecycleState");
    const char *serviceHostKeyFingerprint = jResp.stringOf("serviceHostKeyFingerprint");
    const char *vncConnectionString = jResp.stringOf("vncConnectionString");
    }

Curl Command

curl -X PUT
	-H "opc-request-id: 8wF"
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/instanceConsoleConnections/:instanceConsoleConnectionId

Postman Collection Item JSON

{
  "name": "UpdateInstanceConsoleConnection",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "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    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
    },
    "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": "Updates the defined tags and free-form tags for the specified instance console connection."
  },
  "response": [
    {
      "name": "The instance console connection was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "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": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "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": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "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": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/instanceConsoleConnections/:instanceConsoleConnectionId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "instanceConsoleConnections",
            ":instanceConsoleConnectionId"
          ],
          "variable": [
            {
              "key": "instanceConsoleConnectionId"
            }
          ]
        }
      },
      "status": "Precondition Failed",
      "code": 412,
      "_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": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "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": "PUT",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"freeformTags\": {}\n}"
        },
        "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}"
    }
  ]
}