Chilkat Online Tools

phpAx / Core Services API / UpdateVolume

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.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.

// {
//   "blockVolumeReplicas": [
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   ],
//   "definedTags": {},
//   "displayName": "sunt non",
//   "freeformTags": {},
//   "isAutoTuneEnabled": true,
//   "sizeInGBs": -35753331,
//   "vpusPerGB": -34400178
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('blockVolumeReplicas[0].value','<Error: Too many levels of nesting to fake this schema>');
$json->UpdateNewObject('definedTags');
$json->UpdateString('displayName','sunt non');
$json->UpdateNewObject('freeformTags');
$json->UpdateBool('isAutoTuneEnabled',1);
$json->UpdateInt('sizeInGBs',-35753331);
$json->UpdateInt('vpusPerGB',-34400178);

$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');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

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

$respStatusCode = $resp->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)

// {
//   "id": "dolore magna fugiat",
//   "availabilityDomain": "ut",
//   "displayName": "ut velit commodo",
//   "sizeInMBs": -55113189,
//   "compartmentId": "et ullamco consequat u",
//   "timeCreated": "1988-12-07T08:21:37.359Z",
//   "lifecycleState": "PROVISIONING",
//   "autoTunedVpusPerGB": -84866272,
//   "blockVolumeReplicas": [
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   ],
//   "definedTags": {},
//   "freeformTags": {},
//   "isAutoTuneEnabled": false,
//   "isHydrated": true,
//   "kmsKeyId": "ullamco",
//   "sizeInGBs": -13490866,
//   "sourceDetails": {
//     "type": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   "volumeGroupId": "proident eu velit",
//   "vpusPerGB": -99437639
// }

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

$id = $jResp->stringOf('id');
$availabilityDomain = $jResp->stringOf('availabilityDomain');
$displayName = $jResp->stringOf('displayName');
$sizeInMBs = $jResp->IntOf('sizeInMBs');
$compartmentId = $jResp->stringOf('compartmentId');
$timeCreated = $jResp->stringOf('timeCreated');
$lifecycleState = $jResp->stringOf('lifecycleState');
$autoTunedVpusPerGB = $jResp->IntOf('autoTunedVpusPerGB');
$isAutoTuneEnabled = $jResp->BoolOf('isAutoTuneEnabled');
$isHydrated = $jResp->BoolOf('isHydrated');
$kmsKeyId = $jResp->stringOf('kmsKeyId');
$sizeInGBs = $jResp->IntOf('sizeInGBs');
$Value = $jResp->stringOf('sourceDetails.type.value');
$volumeGroupId = $jResp->stringOf('volumeGroupId');
$vpusPerGB = $jResp->IntOf('vpusPerGB');
$i = 0;
$count_i = $jResp->SizeOfArray('blockVolumeReplicas');
while ($i < $count_i) {
    $jResp->I = $i;
    $value = $jResp->stringOf('blockVolumeReplicas[i].value');
    $i = $i + 1;
}


?>

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 '{
    "blockVolumeReplicas": [
        {
            "value": "<Error: Too many levels of nesting to fake this schema>"
        }
    ],
    "definedTags": {},
    "displayName": "sunt non",
    "freeformTags": {},
    "isAutoTuneEnabled": true,
    "sizeInGBs": -35753331,
    "vpusPerGB": -34400178
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId

Postman Collection Item JSON

{
  "name": "UpdateVolume",
  "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumes/:volumeId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumes",
        ":volumeId"
      ],
      "variable": [
        {
          "key": "volumeId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume."
        }
      ]
    },
    "description": "Updates the specified volume's display name.\nAvoid entering confidential information.\n"
  },
  "response": [
    {
      "name": "The volume 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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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 \"id\": \"dolore magna fugiat\",\n \"availabilityDomain\": \"ut\",\n \"displayName\": \"ut velit commodo\",\n \"sizeInMBs\": -55113189,\n \"compartmentId\": \"et ullamco consequat u\",\n \"timeCreated\": \"1988-12-07T08:21:37.359Z\",\n \"lifecycleState\": \"PROVISIONING\",\n \"autoTunedVpusPerGB\": -84866272,\n \"blockVolumeReplicas\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": false,\n \"isHydrated\": true,\n \"kmsKeyId\": \"ullamco\",\n \"sizeInGBs\": -13490866,\n \"sourceDetails\": {\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"volumeGroupId\": \"proident eu velit\",\n \"vpusPerGB\": -99437639\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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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    \"blockVolumeReplicas\": [\n        {\n            \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n        }\n    ],\n    \"definedTags\": {},\n    \"displayName\": \"sunt non\",\n    \"freeformTags\": {},\n    \"isAutoTuneEnabled\": true,\n    \"sizeInGBs\": -35753331,\n    \"vpusPerGB\": -34400178\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}