Chilkat Online Tools

TCL / Core Services API / GetLocalPeeringGateway

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]

CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways/:localPeeringGatewayId" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

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

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set id [CkJsonObject_stringOf $jResp "id"]
set peerId [CkJsonObject_stringOf $jResp "peerId"]
set isCrossTenancyPeering [CkJsonObject_BoolOf $jResp "isCrossTenancyPeering"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set peeringStatus [CkJsonObject_stringOf $jResp "peeringStatus"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set vcnId [CkJsonObject_stringOf $jResp "vcnId"]
set peerAdvertisedCidr [CkJsonObject_stringOf $jResp "peerAdvertisedCidr"]
set peeringStatusDetails [CkJsonObject_stringOf $jResp "peeringStatusDetails"]
set routeTableId [CkJsonObject_stringOf $jResp "routeTableId"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "peerAdvertisedCidrDetails"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "peerAdvertisedCidrDetails[i]"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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}"
    }
  ]
}