Chilkat Online Tools

autoit / Core Services API / GetVcn

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.SetRequestHeader "Authorization","{{signature}}"
$oHttp.SetRequestHeader "Date","{{date}}"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/vcns/:vcnId",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "id": "id magna consectetur",
;   "compartmentId": "proident ullamco et non",
;   "cidrBlock": "ut amet la",
;   "lifecycleState": "TERMINATING",
;   "cidrBlocks": [
;     "et",
;     "amet"
;   ],
;   "defaultDhcpOptionsId": "qui officia reprehenderit Ut",
;   "defaultRouteTableId": "nulla incididunt exercitation fugiat",
;   "defaultSecurityListId": "eiusmod sint aliqua",
;   "definedTags": {},
;   "displayName": "in",
;   "dnsLabel": "qui cupida",
;   "freeformTags": {},
;   "ipv6CidrBlock": "aute Excepteur",
;   "ipv6PublicCidrBlock": "dolore ex dolor Lorem adipisicing",
;   "timeCreated": "1985-03-26T20:05:22.459Z",
;   "vcnDomainName": "ex laborum magna"
; }

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

Local $strVal

Local $sId = $oJResp.StringOf("id")
Local $sCompartmentId = $oJResp.StringOf("compartmentId")
Local $sCidrBlock = $oJResp.StringOf("cidrBlock")
Local $sLifecycleState = $oJResp.StringOf("lifecycleState")
Local $sDefaultDhcpOptionsId = $oJResp.StringOf("defaultDhcpOptionsId")
Local $sDefaultRouteTableId = $oJResp.StringOf("defaultRouteTableId")
Local $sDefaultSecurityListId = $oJResp.StringOf("defaultSecurityListId")
Local $sDisplayName = $oJResp.StringOf("displayName")
Local $sDnsLabel = $oJResp.StringOf("dnsLabel")
Local $sIpv6CidrBlock = $oJResp.StringOf("ipv6CidrBlock")
Local $sIpv6PublicCidrBlock = $oJResp.StringOf("ipv6PublicCidrBlock")
Local $sTimeCreated = $oJResp.StringOf("timeCreated")
Local $sVcnDomainName = $oJResp.StringOf("vcnDomainName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("cidrBlocks")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("cidrBlocks[i]")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetVcn",
  "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}}/vcns/:vcnId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "vcns",
        ":vcnId"
      ],
      "variable": [
        {
          "key": "vcnId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
        }
      ]
    },
    "description": "Gets the specified VCN's information."
  },
  "response": [
    {
      "name": "The VCN was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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\": \"id magna consectetur\",\n \"compartmentId\": \"proident ullamco et non\",\n \"cidrBlock\": \"ut amet la\",\n \"lifecycleState\": \"TERMINATING\",\n \"cidrBlocks\": [\n  \"et\",\n  \"amet\"\n ],\n \"defaultDhcpOptionsId\": \"qui officia reprehenderit Ut\",\n \"defaultRouteTableId\": \"nulla incididunt exercitation fugiat\",\n \"defaultSecurityListId\": \"eiusmod sint aliqua\",\n \"definedTags\": {},\n \"displayName\": \"in\",\n \"dnsLabel\": \"qui cupida\",\n \"freeformTags\": {},\n \"ipv6CidrBlock\": \"aute Excepteur\",\n \"ipv6PublicCidrBlock\": \"dolore ex dolor Lorem adipisicing\",\n \"timeCreated\": \"1985-03-26T20:05:22.459Z\",\n \"vcnDomainName\": \"ex laborum magna\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}}/vcns/:vcnId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "vcns",
            ":vcnId"
          ],
          "variable": [
            {
              "key": "vcnId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}