Chilkat Online Tools

C / Core Services API / GetPublicIpByIpAddress

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *assignedEntityId;
    const char *assignedEntityType;
    const char *availabilityDomain;
    const char *compartmentId;
    const char *displayName;
    const char *id;
    const char *ipAddress;
    const char *lifecycleState;
    const char *lifetime;
    const char *privateIpId;
    const char *publicIpPoolId;
    const char *scope;
    const char *timeCreated;

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

    http = CkHttp_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 = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"ipAddress","commodo amet qui");

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

    resp = CkHttp_PostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

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

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

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

    CkHttpResponse_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 = CkJsonObject_stringOf(jResp,"assignedEntityId");
    assignedEntityType = CkJsonObject_stringOf(jResp,"assignedEntityType");
    availabilityDomain = CkJsonObject_stringOf(jResp,"availabilityDomain");
    compartmentId = CkJsonObject_stringOf(jResp,"compartmentId");
    displayName = CkJsonObject_stringOf(jResp,"displayName");
    id = CkJsonObject_stringOf(jResp,"id");
    ipAddress = CkJsonObject_stringOf(jResp,"ipAddress");
    lifecycleState = CkJsonObject_stringOf(jResp,"lifecycleState");
    lifetime = CkJsonObject_stringOf(jResp,"lifetime");
    privateIpId = CkJsonObject_stringOf(jResp,"privateIpId");
    publicIpPoolId = CkJsonObject_stringOf(jResp,"publicIpPoolId");
    scope = CkJsonObject_stringOf(jResp,"scope");
    timeCreated = CkJsonObject_stringOf(jResp,"timeCreated");


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