PowerBuilder / Core Services API / CreateVolumeGroupBackup
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_Id
string ls_DisplayName
string ls_CompartmentId
string ls_TimeCreated
string ls_V_type
string ls_LifecycleState
string ls_ExpirationTime
integer li_SizeInGBs
integer li_SizeInMBs
string ls_SourceType
string ls_SourceVolumeGroupBackupId
string ls_TimeRequestReceived
integer li_UniqueSizeInGbs
integer li_UniqueSizeInMbs
string ls_VolumeGroupId
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// 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"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("volumeGroupId","elit dolor irure in consectetur")
loo_Json.UpdateString("compartmentId","{{compartment_ocid}}")
loo_Json.UpdateNewObject("definedTags")
loo_Json.UpdateString("displayName","laboris pariatur")
loo_Json.UpdateNewObject("freeformTags")
loo_Json.UpdateString("type","FULL")
loo_Http.SetRequestHeader("opc-retry-token","aliqua enim i")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("x-content-sha256","{{content_sha256}}")
loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")
loo_Resp = loo_Http.PostJson3("https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
ls_Id = loo_JResp.StringOf("id")
ls_DisplayName = loo_JResp.StringOf("displayName")
ls_CompartmentId = loo_JResp.StringOf("compartmentId")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
ls_V_type = loo_JResp.StringOf("type")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_ExpirationTime = loo_JResp.StringOf("expirationTime")
li_SizeInGBs = loo_JResp.IntOf("sizeInGBs")
li_SizeInMBs = loo_JResp.IntOf("sizeInMBs")
ls_SourceType = loo_JResp.StringOf("sourceType")
ls_SourceVolumeGroupBackupId = loo_JResp.StringOf("sourceVolumeGroupBackupId")
ls_TimeRequestReceived = loo_JResp.StringOf("timeRequestReceived")
li_UniqueSizeInGbs = loo_JResp.IntOf("uniqueSizeInGbs")
li_UniqueSizeInMbs = loo_JResp.IntOf("uniqueSizeInMbs")
ls_VolumeGroupId = loo_JResp.StringOf("volumeGroupId")
i = 0
li_Count_i = loo_JResp.SizeOfArray("volumeBackupIds")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("volumeBackupIds[i]")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
