Chilkat Online Tools

Perl / Core Services API / GetNatGateway

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->SetRequestHeader("Authorization","{{signature}}");
$http->SetRequestHeader("Date","{{date}}");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/natGateways/:natGatewayId",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    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

$compartmentId = $jResp->stringOf("compartmentId");
$vcnId = $jResp->stringOf("vcnId");
$natIp = $jResp->stringOf("natIp");
$id = $jResp->stringOf("id");
$lifecycleState = $jResp->stringOf("lifecycleState");
$timeCreated = $jResp->stringOf("timeCreated");
$blockTraffic = $jResp->BoolOf("blockTraffic");
$displayName = $jResp->stringOf("displayName");
$publicIpId = $jResp->stringOf("publicIpId");

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