Chilkat Online Tools

Node.js / Core Services API / UpdateVlan

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.

    // {
    //   "definedTags": {},
    //   "displayName": "laboris tempor",
    //   "freeformTags": {},
    //   "nsgIds": [
    //     "culpa in",
    //     "do mollit dolore"
    //   ],
    //   "routeTableId": "ipsum ullamco Excepteur ut cillum"
    // }

    var json = new chilkat.JsonObject();
    json.UpdateNewObject("definedTags");
    json.UpdateString("displayName","laboris tempor");
    json.UpdateNewObject("freeformTags");
    json.UpdateString("nsgIds[0]","culpa in");
    json.UpdateString("nsgIds[1]","do mollit dolore");
    json.UpdateString("routeTableId","ipsum ullamco Excepteur ut cillum");

    http.SetRequestHeader("opc-request-id","8wF");
    http.SetRequestHeader("Content-Type","application/json");
    http.SetRequestHeader("x-content-sha256","{{content_sha256}}");
    http.SetRequestHeader("Authorization","{{signature}}");
    http.SetRequestHeader("Date","{{date}}");
    http.SetRequestHeader("if-match","officia sed");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);

    // resp: HttpResponse
    var resp = http.PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/vlans/:vlanId",sbRequestBody,"utf-8","application/json",false,false);
    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)

    // {
    //   "id": "magna in Lorem",
    //   "compartmentId": "amet ut quis",
    //   "cidrBlock": "consequat non",
    //   "lifecycleState": "AVAILABLE",
    //   "vcnId": "sit consectetur Ut qui",
    //   "availabilityDomain": "ea sunt officia mollit",
    //   "definedTags": {},
    //   "displayName": "ullamco magna eu",
    //   "freeformTags": {},
    //   "nsgIds": [
    //     "ad amet exercitation",
    //     "ut irure magna"
    //   ],
    //   "routeTableId": "sunt occaecat exercitation mollit",
    //   "timeCreated": "1974-12-31T12:49:21.840Z",
    //   "vlanTag": -19036463
    // }

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

    var strVal;

    var id = jResp.StringOf("id");
    var compartmentId = jResp.StringOf("compartmentId");
    var cidrBlock = jResp.StringOf("cidrBlock");
    var lifecycleState = jResp.StringOf("lifecycleState");
    var vcnId = jResp.StringOf("vcnId");
    var availabilityDomain = jResp.StringOf("availabilityDomain");
    var displayName = jResp.StringOf("displayName");
    var routeTableId = jResp.StringOf("routeTableId");
    var timeCreated = jResp.StringOf("timeCreated");
    var vlanTag = jResp.IntOf("vlanTag");
    var i = 0;
    var count_i = jResp.SizeOfArray("nsgIds");
    while (i < count_i) {
        jResp.I = i;
        strVal = jResp.StringOf("nsgIds[i]");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "opc-request-id: 8wF"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "displayName": "laboris tempor",
    "freeformTags": {},
    "nsgIds": [
        "culpa in",
        "do mollit dolore"
    ],
    "routeTableId": "ipsum ullamco Excepteur ut cillum"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/vlans/:vlanId

Postman Collection Item JSON

{
  "name": "UpdateVlan",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/vlans/:vlanId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "vlans",
        ":vlanId"
      ],
      "variable": [
        {
          "key": "vlanId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
        }
      ]
    },
    "description": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n"
  },
  "response": [
    {
      "name": "The VLAN was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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\": \"magna in Lorem\",\n \"compartmentId\": \"amet ut quis\",\n \"cidrBlock\": \"consequat non\",\n \"lifecycleState\": \"AVAILABLE\",\n \"vcnId\": \"sit consectetur Ut qui\",\n \"availabilityDomain\": \"ea sunt officia mollit\",\n \"definedTags\": {},\n \"displayName\": \"ullamco magna eu\",\n \"freeformTags\": {},\n \"nsgIds\": [\n  \"ad amet exercitation\",\n  \"ut irure magna\"\n ],\n \"routeTableId\": \"sunt occaecat exercitation mollit\",\n \"timeCreated\": \"1974-12-31T12:49:21.840Z\",\n \"vlanTag\": -19036463\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "status": "Precondition Failed",
      "code": 412,
      "_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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"laboris tempor\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"culpa in\",\n        \"do mollit dolore\"\n    ],\n    \"routeTableId\": \"ipsum ullamco Excepteur ut cillum\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans/:vlanId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans",
            ":vlanId"
          ],
          "variable": [
            {
              "key": "vlanId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}