Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
#include <CkJsonArrayW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
CkJsonObjectW queryParams;
queryParams.UpdateString(L"availabilityDomain",L"officia sed");
queryParams.UpdateString(L"compartmentId",L"{{compartment_ocid}}");
queryParams.UpdateInt(L"limit",801);
queryParams.UpdateString(L"page",L"laboris proident officia tempor");
queryParams.UpdateString(L"volumeGroupId",L"officia sed");
http.SetRequestHeader(L"Authorization",L"{{signature}}");
http.SetRequestHeader(L"Date",L"{{date}}");
CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumes",queryParams);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonArrayW jarrResp;
jarrResp.LoadSb(sbResponseBody);
jarrResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jarrResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "availabilityDomain": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInMBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "autoTunedVpusPerGB": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "bootVolumeReplicas": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "imageId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isAutoTuneEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isHydrated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "kmsKeyId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeGroupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vpusPerGB": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// {
// "id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "availabilityDomain": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInMBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "compartmentId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "timeCreated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "lifecycleState": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "autoTunedVpusPerGB": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "bootVolumeReplicas": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "definedTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "displayName": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "freeformTags": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "imageId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isAutoTuneEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isHydrated": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "kmsKeyId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sizeInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "sourceDetails": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "volumeGroupId": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "vpusPerGB": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ]
// 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.
CkJsonObjectW *json = 0;
const wchar_t *Value = 0;
const wchar_t *availabilityDomainValue = 0;
const wchar_t *sizeInMBsValue = 0;
const wchar_t *compartmentIdValue = 0;
const wchar_t *timeCreatedValue = 0;
const wchar_t *lifecycleStateValue = 0;
const wchar_t *autoTunedVpusPerGBValue = 0;
const wchar_t *bootVolumeReplicasValue = 0;
const wchar_t *definedTagsValue = 0;
const wchar_t *displayNameValue = 0;
const wchar_t *freeformTagsValue = 0;
const wchar_t *imageIdValue = 0;
const wchar_t *isAutoTuneEnabledValue = 0;
const wchar_t *isHydratedValue = 0;
const wchar_t *kmsKeyIdValue = 0;
const wchar_t *sizeInGBsValue = 0;
const wchar_t *sourceDetailsValue = 0;
const wchar_t *volumeGroupIdValue = 0;
const wchar_t *vpusPerGBValue = 0;
int i = 0;
int count_i = jarrResp.get_Size();
while (i < count_i) {
json = jarrResp.ObjectAt(i);
Value = json->stringOf(L"id.value");
availabilityDomainValue = json->stringOf(L"availabilityDomain.value");
sizeInMBsValue = json->stringOf(L"sizeInMBs.value");
compartmentIdValue = json->stringOf(L"compartmentId.value");
timeCreatedValue = json->stringOf(L"timeCreated.value");
lifecycleStateValue = json->stringOf(L"lifecycleState.value");
autoTunedVpusPerGBValue = json->stringOf(L"autoTunedVpusPerGB.value");
bootVolumeReplicasValue = json->stringOf(L"bootVolumeReplicas.value");
definedTagsValue = json->stringOf(L"definedTags.value");
displayNameValue = json->stringOf(L"displayName.value");
freeformTagsValue = json->stringOf(L"freeformTags.value");
imageIdValue = json->stringOf(L"imageId.value");
isAutoTuneEnabledValue = json->stringOf(L"isAutoTuneEnabled.value");
isHydratedValue = json->stringOf(L"isHydrated.value");
kmsKeyIdValue = json->stringOf(L"kmsKeyId.value");
sizeInGBsValue = json->stringOf(L"sizeInGBs.value");
sourceDetailsValue = json->stringOf(L"sourceDetails.value");
volumeGroupIdValue = json->stringOf(L"volumeGroupId.value");
vpusPerGBValue = json->stringOf(L"vpusPerGB.value");
delete json;
i = i + 1;
}
}
Curl Command
curl -G -d "availabilityDomain=officia%20sed"
-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "limit=801"
-d "page=laboris%20proident%20officia%20tempor"
-d "volumeGroupId=officia%20sed"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumes
Postman Collection Item JSON
{
"name": "ListBootVolumes",
"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?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed",
"description": "(Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n"
},
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
},
{
"key": "limit",
"value": "801",
"description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
},
{
"key": "page",
"value": "laboris proident officia tempor",
"description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
},
{
"key": "volumeGroupId",
"value": "officia sed",
"description": "The OCID of the volume group."
}
]
},
"description": "Lists the boot volumes in the specified compartment and availability domain.\n"
},
"response": [
{
"name": "The list is being retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-next-page",
"value": "officia sed",
"description": "For list pagination. When this header appears in the response, additional pages\nof results remain. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\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 {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"autoTunedVpusPerGB\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"bootVolumeReplicas\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"imageId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isAutoTuneEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isHydrated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"kmsKeyId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceDetails\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeGroupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vpusPerGB\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n {\n \"id\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"availabilityDomain\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInMBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"compartmentId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"timeCreated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"lifecycleState\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"autoTunedVpusPerGB\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"bootVolumeReplicas\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"definedTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"displayName\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"freeformTags\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"imageId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isAutoTuneEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isHydrated\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"kmsKeyId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"sourceDetails\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"volumeGroupId\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"vpusPerGB\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/bootVolumes?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"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?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"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?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"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?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"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?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&volumeGroupId=officia sed",
"host": [
"{{baseUrl}}"
],
"path": [
"bootVolumes"
],
"query": [
{
"key": "availabilityDomain",
"value": "officia sed"
},
{
"key": "compartmentId",
"value": "amet ut"
},
{
"key": "limit",
"value": "801"
},
{
"key": "page",
"value": "laboris proident officia tempor"
},
{
"key": "volumeGroupId",
"value": "officia sed"
}
]
}
},
"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}"
}
]
}
