DataFlex / Core Services API / CreateVolumeGroupBackup
Back to Collection Items
Use ChilkatAx-9.5.0-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 sStrVal
String sId
String sDisplayName
String sCompartmentId
String sTimeCreated
String sV_type
String sLifecycleState
String sExpirationTime
Integer iSizeInGBs
Integer iSizeInMBs
String sSourceType
String sSourceVolumeGroupBackupId
String sTimeRequestReceived
Integer iUniqueSizeInGbs
Integer iUniqueSizeInMbs
String sVolumeGroupId
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// 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.
// {
// "volumeGroupId": "elit dolor irure in consectetur",
// "compartmentId": "{{compartment_ocid}}",
// "definedTags": {},
// "displayName": "laboris pariatur",
// "freeformTags": {},
// "type": "FULL"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "volumeGroupId" "elit dolor irure in consectetur" To iSuccess
Get ComUpdateString Of hoJson "compartmentId" "{{compartment_ocid}}" To iSuccess
Get ComUpdateNewObject Of hoJson "definedTags" To iSuccess
Get ComUpdateString Of hoJson "displayName" "laboris pariatur" 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 pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = 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."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
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 "type" To sV_type
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "expirationTime" To sExpirationTime
Get ComIntOf Of hoJResp "sizeInGBs" To iSizeInGBs
Get ComIntOf Of hoJResp "sizeInMBs" To iSizeInMBs
Get ComStringOf Of hoJResp "sourceType" To sSourceType
Get ComStringOf Of hoJResp "sourceVolumeGroupBackupId" To sSourceVolumeGroupBackupId
Get ComStringOf Of hoJResp "timeRequestReceived" To sTimeRequestReceived
Get ComIntOf Of hoJResp "uniqueSizeInGbs" To iUniqueSizeInGbs
Get ComIntOf Of hoJResp "uniqueSizeInMbs" To iUniqueSizeInMbs
Get ComStringOf Of hoJResp "volumeGroupId" To sVolumeGroupId
Move 0 To i
Get ComSizeOfArray Of hoJResp "volumeBackupIds" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "volumeBackupIds[i]" To sStrVal
Move (i + 1) To i
Loop
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 '{
"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}"
}
]
}
