TCL / Core Services API / CreateVolumeGroupBackupCopy
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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.
# {
# "destinationRegion": "ex sint officia ipsum exercitation",
# "displayName": "non dolore ea nulla in",
# "kmsKeyId": "officia culpa est occaecat"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "destinationRegion" "ex sint officia ipsum exercitation"
CkJsonObject_UpdateString $json "displayName" "non dolore ea nulla in"
CkJsonObject_UpdateString $json "kmsKeyId" "officia culpa est occaecat"
CkHttp_SetRequestHeader $http "opc-retry-token" "aliqua enim i"
CkHttp_SetRequestHeader $http "opc-request-id" "8wF"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups/:volumeGroupBackupId/actions/copy" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set id [CkJsonObject_stringOf $jResp "id"]
set displayName [CkJsonObject_stringOf $jResp "displayName"]
set compartmentId [CkJsonObject_stringOf $jResp "compartmentId"]
set timeCreated [CkJsonObject_stringOf $jResp "timeCreated"]
set v_type [CkJsonObject_stringOf $jResp "type"]
set lifecycleState [CkJsonObject_stringOf $jResp "lifecycleState"]
set expirationTime [CkJsonObject_stringOf $jResp "expirationTime"]
set sizeInGBs [CkJsonObject_IntOf $jResp "sizeInGBs"]
set sizeInMBs [CkJsonObject_IntOf $jResp "sizeInMBs"]
set sourceType [CkJsonObject_stringOf $jResp "sourceType"]
set sourceVolumeGroupBackupId [CkJsonObject_stringOf $jResp "sourceVolumeGroupBackupId"]
set timeRequestReceived [CkJsonObject_stringOf $jResp "timeRequestReceived"]
set uniqueSizeInGbs [CkJsonObject_IntOf $jResp "uniqueSizeInGbs"]
set uniqueSizeInMbs [CkJsonObject_IntOf $jResp "uniqueSizeInMbs"]
set volumeGroupId [CkJsonObject_stringOf $jResp "volumeGroupId"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "volumeBackupIds"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set strVal [CkJsonObject_stringOf $jResp "volumeBackupIds[i]"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": "ex sint officia ipsum exercitation",
"displayName": "non dolore ea nulla in",
"kmsKeyId": "officia culpa est occaecat"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups/:volumeGroupBackupId/actions/copy
Postman Collection Item JSON
{
"name": "CreateVolumeGroupBackupCopy",
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId",
"value": "officia sed",
"description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
}
]
},
"description": "Creates a volume group backup copy in specified region. For general information about volume group backups,\nsee [Overview of Block Volume Service Backups](/Content/Block/Concepts/blockvolumebackups.htm)\n"
},
"response": [
{
"name": "The volume group 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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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"
},
{
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"ex sint officia ipsum exercitation\",\n \"displayName\": \"non dolore ea nulla in\",\n \"kmsKeyId\": \"officia culpa est occaecat\"\n}"
},
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId/actions/copy",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId",
"actions",
"copy"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}"
}
]
}