Chilkat Online Tools

Foxpro / Core Services API / GetIPSecConnectionTunnel

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCompartmentId
LOCAL lcId
LOCAL lcLifecycleState
LOCAL lcValue
LOCAL lcCustomerBgpAsnValue
LOCAL lcCustomerInterfaceIpValue
LOCAL lcOracleBgpAsnValue
LOCAL lcOracleInterfaceIpValue
LOCAL lcCpeIp
LOCAL lcDisplayName
LOCAL lcCpeTrafficSelectorValue
LOCAL lcOracleTrafficSelectorValue
LOCAL lcRouting
LOCAL lcStatus
LOCAL lcTimeCreated
LOCAL lcTimeStatusUpdated
LOCAL lcVpnIp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcCompartmentId = loJResp.StringOf("compartmentId")
lcId = loJResp.StringOf("id")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcValue = loJResp.StringOf("bgpSessionInfo.bgpState.value")
lcCustomerBgpAsnValue = loJResp.StringOf("bgpSessionInfo.customerBgpAsn.value")
lcCustomerInterfaceIpValue = loJResp.StringOf("bgpSessionInfo.customerInterfaceIp.value")
lcOracleBgpAsnValue = loJResp.StringOf("bgpSessionInfo.oracleBgpAsn.value")
lcOracleInterfaceIpValue = loJResp.StringOf("bgpSessionInfo.oracleInterfaceIp.value")
lcCpeIp = loJResp.StringOf("cpeIp")
lcDisplayName = loJResp.StringOf("displayName")
lcCpeTrafficSelectorValue = loJResp.StringOf("encryptionDomainConfig.cpeTrafficSelector.value")
lcOracleTrafficSelectorValue = loJResp.StringOf("encryptionDomainConfig.oracleTrafficSelector.value")
lcRouting = loJResp.StringOf("routing")
lcStatus = loJResp.StringOf("status")
lcTimeCreated = loJResp.StringOf("timeCreated")
lcTimeStatusUpdated = loJResp.StringOf("timeStatusUpdated")
lcVpnIp = loJResp.StringOf("vpnIp")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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