Chilkat Online Tools

TCL / Core Services API / CreateVlan

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "availabilityDomain": "es",
#   "compartmentId": "{{compartment_ocid}}",
#   "cidrBlock": "esse est",
#   "vcnId": "ea aute",
#   "definedTags": {},
#   "displayName": "esse",
#   "freeformTags": {},
#   "nsgIds": [
#     "elit",
#     "nisi consequat ea dolore"
#   ],
#   "routeTableId": "sint laboris sed",
#   "vlanTag": 2006
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "availabilityDomain" "es"
CkJsonObject_UpdateString $json "compartmentId" "{{compartment_ocid}}"
CkJsonObject_UpdateString $json "cidrBlock" "esse est"
CkJsonObject_UpdateString $json "vcnId" "ea aute"
CkJsonObject_UpdateNewObject $json "definedTags"
CkJsonObject_UpdateString $json "displayName" "esse"
CkJsonObject_UpdateNewObject $json "freeformTags"
CkJsonObject_UpdateString $json "nsgIds[0]" "elit"
CkJsonObject_UpdateString $json "nsgIds[1]" "nisi consequat ea dolore"
CkJsonObject_UpdateString $json "routeTableId" "sint laboris sed"
CkJsonObject_UpdateInt $json "vlanTag" 2006

CkHttp_SetRequestHeader $http "opc-retry-token" "aliqua enim i"
CkHttp_SetRequestHeader $http "opc-request-id" "8wF"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://iaas.{{region}}.oraclecloud.com/20160918/vlans" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# 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

set id [CkJsonObject_stringOf $jResp "id"]
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set cidrBlock [CkJsonObject_stringOf $jResp "cidrBlock"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set vcnId [CkJsonObject_stringOf $jResp "vcnId"]
set availabilityDomain [CkJsonObject_stringOf $jResp "availabilityDomain"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set routeTableId [CkJsonObject_stringOf $jResp "routeTableId"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set vlanTag [CkJsonObject_IntOf $jResp "vlanTag"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "nsgIds"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "nsgIds[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "opc-request-id: 8wF"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "availabilityDomain": "es",
    "compartmentId": "{{compartment_ocid}}",
    "cidrBlock": "esse est",
    "vcnId": "ea aute",
    "definedTags": {},
    "displayName": "esse",
    "freeformTags": {},
    "nsgIds": [
        "elit",
        "nisi consequat ea dolore"
    ],
    "routeTableId": "sint laboris sed",
    "vlanTag": 2006
}'
https://iaas.{{region}}.oraclecloud.com/20160918/vlans

Postman Collection Item JSON

{
  "name": "CreateVlan",
  "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"
      },
      {
        "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"{{compartment_ocid}}\",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/vlans",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "vlans"
      ]
    },
    "description": "Creates a VLAN in the specified VCN and the specified compartment.\n"
  },
  "response": [
    {
      "name": "The VLAN 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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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": "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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"
          },
          {
            "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    \"availabilityDomain\": \"es\",\n    \"compartmentId\": \"reprehenderit eu cillum \",\n    \"cidrBlock\": \"esse est\",\n    \"vcnId\": \"ea aute\",\n    \"definedTags\": {},\n    \"displayName\": \"esse\",\n    \"freeformTags\": {},\n    \"nsgIds\": [\n        \"elit\",\n        \"nisi consequat ea dolore\"\n    ],\n    \"routeTableId\": \"sint laboris sed\",\n    \"vlanTag\": 2006\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/vlans",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vlans"
          ]
        }
      },
      "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}"
    }
  ]
}