Chilkat Online Tools

Mono / Core Services API / GetVolumeAttachment

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/:volumeAttachmentId",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

string id = jResp.StringOf("id");
string attachmentType = jResp.StringOf("attachmentType");
string instanceId = jResp.StringOf("instanceId");
string volumeId = jResp.StringOf("volumeId");
string lifecycleState = jResp.StringOf("lifecycleState");
string compartmentId = jResp.StringOf("compartmentId");
string availabilityDomain = jResp.StringOf("availabilityDomain");
string timeCreated = jResp.StringOf("timeCreated");
string device = jResp.StringOf("device");
string displayName = jResp.StringOf("displayName");
bool isMultipath = jResp.BoolOf("isMultipath");
bool isPvEncryptionInTransitEnabled = jResp.BoolOf("isPvEncryptionInTransitEnabled");
bool isReadOnly = jResp.BoolOf("isReadOnly");
bool isShareable = jResp.BoolOf("isShareable");
string iscsiLoginState = jResp.StringOf("iscsiLoginState");

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}"
    }
  ]
}