Chilkat Online Tools

autoit / Core Services API / GetLocalPeeringGateway

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/localPeeringGateways/:localPeeringGatewayId",$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)

; {
;   "compartmentId": "dolore tempor ",
;   "displayName": "amet sit",
;   "id": "adipisicing nulla esse",
;   "peerId": "incididunt dolor commodo ex do",
;   "isCrossTenancyPeering": true,
;   "lifecycleState": "TERMINATED",
;   "peeringStatus": "PEERED",
;   "timeCreated": "1961-11-06T04:30:14.685Z",
;   "vcnId": "reprehenderit enim in nisi sit",
;   "definedTags": {},
;   "freeformTags": {},
;   "peerAdvertisedCidr": "ex pariatur",
;   "peerAdvertisedCidrDetails": [
;     "utpariatur d",
;     "consequat quis "
;   ],
;   "peeringStatusDetails": "sunt veniam dolo",
;   "routeTableId": "commodo"
; }

; 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 $sCompartmentId = $oJResp.StringOf("compartmentId")
Local $sDisplayName = $oJResp.StringOf("displayName")
Local $sId = $oJResp.StringOf("id")
Local $sPeerId = $oJResp.StringOf("peerId")
Local $bIsCrossTenancyPeering = $oJResp.BoolOf("isCrossTenancyPeering")
Local $sLifecycleState = $oJResp.StringOf("lifecycleState")
Local $sPeeringStatus = $oJResp.StringOf("peeringStatus")
Local $sTimeCreated = $oJResp.StringOf("timeCreated")
Local $sVcnId = $oJResp.StringOf("vcnId")
Local $sPeerAdvertisedCidr = $oJResp.StringOf("peerAdvertisedCidr")
Local $sPeeringStatusDetails = $oJResp.StringOf("peeringStatusDetails")
Local $sRouteTableId = $oJResp.StringOf("routeTableId")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("peerAdvertisedCidrDetails")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("peerAdvertisedCidrDetails[i]")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetLocalPeeringGateway",
  "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}}/localPeeringGateways/:localPeeringGatewayId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "localPeeringGateways",
        ":localPeeringGatewayId"
      ],
      "variable": [
        {
          "key": "localPeeringGatewayId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
        }
      ]
    },
    "description": "Gets the specified local peering gateway's information."
  },
  "response": [
    {
      "name": "The local peering gateway was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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 \"compartmentId\": \"dolore tempor \",\n \"displayName\": \"amet sit\",\n \"id\": \"adipisicing nulla esse\",\n \"peerId\": \"incididunt dolor commodo ex do\",\n \"isCrossTenancyPeering\": true,\n \"lifecycleState\": \"TERMINATED\",\n \"peeringStatus\": \"PEERED\",\n \"timeCreated\": \"1961-11-06T04:30:14.685Z\",\n \"vcnId\": \"reprehenderit enim in nisi sit\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"peerAdvertisedCidr\": \"ex pariatur\",\n \"peerAdvertisedCidrDetails\": [\n  \"utpariatur d\",\n  \"consequat quis \"\n ],\n \"peeringStatusDetails\": \"sunt veniam dolo\",\n \"routeTableId\": \"commodo\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}