Chilkat Online Tools

Node.js / Core Services API / CreateServiceGateway

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;

    // 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....",
    //   "services": [
    //     {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   ],
    //   "definedTags": {},
    //   "displayName": "tempor esse",
    //   "freeformTags": {},
    //   "routeTableId": "ut"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateString("compartmentId","{{compartment_ocid}}");
    json.UpdateString("vcnId","ocid1.vcn.oc1....");
    json.UpdateString("services[0].value","<Error: Too many levels of nesting to fake this schema>");
    json.UpdateNewObject("definedTags");
    json.UpdateString("displayName","tempor esse");
    json.UpdateNewObject("freeformTags");
    json.UpdateString("routeTableId","ut");

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

    // resp: HttpResponse
    var resp = http.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways","application/json",json);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

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

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

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

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

    // {
    //   "compartmentId": "ut eu",
    //   "id": "tempor anim",
    //   "lifecycleState": "PROVISIONING",
    //   "vcnId": "fugiat mollit Lorem",
    //   "blockTraffic": false,
    //   "services": [
    //     {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   ],
    //   "definedTags": {},
    //   "displayName": "irure Lorem sit reprehenderit",
    //   "freeformTags": {},
    //   "routeTableId": "sunt ut",
    //   "timeCreated": "1970-01-23T01:47:19.226Z"
    // }

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

    var value;

    var compartmentId = jResp.StringOf("compartmentId");
    var id = jResp.StringOf("id");
    var lifecycleState = jResp.StringOf("lifecycleState");
    var vcnId = jResp.StringOf("vcnId");
    var blockTraffic = jResp.BoolOf("blockTraffic");
    var displayName = jResp.StringOf("displayName");
    var routeTableId = jResp.StringOf("routeTableId");
    var timeCreated = jResp.StringOf("timeCreated");
    var i = 0;
    var count_i = jResp.SizeOfArray("services");
    while (i < count_i) {
        jResp.I = i;
        value = jResp.StringOf("services[i].value");
        i = i+1;
    }


}

chilkatExample();

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....",
    "services": [
        {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    ],
    "definedTags": {},
    "displayName": "tempor esse",
    "freeformTags": {},
    "routeTableId": "ut"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/serviceGateways

Postman Collection Item JSON

{
  "name": "CreateServiceGateway",
  "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    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"tempor esse\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"ut\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/serviceGateways",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "serviceGateways"
      ]
    },
    "description": "Creates a new service gateway in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe service gateway to reside. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the service gateway, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n"
  },
  "response": [
    {
      "name": "The service 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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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 \"compartmentId\": \"ut eu\",\n \"id\": \"tempor anim\",\n \"lifecycleState\": \"PROVISIONING\",\n \"vcnId\": \"fugiat mollit Lorem\",\n \"blockTraffic\": false,\n \"services\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"definedTags\": {},\n \"displayName\": \"irure Lorem sit reprehenderit\",\n \"freeformTags\": {},\n \"routeTableId\": \"sunt ut\",\n \"timeCreated\": \"1970-01-23T01:47:19.226Z\"\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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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\": \"occaecat\",\n    \"vcnId\": \"ullamco qui\",\n    \"services\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"laborum adipisicing minim\",\n    \"freeformTags\": {},\n    \"routeTableId\": \"anim\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/serviceGateways",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "serviceGateways"
          ]
        }
      },
      "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}"
    }
  ]
}