Chilkat Online Tools

Foxpro / Core Services API / GetBootVolumeBackup

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcDisplayName
LOCAL lcCompartmentId
LOCAL lcTimeCreated
LOCAL lcLifecycleState
LOCAL lcBootVolumeId
LOCAL lcExpirationTime
LOCAL lcImageId
LOCAL lcKmsKeyId
LOCAL lnSizeInGBs
LOCAL lcSourceBootVolumeBackupId
LOCAL lcSourceType
LOCAL lcTimeRequestReceived
LOCAL lcV_type
LOCAL lnUniqueSizeInGBs

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeBackups/:bootVolumeBackupId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcId = loJResp.StringOf("id")
lcDisplayName = loJResp.StringOf("displayName")
lcCompartmentId = loJResp.StringOf("compartmentId")
lcTimeCreated = loJResp.StringOf("timeCreated")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcBootVolumeId = loJResp.StringOf("bootVolumeId")
lcExpirationTime = loJResp.StringOf("expirationTime")
lcImageId = loJResp.StringOf("imageId")
lcKmsKeyId = loJResp.StringOf("kmsKeyId")
lnSizeInGBs = loJResp.IntOf("sizeInGBs")
lcSourceBootVolumeBackupId = loJResp.StringOf("sourceBootVolumeBackupId")
lcSourceType = loJResp.StringOf("sourceType")
lcTimeRequestReceived = loJResp.StringOf("timeRequestReceived")
lcV_type = loJResp.StringOf("type")
lnUniqueSizeInGBs = loJResp.IntOf("uniqueSizeInGBs")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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