Chilkat Online Tools

Powershell / Core Services API / GetVolumeGroupBackup

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

$http.SetRequestHeader("Authorization","{{signature}}")
$http.SetRequestHeader("Date","{{date}}")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeGroupBackups/:volumeGroupBackupId",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$id = $jResp.StringOf("id")
$displayName = $jResp.StringOf("displayName")
$compartmentId = $jResp.StringOf("compartmentId")
$timeCreated = $jResp.StringOf("timeCreated")
$v_type = $jResp.StringOf("type")
$lifecycleState = $jResp.StringOf("lifecycleState")
$expirationTime = $jResp.StringOf("expirationTime")
$sizeInGBs = $jResp.IntOf("sizeInGBs")
$sizeInMBs = $jResp.IntOf("sizeInMBs")
$sourceType = $jResp.StringOf("sourceType")
$sourceVolumeGroupBackupId = $jResp.StringOf("sourceVolumeGroupBackupId")
$timeRequestReceived = $jResp.StringOf("timeRequestReceived")
$uniqueSizeInGbs = $jResp.IntOf("uniqueSizeInGbs")
$uniqueSizeInMbs = $jResp.IntOf("uniqueSizeInMbs")
$volumeGroupId = $jResp.StringOf("volumeGroupId")
$i = 0
$count_i = $jResp.SizeOfArray("volumeBackupIds")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("volumeBackupIds[i]")
    $i = $i + 1
}

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}"
    }
  ]
}