Chilkat Online Tools

Powershell / Core Services API / GetPublicIp

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.SetRequestHeader("Authorization","{{signature}}")
$http.SetRequestHeader("Date","{{date}}")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/:publicIpId",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$assignedEntityId = $jResp.StringOf("assignedEntityId")
$assignedEntityType = $jResp.StringOf("assignedEntityType")
$availabilityDomain = $jResp.StringOf("availabilityDomain")
$compartmentId = $jResp.StringOf("compartmentId")
$displayName = $jResp.StringOf("displayName")
$id = $jResp.StringOf("id")
$ipAddress = $jResp.StringOf("ipAddress")
$lifecycleState = $jResp.StringOf("lifecycleState")
$lifetime = $jResp.StringOf("lifetime")
$privateIpId = $jResp.StringOf("privateIpId")
$publicIpPoolId = $jResp.StringOf("publicIpPoolId")
$scope = $jResp.StringOf("scope")
$timeCreated = $jResp.StringOf("timeCreated")

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetPublicIp",
  "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}}/publicIps/:publicIpId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "publicIps",
        ":publicIpId"
      ],
      "variable": [
        {
          "key": "publicIpId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
        }
      ]
    },
    "description": "Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nAlternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress)\nwith the public IP address (for example, 203.0.113.2).\n\nOr you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId)\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to.\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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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}}/publicIps/:publicIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIps",
            ":publicIpId"
          ],
          "variable": [
            {
              "key": "publicIpId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}