DataFlex / Core Services API / GetBlockVolumeReplica
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sAvailabilityDomain
Integer iSizeInGBs
String sCompartmentId
String sDisplayName
String sTimeCreated
String sLifecycleState
String sTimeLastSynced
String sBlockVolumeId
Integer iTotalDataTransferredInGBs
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Authorization" "{{signature}}"
Send ComSetRequestHeader To hoHttp "Date" "{{date}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://iaas.{{region}}.oraclecloud.com/20160918/blockVolumeReplicas/:blockVolumeReplicaId" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "availabilityDomain" To sAvailabilityDomain
Get ComIntOf Of hoJResp "sizeInGBs" To iSizeInGBs
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "timeLastSynced" To sTimeLastSynced
Get ComStringOf Of hoJResp "blockVolumeId" To sBlockVolumeId
Get ComIntOf Of hoJResp "totalDataTransferredInGBs" To iTotalDataTransferredInGBs
End_Procedure
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}"
}
]
}
