Chilkat Online Tools

unicodeC / Core Services API / GetLocalPeeringGateway

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *strVal;
    const wchar_t *compartmentId;
    const wchar_t *displayName;
    const wchar_t *id;
    const wchar_t *peerId;
    BOOL isCrossTenancyPeering;
    const wchar_t *lifecycleState;
    const wchar_t *peeringStatus;
    const wchar_t *timeCreated;
    const wchar_t *vcnId;
    const wchar_t *peerAdvertisedCidr;
    const wchar_t *peeringStatusDetails;
    const wchar_t *routeTableId;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

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

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways/:localPeeringGatewayId",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "compartmentId": "dolore tempor ",
    //   "displayName": "amet sit",
    //   "id": "adipisicing nulla esse",
    //   "peerId": "incididunt dolor commodo ex do",
    //   "isCrossTenancyPeering": true,
    //   "lifecycleState": "TERMINATED",
    //   "peeringStatus": "PEERED",
    //   "timeCreated": "1961-11-06T04:30:14.685Z",
    //   "vcnId": "reprehenderit enim in nisi sit",
    //   "definedTags": {},
    //   "freeformTags": {},
    //   "peerAdvertisedCidr": "ex pariatur",
    //   "peerAdvertisedCidrDetails": [
    //     "utpariatur d",
    //     "consequat quis "
    //   ],
    //   "peeringStatusDetails": "sunt veniam dolo",
    //   "routeTableId": "commodo"
    // }

    // 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 = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    id = CkJsonObjectW_stringOf(jResp,L"id");
    peerId = CkJsonObjectW_stringOf(jResp,L"peerId");
    isCrossTenancyPeering = CkJsonObjectW_BoolOf(jResp,L"isCrossTenancyPeering");
    lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
    peeringStatus = CkJsonObjectW_stringOf(jResp,L"peeringStatus");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
    vcnId = CkJsonObjectW_stringOf(jResp,L"vcnId");
    peerAdvertisedCidr = CkJsonObjectW_stringOf(jResp,L"peerAdvertisedCidr");
    peeringStatusDetails = CkJsonObjectW_stringOf(jResp,L"peeringStatusDetails");
    routeTableId = CkJsonObjectW_stringOf(jResp,L"routeTableId");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"peerAdvertisedCidrDetails");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        strVal = CkJsonObjectW_stringOf(jResp,L"peerAdvertisedCidrDetails[i]");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/localPeeringGateways/:localPeeringGatewayId

Postman Collection Item JSON

{
  "name": "GetLocalPeeringGateway",
  "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}}/localPeeringGateways/:localPeeringGatewayId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "localPeeringGateways",
        ":localPeeringGatewayId"
      ],
      "variable": [
        {
          "key": "localPeeringGatewayId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
        }
      ]
    },
    "description": "Gets the specified local peering gateway's information."
  },
  "response": [
    {
      "name": "The local peering gateway was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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\": \"dolore tempor \",\n \"displayName\": \"amet sit\",\n \"id\": \"adipisicing nulla esse\",\n \"peerId\": \"incididunt dolor commodo ex do\",\n \"isCrossTenancyPeering\": true,\n \"lifecycleState\": \"TERMINATED\",\n \"peeringStatus\": \"PEERED\",\n \"timeCreated\": \"1961-11-06T04:30:14.685Z\",\n \"vcnId\": \"reprehenderit enim in nisi sit\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"peerAdvertisedCidr\": \"ex pariatur\",\n \"peerAdvertisedCidrDetails\": [\n  \"utpariatur d\",\n  \"consequat quis \"\n ],\n \"peeringStatusDetails\": \"sunt veniam dolo\",\n \"routeTableId\": \"commodo\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}}/localPeeringGateways/:localPeeringGatewayId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "localPeeringGateways",
            ":localPeeringGatewayId"
          ],
          "variable": [
            {
              "key": "localPeeringGatewayId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}