DataFlex / Core Services API / CreateBootVolumeBackup
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sDisplayName
String sCompartmentId
String sTimeCreated
String sLifecycleState
String sBootVolumeId
String sExpirationTime
String sImageId
String sKmsKeyId
Integer iSizeInGBs
String sSourceBootVolumeBackupId
String sSourceType
String sTimeRequestReceived
String sV_type
Integer iUniqueSizeInGBs
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "bootVolumeId": "aute in",
// "definedTags": {},
// "displayName": "aliquip in magna",
// "freeformTags": {},
// "type": "FULL"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "bootVolumeId" "aute in" To iSuccess
Get ComUpdateNewObject Of hoJson "definedTags" To iSuccess
Get ComUpdateString Of hoJson "displayName" "aliquip in magna" To iSuccess
Get ComUpdateNewObject Of hoJson "freeformTags" To iSuccess
Get ComUpdateString Of hoJson "type" "FULL" To iSuccess
Send ComSetRequestHeader To hoHttp "opc-retry-token" "aliqua enim i"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "x-content-sha256" "{{content_sha256}}"
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoJson to vJson
Get pvComObject of hoResp to vResp
Get ComHttpJson Of hoHttp "POST" "https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups" vJson "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "reprehenderit dolore irure elit",
// "displayName": "ex culpa",
// "compartmentId": "tempor exercitation commodo cillum",
// "timeCreated": "1981-07-30T00:01:31.556Z",
// "lifecycleState": "TERMINATED",
// "bootVolumeId": "dolore culpa sint",
// "definedTags": {},
// "expirationTime": "1947-05-09T22:23:58.728Z",
// "freeformTags": {},
// "imageId": "magna ipsum nisi in",
// "kmsKeyId": "tempor veniam deserunt",
// "sizeInGBs": 8220,
// "sourceBootVolumeBackupId": "consequat sit dolore",
// "sourceType": "MANUAL",
// "timeRequestReceived": "1959-02-03T20:49:53.527Z",
// "type": "INCREMENTAL",
// "uniqueSizeInGBs": 2985
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "bootVolumeId" To sBootVolumeId
Get ComStringOf Of hoJResp "expirationTime" To sExpirationTime
Get ComStringOf Of hoJResp "imageId" To sImageId
Get ComStringOf Of hoJResp "kmsKeyId" To sKmsKeyId
Get ComIntOf Of hoJResp "sizeInGBs" To iSizeInGBs
Get ComStringOf Of hoJResp "sourceBootVolumeBackupId" To sSourceBootVolumeBackupId
Get ComStringOf Of hoJResp "sourceType" To sSourceType
Get ComStringOf Of hoJResp "timeRequestReceived" To sTimeRequestReceived
Get ComStringOf Of hoJResp "type" To sV_type
Get ComIntOf Of hoJResp "uniqueSizeInGBs" To iUniqueSizeInGBs
End_Procedure
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 '{
"bootVolumeId": "aute in",
"definedTags": {},
"displayName": "aliquip in magna",
"freeformTags": {},
"type": "FULL"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups
Postman Collection Item JSON
{
"name": "CreateBootVolumeBackup",
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
},
"description": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n"
},
"response": [
{
"name": "The boot volume 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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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\": \"reprehenderit dolore irure elit\",\n \"displayName\": \"ex culpa\",\n \"compartmentId\": \"tempor exercitation commodo cillum\",\n \"timeCreated\": \"1981-07-30T00:01:31.556Z\",\n \"lifecycleState\": \"TERMINATED\",\n \"bootVolumeId\": \"dolore culpa sint\",\n \"definedTags\": {},\n \"expirationTime\": \"1947-05-09T22:23:58.728Z\",\n \"freeformTags\": {},\n \"imageId\": \"magna ipsum nisi in\",\n \"kmsKeyId\": \"tempor veniam deserunt\",\n \"sizeInGBs\": 8220,\n \"sourceBootVolumeBackupId\": \"consequat sit dolore\",\n \"sourceType\": \"MANUAL\",\n \"timeRequestReceived\": \"1959-02-03T20:49:53.527Z\",\n \"type\": \"INCREMENTAL\",\n \"uniqueSizeInGBs\": 2985\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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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 \"bootVolumeId\": \"aute in\",\n \"definedTags\": {},\n \"displayName\": \"aliquip in magna\",\n \"freeformTags\": {},\n \"type\": \"FULL\"\n}"
},
"url": {
"raw": "{{baseUrl}}/bootVolumeBackups",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumeBackups"
]
}
},
"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}"
}
]
}
