PowerBuilder / Core Services API / GetVolumeAttachment
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_AttachmentType
string ls_InstanceId
string ls_VolumeId
string ls_LifecycleState
string ls_CompartmentId
string ls_AvailabilityDomain
string ls_TimeCreated
string ls_Device
string ls_DisplayName
integer li_IsMultipath
integer li_IsPvEncryptionInTransitEnabled
integer li_IsReadOnly
integer li_IsShareable
string ls_IscsiLoginState
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("Authorization","{{signature}}")
loo_Http.SetRequestHeader("Date","{{date}}")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/:volumeAttachmentId",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// 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
ls_Id = loo_JResp.StringOf("id")
ls_AttachmentType = loo_JResp.StringOf("attachmentType")
ls_InstanceId = loo_JResp.StringOf("instanceId")
ls_VolumeId = loo_JResp.StringOf("volumeId")
ls_LifecycleState = loo_JResp.StringOf("lifecycleState")
ls_CompartmentId = loo_JResp.StringOf("compartmentId")
ls_AvailabilityDomain = loo_JResp.StringOf("availabilityDomain")
ls_TimeCreated = loo_JResp.StringOf("timeCreated")
ls_Device = loo_JResp.StringOf("device")
ls_DisplayName = loo_JResp.StringOf("displayName")
li_IsMultipath = loo_JResp.BoolOf("isMultipath")
li_IsPvEncryptionInTransitEnabled = loo_JResp.BoolOf("isPvEncryptionInTransitEnabled")
li_IsReadOnly = loo_JResp.BoolOf("isReadOnly")
li_IsShareable = loo_JResp.BoolOf("isShareable")
ls_IscsiLoginState = loo_JResp.StringOf("iscsiLoginState")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_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}"
}
]
}
