Chilkat Online Tools

autoit / Core Services API / GetVolume

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.SetRequestHeader "Authorization","{{signature}}"
$oHttp.SetRequestHeader "Date","{{date}}"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "id": "dolore magna fugiat",
;   "availabilityDomain": "ut",
;   "displayName": "ut velit commodo",
;   "sizeInMBs": -55113189,
;   "compartmentId": "et ullamco consequat u",
;   "timeCreated": "1988-12-07T08:21:37.359Z",
;   "lifecycleState": "PROVISIONING",
;   "autoTunedVpusPerGB": -84866272,
;   "blockVolumeReplicas": [
;     {
;       "value": "<Error: Too many levels of nesting to fake this schema>"
;     },
;     {
;       "value": "<Error: Too many levels of nesting to fake this schema>"
;     }
;   ],
;   "definedTags": {},
;   "freeformTags": {},
;   "isAutoTuneEnabled": false,
;   "isHydrated": true,
;   "kmsKeyId": "ullamco",
;   "sizeInGBs": -13490866,
;   "sourceDetails": {
;     "type": {
;       "value": "<Error: Too many levels of nesting to fake this schema>"
;     }
;   },
;   "volumeGroupId": "proident eu velit",
;   "vpusPerGB": -99437639
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sValue

Local $sId = $oJResp.StringOf("id")
Local $sAvailabilityDomain = $oJResp.StringOf("availabilityDomain")
Local $sDisplayName = $oJResp.StringOf("displayName")
Local $iSizeInMBs = $oJResp.IntOf("sizeInMBs")
Local $sCompartmentId = $oJResp.StringOf("compartmentId")
Local $sTimeCreated = $oJResp.StringOf("timeCreated")
Local $sLifecycleState = $oJResp.StringOf("lifecycleState")
Local $iAutoTunedVpusPerGB = $oJResp.IntOf("autoTunedVpusPerGB")
Local $bIsAutoTuneEnabled = $oJResp.BoolOf("isAutoTuneEnabled")
Local $bIsHydrated = $oJResp.BoolOf("isHydrated")
Local $sKmsKeyId = $oJResp.StringOf("kmsKeyId")
Local $iSizeInGBs = $oJResp.IntOf("sizeInGBs")
Local $sValue = $oJResp.StringOf("sourceDetails.type.value")
Local $sVolumeGroupId = $oJResp.StringOf("volumeGroupId")
Local $iVpusPerGB = $oJResp.IntOf("vpusPerGB")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("blockVolumeReplicas")
While $i < $iCount_i
    $oJResp.I = $i
    $sValue = $oJResp.StringOf("blockVolumeReplicas[i].value")
    $i = $i + 1
Wend

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetVolume",
  "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}}/volumes/:volumeId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumes",
        ":volumeId"
      ],
      "variable": [
        {
          "key": "volumeId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume."
        }
      ]
    },
    "description": "Gets information for the specified volume."
  },
  "response": [
    {
      "name": "The volume's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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\": \"dolore magna fugiat\",\n \"availabilityDomain\": \"ut\",\n \"displayName\": \"ut velit commodo\",\n \"sizeInMBs\": -55113189,\n \"compartmentId\": \"et ullamco consequat u\",\n \"timeCreated\": \"1988-12-07T08:21:37.359Z\",\n \"lifecycleState\": \"PROVISIONING\",\n \"autoTunedVpusPerGB\": -84866272,\n \"blockVolumeReplicas\": [\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n ],\n \"definedTags\": {},\n \"freeformTags\": {},\n \"isAutoTuneEnabled\": false,\n \"isHydrated\": true,\n \"kmsKeyId\": \"ullamco\",\n \"sizeInGBs\": -13490866,\n \"sourceDetails\": {\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"volumeGroupId\": \"proident eu velit\",\n \"vpusPerGB\": -99437639\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}}/volumes/:volumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumes",
            ":volumeId"
          ],
          "variable": [
            {
              "key": "volumeId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}