PureBasic / Core Services API / GetVolumeGroupBackup
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups/:volumeGroupBackupId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
strVal.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
expirationTime.s = CkJsonObject::ckStringOf(jResp,"expirationTime")
sizeInGBs.i = CkJsonObject::ckIntOf(jResp,"sizeInGBs")
sizeInMBs.i = CkJsonObject::ckIntOf(jResp,"sizeInMBs")
sourceType.s = CkJsonObject::ckStringOf(jResp,"sourceType")
sourceVolumeGroupBackupId.s = CkJsonObject::ckStringOf(jResp,"sourceVolumeGroupBackupId")
timeRequestReceived.s = CkJsonObject::ckStringOf(jResp,"timeRequestReceived")
uniqueSizeInGbs.i = CkJsonObject::ckIntOf(jResp,"uniqueSizeInGbs")
uniqueSizeInMbs.i = CkJsonObject::ckIntOf(jResp,"uniqueSizeInMbs")
volumeGroupId.s = CkJsonObject::ckStringOf(jResp,"volumeGroupId")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"volumeBackupIds")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"volumeBackupIds[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups/:volumeGroupBackupId
Postman Collection Item JSON
{
"name": "GetVolumeGroupBackup",
"request": {
"method": "GET",
"header": [
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId",
"value": "officia sed",
"description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
}
]
},
"description": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)."
},
"response": [
{
"name": "The volume group backup was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"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}"
}
]
}
