Chilkat Online Tools

C# / Core Services API / GetBootVolume

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumes/:bootVolumeId",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

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

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

// {
//   "id": "officia reprehenderit",
//   "availabilityDomain": "Duis nostrud do non deserunt",
//   "sizeInMBs": -98569692,
//   "compartmentId": "Excepteur Lorem",
//   "timeCreated": "1956-06-30T22:30:00.790Z",
//   "lifecycleState": "RESTORING",
//   "autoTunedVpusPerGB": -7197285,
//   "bootVolumeReplicas": [
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     },
//     {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   ],
//   "definedTags": {},
//   "displayName": "irure Lorem ad",
//   "freeformTags": {},
//   "imageId": "non in sit",
//   "isAutoTuneEnabled": true,
//   "isHydrated": false,
//   "kmsKeyId": "consequat incididunt labore eiusmod quis",
//   "sizeInGBs": -5147606,
//   "sourceDetails": {
//     "type": {
//       "value": "<Error: Too many levels of nesting to fake this schema>"
//     }
//   },
//   "volumeGroupId": "sed",
//   "vpusPerGB": -31448022
// }

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

string value;

string id = jResp.StringOf("id");
string availabilityDomain = jResp.StringOf("availabilityDomain");
int sizeInMBs = jResp.IntOf("sizeInMBs");
string compartmentId = jResp.StringOf("compartmentId");
string timeCreated = jResp.StringOf("timeCreated");
string lifecycleState = jResp.StringOf("lifecycleState");
int autoTunedVpusPerGB = jResp.IntOf("autoTunedVpusPerGB");
string displayName = jResp.StringOf("displayName");
string imageId = jResp.StringOf("imageId");
bool isAutoTuneEnabled = jResp.BoolOf("isAutoTuneEnabled");
bool isHydrated = jResp.BoolOf("isHydrated");
string kmsKeyId = jResp.StringOf("kmsKeyId");
int sizeInGBs = jResp.IntOf("sizeInGBs");
string Value = jResp.StringOf("sourceDetails.type.value");
string volumeGroupId = jResp.StringOf("volumeGroupId");
int vpusPerGB = jResp.IntOf("vpusPerGB");
int i = 0;
int count_i = jResp.SizeOfArray("bootVolumeReplicas");
while (i < count_i) {
    jResp.I = i;
    value = jResp.StringOf("bootVolumeReplicas[i].value");
    i = i + 1;
}

Curl Command

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

Postman Collection Item JSON

{
  "name": "GetBootVolume",
  "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}}/bootVolumes/:bootVolumeId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumes",
        ":bootVolumeId"
      ],
      "variable": [
        {
          "key": "bootVolumeId",
          "value": "officia sed",
          "description": "(Required) The OCID of the boot volume."
        }
      ]
    },
    "description": "Gets information for the specified boot volume."
  },
  "response": [
    {
      "name": "The boot volume's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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\": \"officia reprehenderit\",\n \"availabilityDomain\": \"Duis nostrud do non deserunt\",\n \"sizeInMBs\": -98569692,\n \"compartmentId\": \"Excepteur Lorem\",\n \"timeCreated\": \"1956-06-30T22:30:00.790Z\",\n \"lifecycleState\": \"RESTORING\",\n \"autoTunedVpusPerGB\": -7197285,\n \"bootVolumeReplicas\": [\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 \"displayName\": \"irure Lorem ad\",\n \"freeformTags\": {},\n \"imageId\": \"non in sit\",\n \"isAutoTuneEnabled\": true,\n \"isHydrated\": false,\n \"kmsKeyId\": \"consequat incididunt labore eiusmod quis\",\n \"sizeInGBs\": -5147606,\n \"sourceDetails\": {\n  \"type\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  }\n },\n \"volumeGroupId\": \"sed\",\n \"vpusPerGB\": -31448022\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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}}/bootVolumes/:bootVolumeId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumes",
            ":bootVolumeId"
          ],
          "variable": [
            {
              "key": "bootVolumeId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}