Chilkat Online Tools

Foxpro / Core Services API / CreateNatGateway

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCompartmentId
LOCAL lcVcnId
LOCAL lcNatIp
LOCAL lcId
LOCAL lcLifecycleState
LOCAL lcTimeCreated
LOCAL lnBlockTraffic
LOCAL lcDisplayName
LOCAL lcPublicIpId

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

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

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("compartmentId","{{compartment_ocid}}")
loJson.UpdateString("vcnId","ocid1.vcn.oc1...")
loJson.UpdateBool("blockTraffic",0)
loJson.UpdateNewObject("definedTags")
loJson.UpdateString("displayName","esse ad consectetur reprehenderit labore")
loJson.UpdateNewObject("freeformTags")
loJson.UpdateString("publicIpId","in dolor dolor vel")

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

loResp = loHttp.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/natGateways","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcCompartmentId = loJResp.StringOf("compartmentId")
lcVcnId = loJResp.StringOf("vcnId")
lcNatIp = loJResp.StringOf("natIp")
lcId = loJResp.StringOf("id")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcTimeCreated = loJResp.StringOf("timeCreated")
lnBlockTraffic = loJResp.BoolOf("blockTraffic")
lcDisplayName = loJResp.StringOf("displayName")
lcPublicIpId = loJResp.StringOf("publicIpId")

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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