Chilkat Online Tools

phpAx / Core Services API / CreateVolumeBackupCopy

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.

// {
//   "destinationRegion": "aliqua sunt Ut exercitation sit",
//   "displayName": "velit",
//   "kmsKeyId": "proident magna"
// }

$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('destinationRegion','aliqua sunt Ut exercitation sit');
$json->UpdateString('displayName','velit');
$json->UpdateString('kmsKeyId','proident magna');

$http->SetRequestHeader('opc-retry-token','aliqua enim i');
$http->SetRequestHeader('opc-request-id','8wF');
$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/volumeBackups/:volumeBackupId/actions/copy','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": "ea",
//   "type": "FULL",
//   "displayName": "amet elit occaecat laboris",
//   "compartmentId": "eu et sint",
//   "timeCreated": "2007-11-11T04:41:21.719Z",
//   "lifecycleState": "CREATING",
//   "definedTags": {},
//   "expirationTime": "1998-05-31T02:51:40.598Z",
//   "freeformTags": {},
//   "kmsKeyId": "nostrud sint",
//   "sizeInGBs": 11402,
//   "sizeInMBs": 12081259,
//   "sourceType": "MANUAL",
//   "sourceVolumeBackupId": "in magna laboris consectetur",
//   "timeRequestReceived": "1981-12-16T03:31:57.153Z",
//   "uniqueSizeInGBs": 2257,
//   "uniqueSizeInMbs": 13322289,
//   "volumeId": "eu mollit consectetur Excepteur"
// }

// 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');
$v_type = $jResp->stringOf('type');
$displayName = $jResp->stringOf('displayName');
$compartmentId = $jResp->stringOf('compartmentId');
$timeCreated = $jResp->stringOf('timeCreated');
$lifecycleState = $jResp->stringOf('lifecycleState');
$expirationTime = $jResp->stringOf('expirationTime');
$kmsKeyId = $jResp->stringOf('kmsKeyId');
$sizeInGBs = $jResp->IntOf('sizeInGBs');
$sizeInMBs = $jResp->IntOf('sizeInMBs');
$sourceType = $jResp->stringOf('sourceType');
$sourceVolumeBackupId = $jResp->stringOf('sourceVolumeBackupId');
$timeRequestReceived = $jResp->stringOf('timeRequestReceived');
$uniqueSizeInGBs = $jResp->IntOf('uniqueSizeInGBs');
$uniqueSizeInMbs = $jResp->IntOf('uniqueSizeInMbs');
$volumeId = $jResp->stringOf('volumeId');

?>

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "opc-request-id: 8wF"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "destinationRegion": "aliqua sunt Ut exercitation sit",
    "displayName": "velit",
    "kmsKeyId": "proident magna"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackups/:volumeBackupId/actions/copy

Postman Collection Item JSON

{
  "name": "CreateVolumeBackupCopy",
  "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"
      },
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "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    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackups",
        ":volumeBackupId",
        "actions",
        "copy"
      ],
      "variable": [
        {
          "key": "volumeBackupId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume backup."
        }
      ]
    },
    "description": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n"
  },
  "response": [
    {
      "name": "The volume backup copy is being created in specified region.",
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "content-location",
          "value": "officia sed",
          "description": "Location of the resource.\n"
        },
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "location",
          "value": "officia sed",
          "description": "Location of the resource.\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": "opc-work-request-id",
          "value": "officia sed",
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nwith this ID to track the status of the request.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"ea\",\n \"type\": \"FULL\",\n \"displayName\": \"amet elit occaecat laboris\",\n \"compartmentId\": \"eu et sint\",\n \"timeCreated\": \"2007-11-11T04:41:21.719Z\",\n \"lifecycleState\": \"CREATING\",\n \"definedTags\": {},\n \"expirationTime\": \"1998-05-31T02:51:40.598Z\",\n \"freeformTags\": {},\n \"kmsKeyId\": \"nostrud sint\",\n \"sizeInGBs\": 11402,\n \"sizeInMBs\": 12081259,\n \"sourceType\": \"MANUAL\",\n \"sourceVolumeBackupId\": \"in magna laboris consectetur\",\n \"timeRequestReceived\": \"1981-12-16T03:31:57.153Z\",\n \"uniqueSizeInGBs\": 2257,\n \"uniqueSizeInMbs\": 13322289,\n \"volumeId\": \"eu mollit consectetur Excepteur\"\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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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"
          },
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"destinationRegion\": \"aliqua sunt Ut exercitation sit\",\n    \"displayName\": \"velit\",\n    \"kmsKeyId\": \"proident magna\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeBackups/:volumeBackupId/actions/copy",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackups",
            ":volumeBackupId",
            "actions",
            "copy"
          ],
          "variable": [
            {
              "key": "volumeBackupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}