Chilkat Online Tools

PowerBuilder / Core Services API / GetIPSecConnectionTunnel

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_CompartmentId
string ls_Id
string ls_LifecycleState
string ls_Value
string ls_CustomerBgpAsnValue
string ls_CustomerInterfaceIpValue
string ls_OracleBgpAsnValue
string ls_OracleInterfaceIpValue
string ls_CpeIp
string ls_DisplayName
string ls_CpeTrafficSelectorValue
string ls_OracleTrafficSelectorValue
string ls_Routing
string ls_Status
string ls_TimeCreated
string ls_TimeStatusUpdated
string ls_VpnIp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

ls_CompartmentId = loo_JResp.StringOf("compartmentId")
ls_Id = loo_JResp.StringOf("id")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_Value = loo_JResp.StringOf("bgpSessionInfo.bgpState.value")
ls_CustomerBgpAsnValue = loo_JResp.StringOf("bgpSessionInfo.customerBgpAsn.value")
ls_CustomerInterfaceIpValue = loo_JResp.StringOf("bgpSessionInfo.customerInterfaceIp.value")
ls_OracleBgpAsnValue = loo_JResp.StringOf("bgpSessionInfo.oracleBgpAsn.value")
ls_OracleInterfaceIpValue = loo_JResp.StringOf("bgpSessionInfo.oracleInterfaceIp.value")
ls_CpeIp = loo_JResp.StringOf("cpeIp")
ls_DisplayName = loo_JResp.StringOf("displayName")
ls_CpeTrafficSelectorValue = loo_JResp.StringOf("encryptionDomainConfig.cpeTrafficSelector.value")
ls_OracleTrafficSelectorValue = loo_JResp.StringOf("encryptionDomainConfig.oracleTrafficSelector.value")
ls_Routing = loo_JResp.StringOf("routing")
ls_Status = loo_JResp.StringOf("status")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
ls_TimeStatusUpdated = loo_JResp.StringOf("timeStatusUpdated")
ls_VpnIp = loo_JResp.StringOf("vpnIp")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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