Chilkat Online Tools

Foxpro / Core Services API / GetVolumeAttachment

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcAttachmentType
LOCAL lcInstanceId
LOCAL lcVolumeId
LOCAL lcLifecycleState
LOCAL lcCompartmentId
LOCAL lcAvailabilityDomain
LOCAL lcTimeCreated
LOCAL lcDevice
LOCAL lcDisplayName
LOCAL lnIsMultipath
LOCAL lnIsPvEncryptionInTransitEnabled
LOCAL lnIsReadOnly
LOCAL lnIsShareable
LOCAL lcIscsiLoginState

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

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

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/:volumeAttachmentId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcId = loJResp.StringOf("id")
lcAttachmentType = loJResp.StringOf("attachmentType")
lcInstanceId = loJResp.StringOf("instanceId")
lcVolumeId = loJResp.StringOf("volumeId")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcCompartmentId = loJResp.StringOf("compartmentId")
lcAvailabilityDomain = loJResp.StringOf("availabilityDomain")
lcTimeCreated = loJResp.StringOf("timeCreated")
lcDevice = loJResp.StringOf("device")
lcDisplayName = loJResp.StringOf("displayName")
lnIsMultipath = loJResp.BoolOf("isMultipath")
lnIsPvEncryptionInTransitEnabled = loJResp.BoolOf("isPvEncryptionInTransitEnabled")
lnIsReadOnly = loJResp.BoolOf("isReadOnly")
lnIsShareable = loJResp.BoolOf("isShareable")
lcIscsiLoginState = loJResp.StringOf("iscsiLoginState")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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