Chilkat Online Tools

unicodeC / Core Services API / ListVolumeBackupPolicies

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonArrayW jarrResp;
    int respStatusCode;
    HCkJsonObjectW json;
    const wchar_t *Value;
    const wchar_t *displayNameValue;
    const wchar_t *schedulesValue;
    const wchar_t *timeCreatedValue;
    const wchar_t *compartmentIdValue;
    const wchar_t *definedTagsValue;
    const wchar_t *destinationRegionValue;
    const wchar_t *freeformTagsValue;
    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();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateInt(queryParams,L"limit",801);
    CkJsonObjectW_UpdateString(queryParams,L"compartmentId",L"{{compartment_ocid}}");

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

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackupPolicies",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jarrResp = CkJsonArrayW_Create();
    CkJsonArrayW_LoadSb(jarrResp,sbResponseBody);
    CkJsonArrayW_putEmitCompact(jarrResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonArrayW_emit(jarrResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonArrayW_Dispose(jarrResp);
        return;
    }

    CkHttpResponseW_Dispose(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>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "schedules": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "destinationRegion": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "freeformTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   {
    //     "id": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "schedules": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "definedTags": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "destinationRegion": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "freeformTags": {
    //       "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.

    i = 0;
    count_i = CkJsonArrayW_getSize(jarrResp);
    while (i < count_i) {
        json = CkJsonArrayW_ObjectAt(jarrResp,i);
        Value = CkJsonObjectW_stringOf(json,L"id.value");
        displayNameValue = CkJsonObjectW_stringOf(json,L"displayName.value");
        schedulesValue = CkJsonObjectW_stringOf(json,L"schedules.value");
        timeCreatedValue = CkJsonObjectW_stringOf(json,L"timeCreated.value");
        compartmentIdValue = CkJsonObjectW_stringOf(json,L"compartmentId.value");
        definedTagsValue = CkJsonObjectW_stringOf(json,L"definedTags.value");
        destinationRegionValue = CkJsonObjectW_stringOf(json,L"destinationRegion.value");
        freeformTagsValue = CkJsonObjectW_stringOf(json,L"freeformTags.value");
        CkJsonObjectW_Dispose(json);
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonArrayW_Dispose(jarrResp);

    }

Curl Command

curl -G -d "limit=801"
	-d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/volumeBackupPolicies

Postman Collection Item JSON

{
  "name": "ListVolumeBackupPolicies",
  "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}}/volumeBackupPolicies?limit=801&compartmentId={{compartment_ocid}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeBackupPolicies"
      ],
      "query": [
        {
          "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",
          "disabled": true
        },
        {
          "key": "compartmentId",
          "value": "{{compartment_ocid}}",
          "description": "The OCID of the compartment.\nIf no compartment is specified, the Oracle defined backup policies are listed.\n"
        }
      ]
    },
    "description": "Lists all the volume backup policies available in the specified compartment.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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  \"displayName\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"schedules\": {\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  \"compartmentId\": {\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  \"destinationRegion\": {\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 },\n {\n  \"id\": {\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  \"schedules\": {\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  \"compartmentId\": {\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  \"destinationRegion\": {\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 }\n]"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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}}/volumeBackupPolicies?limit=801&page=laboris proident officia tempor&compartmentId=amet ut",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeBackupPolicies"
          ],
          "query": [
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            }
          ]
        }
      },
      "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}"
    }
  ]
}