Chilkat Online Tools

Ruby / Core Services API / GetIPSecConnectionTunnel

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "compartmentId": "sit Duis deserunt in",
#   "id": "et consequat",
#   "lifecycleState": "PROVISIONING",
#   "bgpSessionInfo": {
#     "bgpState": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "customerBgpAsn": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "customerInterfaceIp": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "oracleBgpAsn": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "oracleInterfaceIp": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   },
#   "cpeIp": "mollit do sint",
#   "displayName": "adipisicing tempor",
#   "encryptionDomainConfig": {
#     "cpeTrafficSelector": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     },
#     "oracleTrafficSelector": {
#       "value": "<Error: Too many levels of nesting to fake this schema>"
#     }
#   },
#   "routing": "BGP",
#   "status": "DOWN",
#   "timeCreated": "1962-02-12T23:04:29.241Z",
#   "timeStatusUpdated": "1971-12-18T13:16:38.390Z",
#   "vpnIp": "cil"
# }

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

compartmentId = jResp.stringOf("compartmentId")
id = jResp.stringOf("id")
lifecycleState = jResp.stringOf("lifecycleState")
Value = jResp.stringOf("bgpSessionInfo.bgpState.value")
CustomerBgpAsnValue = jResp.stringOf("bgpSessionInfo.customerBgpAsn.value")
CustomerInterfaceIpValue = jResp.stringOf("bgpSessionInfo.customerInterfaceIp.value")
OracleBgpAsnValue = jResp.stringOf("bgpSessionInfo.oracleBgpAsn.value")
OracleInterfaceIpValue = jResp.stringOf("bgpSessionInfo.oracleInterfaceIp.value")
cpeIp = jResp.stringOf("cpeIp")
displayName = jResp.stringOf("displayName")
CpeTrafficSelectorValue = jResp.stringOf("encryptionDomainConfig.cpeTrafficSelector.value")
OracleTrafficSelectorValue = jResp.stringOf("encryptionDomainConfig.oracleTrafficSelector.value")
routing = jResp.stringOf("routing")
status = jResp.stringOf("status")
timeCreated = jResp.stringOf("timeCreated")
timeStatusUpdated = jResp.stringOf("timeStatusUpdated")
vpnIp = jResp.stringOf("vpnIp")

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId

Postman Collection Item JSON

{
  "name": "GetIPSecConnectionTunnel",
  "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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "ipsecConnections",
        ":ipscId",
        "tunnels",
        ":tunnelId"
      ],
      "variable": [
        {
          "key": "ipscId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
        },
        {
          "key": "tunnelId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
        }
      ]
    },
    "description": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n"
  },
  "response": [
    {
      "name": "The information was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId",
            "tunnels",
            ":tunnelId"
          ],
          "variable": [
            {
              "key": "ipscId"
            },
            {
              "key": "tunnelId"
            }
          ]
        }
      },
      "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\": \"sit Duis deserunt in\",\n \"id\": \"et consequat\",\n \"lifecycleState\": \"PROVISIONING\",\n \"bgpSessionInfo\": {\n  \"bgpState\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"customerBgpAsn\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"customerInterfaceIp\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"oracleBgpAsn\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"oracleInterfaceIp\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"cpeIp\": \"mollit do sint\",\n \"displayName\": \"adipisicing tempor\",\n \"encryptionDomainConfig\": {\n  \"cpeTrafficSelector\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"oracleTrafficSelector\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"routing\": \"BGP\",\n \"status\": \"DOWN\",\n \"timeCreated\": \"1962-02-12T23:04:29.241Z\",\n \"timeStatusUpdated\": \"1971-12-18T13:16:38.390Z\",\n \"vpnIp\": \"cil\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId",
            "tunnels",
            ":tunnelId"
          ],
          "variable": [
            {
              "key": "ipscId"
            },
            {
              "key": "tunnelId"
            }
          ]
        }
      },
      "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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId",
            "tunnels",
            ":tunnelId"
          ],
          "variable": [
            {
              "key": "ipscId"
            },
            {
              "key": "tunnelId"
            }
          ]
        }
      },
      "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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId",
            "tunnels",
            ":tunnelId"
          ],
          "variable": [
            {
              "key": "ipscId"
            },
            {
              "key": "tunnelId"
            }
          ]
        }
      },
      "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}}/ipsecConnections/:ipscId/tunnels/:tunnelId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId",
            "tunnels",
            ":tunnelId"
          ],
          "variable": [
            {
              "key": "ipscId"
            },
            {
              "key": "tunnelId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}