Chilkat Online Tools

phpExt / Core Services API / CreatePrivateIp

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// 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.

// {
//   "definedTags": {},
//   "displayName": "dolore nostrud",
//   "freeformTags": {},
//   "hostnameLabel": "et dolor incididunt veniam",
//   "ipAddress": "ut mollit a",
//   "vlanId": "anim aute dolore",
//   "vnicId": "elit adipisicing "
// }

$json = new CkJsonObject();
$json->UpdateNewObject('definedTags');
$json->UpdateString('displayName','dolore nostrud');
$json->UpdateNewObject('freeformTags');
$json->UpdateString('hostnameLabel','et dolor incididunt veniam');
$json->UpdateString('ipAddress','ut mollit a');
$json->UpdateString('vlanId','anim aute dolore');
$json->UpdateString('vnicId','elit adipisicing ');

$http->SetRequestHeader('opc-retry-token','aliqua enim i');
$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/privateIps','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)

// {
//   "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 POST
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "definedTags": {},
    "displayName": "dolore nostrud",
    "freeformTags": {},
    "hostnameLabel": "et dolor incididunt veniam",
    "ipAddress": "ut mollit a",
    "vlanId": "anim aute dolore",
    "vnicId": "elit adipisicing "
}'
https://iaas.{{region}}.oraclecloud.com/20160918/privateIps

Postman Collection Item JSON

{
  "name": "CreatePrivateIp",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "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\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/privateIps",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "privateIps"
      ]
    },
    "description": "Creates a secondary private IP for the specified VNIC.\nFor more information about secondary private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n"
  },
  "response": [
    {
      "name": "The private IP was created.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"definedTags\": {},\n    \"displayName\": \"dolore nostrud\",\n    \"freeformTags\": {},\n    \"hostnameLabel\": \"et dolor incididunt veniam\",\n    \"ipAddress\": \"ut mollit a\",\n    \"vlanId\": \"anim aute dolore\",\n    \"vnicId\": \"elit adipisicing \"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/privateIps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "privateIps"
          ]
        }
      },
      "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}"
    }
  ]
}