Chilkat Online Tools

Foxpro / Core Services API / GetNatGateway

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
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.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.SetRequestHeader("Authorization","{{signature}}")
loHttp.SetRequestHeader("Date","{{date}}")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/natGateways/:natGatewayId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

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

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

* 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 loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/natGateways/:natGatewayId

Postman Collection Item JSON

{
  "name": "GetNatGateway",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      }
    ],
    "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": "Gets the specified NAT gateway's information."
  },
  "response": [
    {
      "name": "The NAT gateway was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "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": "GET",
        "header": [
        ],
        "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": "GET",
        "header": [
        ],
        "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": "GET",
        "header": [
        ],
        "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": "Internal Server Error",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "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": "GET",
        "header": [
        ],
        "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}"
    }
  ]
}