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 sCompartmentId
String sShape
String sRegion
String sAvailabilityDomain
String sLifecycleState
String sTimeCreated
String sValue
String sIsManagementDisabledValue
String sIsMonitoringDisabledValue
String sPluginsConfigValue
String sIsLiveMigrationPreferredValue
String sRecoveryActionValue
String sCapacityReservationId
String sDedicatedVmHostId
String sDisplayName
String sFaultDomain
String sImageId
String sAreLegacyImdsEndpointsDisabledValue
String sIpxeScript
String sLaunchMode
String sBootVolumeTypeValue
String sFirmwareValue
String sIsConsistentVolumeNamingEnabledValue
String sIsPvEncryptionInTransitEnabledValue
String sNetworkTypeValue
String sRemoteDataVolumeTypeValue
String sTypeValue
String sIsMeasuredBootEnabledValue
String sIsSecureBootEnabledValue
String sIsTrustedPlatformModuleEnabledValue
String sPreemptionActionValue
String sBaselineOcpuUtilizationValue
String sGpuDescriptionValue
String sGpusValue
String sLocalDiskDescriptionValue
String sLocalDisksValue
String sLocalDisksTotalSizeInGBsValue
String sMaxVnicAttachmentsValue
String sMemoryInGBsValue
String sNetworkingBandwidthInGbpsValue
String sOcpusValue
String sProcessorDescriptionValue
String sSourceTypeValue
String sTimeMaintenanceRebootDue
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/instances/:instanceId" 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": "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
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "compartmentId" To sCompartmentId
Get ComStringOf Of hoJResp "shape" To sShape
Get ComStringOf Of hoJResp "region" To sRegion
Get ComStringOf Of hoJResp "availabilityDomain" To sAvailabilityDomain
Get ComStringOf Of hoJResp "lifecycleState" To sLifecycleState
Get ComStringOf Of hoJResp "timeCreated" To sTimeCreated
Get ComStringOf Of hoJResp "agentConfig.areAllPluginsDisabled.value" To sValue
Get ComStringOf Of hoJResp "agentConfig.isManagementDisabled.value" To sIsManagementDisabledValue
Get ComStringOf Of hoJResp "agentConfig.isMonitoringDisabled.value" To sIsMonitoringDisabledValue
Get ComStringOf Of hoJResp "agentConfig.pluginsConfig.value" To sPluginsConfigValue
Get ComStringOf Of hoJResp "availabilityConfig.isLiveMigrationPreferred.value" To sIsLiveMigrationPreferredValue
Get ComStringOf Of hoJResp "availabilityConfig.recoveryAction.value" To sRecoveryActionValue
Get ComStringOf Of hoJResp "capacityReservationId" To sCapacityReservationId
Get ComStringOf Of hoJResp "dedicatedVmHostId" To sDedicatedVmHostId
Get ComStringOf Of hoJResp "displayName" To sDisplayName
Get ComStringOf Of hoJResp "faultDomain" To sFaultDomain
Get ComStringOf Of hoJResp "imageId" To sImageId
Get ComStringOf Of hoJResp "instanceOptions.areLegacyImdsEndpointsDisabled.value" To sAreLegacyImdsEndpointsDisabledValue
Get ComStringOf Of hoJResp "ipxeScript" To sIpxeScript
Get ComStringOf Of hoJResp "launchMode" To sLaunchMode
Get ComStringOf Of hoJResp "launchOptions.bootVolumeType.value" To sBootVolumeTypeValue
Get ComStringOf Of hoJResp "launchOptions.firmware.value" To sFirmwareValue
Get ComStringOf Of hoJResp "launchOptions.isConsistentVolumeNamingEnabled.value" To sIsConsistentVolumeNamingEnabledValue
Get ComStringOf Of hoJResp "launchOptions.isPvEncryptionInTransitEnabled.value" To sIsPvEncryptionInTransitEnabledValue
Get ComStringOf Of hoJResp "launchOptions.networkType.value" To sNetworkTypeValue
Get ComStringOf Of hoJResp "launchOptions.remoteDataVolumeType.value" To sRemoteDataVolumeTypeValue
Get ComStringOf Of hoJResp "platformConfig.type.value" To sTypeValue
Get ComStringOf Of hoJResp "platformConfig.isMeasuredBootEnabled.value" To sIsMeasuredBootEnabledValue
Get ComStringOf Of hoJResp "platformConfig.isSecureBootEnabled.value" To sIsSecureBootEnabledValue
Get ComStringOf Of hoJResp "platformConfig.isTrustedPlatformModuleEnabled.value" To sIsTrustedPlatformModuleEnabledValue
Get ComStringOf Of hoJResp "preemptibleInstanceConfig.preemptionAction.value" To sPreemptionActionValue
Get ComStringOf Of hoJResp "shapeConfig.baselineOcpuUtilization.value" To sBaselineOcpuUtilizationValue
Get ComStringOf Of hoJResp "shapeConfig.gpuDescription.value" To sGpuDescriptionValue
Get ComStringOf Of hoJResp "shapeConfig.gpus.value" To sGpusValue
Get ComStringOf Of hoJResp "shapeConfig.localDiskDescription.value" To sLocalDiskDescriptionValue
Get ComStringOf Of hoJResp "shapeConfig.localDisks.value" To sLocalDisksValue
Get ComStringOf Of hoJResp "shapeConfig.localDisksTotalSizeInGBs.value" To sLocalDisksTotalSizeInGBsValue
Get ComStringOf Of hoJResp "shapeConfig.maxVnicAttachments.value" To sMaxVnicAttachmentsValue
Get ComStringOf Of hoJResp "shapeConfig.memoryInGBs.value" To sMemoryInGBsValue
Get ComStringOf Of hoJResp "shapeConfig.networkingBandwidthInGbps.value" To sNetworkingBandwidthInGbpsValue
Get ComStringOf Of hoJResp "shapeConfig.ocpus.value" To sOcpusValue
Get ComStringOf Of hoJResp "shapeConfig.processorDescription.value" To sProcessorDescriptionValue
Get ComStringOf Of hoJResp "sourceDetails.sourceType.value" To sSourceTypeValue
Get ComStringOf Of hoJResp "timeMaintenanceRebootDue" To sTimeMaintenanceRebootDue
End_Procedure
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}"
}
]
}
