Chilkat Online Tools

Foxpro / Core Services API / GetPublicIpByIpAddress

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcAssignedEntityId
LOCAL lcAssignedEntityType
LOCAL lcAvailabilityDomain
LOCAL lcCompartmentId
LOCAL lcDisplayName
LOCAL lcId
LOCAL lcIpAddress
LOCAL lcLifecycleState
LOCAL lcLifetime
LOCAL lcPrivateIpId
LOCAL lcPublicIpPoolId
LOCAL lcScope
LOCAL lcTimeCreated

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

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

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("ipAddress","commodo amet qui")

loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("x-content-sha256","{{content_sha256}}")
loHttp.SetRequestHeader("Authorization","{{signature}}")
loHttp.SetRequestHeader("Date","{{date}}")

loResp = loHttp.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByIpAddress","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcAssignedEntityId = loJResp.StringOf("assignedEntityId")
lcAssignedEntityType = loJResp.StringOf("assignedEntityType")
lcAvailabilityDomain = loJResp.StringOf("availabilityDomain")
lcCompartmentId = loJResp.StringOf("compartmentId")
lcDisplayName = loJResp.StringOf("displayName")
lcId = loJResp.StringOf("id")
lcIpAddress = loJResp.StringOf("ipAddress")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcLifetime = loJResp.StringOf("lifetime")
lcPrivateIpId = loJResp.StringOf("privateIpId")
lcPublicIpPoolId = loJResp.StringOf("publicIpPoolId")
lcScope = loJResp.StringOf("scope")
lcTimeCreated = loJResp.StringOf("timeCreated")

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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