Chilkat Online Tools

PowerBuilder / Core Services API / GetBootVolumeBackup

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_DisplayName
string ls_CompartmentId
string ls_TimeCreated
string ls_LifecycleState
string ls_BootVolumeId
string ls_ExpirationTime
string ls_ImageId
string ls_KmsKeyId
integer li_SizeInGBs
string ls_SourceBootVolumeBackupId
string ls_SourceType
string ls_TimeRequestReceived
string ls_V_type
integer li_UniqueSizeInGBs

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups/:bootVolumeBackupId",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

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_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_BootVolumeId = loo_JResp.StringOf("bootVolumeId")
ls_ExpirationTime = loo_JResp.StringOf("expirationTime")
ls_ImageId = loo_JResp.StringOf("imageId")
ls_KmsKeyId = loo_JResp.StringOf("kmsKeyId")
li_SizeInGBs = loo_JResp.IntOf("sizeInGBs")
ls_SourceBootVolumeBackupId = loo_JResp.StringOf("sourceBootVolumeBackupId")
ls_SourceType = loo_JResp.StringOf("sourceType")
ls_TimeRequestReceived = loo_JResp.StringOf("timeRequestReceived")
ls_V_type = loo_JResp.StringOf("type")
li_UniqueSizeInGBs = loo_JResp.IntOf("uniqueSizeInGBs")


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups/:bootVolumeBackupId

Postman Collection Item JSON

{
  "name": "GetBootVolumeBackup",
  "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}}/bootVolumeBackups/:bootVolumeBackupId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumeBackups",
        ":bootVolumeBackupId"
      ],
      "variable": [
        {
          "key": "bootVolumeBackupId",
          "value": "officia sed",
          "description": "(Required) The OCID of the boot volume backup."
        }
      ]
    },
    "description": "Gets information for the specified boot volume backup."
  },
  "response": [
    {
      "name": "The boot volume backup was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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}}/bootVolumeBackups/:bootVolumeBackupId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeBackups",
            ":bootVolumeBackupId"
          ],
          "variable": [
            {
              "key": "bootVolumeBackupId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}