Chilkat Online Tools

Node.js / Core Services API / GetInternetGateway

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

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

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/internetGateways/:igId",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "id": "quis laborum eu",
    //   "compartmentId": "sed",
    //   "lifecycleState": "AVAILABLE",
    //   "vcnId": "fugiat nostrud",
    //   "definedTags": {},
    //   "displayName": "Ut reprehend",
    //   "freeformTags": {},
    //   "isEnabled": true,
    //   "timeCreated": "1994-01-17T22:51:32.949Z"
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var id = jResp.StringOf("id");
    var compartmentId = jResp.StringOf("compartmentId");
    var lifecycleState = jResp.StringOf("lifecycleState");
    var vcnId = jResp.StringOf("vcnId");
    var displayName = jResp.StringOf("displayName");
    var isEnabled = jResp.BoolOf("isEnabled");
    var timeCreated = jResp.StringOf("timeCreated");

}

chilkatExample();

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetInternetGateway",
  "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}}/internetGateways/:igId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "internetGateways",
        ":igId"
      ],
      "variable": [
        {
          "key": "igId",
          "value": "ocid1.internetgateway.oc1....",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
        }
      ]
    },
    "description": "Gets the specified internet gateway's information."
  },
  "response": [
    {
      "name": "The internet gateway was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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 \"id\": \"quis laborum eu\",\n \"compartmentId\": \"sed\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"fugiat nostrud\",\n \"definedTags\": {},\n \"displayName\": \"Ut reprehend\",\n \"freeformTags\": {},\n \"isEnabled\": true,\n \"timeCreated\": \"1994-01-17T22:51:32.949Z\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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}}/internetGateways/:igId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "internetGateways",
            ":igId"
          ],
          "variable": [
            {
              "key": "igId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}