Chilkat Online Tools

unicodeC / Core Services API / GetBootVolume

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *value;
    const wchar_t *id;
    const wchar_t *availabilityDomain;
    int sizeInMBs;
    const wchar_t *compartmentId;
    const wchar_t *timeCreated;
    const wchar_t *lifecycleState;
    int autoTunedVpusPerGB;
    const wchar_t *displayName;
    const wchar_t *imageId;
    BOOL isAutoTuneEnabled;
    BOOL isHydrated;
    const wchar_t *kmsKeyId;
    int sizeInGBs;
    const wchar_t *Value;
    const wchar_t *volumeGroupId;
    int vpusPerGB;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    CkHttpW_SetRequestHeader(http,L"Authorization",L"{{signature}}");
    CkHttpW_SetRequestHeader(http,L"Date",L"{{date}}");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumes/:bootVolumeId",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    id = CkJsonObjectW_stringOf(jResp,L"id");
    availabilityDomain = CkJsonObjectW_stringOf(jResp,L"availabilityDomain");
    sizeInMBs = CkJsonObjectW_IntOf(jResp,L"sizeInMBs");
    compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
    lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
    autoTunedVpusPerGB = CkJsonObjectW_IntOf(jResp,L"autoTunedVpusPerGB");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    imageId = CkJsonObjectW_stringOf(jResp,L"imageId");
    isAutoTuneEnabled = CkJsonObjectW_BoolOf(jResp,L"isAutoTuneEnabled");
    isHydrated = CkJsonObjectW_BoolOf(jResp,L"isHydrated");
    kmsKeyId = CkJsonObjectW_stringOf(jResp,L"kmsKeyId");
    sizeInGBs = CkJsonObjectW_IntOf(jResp,L"sizeInGBs");
    Value = CkJsonObjectW_stringOf(jResp,L"sourceDetails.type.value");
    volumeGroupId = CkJsonObjectW_stringOf(jResp,L"volumeGroupId");
    vpusPerGB = CkJsonObjectW_IntOf(jResp,L"vpusPerGB");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"bootVolumeReplicas");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        value = CkJsonObjectW_stringOf(jResp,L"bootVolumeReplicas[i].value");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

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