Chilkat Online Tools

lianja / Core Services API / GetIPSecConnection

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
endif

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

lcCompartmentId = loJResp.StringOf("compartmentId")
lcId = loJResp.StringOf("id")
lcDrgId = loJResp.StringOf("drgId")
lcCpeId = loJResp.StringOf("cpeId")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcCpeLocalIdentifier = loJResp.StringOf("cpeLocalIdentifier")
lcCpeLocalIdentifierType = loJResp.StringOf("cpeLocalIdentifierType")
lcDisplayName = loJResp.StringOf("displayName")
lcTimeCreated = loJResp.StringOf("timeCreated")
i = 0
lnCount_i = loJResp.SizeOfArray("staticRoutes")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("staticRoutes[i]")
    i = i + 1
enddo


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

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