Chilkat Online Tools

SQL Server / Core Services API / GetBootVolumeReplica

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/bootVolumeReplicas/:bootVolumeReplicaId', @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": "nulla dolore eu laborum",
    --   "availabilityDomain": "nostrud ea",
    --   "sizeInGBs": 4636,
    --   "displayName": "incididunt Duis",
    --   "compartmentId": "sunt aliqua occaecat nostrud",
    --   "timeCreated": "1997-02-12T06:09:55.412Z",
    --   "lifecycleState": "ACTIVATING",
    --   "timeLastSynced": "2021-07-02T14:45:19.765Z",
    --   "bootVolumeId": "labore laboris",
    --   "definedTags": {},
    --   "freeformTags": {},
    --   "imageId": "veniam ad eu Duis",
    --   "totalDataTransferredInGBs": 1832269
    -- }

    -- 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 @availabilityDomain nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @availabilityDomain OUT, 'availabilityDomain'
    DECLARE @sizeInGBs int
    EXEC sp_OAMethod @jResp, 'IntOf', @sizeInGBs OUT, 'sizeInGBs'
    DECLARE @displayName nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'displayName'
    DECLARE @compartmentId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @compartmentId OUT, 'compartmentId'
    DECLARE @timeCreated nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @timeCreated OUT, 'timeCreated'
    DECLARE @lifecycleState nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @lifecycleState OUT, 'lifecycleState'
    DECLARE @timeLastSynced nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @timeLastSynced OUT, 'timeLastSynced'
    DECLARE @bootVolumeId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @bootVolumeId OUT, 'bootVolumeId'
    DECLARE @imageId nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @imageId OUT, 'imageId'
    DECLARE @totalDataTransferredInGBs int
    EXEC sp_OAMethod @jResp, 'IntOf', @totalDataTransferredInGBs OUT, 'totalDataTransferredInGBs'

    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/bootVolumeReplicas/:bootVolumeReplicaId

Postman Collection Item JSON

{
  "name": "GetBootVolumeReplica",
  "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "bootVolumeReplicas",
        ":bootVolumeReplicaId"
      ],
      "variable": [
        {
          "key": "bootVolumeReplicaId",
          "value": "officia sed",
          "description": "(Required) The OCID of the boot volume replica."
        }
      ]
    },
    "description": "Gets information for the specified boot volume replica."
  },
  "response": [
    {
      "name": "The boot volume replica's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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\": \"nulla dolore eu laborum\",\n \"availabilityDomain\": \"nostrud ea\",\n \"sizeInGBs\": 4636,\n \"displayName\": \"incididunt Duis\",\n \"compartmentId\": \"sunt aliqua occaecat nostrud\",\n \"timeCreated\": \"1997-02-12T06:09:55.412Z\",\n \"lifecycleState\": \"ACTIVATING\",\n \"timeLastSynced\": \"2021-07-02T14:45:19.765Z\",\n \"bootVolumeId\": \"labore laboris\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"imageId\": \"veniam ad eu Duis\",\n \"totalDataTransferredInGBs\": 1832269\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_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": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/bootVolumeReplicas/:bootVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "bootVolumeReplicas",
            ":bootVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "bootVolumeReplicaId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}