Chilkat Online Tools

C / Core Services API / GetIPSecConnectionTunnel

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *compartmentId;
    const char *id;
    const char *lifecycleState;
    const char *Value;
    const char *CustomerBgpAsnValue;
    const char *CustomerInterfaceIpValue;
    const char *OracleBgpAsnValue;
    const char *OracleInterfaceIpValue;
    const char *cpeIp;
    const char *displayName;
    const char *CpeTrafficSelectorValue;
    const char *OracleTrafficSelectorValue;
    const char *routing;
    const char *status;
    const char *timeCreated;
    const char *timeStatusUpdated;
    const char *vpnIp;

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

    http = CkHttp_Create();

    CkHttp_SetRequestHeader(http,"Authorization","{{signature}}");
    CkHttp_SetRequestHeader(http,"Date","{{date}}");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

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


    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(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}"
    }
  ]
}