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 *v_type;
const wchar_t *displayName;
const wchar_t *compartmentId;
const wchar_t *timeCreated;
const wchar_t *lifecycleState;
const wchar_t *expirationTime;
const wchar_t *kmsKeyId;
int sizeInGBs;
int sizeInMBs;
const wchar_t *sourceType;
const wchar_t *sourceVolumeBackupId;
const wchar_t *timeRequestReceived;
int uniqueSizeInGBs;
int uniqueSizeInMbs;
const wchar_t *volumeId;
// 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/volumeBackups/:volumeBackupId",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": "ea",
// "type": "FULL",
// "displayName": "amet elit occaecat laboris",
// "compartmentId": "eu et sint",
// "timeCreated": "2007-11-11T04:41:21.719Z",
// "lifecycleState": "CREATING",
// "definedTags": {},
// "expirationTime": "1998-05-31T02:51:40.598Z",
// "freeformTags": {},
// "kmsKeyId": "nostrud sint",
// "sizeInGBs": 11402,
// "sizeInMBs": 12081259,
// "sourceType": "MANUAL",
// "sourceVolumeBackupId": "in magna laboris consectetur",
// "timeRequestReceived": "1981-12-16T03:31:57.153Z",
// "uniqueSizeInGBs": 2257,
// "uniqueSizeInMbs": 13322289,
// "volumeId": "eu mollit consectetur Excepteur"
// }
// 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");
v_type = CkJsonObjectW_stringOf(jResp,L"type");
displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
expirationTime = CkJsonObjectW_stringOf(jResp,L"expirationTime");
kmsKeyId = CkJsonObjectW_stringOf(jResp,L"kmsKeyId");
sizeInGBs = CkJsonObjectW_IntOf(jResp,L"sizeInGBs");
sizeInMBs = CkJsonObjectW_IntOf(jResp,L"sizeInMBs");
sourceType = CkJsonObjectW_stringOf(jResp,L"sourceType");
sourceVolumeBackupId = CkJsonObjectW_stringOf(jResp,L"sourceVolumeBackupId");
timeRequestReceived = CkJsonObjectW_stringOf(jResp,L"timeRequestReceived");
uniqueSizeInGBs = CkJsonObjectW_IntOf(jResp,L"uniqueSizeInGBs");
uniqueSizeInMbs = CkJsonObjectW_IntOf(jResp,L"uniqueSizeInMbs");
volumeId = CkJsonObjectW_stringOf(jResp,L"volumeId");
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/volumeBackups/:volumeBackupId
Postman Collection Item JSON
{
"name": "GetVolumeBackup",
"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}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId",
"value": "officia sed",
"description": "(Required) The OCID of the volume backup."
}
]
},
"description": "Gets information for the specified volume backup."
},
"response": [
{
"name": "The volume backup was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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\": \"ea\",\n \"type\": \"FULL\",\n \"displayName\": \"amet elit occaecat laboris\",\n \"compartmentId\": \"eu et sint\",\n \"timeCreated\": \"2007-11-11T04:41:21.719Z\",\n \"lifecycleState\": \"CREATING\",\n \"definedTags\": {},\n \"expirationTime\": \"1998-05-31T02:51:40.598Z\",\n \"freeformTags\": {},\n \"kmsKeyId\": \"nostrud sint\",\n \"sizeInGBs\": 11402,\n \"sizeInMBs\": 12081259,\n \"sourceType\": \"MANUAL\",\n \"sourceVolumeBackupId\": \"in magna laboris consectetur\",\n \"timeRequestReceived\": \"1981-12-16T03:31:57.153Z\",\n \"uniqueSizeInGBs\": 2257,\n \"uniqueSizeInMbs\": 13322289,\n \"volumeId\": \"eu mollit consectetur Excepteur\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}}/volumeBackups/:volumeBackupId",
"host": [
"{{baseUrl}}"
],
"path": [
"volumeBackups",
":volumeBackupId"
],
"variable": [
{
"key": "volumeBackupId"
}
]
}
},
"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}"
}
]
}