Chilkat Online Tools

VB.NET / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumes/:volumeId",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim value As String

Dim id As String = jResp.StringOf("id")
Dim availabilityDomain As String = jResp.StringOf("availabilityDomain")
Dim displayName As String = jResp.StringOf("displayName")
Dim sizeInMBs As Integer = jResp.IntOf("sizeInMBs")
Dim compartmentId As String = jResp.StringOf("compartmentId")
Dim timeCreated As String = jResp.StringOf("timeCreated")
Dim lifecycleState As String = jResp.StringOf("lifecycleState")
Dim autoTunedVpusPerGB As Integer = jResp.IntOf("autoTunedVpusPerGB")
Dim isAutoTuneEnabled As Boolean = jResp.BoolOf("isAutoTuneEnabled")
Dim isHydrated As Boolean = jResp.BoolOf("isHydrated")
Dim kmsKeyId As String = jResp.StringOf("kmsKeyId")
Dim sizeInGBs As Integer = jResp.IntOf("sizeInGBs")
Dim Value As String = jResp.StringOf("sourceDetails.type.value")
Dim volumeGroupId As String = jResp.StringOf("volumeGroupId")
Dim vpusPerGB As Integer = jResp.IntOf("vpusPerGB")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("blockVolumeReplicas")
While i < count_i
    jResp.I = i
    value = jResp.StringOf("blockVolumeReplicas[i].value")
    i = i + 1
End While

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