Chilkat Online Tools

PowerBuilder / Core Services API / GetIPSecConnection

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_CompartmentId
string ls_Id
string ls_DrgId
string ls_CpeId
string ls_LifecycleState
string ls_CpeLocalIdentifier
string ls_CpeLocalIdentifierType
string ls_DisplayName
string ls_TimeCreated
integer i
integer li_Count_i

// 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",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": "magna proident dolor",
//   "id": "proident ipsum Excepteur",
//   "drgId": "amet velit fugiat",
//   "cpeId": "et enim exercitation voluptate ut",
//   "lifecycleState": "TERMINATED",
//   "staticRoutes": [
//     "n",
//     "i"
//   ],
//   "cpeLocalIdentifier": "anim est in reprehenderit",
//   "cpeLocalIdentifierType": "HOSTNAME",
//   "definedTags": {},
//   "displayName": "sit",
//   "freeformTags": {},
//   "timeCreated": "1953-03-10T14:08:02.379Z"
// }

// 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_DrgId = loo_JResp.StringOf("drgId")
ls_CpeId = loo_JResp.StringOf("cpeId")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_CpeLocalIdentifier = loo_JResp.StringOf("cpeLocalIdentifier")
ls_CpeLocalIdentifierType = loo_JResp.StringOf("cpeLocalIdentifierType")
ls_DisplayName = loo_JResp.StringOf("displayName")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
i = 0
li_Count_i = loo_JResp.SizeOfArray("staticRoutes")
do while i < li_Count_i
    loo_JResp.I = i
    ls_StrVal = loo_JResp.StringOf("staticRoutes[i]")
    i = i + 1
loop


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

Postman Collection Item JSON

{
  "name": "GetIPSecConnection",
  "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "ipsecConnections",
        ":ipscId"
      ],
      "variable": [
        {
          "key": "ipscId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
        }
      ]
    },
    "description": "Gets the specified IPSec connection's basic information, including the static routes for the\non-premises router. If you want the status of the connection (whether it's up or down), use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n"
  },
  "response": [
    {
      "name": "The information was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections/:ipscId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId"
          ],
          "variable": [
            {
              "key": "ipscId"
            }
          ]
        }
      },
      "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\": \"magna proident dolor\",\n \"id\": \"proident ipsum Excepteur\",\n \"drgId\": \"amet velit fugiat\",\n \"cpeId\": \"et enim exercitation voluptate ut\",\n \"lifecycleState\": \"TERMINATED\",\n \"staticRoutes\": [\n  \"n\",\n  \"i\"\n ],\n \"cpeLocalIdentifier\": \"anim est in reprehenderit\",\n \"cpeLocalIdentifierType\": \"HOSTNAME\",\n \"definedTags\": {},\n \"displayName\": \"sit\",\n \"freeformTags\": {},\n \"timeCreated\": \"1953-03-10T14:08:02.379Z\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/ipsecConnections/:ipscId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId"
          ],
          "variable": [
            {
              "key": "ipscId"
            }
          ]
        }
      },
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId"
          ],
          "variable": [
            {
              "key": "ipscId"
            }
          ]
        }
      },
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId"
          ],
          "variable": [
            {
              "key": "ipscId"
            }
          ]
        }
      },
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "ipsecConnections",
            ":ipscId"
          ],
          "variable": [
            {
              "key": "ipscId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}