Chilkat Online Tools

unicodeC / Core Services API / GetPublicIpByIpAddress

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *assignedEntityId;
    const wchar_t *assignedEntityType;
    const wchar_t *availabilityDomain;
    const wchar_t *compartmentId;
    const wchar_t *displayName;
    const wchar_t *id;
    const wchar_t *ipAddress;
    const wchar_t *lifecycleState;
    const wchar_t *lifetime;
    const wchar_t *privateIpId;
    const wchar_t *publicIpPoolId;
    const wchar_t *scope;
    const wchar_t *timeCreated;

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

    http = CkHttpW_Create();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "ipAddress": "commodo amet qui"
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"ipAddress",L"commodo amet qui");

    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
    CkHttpW_SetRequestHeader(http,L"x-content-sha256",L"{{content_sha256}}");
    CkHttpW_SetRequestHeader(http,L"Authorization",L"{{signature}}");
    CkHttpW_SetRequestHeader(http,L"Date",L"{{date}}");

    resp = CkHttpW_PostJson3(http,L"https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

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

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

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

    CkHttpResponseW_Dispose(resp);

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

    // {
    //   "assignedEntityId": "eu reprehenderit aliquip nulla",
    //   "assignedEntityType": "NAT_GATEWAY",
    //   "availabilityDomain": "irure commodo",
    //   "compartmentId": "est dolor proident",
    //   "definedTags": {},
    //   "displayName": "ipsum quis dolore",
    //   "freeformTags": {},
    //   "id": "sint commodo dolor culpa",
    //   "ipAddress": "dolore quis esse aliqua",
    //   "lifecycleState": "UNASSIGNED",
    //   "lifetime": "EPHEMERAL",
    //   "privateIpId": "non in consectetur laborum nostrud",
    //   "publicIpPoolId": "quis aliquip anim",
    //   "scope": "REGION",
    //   "timeCreated": "1986-03-06T20:25:38.760Z"
    // }

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

    assignedEntityId = CkJsonObjectW_stringOf(jResp,L"assignedEntityId");
    assignedEntityType = CkJsonObjectW_stringOf(jResp,L"assignedEntityType");
    availabilityDomain = CkJsonObjectW_stringOf(jResp,L"availabilityDomain");
    compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    id = CkJsonObjectW_stringOf(jResp,L"id");
    ipAddress = CkJsonObjectW_stringOf(jResp,L"ipAddress");
    lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
    lifetime = CkJsonObjectW_stringOf(jResp,L"lifetime");
    privateIpId = CkJsonObjectW_stringOf(jResp,L"privateIpId");
    publicIpPoolId = CkJsonObjectW_stringOf(jResp,L"publicIpPoolId");
    scope = CkJsonObjectW_stringOf(jResp,L"scope");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");


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

    }

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "ipAddress": "commodo amet qui"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress

Postman Collection Item JSON

{
  "name": "GetPublicIpByIpAddress",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "publicIps",
        "actions",
        "getByIpAddress"
      ]
    },
    "description": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n"
  },
  "response": [
    {
      "name": "The public IP was retrieved.",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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 \"assignedEntityId\": \"eu reprehenderit aliquip nulla\",\n \"assignedEntityType\": \"NAT_GATEWAY\",\n \"availabilityDomain\": \"irure commodo\",\n \"compartmentId\": \"est dolor proident\",\n \"definedTags\": {},\n \"displayName\": \"ipsum quis dolore\",\n \"freeformTags\": {},\n \"id\": \"sint commodo dolor culpa\",\n \"ipAddress\": \"dolore quis esse aliqua\",\n \"lifecycleState\": \"UNASSIGNED\",\n \"lifetime\": \"EPHEMERAL\",\n \"privateIpId\": \"non in consectetur laborum nostrud\",\n \"publicIpPoolId\": \"quis aliquip anim\",\n \"scope\": \"REGION\",\n \"timeCreated\": \"1986-03-06T20:25:38.760Z\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"ipAddress\": \"commodo amet qui\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIps/actions/getByIpAddress",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            "actions",
            "getByIpAddress"
          ]
        }
      },
      "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}"
    }
  ]
}