Chilkat Online Tools

TCL / Core Services API / CreateNatGateway

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.

# {
#   "compartmentId": "{{compartment_ocid}}",
#   "vcnId": "ocid1.vcn.oc1...",
#   "blockTraffic": false,
#   "definedTags": {},
#   "displayName": "esse ad consectetur reprehenderit labore",
#   "freeformTags": {},
#   "publicIpId": "in dolor dolor vel"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "compartmentId" "{{compartment_ocid}}"
CkJsonObject_UpdateString $json "vcnId" "ocid1.vcn.oc1..."
CkJsonObject_UpdateBool $json "blockTraffic" 0
CkJsonObject_UpdateNewObject $json "definedTags"
CkJsonObject_UpdateString $json "displayName" "esse ad consectetur reprehenderit labore"
CkJsonObject_UpdateNewObject $json "freeformTags"
CkJsonObject_UpdateString $json "publicIpId" "in dolor dolor vel"

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}}"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://iaas.{{region}}.oraclecloud.com/20160918/natGateways" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    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_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set vcnId [CkJsonObject_stringOf $jResp "vcnId"]
set natIp [CkJsonObject_stringOf $jResp "natIp"]
set id [CkJsonObject_stringOf $jResp "id"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set blockTraffic [CkJsonObject_BoolOf $jResp "blockTraffic"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set publicIpId [CkJsonObject_stringOf $jResp "publicIpId"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
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 '{
    "compartmentId": "{{compartment_ocid}}",
    "vcnId": "ocid1.vcn.oc1...",
    "blockTraffic": false,
    "definedTags": {},
    "displayName": "esse ad consectetur reprehenderit labore",
    "freeformTags": {},
    "publicIpId": "in dolor dolor vel"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/natGateways

Postman Collection Item JSON

{
  "name": "CreateNatGateway",
  "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    \"compartmentId\": \"{{compartment_ocid}}\",\n    \"vcnId\": \"ocid1.vcn.oc1...\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/natGateways",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "natGateways"
      ]
    },
    "description": "Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the\nNAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).\n"
  },
  "response": [
    {
      "name": "The NAT gateway was created.",
      "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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": "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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": "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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": "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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    \"compartmentId\": \"elit esse Excepteur ea ipsum\",\n    \"vcnId\": \"est dolor nostrud\",\n    \"blockTraffic\": false,\n    \"definedTags\": {},\n    \"displayName\": \"esse ad consectetur reprehenderit labore\",\n    \"freeformTags\": {},\n    \"publicIpId\": \"in dolor dolor vel\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/natGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "natGateways"
          ]
        }
      },
      "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}"
    }
  ]
}