Chilkat Online Tools

C++ / Core Services API / ListBootVolumeAttachments

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>
#include <CkJsonArray.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("availabilityDomain","officia sed");
    queryParams.UpdateString("compartmentId","{{compartment_ocid}}");
    queryParams.UpdateInt("limit",801);
    queryParams.UpdateString("page","laboris proident officia tempor");
    queryParams.UpdateString("instanceId","officia sed");
    queryParams.UpdateString("bootVolumeId","officia sed");

    http.SetRequestHeader("Authorization","{{signature}}");
    http.SetRequestHeader("Date","{{date}}");

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeAttachments/",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonArray jarrResp;
    jarrResp.LoadSb(sbResponseBody);
    jarrResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jarrResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\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>"
    //     },
    //     "instanceId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "bootVolumeId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "availabilityDomain": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "encryptionInTransitType": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isPvEncryptionInTransitEnabled": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     }
    //   },
    //   {
    //     "id": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "instanceId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "bootVolumeId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "lifecycleState": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "compartmentId": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "availabilityDomain": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "timeCreated": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "displayName": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "encryptionInTransitType": {
    //       "value": "<Error: Too many levels of nesting to fake this schema>"
    //     },
    //     "isPvEncryptionInTransitEnabled": {
    //       "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.

    CkJsonObject *json = 0;
    const char *Value = 0;
    const char *instanceIdValue = 0;
    const char *bootVolumeIdValue = 0;
    const char *lifecycleStateValue = 0;
    const char *compartmentIdValue = 0;
    const char *availabilityDomainValue = 0;
    const char *timeCreatedValue = 0;
    const char *displayNameValue = 0;
    const char *encryptionInTransitTypeValue = 0;
    const char *isPvEncryptionInTransitEnabledValue = 0;

    int i = 0;
    int count_i = jarrResp.get_Size();
    while (i < count_i) {
        json = jarrResp.ObjectAt(i);
        Value = json->stringOf("id.value");
        instanceIdValue = json->stringOf("instanceId.value");
        bootVolumeIdValue = json->stringOf("bootVolumeId.value");
        lifecycleStateValue = json->stringOf("lifecycleState.value");
        compartmentIdValue = json->stringOf("compartmentId.value");
        availabilityDomainValue = json->stringOf("availabilityDomain.value");
        timeCreatedValue = json->stringOf("timeCreated.value");
        displayNameValue = json->stringOf("displayName.value");
        encryptionInTransitTypeValue = json->stringOf("encryptionInTransitType.value");
        isPvEncryptionInTransitEnabledValue = json->stringOf("isPvEncryptionInTransitEnabled.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 "instanceId=officia%20sed"
	-d "bootVolumeId=officia%20sed"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/bootVolumeAttachments/

Postman Collection Item JSON

{
  "name": "ListBootVolumeAttachments",
  "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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId={{compartment_ocid}}&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumeAttachments",
        ""
      ],
      "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": "instanceId",
          "value": "officia sed",
          "description": "The OCID of the instance."
        },
        {
          "key": "bootVolumeId",
          "value": "officia sed",
          "description": "The OCID of the boot volume."
        }
      ]
    },
    "description": "Lists the boot volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, boot volume OCID, or both.\n"
  },
  "response": [
    {
      "name": "The list is being retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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  \"instanceId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"bootVolumeId\": {\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  \"compartmentId\": {\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  \"timeCreated\": {\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  \"encryptionInTransitType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isPvEncryptionInTransitEnabled\": {\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  \"instanceId\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"bootVolumeId\": {\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  \"compartmentId\": {\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  \"timeCreated\": {\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  \"encryptionInTransitType\": {\n   \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n  },\n  \"isPvEncryptionInTransitEnabled\": {\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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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}}/bootVolumeAttachments/?availabilityDomain=officia sed&compartmentId=amet ut&limit=801&page=laboris proident officia tempor&instanceId=officia sed&bootVolumeId=officia sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeAttachments",
            ""
          ],
          "query": [
            {
              "key": "availabilityDomain",
              "value": "officia sed"
            },
            {
              "key": "compartmentId",
              "value": "amet ut"
            },
            {
              "key": "limit",
              "value": "801"
            },
            {
              "key": "page",
              "value": "laboris proident officia tempor"
            },
            {
              "key": "instanceId",
              "value": "officia sed"
            },
            {
              "key": "bootVolumeId",
              "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}"
    }
  ]
}