Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$success = $http->QuickGetSb('https://iaas.{{region}}.oraclecloud.com/20160918/instances/:instanceId',$sbResponseBody);
if ($success == 0) {
print $http->LastErrorText . "\n";
exit;
}
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->LastHeader . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "sit dolor",
// "compartmentId": "et esse",
// "shape": "sunt veniam",
// "region": "laboris",
// "availabilityDomain": "dolor",
// "lifecycleState": "TERMINATED",
// "timeCreated": "2006-02-03T20:50:31.716Z",
// "agentConfig": {
// "areAllPluginsDisabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isManagementDisabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isMonitoringDisabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "pluginsConfig": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "availabilityConfig": {
// "isLiveMigrationPreferred": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "recoveryAction": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "capacityReservationId": "occaecat sint id",
// "dedicatedVmHostId": "ipsum dolor incididunt sit ex",
// "definedTags": {},
// "displayName": "consequat aliquip magna ullamco",
// "extendedMetadata": {},
// "faultDomain": "incididunt esse",
// "freeformTags": {},
// "imageId": "dolor nulla consequat ipsum",
// "instanceOptions": {
// "areLegacyImdsEndpointsDisabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "ipxeScript": "anim magna",
// "launchMode": "CUSTOM",
// "launchOptions": {
// "bootVolumeType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "firmware": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isConsistentVolumeNamingEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isPvEncryptionInTransitEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "networkType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "remoteDataVolumeType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "metadata": {},
// "platformConfig": {
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isMeasuredBootEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isSecureBootEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "isTrustedPlatformModuleEnabled": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "preemptibleInstanceConfig": {
// "preemptionAction": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "shapeConfig": {
// "baselineOcpuUtilization": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "gpuDescription": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "gpus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "localDiskDescription": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "localDisks": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "localDisksTotalSizeInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "maxVnicAttachments": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "memoryInGBs": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "networkingBandwidthInGbps": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "ocpus": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "processorDescription": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "sourceDetails": {
// "sourceType": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "timeMaintenanceRebootDue": "1973-07-06T14:36:00.263Z"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$id = $jResp->stringOf('id');
$compartmentId = $jResp->stringOf('compartmentId');
$shape = $jResp->stringOf('shape');
$region = $jResp->stringOf('region');
$availabilityDomain = $jResp->stringOf('availabilityDomain');
$lifecycleState = $jResp->stringOf('lifecycleState');
$timeCreated = $jResp->stringOf('timeCreated');
$Value = $jResp->stringOf('agentConfig.areAllPluginsDisabled.value');
$IsManagementDisabledValue = $jResp->stringOf('agentConfig.isManagementDisabled.value');
$IsMonitoringDisabledValue = $jResp->stringOf('agentConfig.isMonitoringDisabled.value');
$PluginsConfigValue = $jResp->stringOf('agentConfig.pluginsConfig.value');
$IsLiveMigrationPreferredValue = $jResp->stringOf('availabilityConfig.isLiveMigrationPreferred.value');
$RecoveryActionValue = $jResp->stringOf('availabilityConfig.recoveryAction.value');
$capacityReservationId = $jResp->stringOf('capacityReservationId');
$dedicatedVmHostId = $jResp->stringOf('dedicatedVmHostId');
$displayName = $jResp->stringOf('displayName');
$faultDomain = $jResp->stringOf('faultDomain');
$imageId = $jResp->stringOf('imageId');
$AreLegacyImdsEndpointsDisabledValue = $jResp->stringOf('instanceOptions.areLegacyImdsEndpointsDisabled.value');
$ipxeScript = $jResp->stringOf('ipxeScript');
$launchMode = $jResp->stringOf('launchMode');
$BootVolumeTypeValue = $jResp->stringOf('launchOptions.bootVolumeType.value');
$FirmwareValue = $jResp->stringOf('launchOptions.firmware.value');
$IsConsistentVolumeNamingEnabledValue = $jResp->stringOf('launchOptions.isConsistentVolumeNamingEnabled.value');
$IsPvEncryptionInTransitEnabledValue = $jResp->stringOf('launchOptions.isPvEncryptionInTransitEnabled.value');
$NetworkTypeValue = $jResp->stringOf('launchOptions.networkType.value');
$RemoteDataVolumeTypeValue = $jResp->stringOf('launchOptions.remoteDataVolumeType.value');
$TypeValue = $jResp->stringOf('platformConfig.type.value');
$IsMeasuredBootEnabledValue = $jResp->stringOf('platformConfig.isMeasuredBootEnabled.value');
$IsSecureBootEnabledValue = $jResp->stringOf('platformConfig.isSecureBootEnabled.value');
$IsTrustedPlatformModuleEnabledValue = $jResp->stringOf('platformConfig.isTrustedPlatformModuleEnabled.value');
$PreemptionActionValue = $jResp->stringOf('preemptibleInstanceConfig.preemptionAction.value');
$BaselineOcpuUtilizationValue = $jResp->stringOf('shapeConfig.baselineOcpuUtilization.value');
$GpuDescriptionValue = $jResp->stringOf('shapeConfig.gpuDescription.value');
$GpusValue = $jResp->stringOf('shapeConfig.gpus.value');
$LocalDiskDescriptionValue = $jResp->stringOf('shapeConfig.localDiskDescription.value');
$LocalDisksValue = $jResp->stringOf('shapeConfig.localDisks.value');
$LocalDisksTotalSizeInGBsValue = $jResp->stringOf('shapeConfig.localDisksTotalSizeInGBs.value');
$MaxVnicAttachmentsValue = $jResp->stringOf('shapeConfig.maxVnicAttachments.value');
$MemoryInGBsValue = $jResp->stringOf('shapeConfig.memoryInGBs.value');
$NetworkingBandwidthInGbpsValue = $jResp->stringOf('shapeConfig.networkingBandwidthInGbps.value');
$OcpusValue = $jResp->stringOf('shapeConfig.ocpus.value');
$ProcessorDescriptionValue = $jResp->stringOf('shapeConfig.processorDescription.value');
$SourceTypeValue = $jResp->stringOf('sourceDetails.sourceType.value');
$timeMaintenanceRebootDue = $jResp->stringOf('timeMaintenanceRebootDue');
?>
Curl Command
curl -X GET
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://iaas.{{region}}.oraclecloud.com/20160918/instances/:instanceId
Postman Collection Item JSON
{
"name": "GetInstance",
"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}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId",
"value": "officia sed",
"description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
}
]
},
"description": "Gets information about the specified instance."
},
"response": [
{
"name": "The instance was retrieved.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId"
}
]
}
},
"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\": \"sit dolor\",\n \"compartmentId\": \"et esse\",\n \"shape\": \"sunt veniam\",\n \"region\": \"laboris\",\n \"availabilityDomain\": \"dolor\",\n \"lifecycleState\": \"TERMINATED\",\n \"timeCreated\": \"2006-02-03T20:50:31.716Z\",\n \"agentConfig\": {\n \"areAllPluginsDisabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isManagementDisabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isMonitoringDisabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"pluginsConfig\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"availabilityConfig\": {\n \"isLiveMigrationPreferred\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"recoveryAction\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"capacityReservationId\": \"occaecat sint id\",\n \"dedicatedVmHostId\": \"ipsum dolor incididunt sit ex\",\n \"definedTags\": {},\n \"displayName\": \"consequat aliquip magna ullamco\",\n \"extendedMetadata\": {},\n \"faultDomain\": \"incididunt esse\",\n \"freeformTags\": {},\n \"imageId\": \"dolor nulla consequat ipsum\",\n \"instanceOptions\": {\n \"areLegacyImdsEndpointsDisabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"ipxeScript\": \"anim magna\",\n \"launchMode\": \"CUSTOM\",\n \"launchOptions\": {\n \"bootVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"firmware\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isConsistentVolumeNamingEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isPvEncryptionInTransitEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"networkType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"remoteDataVolumeType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"metadata\": {},\n \"platformConfig\": {\n \"type\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isMeasuredBootEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isSecureBootEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"isTrustedPlatformModuleEnabled\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"preemptibleInstanceConfig\": {\n \"preemptionAction\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"shapeConfig\": {\n \"baselineOcpuUtilization\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"gpuDescription\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"gpus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"localDiskDescription\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"localDisks\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"localDisksTotalSizeInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"maxVnicAttachments\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"memoryInGBs\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"networkingBandwidthInGbps\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"ocpus\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"processorDescription\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"sourceDetails\": {\n \"sourceType\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"timeMaintenanceRebootDue\": \"1973-07-06T14:36:00.263Z\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId"
}
]
}
},
"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}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId"
}
]
}
},
"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}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId"
}
]
}
},
"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}}/instances/:instanceId",
"host": [
"{{baseUrl}}"
],
"path": [
"instances",
":instanceId"
],
"variable": [
{
"key": "instanceId"
}
]
}
},
"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}"
}
]
}
