Chilkat Online Tools

unicodeC / Core Services API / AttachVolume

Back to Collection Items

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

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    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();

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "instanceId": "consequat laboris",
    //   "volumeId": "nulla dolor consectetur Duis",
    //   "type": "in occaecat velit in",
    //   "device": "Duis",
    //   "displayName": "dolore enim cillum",
    //   "isReadOnly": false,
    //   "isShareable": true
    // }

    json = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(json,L"instanceId",L"consequat laboris");
    CkJsonObjectW_UpdateString(json,L"volumeId",L"nulla dolor consectetur Duis");
    CkJsonObjectW_UpdateString(json,L"type",L"in occaecat velit in");
    CkJsonObjectW_UpdateString(json,L"device",L"Duis");
    CkJsonObjectW_UpdateString(json,L"displayName",L"dolore enim cillum");
    CkJsonObjectW_UpdateBool(json,L"isReadOnly",FALSE);
    CkJsonObjectW_UpdateBool(json,L"isShareable",TRUE);

    CkHttpW_SetRequestHeader(http,L"opc-retry-token",L"aliqua enim i");
    CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
    CkHttpW_SetRequestHeader(http,L"x-content-sha256",L"{{content_sha256}}");
    CkHttpW_SetRequestHeader(http,L"Authorization",L"{{signature}}");
    CkHttpW_SetRequestHeader(http,L"Date",L"{{date}}");

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

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

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    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(json);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

    // 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);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X POST
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "instanceId": "consequat laboris",
    "volumeId": "nulla dolor consectetur Duis",
    "type": "in occaecat velit in",
    "device": "Duis",
    "displayName": "dolore enim cillum",
    "isReadOnly": false,
    "isShareable": true
}'
https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/

Postman Collection Item JSON

{
  "name": "AttachVolume",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/volumeAttachments/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "volumeAttachments",
        ""
      ]
    },
    "description": "Attaches the specified storage volume to the specified instance.\n"
  },
  "response": [
    {
      "name": "The volume is being attached.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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": "POST",
        "header": [
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"instanceId\": \"consequat laboris\",\n    \"volumeId\": \"nulla dolor consectetur Duis\",\n    \"type\": \"in occaecat velit in\",\n    \"device\": \"Duis\",\n    \"displayName\": \"dolore enim cillum\",\n    \"isReadOnly\": false,\n    \"isShareable\": true\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/volumeAttachments/",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "volumeAttachments",
            ""
          ]
        }
      },
      "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}"
    }
  ]
}