Qodex.ai

InstanceAction

POST {{baseUrl}}/instances/:instanceId?action=START

Performs one of the following power actions on the specified instance:

  • START - Powers on the instance.

  • STOP - Powers off the instance.

  • RESET - Powers off the instance and then powers it back on.

  • SOFTSTOP - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance.

  • SOFTRESET - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on.

  • SENDDIAGNOSTICINTERRUPT - For advanced users. Warning: Sending a diagnostic interrupt to a live system can cause data corruption or system failure. Sends a diagnostic interrupt that causes the instance's OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see Sending a Diagnostic Interrupt.

For more information about managing instance lifecycle states, see Stopping and Starting an Instance.

Request Params

KeyDatatypeRequiredDescription
actionstring(Required) The action to perform on the instance.

HEADERS

KeyDatatypeRequiredDescription
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations (for example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
may be rejected).
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match
parameter to the value of the etag from a previous GET or POST response for that resource. The resource
will be updated or deleted only if the etag you provide matches the resource's current etag value.
Datestring(Required) Current Date
Authorizationstring(Required) Signature Authentication on Authorization header
x-content-sha256string(Required) Content sha256 for POST, PUT and PATCH operations
Content-Typestring

RESPONSES

status: OK

{"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":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isManagementDisabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isMonitoringDisabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"pluginsConfig":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"availabilityConfig":{"isLiveMigrationPreferred":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"recoveryAction":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"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":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"ipxeScript":"anim magna","launchMode":"CUSTOM","launchOptions":{"bootVolumeType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"firmware":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isConsistentVolumeNamingEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPvEncryptionInTransitEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"networkType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"remoteDataVolumeType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"metadata":{},"platformConfig":{"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isMeasuredBootEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isSecureBootEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isTrustedPlatformModuleEnabled":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"preemptibleInstanceConfig":{"preemptionAction":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"shapeConfig":{"baselineOcpuUtilization":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"gpuDescription":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"gpus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"localDiskDescription":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"localDisks":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"localDisksTotalSizeInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"maxVnicAttachments":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"memoryInGBs":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"networkingBandwidthInGbps":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ocpus":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"processorDescription":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"sourceDetails":{"sourceType":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"timeMaintenanceRebootDue":"1973-07-06T14:36:00.263Z"}