Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
CkHttp::ckSetRequestHeader(http,"Date","{{date}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/:volumeAttachmentId",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
id.s = CkJsonObject::ckStringOf(jResp,"id")
attachmentType.s = CkJsonObject::ckStringOf(jResp,"attachmentType")
instanceId.s = CkJsonObject::ckStringOf(jResp,"instanceId")
volumeId.s = CkJsonObject::ckStringOf(jResp,"volumeId")
lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
availabilityDomain.s = CkJsonObject::ckStringOf(jResp,"availabilityDomain")
timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
device.s = CkJsonObject::ckStringOf(jResp,"device")
displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
isMultipath.i = CkJsonObject::ckBoolOf(jResp,"isMultipath")
isPvEncryptionInTransitEnabled.i = CkJsonObject::ckBoolOf(jResp,"isPvEncryptionInTransitEnabled")
isReadOnly.i = CkJsonObject::ckBoolOf(jResp,"isReadOnly")
isShareable.i = CkJsonObject::ckBoolOf(jResp,"isShareable")
iscsiLoginState.s = CkJsonObject::ckStringOf(jResp,"iscsiLoginState")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
