phpExt / Core Services API / GetPublicIpByPrivateIpId
Back to Collection Items
<?php
include("chilkat_9_5_0.php");
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "privateIpId": "in ipsum ad id exercitation"
// }
$json = new CkJsonObject();
$json->UpdateString('privateIpId','in ipsum ad id exercitation');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-content-sha256','{{content_sha256}}');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByPrivateIpId','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
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 POST
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"privateIpId": "in ipsum ad id exercitation"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIps/actions/getByPrivateIpId
Postman Collection Item JSON
{
"name": "GetPublicIpByPrivateIpId",
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
},
"description": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\nprivate IP, or if you instead call\n[GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or\n[GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the\nservice returns the public IP object with `lifecycleState` = ASSIGNING and\n`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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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 \"privateIpId\": \"in ipsum ad id exercitation\"\n}"
},
"url": {
"raw": "{{baseUrl}}/publicIps/actions/getByPrivateIpId",
"host": [
"{{baseUrl}}"
],
"path": [
"publicIps",
"actions",
"getByPrivateIpId"
]
}
},
"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}"
}
]
}
