Chilkat Online Tools

Foxpro / Core Services API / GetBlockVolumeReplica

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcAvailabilityDomain
LOCAL lnSizeInGBs
LOCAL lcCompartmentId
LOCAL lcDisplayName
LOCAL lcTimeCreated
LOCAL lcLifecycleState
LOCAL lcTimeLastSynced
LOCAL lcBlockVolumeId
LOCAL lnTotalDataTransferredInGBs

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://iaas.{{region}}.oraclecloud.com/20160918/blockVolumeReplicas/:blockVolumeReplicaId",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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": "ea in fugiat",
*   "availabilityDomain": "nisi cillum do elit",
*   "sizeInGBs": 2853,
*   "compartmentId": "Duis dolor",
*   "displayName": "tempor cillum consequat",
*   "timeCreated": "1994-05-04T07:42:04.840Z",
*   "lifecycleState": "FAULTY",
*   "timeLastSynced": "2006-11-07T06:32:00.457Z",
*   "blockVolumeId": "sed reprehenderit",
*   "definedTags": {},
*   "freeformTags": {},
*   "totalDataTransferredInGBs": 83632600
* }

* 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")
lcAvailabilityDomain = loJResp.StringOf("availabilityDomain")
lnSizeInGBs = loJResp.IntOf("sizeInGBs")
lcCompartmentId = loJResp.StringOf("compartmentId")
lcDisplayName = loJResp.StringOf("displayName")
lcTimeCreated = loJResp.StringOf("timeCreated")
lcLifecycleState = loJResp.StringOf("lifecycleState")
lcTimeLastSynced = loJResp.StringOf("timeLastSynced")
lcBlockVolumeId = loJResp.StringOf("blockVolumeId")
lnTotalDataTransferredInGBs = loJResp.IntOf("totalDataTransferredInGBs")

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X GET
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/blockVolumeReplicas/:blockVolumeReplicaId

Postman Collection Item JSON

{
  "name": "GetBlockVolumeReplica",
  "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "blockVolumeReplicas",
        ":blockVolumeReplicaId"
      ],
      "variable": [
        {
          "key": "blockVolumeReplicaId",
          "value": "officia sed",
          "description": "(Required) The OCID of the block volume replica."
        }
      ]
    },
    "description": "Gets information for the specified block volume replica."
  },
  "response": [
    {
      "name": "The block volume replica's information has been retrieved.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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\": \"ea in fugiat\",\n \"availabilityDomain\": \"nisi cillum do elit\",\n \"sizeInGBs\": 2853,\n \"compartmentId\": \"Duis dolor\",\n \"displayName\": \"tempor cillum consequat\",\n \"timeCreated\": \"1994-05-04T07:42:04.840Z\",\n \"lifecycleState\": \"FAULTY\",\n \"timeLastSynced\": \"2006-11-07T06:32:00.457Z\",\n \"blockVolumeId\": \"sed reprehenderit\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"totalDataTransferredInGBs\": 83632600\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}}/blockVolumeReplicas/:blockVolumeReplicaId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "blockVolumeReplicas",
            ":blockVolumeReplicaId"
          ],
          "variable": [
            {
              "key": "blockVolumeReplicaId"
            }
          ]
        }
      },
      "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}"
    }
  ]
}