SQL Server / Core Services API / GetVolumeAttachment
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://iaas.{{region}}.oraclecloud.com/20160918/volumeAttachments/:volumeAttachmentId', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @attachmentType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @attachmentType OUT, 'attachmentType'
DECLARE @instanceId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @instanceId OUT, 'instanceId'
DECLARE @volumeId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @volumeId OUT, 'volumeId'
DECLARE @lifecycleState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
DECLARE @compartmentId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
DECLARE @availabilityDomain nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
DECLARE @timeCreated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
DECLARE @device nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @device OUT, 'device'
DECLARE @displayName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
DECLARE @isMultipath int
EXEC sp_OAMethod @jResp, 'BoolOf', @isMultipath OUT, 'isMultipath'
DECLARE @isPvEncryptionInTransitEnabled int
EXEC sp_OAMethod @jResp, 'BoolOf', @isPvEncryptionInTransitEnabled OUT, 'isPvEncryptionInTransitEnabled'
DECLARE @isReadOnly int
EXEC sp_OAMethod @jResp, 'BoolOf', @isReadOnly OUT, 'isReadOnly'
DECLARE @isShareable int
EXEC sp_OAMethod @jResp, 'BoolOf', @isShareable OUT, 'isShareable'
DECLARE @iscsiLoginState nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @iscsiLoginState OUT, 'iscsiLoginState'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
