Chilkat Online Tools

Perl / Core Services API / UpdatePrivateIp

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

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

# The following JSON is sent in the request body.

# {
#   "definedTags": {},
#   "displayName": "ullamco quis sed nostru",
#   "freeformTags": {},
#   "hostnameLabel": "t",
#   "vnicId": "magna labor"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateNewObject("definedTags");
$json->UpdateString("displayName","ullamco quis sed nostru");
$json->UpdateNewObject("freeformTags");
$json->UpdateString("hostnameLabel","t");
$json->UpdateString("vnicId","magna labor");

$http->SetRequestHeader("Content-Type","application/json");
$http->SetRequestHeader("x-content-sha256","{{content_sha256}}");
$http->SetRequestHeader("Authorization","{{signature}}");
$http->SetRequestHeader("Date","{{date}}");
$http->SetRequestHeader("if-match","officia sed");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# resp is a HttpResponse
$resp = $http->PTextSb("PUT","https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId",$sbRequestBody,"utf-8","application/json",0,0);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

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

# {
#   "availabilityDomain": "Excepteur",
#   "compartmentId": "dolore est sed",
#   "definedTags": {},
#   "displayName": "amet dolor qui fugiat",
#   "freeformTags": {},
#   "hostnameLabel": "pariatur Lorem in",
#   "id": "qui Ut",
#   "ipAddress": "proident irure non enim",
#   "isPrimary": true,
#   "lifecycleState": "TERMINATING",
#   "subnetId": "velit tempor officia incididunt ullamco",
#   "timeCreated": "2011-12-31T21:46:36.823Z",
#   "vlanId": "ut ullamco reprehenderit",
#   "vnicId": "magna"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$availabilityDomain = $jResp->stringOf("availabilityDomain");
$compartmentId = $jResp->stringOf("compartmentId");
$displayName = $jResp->stringOf("displayName");
$hostnameLabel = $jResp->stringOf("hostnameLabel");
$id = $jResp->stringOf("id");
$ipAddress = $jResp->stringOf("ipAddress");
$isPrimary = $jResp->BoolOf("isPrimary");
$lifecycleState = $jResp->stringOf("lifecycleState");
$subnetId = $jResp->stringOf("subnetId");
$timeCreated = $jResp->stringOf("timeCreated");
$vlanId = $jResp->stringOf("vlanId");
$vnicId = $jResp->stringOf("vnicId");

Curl Command

curl -X PUT
	-H "if-match: officia sed"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "displayName": "ullamco quis sed nostru",
    "freeformTags": {},
    "hostnameLabel": "t",
    "vnicId": "magna labor"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps/:privateIpId

Postman Collection Item JSON

{
  "name": "UpdatePrivateIp",
  "request": {
    "method": "PUT",
    "header": [
      {
        "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
        "key": "if-match",
        "value": "officia sed"
      },
      {
        "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    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/privateIps/:privateIpId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "privateIps",
        ":privateIpId"
      ],
      "variable": [
        {
          "key": "privateIpId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
        }
      ]
    },
    "description": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n  - Move a secondary private IP to a different VNIC in the same subnet.\n  - Change the display name for a secondary private IP.\n  - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n"
  },
  "response": [
    {
      "name": "The private IP was updated.",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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 \"availabilityDomain\": \"Excepteur\",\n \"compartmentId\": \"dolore est sed\",\n \"definedTags\": {},\n \"displayName\": \"amet dolor qui fugiat\",\n \"freeformTags\": {},\n \"hostnameLabel\": \"pariatur Lorem in\",\n \"id\": \"qui Ut\",\n \"ipAddress\": \"proident irure non enim\",\n \"isPrimary\": true,\n \"lifecycleState\": \"TERMINATING\",\n \"subnetId\": \"velit tempor officia incididunt ullamco\",\n \"timeCreated\": \"2011-12-31T21:46:36.823Z\",\n \"vlanId\": \"ut ullamco reprehenderit\",\n \"vnicId\": \"magna\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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": "Precondition Failed",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "status": "Precondition Failed",
      "code": 412,
      "_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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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": "PUT",
        "header": [
          {
            "description": "For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
            "key": "if-match",
            "value": "officia sed"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"ullamco quis sed nostru\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"t\",\n    \"vnicId\": \"magna labor\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps/:privateIpId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps",
            ":privateIpId"
          ],
          "variable": [
            {
              "key": "privateIpId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}