Chilkat Online Tools

phpAx / Core Services API / CreateVolumeGroupBackup

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.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.

// {
//   "volumeGroupId": "elit dolor irure in consectetur",
//   "compartmentId": "{{compartment_ocid}}",
//   "definedTags": {},
//   "displayName": "laboris pariatur",
//   "freeformTags": {},
//   "type": "FULL"
// }

$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('volumeGroupId','elit dolor irure in consectetur');
$json->UpdateString('compartmentId','{{compartment_ocid}}');
$json->UpdateNewObject('definedTags');
$json->UpdateString('displayName','laboris pariatur');
$json->UpdateNewObject('freeformTags');
$json->UpdateString('type','FULL');

$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 Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.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": "amet dolore ullamco",
//   "volumeBackupIds": [
//     "Lorem laborum sunt",
//     "fugiat cillum sunt"
//   ],
//   "displayName": "ex magna",
//   "compartmentId": "dolore laboris",
//   "timeCreated": "1980-12-26T20:45:18.630Z",
//   "type": "INCREMENTAL",
//   "lifecycleState": "FAULTY",
//   "definedTags": {},
//   "expirationTime": "1953-04-03T06:01:14.615Z",
//   "freeformTags": {},
//   "sizeInGBs": 85138526,
//   "sizeInMBs": -60294769,
//   "sourceType": "SCHEDULED",
//   "sourceVolumeGroupBackupId": "in exercitation ea non",
//   "timeRequestReceived": "2020-06-22T19:48:13.717Z",
//   "uniqueSizeInGbs": -64913320,
//   "uniqueSizeInMbs": -98004917,
//   "volumeGroupId": "velit non labore"
// }

// 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');
$displayName = $jResp->stringOf('displayName');
$compartmentId = $jResp->stringOf('compartmentId');
$timeCreated = $jResp->stringOf('timeCreated');
$v_type = $jResp->stringOf('type');
$lifecycleState = $jResp->stringOf('lifecycleState');
$expirationTime = $jResp->stringOf('expirationTime');
$sizeInGBs = $jResp->IntOf('sizeInGBs');
$sizeInMBs = $jResp->IntOf('sizeInMBs');
$sourceType = $jResp->stringOf('sourceType');
$sourceVolumeGroupBackupId = $jResp->stringOf('sourceVolumeGroupBackupId');
$timeRequestReceived = $jResp->stringOf('timeRequestReceived');
$uniqueSizeInGbs = $jResp->IntOf('uniqueSizeInGbs');
$uniqueSizeInMbs = $jResp->IntOf('uniqueSizeInMbs');
$volumeGroupId = $jResp->stringOf('volumeGroupId');
$i = 0;
$count_i = $jResp->SizeOfArray('volumeBackupIds');
while ($i < $count_i) {
    $jResp->I = $i;
    $strVal = $jResp->stringOf('volumeBackupIds[i]');
    $i = $i + 1;
}


?>

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 '{
    "volumeGroupId": "elit dolor irure in consectetur",
    "compartmentId": "{{compartment_ocid}}",
    "definedTags": {},
    "displayName": "laboris pariatur",
    "freeformTags": {},
    "type": "FULL"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups

Postman Collection Item JSON

{
  "name": "CreateVolumeGroupBackup",
  "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"{{compartment_ocid}}\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeGroupBackups",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeGroupBackups"
      ]
    },
    "description": "Creates a new backup volume group of the specified volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n"
  },
  "response": [
    {
      "name": "The volume group backup is being 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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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\": \"amet dolore ullamco\",\n \"volumeBackupIds\": [\n  \"Lorem laborum sunt\",\n  \"fugiat cillum sunt\"\n ],\n \"displayName\": \"ex magna\",\n \"compartmentId\": \"dolore laboris\",\n \"timeCreated\": \"1980-12-26T20:45:18.630Z\",\n \"type\": \"INCREMENTAL\",\n \"lifecycleState\": \"FAULTY\",\n \"definedTags\": {},\n \"expirationTime\": \"1953-04-03T06:01:14.615Z\",\n \"freeformTags\": {},\n \"sizeInGBs\": 85138526,\n \"sizeInMBs\": -60294769,\n \"sourceType\": \"SCHEDULED\",\n \"sourceVolumeGroupBackupId\": \"in exercitation ea non\",\n \"timeRequestReceived\": \"2020-06-22T19:48:13.717Z\",\n \"uniqueSizeInGbs\": -64913320,\n \"uniqueSizeInMbs\": -98004917,\n \"volumeGroupId\": \"velit non labore\"\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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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    \"volumeGroupId\": \"elit dolor irure in consectetur\",\n    \"compartmentId\": \"exercitation dolore\",\n    \"definedTags\": {},\n    \"displayName\": \"laboris pariatur\",\n    \"freeformTags\": {},\n    \"type\": \"FULL\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeGroupBackups",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeGroupBackups"
          ]
        }
      },
      "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}"
    }
  ]
}