Chilkat Online Tools

unicodeCpp / Core Services API / UpdateNatGateway

Back to Collection Items

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpResponseW.h>

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

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

    // {
    //   "blockTraffic": false,
    //   "definedTags": {},
    //   "displayName": "sunt consectetur aliqua Excepteur ut",
    //   "freeformTags": {}
    // }

    CkJsonObjectW json;
    json.UpdateBool(L"blockTraffic",false);
    json.UpdateNewObject(L"definedTags");
    json.UpdateString(L"displayName",L"sunt consectetur aliqua Excepteur ut");
    json.UpdateNewObject(L"freeformTags");

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

    CkStringBuilderW sbRequestBody;
    json.EmitSb(sbRequestBody);

    CkHttpResponseW *resp = http.PTextSb(L"PUT",L"https://iaas.{{region}}.oraclecloud.com/20160918/natGateways/:natGatewayId",sbRequestBody,L"utf-8",L"application/json",false,false);
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkStringBuilderW sbResponseBody;
    resp->GetBodySb(sbResponseBody);

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

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = resp->get_StatusCode();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",resp->header());
        wprintf(L"Failed.\n");
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "compartmentId": "et",
    //   "vcnId": "laboris dolor",
    //   "natIp": "ut ad minim commodo irure",
    //   "id": "ex mollit nostrud",
    //   "lifecycleState": "TERMINATED",
    //   "timeCreated": "1951-12-31T09:14:40.490Z",
    //   "blockTraffic": false,
    //   "definedTags": {},
    //   "displayName": "Excepteur laboris",
    //   "freeformTags": {},
    //   "publicIpId": "veniam est"
    // }

    // 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 wchar_t *compartmentId = jResp.stringOf(L"compartmentId");
    const wchar_t *vcnId = jResp.stringOf(L"vcnId");
    const wchar_t *natIp = jResp.stringOf(L"natIp");
    const wchar_t *id = jResp.stringOf(L"id");
    const wchar_t *lifecycleState = jResp.stringOf(L"lifecycleState");
    const wchar_t *timeCreated = jResp.stringOf(L"timeCreated");
    bool blockTraffic = jResp.BoolOf(L"blockTraffic");
    const wchar_t *displayName = jResp.stringOf(L"displayName");
    const wchar_t *publicIpId = jResp.stringOf(L"publicIpId");
    }

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "blockTraffic": false,
    "definedTags": {},
    "displayName": "sunt consectetur aliqua Excepteur ut",
    "freeformTags": {}
}'
https://iaas.{{region}}.oraclecloud.com/20160918/natGateways/:natGatewayId

Postman Collection Item JSON

{
  "name": "UpdateNatGateway",
  "request": {
    "method": "PUT",
    "header": [
      {
        "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/natGateways/:natGatewayId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "natGateways",
        ":natGatewayId"
      ],
      "variable": [
        {
          "key": "natGatewayId",
          "value": "ocid1.natgateway.oc1....",
          "description": "(Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
        }
      ]
    },
    "description": "Updates the specified NAT gateway.\n"
  },
  "response": [
    {
      "name": "The NAT gateway was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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\": \"et\",\n \"vcnId\": \"laboris dolor\",\n \"natIp\": \"ut ad minim commodo irure\",\n \"id\": \"ex mollit nostrud\",\n \"lifecycleState\": \"TERMINATED\",\n \"timeCreated\": \"1951-12-31T09:14:40.490Z\",\n \"blockTraffic\": false,\n \"definedTags\": {},\n \"displayName\": \"Excepteur laboris\",\n \"freeformTags\": {},\n \"publicIpId\": \"veniam est\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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": "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    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"sunt consectetur aliqua Excepteur ut\",\n    \"freeformTags\": {}\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways/:natGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways",
            ":natGatewayId"
          ],
          "variable": [
            {
              "key": "natGatewayId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}