Chilkat Online Tools

unicodeC / Core Services API / GetBootVolumeReplica

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 *id;
    const wchar_t *availabilityDomain;
    int sizeInGBs;
    const wchar_t *displayName;
    const wchar_t *compartmentId;
    const wchar_t *timeCreated;
    const wchar_t *lifecycleState;
    const wchar_t *timeLastSynced;
    const wchar_t *bootVolumeId;
    const wchar_t *imageId;
    int totalDataTransferredInGBs;

    // 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/bootVolumeReplicas/:bootVolumeReplicaId",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": "nulla dolore eu laborum",
    //   "availabilityDomain": "nostrud ea",
    //   "sizeInGBs": 4636,
    //   "displayName": "incididunt Duis",
    //   "compartmentId": "sunt aliqua occaecat nostrud",
    //   "timeCreated": "1997-02-12T06:09:55.412Z",
    //   "lifecycleState": "ACTIVATING",
    //   "timeLastSynced": "2021-07-02T14:45:19.765Z",
    //   "bootVolumeId": "labore laboris",
    //   "definedTags": {},
    //   "freeformTags": {},
    //   "imageId": "veniam ad eu Duis",
    //   "totalDataTransferredInGBs": 1832269
    // }

    // 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");
    sizeInGBs = CkJsonObjectW_IntOf(jResp,L"sizeInGBs");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
    lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
    timeLastSynced = CkJsonObjectW_stringOf(jResp,L"timeLastSynced");
    bootVolumeId = CkJsonObjectW_stringOf(jResp,L"bootVolumeId");
    imageId = CkJsonObjectW_stringOf(jResp,L"imageId");
    totalDataTransferredInGBs = CkJsonObjectW_IntOf(jResp,L"totalDataTransferredInGBs");


    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/bootVolumeReplicas/:bootVolumeReplicaId

Postman Collection Item JSON

{
  "name": "GetBootVolumeReplica",
  "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumeReplicas",
        ":bootVolumeReplicaId"
      ],
      "variable": [
        {
          "key": "bootVolumeReplicaId",
          "value": "officia sed",
          "description": "(Required) The OCID of the boot volume replica."
        }
      ]
    },
    "description": "Gets information for the specified boot volume replica."
  },
  "response": [
    {
      "name": "The boot volume replica's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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\": \"nulla dolore eu laborum\",\n \"availabilityDomain\": \"nostrud ea\",\n \"sizeInGBs\": 4636,\n \"displayName\": \"incididunt Duis\",\n \"compartmentId\": \"sunt aliqua occaecat nostrud\",\n \"timeCreated\": \"1997-02-12T06:09:55.412Z\",\n \"lifecycleState\": \"ACTIVATING\",\n \"timeLastSynced\": \"2021-07-02T14:45:19.765Z\",\n \"bootVolumeId\": \"labore laboris\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"imageId\": \"veniam ad eu Duis\",\n \"totalDataTransferredInGBs\": 1832269\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}