Chilkat Online Tools

unicodeC / Core Services API / GetVolumeAttachment

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 *attachmentType;
    const wchar_t *instanceId;
    const wchar_t *volumeId;
    const wchar_t *lifecycleState;
    const wchar_t *compartmentId;
    const wchar_t *availabilityDomain;
    const wchar_t *timeCreated;
    const wchar_t *device;
    const wchar_t *displayName;
    BOOL isMultipath;
    BOOL isPvEncryptionInTransitEnabled;
    BOOL isReadOnly;
    BOOL isShareable;
    const wchar_t *iscsiLoginState;

    // 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/volumeAttachments/:volumeAttachmentId",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": "ipsum minim",
    //   "attachmentType": "non",
    //   "instanceId": "esse ea sint",
    //   "volumeId": "minim occaecat in est anim",
    //   "lifecycleState": "ATTACHING",
    //   "compartmentId": "eu ex sunt",
    //   "availabilityDomain": "magna proident",
    //   "timeCreated": "1954-08-02T00:08:02.631Z",
    //   "device": "consequat Lorem",
    //   "displayName": "cupidatat do dolore cillum",
    //   "isMultipath": false,
    //   "isPvEncryptionInTransitEnabled": true,
    //   "isReadOnly": true,
    //   "isShareable": true,
    //   "iscsiLoginState": "UNKNOWN"
    // }

    // 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");
    attachmentType = CkJsonObjectW_stringOf(jResp,L"attachmentType");
    instanceId = CkJsonObjectW_stringOf(jResp,L"instanceId");
    volumeId = CkJsonObjectW_stringOf(jResp,L"volumeId");
    lifecycleState = CkJsonObjectW_stringOf(jResp,L"lifecycleState");
    compartmentId = CkJsonObjectW_stringOf(jResp,L"compartmentId");
    availabilityDomain = CkJsonObjectW_stringOf(jResp,L"availabilityDomain");
    timeCreated = CkJsonObjectW_stringOf(jResp,L"timeCreated");
    device = CkJsonObjectW_stringOf(jResp,L"device");
    displayName = CkJsonObjectW_stringOf(jResp,L"displayName");
    isMultipath = CkJsonObjectW_BoolOf(jResp,L"isMultipath");
    isPvEncryptionInTransitEnabled = CkJsonObjectW_BoolOf(jResp,L"isPvEncryptionInTransitEnabled");
    isReadOnly = CkJsonObjectW_BoolOf(jResp,L"isReadOnly");
    isShareable = CkJsonObjectW_BoolOf(jResp,L"isShareable");
    iscsiLoginState = CkJsonObjectW_stringOf(jResp,L"iscsiLoginState");


    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/volumeAttachments/:volumeAttachmentId

Postman Collection Item JSON

{
  "name": "GetVolumeAttachment",
  "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}}/volumeAttachments/:volumeAttachmentId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeAttachments",
        ":volumeAttachmentId"
      ],
      "variable": [
        {
          "key": "volumeAttachmentId",
          "value": "officia sed",
          "description": "(Required) The OCID of the volume attachment."
        }
      ]
    },
    "description": "Gets information about the specified volume attachment."
  },
  "response": [
    {
      "name": "The volume attachment was retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/:volumeAttachmentId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ":volumeAttachmentId"
          ],
          "variable": [
            {
              "key": "volumeAttachmentId"
            }
          ]
        }
      },
      "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\": \"ipsum minim\",\n \"attachmentType\": \"non\",\n \"instanceId\": \"esse ea sint\",\n \"volumeId\": \"minim occaecat in est anim\",\n \"lifecycleState\": \"ATTACHING\",\n \"compartmentId\": \"eu ex sunt\",\n \"availabilityDomain\": \"magna proident\",\n \"timeCreated\": \"1954-08-02T00:08:02.631Z\",\n \"device\": \"consequat Lorem\",\n \"displayName\": \"cupidatat do dolore cillum\",\n \"isMultipath\": false,\n \"isPvEncryptionInTransitEnabled\": true,\n \"isReadOnly\": true,\n \"isShareable\": true,\n \"iscsiLoginState\": \"UNKNOWN\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/:volumeAttachmentId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ":volumeAttachmentId"
          ],
          "variable": [
            {
              "key": "volumeAttachmentId"
            }
          ]
        }
      },
      "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}}/volumeAttachments/:volumeAttachmentId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ":volumeAttachmentId"
          ],
          "variable": [
            {
              "key": "volumeAttachmentId"
            }
          ]
        }
      },
      "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}}/volumeAttachments/:volumeAttachmentId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ":volumeAttachmentId"
          ],
          "variable": [
            {
              "key": "volumeAttachmentId"
            }
          ]
        }
      },
      "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}}/volumeAttachments/:volumeAttachmentId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ":volumeAttachmentId"
          ],
          "variable": [
            {
              "key": "volumeAttachmentId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}