List Instances

Lists Oracle Cloud instances.

External Documentation

To learn more, visit the Oracle Cloud documentation.

​

Parameters

Parameter	Description
Compartment OCID	The OCID of the compartment.
Display Name	A filter to return only resources that match the given display name exactly.
Lifecycle State	A filter to only return resources that match the given lifecycle state.
Limit	For list pagination. The maximum number of results per page, or items to return in a paginated “List” call.
Page	For list pagination. The value of the opc-next-page response header from the previous “List”.
Sort By	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
Sort Order	The sort order to use, either ascending (ASC) or descending (DESC).

​

Example Output

[
	{
		"availabilityDomain": "<string>",
		"capacityReservationId": null,
		"compartmentId": "<string>",
		"clusterPlacementGroupId": null,
		"dedicatedVmHostId": null,
		"definedTags": {
			"Oracle-Tags": {
				"CreatedBy": "<string>",
				"CreatedOn": "2021-10-07T21:28:03"
			}
		},
		"securityAttributes": {},
		"securityAttributesState": "<string>",
		"displayName": "<string>",
		"extendedMetadata": {},
		"faultDomain": "<string>",
		"freeformTags": {},
		"id": "<string>",
		"imageId": "<string>",
		"ipxeScript": null,
		"launchMode": "<string>",
		"launchOptions": {
			"bootVolumeType": "<string>",
			"firmware": "<string>",
			"networkType": "<string>",
			"remoteDataVolumeType": "<string>",
			"isPvEncryptionInTransitEnabled": true,
			"isEncryptionInTransitEnabled": null,
			"isConsistentVolumeNamingEnabled": true
		},
		"instanceOptions": {
			"areLegacyImdsEndpointsDisabled": true
		},
		"availabilityConfig": {
			"isLiveMigrationPreferred": null,
			"recoveryAction": "<string>"
		},
		"preemptibleInstanceConfig": null,
		"lifecycleState": "<string>",
		"metadata": {},
		"region": "<string>",
		"shape": "<string>",
		"shapeConfig": {
			"ocpus": 999.3,
			"memoryInGBs": 830.56,
			"baselineOcpuUtilization": null,
			"processorDescription": "<string>",
			"networkingBandwidthInGbps": 838.14,
			"maxVnicAttachments": 314,
			"gpus": 676,
			"gpuDescription": null,
			"localDisks": 123,
			"localDisksTotalSizeInGBs": null,
			"localDiskDescription": null,
			"vcpus": 854
		},
		"isCrossNumaNode": false,
		"sourceDetails": {
			"sourceType": "<string>",
			"bootVolumeSizeInGBs": null,
			"imageId": "<string>",
			"kmsKeyId": null,
			"bootVolumeVpusPerGB": null,
			"instanceSourceImageFilterDetails": null
		},
		"systemTags": {
			"orcl-cloud": {
				"free-tier-retained": "<string>"
			}
		},
		"timeCreated": "2023-11-01T10:35:13",
		"agentConfig": {
			"isMonitoringDisabled": false,
			"isManagementDisabled": true,
			"areAllPluginsDisabled": false,
			"pluginsConfig": null
		},
		"timeMaintenanceRebootDue": null,
		"timeStopScheduled": null,
		"preferredMaintenanceAction": null,
		"platformConfig": null,
		"instanceConfigurationId": null,
		"licensingConfigs": null,
		"computeHostGroupId": null
	}
]