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 *strVal;
const wchar_t *id;
const wchar_t *displayName;
const wchar_t *compartmentId;
const wchar_t *timeCreated;
const wchar_t *v_type;
const wchar_t *lifecycleState;
const wchar_t *expirationTime;
int sizeInGBs;
int sizeInMBs;
const wchar_t *sourceType;
const wchar_t *sourceVolumeGroupBackupId;
const wchar_t *timeRequestReceived;
int uniqueSizeInGbs;
int uniqueSizeInMbs;
const wchar_t *volumeGroupId;
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/volumeGroupBackups/:volumeGroupBackupId",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": "amet dolore ullamco",
// "volumeBackupIds": [
// "Lorem laborum sunt",
// "fugiat cillum sunt"
// ],
// "displayName": "ex magna",
// "compartmentId": "dolore laboris",
// "timeCreated": "1980-12-26T20:45:18.630Z",
// "type": "INCREMENTAL",
// "lifecycleState": "FAULTY",
// "definedTags": {},
// "expirationTime": "1953-04-03T06:01:14.615Z",
// "freeformTags": {},
// "sizeInGBs": 85138526,
// "sizeInMBs": -60294769,
// "sourceType": "SCHEDULED",
// "sourceVolumeGroupBackupId": "in exercitation ea non",
// "timeRequestReceived": "2020-06-22T19:48:13.717Z",
// "uniqueSizeInGbs": -64913320,
// "uniqueSizeInMbs": -98004917,
// "volumeGroupId": "velit non labore"
// }
// 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");
displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
v_type = CkJsonObjectW_stringOf(jResp,L"type");
lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
expirationTime = CkJsonObjectW_stringOf(jResp,L"expirationTime");
sizeInGBs = CkJsonObjectW_IntOf(jResp,L"sizeInGBs");
sizeInMBs = CkJsonObjectW_IntOf(jResp,L"sizeInMBs");
sourceType = CkJsonObjectW_stringOf(jResp,L"sourceType");
sourceVolumeGroupBackupId = CkJsonObjectW_stringOf(jResp,L"sourceVolumeGroupBackupId");
timeRequestReceived = CkJsonObjectW_stringOf(jResp,L"timeRequestReceived");
uniqueSizeInGbs = CkJsonObjectW_IntOf(jResp,L"uniqueSizeInGbs");
uniqueSizeInMbs = CkJsonObjectW_IntOf(jResp,L"uniqueSizeInMbs");
volumeGroupId = CkJsonObjectW_stringOf(jResp,L"volumeGroupId");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"volumeBackupIds");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"volumeBackupIds[i]");
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/volumeGroupBackups/:volumeGroupBackupId
Postman Collection Item JSON
{
"name": "GetVolumeGroupBackup",
"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}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId",
"value": "officia sed",
"description": "(Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
}
]
},
"description": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm)."
},
"response": [
{
"name": "The volume group backup was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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\": \"amet dolore ullamco\",\n \"volumeBackupIds\": [\n \"Lorem laborum sunt\",\n \"fugiat cillum sunt\"\n ],\n \"displayName\": \"ex magna\",\n \"compartmentId\": \"dolore laboris\",\n \"timeCreated\": \"1980-12-26T20:45:18.630Z\",\n \"type\": \"INCREMENTAL\",\n \"lifecycleState\": \"FAULTY\",\n \"definedTags\": {},\n \"expirationTime\": \"1953-04-03T06:01:14.615Z\",\n \"freeformTags\": {},\n \"sizeInGBs\": 85138526,\n \"sizeInMBs\": -60294769,\n \"sourceType\": \"SCHEDULED\",\n \"sourceVolumeGroupBackupId\": \"in exercitation ea non\",\n \"timeRequestReceived\": \"2020-06-22T19:48:13.717Z\",\n \"uniqueSizeInGbs\": -64913320,\n \"uniqueSizeInMbs\": -98004917,\n \"volumeGroupId\": \"velit non labore\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}}/volumeGroupBackups/:volumeGroupBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeGroupBackups",
":volumeGroupBackupId"
],
"variable": [
{
"key": "volumeGroupBackupId"
}
]
}
},
"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}"
}
]
}