openapi: 3.2.0
info:
description: 'Use the Core Services API to manage resources such as virtual cloud networks (VCNs),
compute instances, and block storage volumes. For more information, see the console
documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm),
[Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and
[Block Volume](/iaas/Content/Block/Concepts/overview.htm) services.
The required permissions are documented in the
[Details for the Core Services](/iaas/Content/Identity/Reference/corepolicyreference.htm) article.
'
license:
name: Oracle Corporation
title: Core Services Compute API
version: '20160918'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Core Services API OCI service and stored verbatim; API Evangelist added only this provenance block.
x-evidence:
- url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
what: Oracle's own index of every OCI service specification
- url: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml
what: the harvested document for Core Services API
servers:
- url: /20160918
tags:
- name: compute
paths:
/appCatalogListings:
get:
description: Lists the published listings.
operationId: ListAppCatalogListings
parameters:
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByPublisherNameQueryParam'
- $ref: '#/components/parameters/FilterByPublisherTypeQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppCatalogListingSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListAppCatalogListings
tags:
- compute
x-obmcs-client-retries-enabled: true
/appCatalogListings/{listingId}:
get:
description: Gets the specified listing.
operationId: GetAppCatalogListing
parameters:
- $ref: '#/components/parameters/ListingIdPathParam'
responses:
200:
description: The listing was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AppCatalogListing'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetAppCatalogListing
tags:
- compute
x-obmcs-client-retries-enabled: true
/appCatalogListings/{listingId}/resourceVersions:
get:
description: Gets all resource versions for a particular listing.
operationId: ListAppCatalogListingResourceVersions
parameters:
- $ref: '#/components/parameters/ListingIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The listing resource versions were retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppCatalogListingResourceVersionSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListAppCatalogListingResourceVersions
tags:
- compute
x-obmcs-client-retries-enabled: true
/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}:
get:
description: Gets the specified listing resource version.
operationId: GetAppCatalogListingResourceVersion
parameters:
- $ref: '#/components/parameters/ListingIdPathParam'
- $ref: '#/components/parameters/ResourceVersionPathParam'
responses:
200:
description: The listing resource version was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AppCatalogListingResourceVersion'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetAppCatalogListingResourceVersion
tags:
- compute
x-obmcs-client-retries-enabled: true
/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements:
get:
description: Retrieves the agreements for a particular resource version of a listing.
operationId: GetAppCatalogListingAgreements
parameters:
- $ref: '#/components/parameters/ListingIdPathParam'
- $ref: '#/components/parameters/ResourceVersionPathParam'
responses:
200:
description: Agreements for the listing resource version were retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AppCatalogListingResourceVersionAgreements'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetAppCatalogListingAgreements
tags:
- compute
x-obmcs-client-retries-enabled: true
/appCatalogSubscriptions:
delete:
description: Delete a subscription for a listing resource version for a compartment.
operationId: DeleteAppCatalogSubscription
parameters:
- $ref: '#/components/parameters/ListingIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ResourceVersionQueryParam'
responses:
204:
description: The resource version was successfully deleted to for a compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteAppCatalogSubscription
tags:
- compute
get:
description: Lists subscriptions for a compartment.
operationId: ListAppCatalogSubscriptions
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByListingIdQueryParam'
responses:
200:
description: The list of subscriptions has been returned.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppCatalogSubscriptionSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListAppCatalogSubscriptions
tags:
- compute
x-obmcs-client-retries-enabled: true
post:
description: 'Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
'
operationId: CreateAppCatalogSubscription
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The resource version was successfully subscribed to.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AppCatalogSubscription'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateAppCatalogSubscription
tags:
- compute
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppCatalogSubscriptionDetails'
description: Request for the creation of a subscription for listing resource version for a compartment.
required: true
/bootVolumeAttachments/:
get:
description: 'Lists the boot volume attachments in the specified compartment. You can filter the
list by specifying an instance OCID, boot volume OCID, or both.
'
operationId: ListBootVolumeAttachments
parameters:
- $ref: '#/components/parameters/RequiredAvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/BootVolumeIdQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BootVolumeAttachment'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/BootVolumeAttachment'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListBootVolumeAttachments
tags:
- compute
post:
description: 'Attaches the specified boot volume to the specified instance.
'
operationId: AttachBootVolume
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The boot volume is being attached.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BootVolumeAttachment'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AttachBootVolume
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachBootVolumeDetails'
description: Attach boot volume request
required: true
/bootVolumeAttachments/{bootVolumeAttachmentId}:
delete:
description: 'Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.
This is an asynchronous operation. The attachment''s `lifecycleState` will change to DETACHING temporarily
until the attachment is completely removed.
'
operationId: DetachBootVolume
parameters:
- $ref: '#/components/parameters/BootVolumeAttachmentIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The request was accepted by the server
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DetachBootVolume
tags:
- compute
get:
description: Gets information about the specified boot volume attachment.
operationId: GetBootVolumeAttachment
parameters:
- $ref: '#/components/parameters/BootVolumeAttachmentIdPathParam'
responses:
200:
description: The boot volume attachment was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BootVolumeAttachment'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetBootVolumeAttachment
tags:
- compute
/computeCapacityReports:
post:
description: 'Generates a report of the host capacity within an availability domain that is available for you
to create compute instances. Host capacity is the physical infrastructure that resources such as compute
instances run on.
Use the capacity report to determine whether sufficient capacity is available for a shape before
you create an instance or change the shape of an instance.
'
operationId: CreateComputeCapacityReport
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The compute capacity report was created and retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeCapacityReport
tags:
- compute
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeCapacityReportDetails'
description: 'Details for creating a new compute capacity report.
'
required: true
/computeCapacityReservationInstanceShapes:
get:
description: 'Lists the shapes that can be reserved within the specified compartment.
'
operationId: ListComputeCapacityReservationInstanceShapes
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComputeCapacityReservationInstanceShapeSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityReservationInstanceShapes
tags:
- compute
/computeCapacityReservations:
get:
description: 'Lists the compute capacity reservations that match the specified criteria and compartment.
You can limit the list by specifying a compute capacity reservation display name
(the list will include all the identically-named compute capacity reservations in the compartment).
'
operationId: ListComputeCapacityReservations
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CapacityReservationLifecycleStateQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComputeCapacityReservationSummary'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/ComputeCapacityReservationSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityReservations
tags:
- compute
x-related-resource: '#/definitions/ComputeCapacityReservation'
post:
description: 'Creates a new compute capacity reservation in the specified compartment and availability domain.
Compute capacity reservations let you reserve instances in a compartment.
When you launch an instance using this reservation, you are assured that you have enough space for your instance,
and you won''t get out of capacity errors.
For more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).
'
operationId: CreateComputeCapacityReservation
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The compute capacity reservation is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityReservation'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeCapacityReservation
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeCapacityReservationDetails'
description: 'Details for creating a new compute capacity reservation.
**Caution:** Avoid using any confidential information when you use the API to supply string values.
'
required: true
/computeCapacityReservations/{capacityReservationId}:
delete:
description: Deletes the specified compute capacity reservation.
operationId: DeleteComputeCapacityReservation
parameters:
- $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The compute capacity reservation is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeCapacityReservation
tags:
- compute
x-related-resource: '#/definitions/ComputeCapacityReservation'
get:
description: Gets information about the specified compute capacity reservation.
operationId: GetComputeCapacityReservation
parameters:
- $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The compute capacity reservation's information was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityReservation'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeCapacityReservation
tags:
- compute
put:
description: 'Updates the specified capacity reservation and its associated capacity configurations.
Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted.
Avoid entering confidential information.
'
operationId: UpdateComputeCapacityReservation
parameters:
- $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The compute capacity reservation is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeCapacityReservation
tags:
- compute
x-related-resource: '#/definitions/ComputeCapacityReservation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeCapacityReservationDetails'
description: Update compute capacity reservation details.
required: true
/computeCapacityReservations/{capacityReservationId}/actions/changeCompartment:
post:
description: 'Moves a compute capacity reservation into a different compartment. For information about
moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeCapacityReservationCompartment
parameters:
- $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The compute capacity reservation is being moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeCapacityReservationCompartment
tags:
- compute
x-related-resource: '#/definitions/ComputeCapacityReservation'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeCapacityReservationCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeCapacityReservations/{capacityReservationId}/instances:
get:
description: 'Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.
'
operationId: ListComputeCapacityReservationInstances
parameters:
- $ref: '#/components/parameters/ComputeCapacityReservationIdPathParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CapacityReservationInstanceSummary'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/CapacityReservationInstanceSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityReservationInstances
tags:
- compute
/computeCapacityTopologies:
get:
description: 'Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute
capacity topology display name.
'
operationId: ListComputeCapacityTopologies
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityTopologyCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityTopologies
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeCapacityTopology'
post:
description: 'Creates a new compute capacity topology in the specified compartment and availability domain.
Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch
instances on your bare metal hosts with targeted network locations.
Compute capacity topologies report the health status of your bare metal hosts.
'
operationId: CreateComputeCapacityTopology
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The compute capacity topology is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityTopology'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeCapacityTopology
tags:
- compute
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeCapacityTopologyDetails'
description: 'Details for creating a new compute capacity topology.
'
required: true
/computeCapacityTopologies/{computeCapacityTopologyId}:
delete:
description: Deletes the specified compute capacity topology.
operationId: DeleteComputeCapacityTopology
parameters:
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The compute capacity topology is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeCapacityTopology
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeCapacityTopology'
get:
description: Gets information about the specified compute capacity topology.
operationId: GetComputeCapacityTopology
parameters:
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The information of the compute capacity topology was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCapacityTopology'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeCapacityTopology
tags:
- compute
x-obmcs-client-retries-enabled: true
put:
description: 'Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.
'
operationId: UpdateComputeCapacityTopology
parameters:
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The compute capacity topology is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeCapacityTopology
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeCapacityTopology'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeCapacityTopologyDetails'
description: Update compute capacity topology details.
required: true
/computeCapacityTopologies/{computeCapacityTopologyId}/actions/changeCompartment:
post:
description: 'Moves a compute capacity topology into a different compartment. For information about moving resources between
compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeCapacityTopologyCompartment
parameters:
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The compute capacity topology is being moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeCapacityTopologyCompartment
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeCapacityTopology'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeCapacityTopologyCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeCapacityTopologies/{computeCapacityTopologyId}/computeBareMetalHosts:
get:
description: Lists compute bare metal hosts in the specified compute capacity topology.
operationId: ListComputeCapacityTopologyComputeBareMetalHosts
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam'
- $ref: '#/components/parameters/ComputeNetworkBlockIdQueryParam'
- $ref: '#/components/parameters/ComputeLocalBlockIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of compute bare metal hosts is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeBareMetalHostCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityTopologyComputeBareMetalHosts
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeBareMetalHost'
/computeCapacityTopologies/{computeCapacityTopologyId}/computeHpcIslands:
get:
description: Lists compute HPC islands in the specified compute capacity topology.
operationId: ListComputeCapacityTopologyComputeHpcIslands
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of compute HPC islands is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHpcIslandCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityTopologyComputeHpcIslands
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHpcIsland'
/computeCapacityTopologies/{computeCapacityTopologyId}/computeNetworkBlocks:
get:
description: Lists compute network blocks in the specified compute capacity topology.
operationId: ListComputeCapacityTopologyComputeNetworkBlocks
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ComputeCapacityTopologyIdPathParam'
- $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of compute network blocks is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeNetworkBlockCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCapacityTopologyComputeNetworkBlocks
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeNetworkBlock'
/computeClusters:
get:
description: 'Lists the compute clusters in the specified compartment.
A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.
'
operationId: ListComputeClusters
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeClusterCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeCluster
tags:
- compute
x-related-resource: '#/definitions/ComputeCluster'
post:
description: 'Creates an empty [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster
is a remote direct memory access (RDMA) network group.
After the compute cluster is created, you can use the compute cluster''s OCID with the
[LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster.
The instances must be created in the same compartment and availability domain as the cluster.
Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group.
If you want predictable capacity for a specific number of identical instances that are managed as a group,
create a cluster network that uses instance pools by using the
[CreateClusterNetwork](#/en/iaas/latest/ClusterNetwork/CreateClusterNetwork) operation.
'
operationId: CreateComputeCluster
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The compute cluster is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeCluster
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeClusterDetails'
description: 'The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). A compute cluster
is an empty remote direct memory access (RDMA) network group.
After the compute cluster is created, you can use the compute cluster''s OCID with the
[LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) operation to create instances in the compute cluster.
The instances must be created in the same compartment and availability domain as the cluster.
Use compute clusters when you want to manage instances in the cluster individually in the RDMA network group.
For details about creating a cluster network that uses instance pools to manage groups of identical instances,
see [CreateClusterNetworkDetails](#/en/iaas/latest/datatypes/CreateClusterNetworkDetails).
'
required: true
/computeClusters/{computeClusterId}:
delete:
description: 'Deletes a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a
remote direct memory access (RDMA) network group.
Before you delete a compute cluster, first delete all instances in the cluster by using
the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance) operation.
'
operationId: DeleteComputeCluster
parameters:
- $ref: '#/components/parameters/ComputeClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The compute cluster is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeCluster
tags:
- compute
x-related-resource: '#/definitions/ComputeCluster'
get:
description: 'Gets information about a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)
is a remote direct memory access (RDMA) network group.
'
operationId: GetComputeCluster
parameters:
- $ref: '#/components/parameters/ComputeClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The compute cluster was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeCluster
tags:
- compute
put:
description: 'Updates a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a
remote direct memory access (RDMA) network group.
To create instances within a compute cluster, use the [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance)
operation.
To delete instances from a compute cluster, use the [TerminateInstance](#/en/iaas/latest/Instance/TerminateInstance)
operation.
'
operationId: UpdateComputeCluster
parameters:
- $ref: '#/components/parameters/ComputeClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The compute cluster was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeCluster
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeClusterDetails'
description: Details for updating the compute cluster.
required: true
/computeClusters/{computeClusterId}/actions/changeCompartment:
post:
description: 'Moves a compute cluster into a different compartment within the same tenancy.
A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.
For information about moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeClusterCompartment
parameters:
- $ref: '#/components/parameters/ComputeClusterIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The compute cluster was moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: MoveComputeCluster
tags:
- compute
x-related-resource: '#/definitions/ComputeCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeClusterCompartmentDetails'
description: The request to move the compute cluster to a different compartment.
required: true
/computeGlobalImageCapabilitySchemas:
get:
description: 'Lists Compute Global Image Capability Schema in the specified compartment.
'
operationId: ListComputeGlobalImageCapabilitySchemas
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilityCompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComputeGlobalImageCapabilitySchemaSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeGlobalImageCapabilitySchemas
tags:
- compute
x-obmcs-client-retries-enabled: true
/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}:
get:
description: Gets the specified Compute Global Image Capability Schema
operationId: GetComputeGlobalImageCapabilitySchema
parameters:
- $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam'
responses:
200:
description: The compute global image capability schema retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGlobalImageCapabilitySchema'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeGlobalImageCapabilitySchema
tags:
- compute
x-obmcs-client-retries-enabled: true
/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions:
get:
description: 'Lists Compute Global Image Capability Schema versions in the specified compartment.
'
operationId: ListComputeGlobalImageCapabilitySchemaVersions
parameters:
- $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of Compute Global Image Capability Schema Versions retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComputeGlobalImageCapabilitySchemaVersionSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeGlobalImageCapabilitySchemaVersions
tags:
- compute
x-obmcs-client-retries-enabled: true
? /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}
: get:
description: Gets the specified Compute Global Image Capability Schema Version
operationId: GetComputeGlobalImageCapabilitySchemaVersion
parameters:
- $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/ComputeGlobalImageCapabilitySchemaVersionNamePathParam'
responses:
200:
description: The compute global image capability schema version retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGlobalImageCapabilitySchemaVersion'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeGlobalImageCapabilitySchemaVersion
tags:
- compute
x-obmcs-client-retries-enabled: true
/computeGpuMemoryClusters:
get:
description: 'List all of the compute GPU memory clusters.
'
operationId: ListComputeGpuMemoryClusters
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdQueryParam'
- $ref: '#/components/parameters/ComputeGpuMemoryFabricIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/ComputeClusterIdQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list of GPU memory clusters was created and retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryClusterCollection'
application/x-json-stream:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryClusterCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeGpuMemoryClusters
tags:
- compute
x-example: 'GET /20160918/computeGpuMemoryClusters?compartmentId=ocid1.compartment.oc1..<unique_ID>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
post:
description: 'Create a compute GPU memory cluster instance on a specific compute GPU memory fabric
'
operationId: CreateComputeGpuMemoryCluster
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: The compute GPU memory cluster is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeGpuMemoryCluster
tags:
- compute
x-example: "POST /20160918/ComputeGpuMemoryClusters\n<authorization and other headers>\n{\n \"availabilityDomain\": \"Uocm:PHX-AD-1\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"gpuMemoryFabricId\": \"ocid1.computegpumemoryfabric.oc1..<unique_ID>\",\n \"computeClusterId\": \"ocid1.computecluster.oc1..<unique_ID>\",\n \"instanceConfigurationId\": \"ocid1.instanceconfiguration.oc1..<unique_ID>\",\n \"size\": 18,\n \"displayName\": \"example-gpu-memory-cluster\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeGpuMemoryClusterDetails'
description: The configuration details of a GPU memory cluster
required: true
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}:
x-obmcs-client-retries-enabled: true
delete:
description: Terminates and deletes the specified compute GPU memory cluster and underlying instances.
operationId: DeleteComputeGpuMemoryCluster
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The compute GPU memory cluster is terminating and underlying instances are being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeGpuMemoryCluster
tags:
- compute
x-example: 'DELETE /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
get:
description: 'Gets information about the specified compute GPU memory cluster
'
operationId: GetComputeGpuMemoryCluster
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The information of the compute GPU memory cluster was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeGpuMemoryCluster
tags:
- compute
x-example: 'GET /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID>
'
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
put:
description: 'Updates a compute gpu memory cluster resource.
'
operationId: UpdateComputeGpuMemoryCluster
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The compute GPU memory cluster is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryCluster'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeGpuMemoryCluster
tags:
- compute
x-example: "PUT /20160918/computeGpuMemoryClusters/<ComputeGpuMemoryCluster_OCID>\n<authorization and other headers>\n{\n \"instanceConfigurationId\": \"<newInstanceConfigurationId>\",\n \"displayName\": \"<newDisplayName>\",\n \"definedTags\": \"<newDefinedTags>\",\n \"freeformTags\": \"<newFreeformTags>\",\n \"size\": \"<newSize>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeGpuMemoryClusterDetails'
description: Update compute GPU memory cluster details.
required: true
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}/actions/changeCompartment:
post:
description: 'Moves a compute GPU memory cluster into a different compartment. For information about moving resources between
compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeGpuMemoryClusterCompartment
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The GPU memory cluster is moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeGpuMemoryClusterCompartment
tags:
- compute
x-example: "POST /20160918/ComputeGpuMemoryClusters/<computeGpuMemoryCluster_OCID>/actions/changeCompartment\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryCluster'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeGpuMemoryClusterCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}/instances:
get:
description: 'List all of the GPU memory cluster instances.
'
operationId: ListComputeGpuMemoryClusterInstances
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list of summary memory cluster details was created and retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryClusterInstanceCollection'
application/x-json-stream:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryClusterInstanceCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeGpuMemoryClustersInstances
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryClusterInstanceSummary'
/computeGpuMemoryFabrics:
get:
description: Lists the compute GPU memory fabrics that match the specified criteria and compartmentId.
operationId: ListComputeGpuMemoryFabrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ComputeGpuMemoryFabricIdQueryParam'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/ComputeHpcIslandIdQueryParam'
- $ref: '#/components/parameters/ComputeNetworkBlockIdQueryParam'
- $ref: '#/components/parameters/ComputeGpuMemoryFabricLifecycleStateQueryParam'
- $ref: '#/components/parameters/ComputeGpuMemoryFabricHealthQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of summary memory fabric details was created and retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryFabricCollection'
application/x-json-stream:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryFabricCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeGpuMemoryFabrics
tags:
- compute
x-example: 'GET /20160918/computeGpuMemoryFabrics?compartmentId=ocid1.compartment.oc1..<unique_ID>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryFabric'
/computeGpuMemoryFabrics/{computeGpuMemoryFabricId}:
get:
description: 'Gets information about the specified compute GPU memory fabric
'
operationId: GetComputeGpuMemoryFabric
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The information of the compute GPU memory fabric was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryFabric'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeGpuMemoryFabric
tags:
- compute
x-example: 'GET /20160918/computeGpuMemoryFabric/ocid1.computeGpuMemoryFabric.oc1..<unique_ID>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryFabric'
put:
description: "Customer can update displayName, tags and desired firmware bundle, recycle level for \ncompute GPU memory fabric record\n"
operationId: UpdateComputeGpuMemoryFabric
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The compute GPU memory fabric details was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeGpuMemoryFabric'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeGpuMemoryFabric
tags:
- compute
x-example: "PUT /20160918/computeGpuMemoryFabric/<computeGpuMemoryFabric_OCID>\n<authorization and other headers>\n{\n \"displayName\": \"<newDisplayName>\",\n \"definedTags\": \"<newDefinedTags>\",\n \"freeformTags\": \"<newFreeformTags>\"\n \"memoryFabricPreferences\": \"<{\"customerDesiredFirmwareBundleId\": \"ocid1.firmwarebundle.oc1..<unique_ID>\n\", \"fabricRecycleLevel”:“FULL_RECYCLE\"}>\n\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryFabric'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeGpuMemoryFabricDetails'
description: Update compute GPU memory fabric details.
required: true
/computeGpuMemoryFabrics/{computeGpuMemoryFabricId}/actions/changeCompartment:
post:
description: 'Moves a compute GPU memory fabric into a different compartment. For information about moving resources between
compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeGpuMemoryFabricCompartment
parameters:
- $ref: '#/components/parameters/ComputeGpuMemoryFabricIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The compute GPU memory fabric is moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeGpuMemoryFabricCompartment
tags:
- compute
x-example: "POST /20160918/ComputeGpuMemoryFabrics/<computeGpuMemoryFabric_OCID>/actions/changeCompartment\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeGpuMemoryFabric'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeGpuMemoryFabricCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeHostGroups:
get:
description: Lists the compute host groups that match the specified criteria and compartment.
operationId: ListComputeHostGroups
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHostGroupCollection'
application/x-json-stream:
schema:
$ref: '#/components/schemas/ComputeHostGroupCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeHostGroups
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHostGroup'
post:
description: Creates a new compute host group in the specified compartment and availability domain.
operationId: CreateComputeHostGroup
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The compute host group is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHostGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeHostGroup
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHostGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeHostGroupDetails'
description: Details for creating a new host group.
required: true
/computeHostGroups/{computeHostGroupId}:
delete:
description: Deletes the specified compute host group
operationId: DeleteComputeHostGroup
parameters:
- $ref: '#/components/parameters/ComputeHostGroupIdParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The compute host group is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeHostGroup
tags:
- compute
x-related-resource: '#/definitions/ComputeHostGroup'
get:
description: Gets information about the specified compute host group
operationId: GetComputeHostGroup
parameters:
- $ref: '#/components/parameters/ComputeHostGroupIdParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The information host details for the specific host group was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHostGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeHostGroup
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHostGroup'
put:
description: Updates the specified compute host group details.
operationId: UpdateComputeHostGroup
parameters:
- $ref: '#/components/parameters/ComputeHostGroupIdParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The compute host group is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHostGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeHostGroup
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHostGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeHostGroupDetails'
description: Update compute host group details.
required: true
/computeHostGroups/{computeHostGroupId}/actions/changeCompartment:
post:
description: 'Moves a compute host group into a different compartment. For information about moving resources between
compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeHostGroupCompartment
parameters:
- $ref: '#/components/parameters/ComputeHostGroupIdParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The compute host group is being moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeHostGroupCompartment
tags:
- compute
x-example: "POST /20160918/ComputeHostGroup/<computeHostGroup_OCID>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHostGroup'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeHostGroupCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeHosts:
get:
description: 'Generates a list of summary host details
'
operationId: ListComputeHosts
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/ComputeHostNetworkResourceQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ComputeHostLifecycleStateParam'
- $ref: '#/components/parameters/ComputeHostHealthParam'
- $ref: '#/components/parameters/ComputeHostGroupIdQueryParam'
- $ref: '#/components/parameters/ComputeHostInSubtreeQueryParam'
responses:
200:
description: The list of summary host details was created and retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHostCollection'
application/x-json-stream:
schema:
$ref: '#/components/schemas/ComputeHostCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeHosts
tags:
- compute
x-example: 'GET /20160918/computeHost
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHost'
/computeHosts/{computeHostId}:
get:
description: 'Gets information about the specified compute host
'
operationId: GetComputeHost
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The information host details for the specific host was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeHost
tags:
- compute
x-example: 'GET /20160918/computeHost/?computeHostId=ocid1.computeHost.oc1..<unique_ID>
'
x-obmcs-client-retries-enabled: true
put:
description: 'Customer can update the some fields for ComputeHost record
'
operationId: UpdateComputeHost
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The host details for the specific host was successfully updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeHost
tags:
- compute
x-example: "PUT /20160918/ComputeHost/<computeHost_OCID>\n{\n \"displayName\": \"newName\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHost'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeHostDetails'
description: Update compute capacity topology details.
required: true
/computeHosts/{computeHostId}/actions/applyConfiguration:
post:
description: Triggers the asynchronous process that applies the host's target configuration
operationId: ApplyHostConfiguration
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The host's target configuration is being applied
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ApplyHostConfiguration
tags:
- compute
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/ComputeHost'
/computeHosts/{computeHostId}/actions/attachToHostGroup:
post:
description: Attaches the Compute BM Host to a Host group
operationId: AttachComputeHostGroupHost
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The host has been attached to a host group.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AttachComputeHostGroupHost
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHost'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachComputeHostGroupHostDetails'
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.
required: true
/computeHosts/{computeHostId}/actions/changeCompartment:
post:
description: 'Moves a compute host into a different compartment. For information about moving resources between
compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeComputeHostCompartment
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The compute host is being moved into a different compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeHostCompartment
tags:
- compute
x-example: "POST /20160918/ComputeHost/<computeHost_OCID>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHost'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeHostCompartmentDetails'
description: The configuration details for the move operation.
required: true
/computeHosts/{computeHostId}/actions/checkConfiguration:
post:
description: Marks the host to be checked for conformance to its target configuration
operationId: CheckHostConfiguration
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The host's conformance to its configuration will be checked
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'Location of the resource.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CheckHostConfiguration
tags:
- compute
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: UPDATE_FIELD
x-related-resource: '#/definitions/ComputeHost'
/computeHosts/{computeHostId}/actions/detachFromHostGroup:
post:
description: Detaches the specified bare metal host from the compute host group
operationId: DetachComputeHostGroupHost
parameters:
- $ref: '#/components/parameters/ComputeHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The compute bare metal host is being detached from the host group.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DetachComputeHostGroupHost
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeHost'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DetachComputeHostGroupHostDetails'
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.
required: true
/computeImageCapabilitySchemas:
get:
description: 'Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
'
operationId: ListComputeImageCapabilitySchemas
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilityCompartmentIdQueryParam'
- $ref: '#/components/parameters/ImageIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of compute image capability schemas retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ComputeImageCapabilitySchemaSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListComputeImageCapabilitySchemas
tags:
- compute
x-obmcs-client-retries-enabled: true
post:
description: 'Creates compute image capability schema.
'
operationId: CreateComputeImageCapabilitySchema
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: Compute Image Capability Schema
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeImageCapabilitySchema'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateComputeImageCapabilitySchema
tags:
- compute
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateComputeImageCapabilitySchemaDetails'
description: Compute Image Capability Schema creation details
required: true
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}:
delete:
description: 'Deletes the specified Compute Image Capability Schema
'
operationId: DeleteComputeImageCapabilitySchema
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The Compute Image Capability Schema has been deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteComputeImageCapabilitySchema
tags:
- compute
x-related-resource: '#/definitions/ComputeImageCapabilitySchema'
get:
description: 'Gets the specified Compute Image Capability Schema
'
operationId: GetComputeImageCapabilitySchema
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/ComputeImageCapabilityMergeQueryParam'
responses:
200:
description: The compute image capability schema retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeImageCapabilitySchema'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetComputeImageCapabilitySchema
tags:
- compute
x-obmcs-client-retries-enabled: true
put:
description: 'Updates the specified Compute Image Capability Schema
'
operationId: UpdateComputeImageCapabilitySchema
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The updated Compute Image Capability Schema
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ComputeImageCapabilitySchema'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateComputeImageCapabilitySchema
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateComputeImageCapabilitySchemaDetails'
description: Updates the freeFormTags, definedTags, and display name of the image capability schema
required: true
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment:
post:
description: "Moves a compute image capability schema into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n"
operationId: ChangeComputeImageCapabilitySchemaCompartment
parameters:
- $ref: '#/components/parameters/ComputeImageCapabilitySchemaIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The Compute Image Capability Schema has been moved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeComputeImageCapabilitySchemaCompartment
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ComputeImageCapabilitySchema'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeComputeImageCapabilitySchemaCompartmentDetails'
description: Compute Image Capability Schema change compartment details
required: true
/dedicatedVmHostInstanceShapes:
get:
description: 'Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.
You can filter the list by compatibility with a specific dedicated virtual machine host shape.
'
operationId: ListDedicatedVmHostInstanceShapes
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DedicatedVmHostShapeNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostInstanceShapeSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListDedicatedVmHostInstanceShapes
tags:
- compute
/dedicatedVmHostShapes:
get:
description: 'Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
'
operationId: ListDedicatedVmHostShapes
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/InstanceShapeNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostShapeSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListDedicatedVmHostShapes
tags:
- compute
/dedicatedVmHosts:
get:
description: 'Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.
You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named
dedicated virtual machine hosts in the compartment.
'
operationId: ListDedicatedVmHosts
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DedicatedVmHostLifecycleStateQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/InstanceShapeNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RemainingMemoryInGBsGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/RemainingOcpusGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/IsMemoryEncryptionEnabledQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostSummary'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListDedicatedVmHosts
tags:
- compute
post:
description: 'Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.
Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers
that are a single tenant and not shared with other customers.
For more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).
'
operationId: CreateDedicatedVmHost
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The dedicated virtual machine host is being created.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedVmHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateDedicatedVmHost
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDedicatedVmHostDetails'
description: The details for creating a new dedicated virtual machine host.
required: true
/dedicatedVmHosts/{dedicatedVmHostId}:
delete:
description: 'Deletes the specified dedicated virtual machine host.
If any VM instances are assigned to the dedicated virtual machine host,
the delete operation will fail and the service will return a 409 response code.
'
operationId: DeleteDedicatedVmHost
parameters:
- $ref: '#/components/parameters/DedicatedVmHostIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The dedicated virtual machine host is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteDedicatedVmHost
tags:
- compute
x-related-resource: '#/definitions/DedicatedVmHost'
get:
description: Gets information about the specified dedicated virtual machine host.
operationId: GetDedicatedVmHost
parameters:
- $ref: '#/components/parameters/DedicatedVmHostIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The dedicated virtual machine host was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedVmHost'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetDedicatedVmHost
tags:
- compute
put:
description: 'Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.
If an attribute value is not included, it will not be updated.
'
operationId: UpdateDedicatedVmHost
parameters:
- $ref: '#/components/parameters/DedicatedVmHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The dedicated virtual machine host was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DedicatedVmHost'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateDedicatedVmHost
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDedicatedVmHostDetails'
description: Update dedicated VM host details
required: true
/dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment:
post:
description: Moves a dedicated virtual machine host from one compartment to another.
operationId: ChangeDedicatedVmHostCompartment
parameters:
- $ref: '#/components/parameters/DedicatedVmHostIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Moves a dedicated vm host into a different compartment.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeDedicatedVmHostCompartment
tags:
- compute
x-related-resource: '#/definitions/DedicatedVmHost'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDedicatedVmHostCompartmentDetails'
description: The request to move the dedicated virtual machine host to a different compartment.
required: true
/dedicatedVmHosts/{dedicatedVmHostId}/instances:
get:
description: 'Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
'
operationId: ListDedicatedVmHostInstances
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DedicatedVmHostIdPathParam'
- $ref: '#/components/parameters/IsMemoryEncryptionEnabledQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostInstanceSummary'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/DedicatedVmHostInstanceSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListDedicatedVmHostInstances
tags:
- compute
/firmwareBundles:
get:
description: "Gets a list of all Firmware Bundles in a compartment for specified platform. Can filter results to include \nonly the default (recommended) Firmware Bundle for the given platform.\n"
operationId: ListFirmwareBundles
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/DevicePlatformQueryParam'
- $ref: '#/components/parameters/DefaultBundleQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FilterByLifecycleStateQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FirmwareBundlesCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListFirmwareBundles
tags:
- compute
x-related-resource: '#/definitions/FirmwareBundlesCollection'
/firmwareBundles/{firmwareBundleId}:
get:
description: 'Returns the Firmware Bundle matching the provided firmwareBundleId.
'
operationId: GetFirmwareBundle
parameters:
- $ref: '#/components/parameters/FirmwareBundleIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A Firmware Bundle object.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FirmwareBundle'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetFirmwareBundle
tags:
- compute
x-related-resource: '#/definitions/FirmwareBundle'
/images:
get:
description: 'Lists a subset of images available in the specified compartment, including
[platform images](/iaas/Content/Compute/References/images.htm) and
[custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).
The list of platform images includes the three most recently published versions
of each major distribution. The list does not support filtering based on image tags.
The list of images returned is ordered to first show the recent platform images,
then all of the custom images.
**Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced.
The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.
'
operationId: ListImages
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/OperatingSystemQueryParam'
- $ref: '#/components/parameters/OperatingSystemVersionQueryParam'
- $ref: '#/components/parameters/ShapeNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: 'A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-obmcs-enumref: '#/definitions/Image/lifecycleState'
schema:
type: string
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Image'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListImages
tags:
- compute
x-obmcs-client-retries-enabled: true
post:
description: 'Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and
the OCID of the compartment containing that instance. For more information about images,
see [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).
When importing an exported image from Object Storage, you specify the source information
in [ImageSourceDetails](#/en/iaas/latest/requests/ImageSourceDetails).
When importing an image based on the namespace, bucket name, and object name,
use [ImageSourceViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageTupleDetails).
When importing an image based on the Object Storage URL, use
[ImageSourceViaObjectStorageUriDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageUriDetails).
See [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)
for constructing URLs for image import/export.
For more information about importing exported images, see
[Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).
You may optionally specify a *display name* for the image, which is simply a friendly name or description.
It does not have to be unique, and you can change it. See [UpdateImage](#/en/iaas/latest/Image/UpdateImage).
Avoid entering confidential information.
'
operationId: CreateImage
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The image is being created.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Image'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateImage
tags:
- compute
x-example: "Example 1 request: Create new image for specified instance.\nPOST /20160918/images\n{\n \"instanceId\": \"ocid1.instance.oc1.phx.<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"MyCustomImage\"\n}\n\nExample 2 request: Import image using the namespace, bucket name, and object name.\nPOST /20160918/images\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"imageSourceDetails\": {\n \"objectName\": \"image-to-import.oci\",\n \"bucketName\": \"MyBucket\",\n \"namespaceName\": \"MyNamespace\",\n \"sourceType\": \"objectStorageTuple\"\n }\n}\n\nExample 3 request: Import image using the Object Storage URL.\nPOST /20160918/images\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\": \"MyImportedImage\",\n \"imageSourceDetails\": {\n \"sourceUri\": \"https://objectstorage.us-phoenix-1.oraclecloud.com/n/<MyNamespace>/b/<MyBucket>/o/<image-to-import>;.oci\",\n \"sourceType\": \"objectStorageUri\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateImageDetails'
description: Image creation details
required: true
/images/{imageId}:
delete:
description: Deletes an image.
operationId: DeleteImage
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The image is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteImage
tags:
- compute
get:
description: Gets the specified image.
operationId: GetImage
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
responses:
200:
description: The image was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Image'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetImage
tags:
- compute
x-obmcs-client-retries-enabled: true
put:
description: 'Updates the display name of the image. Avoid entering confidential information.
'
operationId: UpdateImage
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The image name was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Image'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateImage
tags:
- compute
x-example: "PUT /20160918/images/<image_OCID>\n{\n \"displayName\": \"MyFavoriteImage\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateImageDetails'
description: 'Updates the image display name field. Avoid entering confidential information.
'
required: true
/images/{imageId}/actions/changeCompartment:
post:
description: 'Moves an image into a different compartment within the same tenancy. For information about moving
resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
'
operationId: ChangeImageCompartment
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
204:
description: The Image Compartment Details is being changed.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeImageCompartment
tags:
- compute
x-example: "POST /20160918/images/<image_OCID>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/Image'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeImageCompartmentDetails'
description: Request to change the compartment of a given image.
required: true
/images/{imageId}/actions/export:
post:
description: 'Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL,
or the namespace, bucket name, and object name when specifying the location to export to.
For more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).
To perform an image export, you need write access to the Object Storage bucket for the image,
see [Let Users Write Objects to Object Storage Buckets](/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)
for constructing URLs for image import/export.
'
operationId: ExportImage
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The export is being performed.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Image'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ExportImage
tags:
- compute
x-example: "Example 1 request: Export image using the namespace, bucket name, and object name without export format\nPOST /20160918/images/<image_OCID>/actions/export\n{\n \"objectName\": \"my-exported-image.oci\",\n \"bucketName\": \"MyBucket\",\n \"namespaceName\": \"MyNamespace\",\n \"destinationType\": \"objectStorageTuple\"\n}\n\nExample 2 request: Export image using the namespace, bucket name, and object name with export format defined as \"VMDK\"\nPOST /20160918/images/<image_OCID>/actions/export\n{\n \"objectName\": \"my-exported-image.vmdk\",\n \"bucketName\": \"MyBucket\",\n \"namespaceName\": \"MyNamespace\",\n \"destinationType\": \"objectStorageTuple\",\n \"exportFormat\": \"VMDK\"\n}\n\n\nExample 3 request: Export image using the Object Storage URL with export format defined as \"QCOW2\"\nPOST /20160918/images/<image_OCID>/actions/export\n{\n \"destinationUri\": \"https://objectstorage.us-phoenix-1.oraclecloud.com/n/<MyNamespace>/b/<MyBucket>/o/<exported-image>.qcow2\",\n \"destinationType\": \"objectStorageUri\",\n \"exportFormat\": \"QCOW2\"\n"
x-obmcs-client-retries-enabled: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportImageDetails'
description: Details for the image export.
required: true
/images/{imageId}/shapes:
get:
description: Lists the compatible shapes for the specified image.
operationId: ListImageShapeCompatibilityEntries
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of compatible images and shapes.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ImageShapeCompatibilitySummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListImageShapeCompatibilityEntries
tags:
- compute
x-example: 'GET /20160918/images/<image_OCID>/shapes
Host: iaas.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ImageShapeCompatibilityEntry'
/images/{imageId}/shapes/{shapeName}:
delete:
description: Removes a shape from the compatible shapes list for the image.
operationId: RemoveImageShapeCompatibilityEntry
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/ShapeNamePathParam'
responses:
204:
description: The shape has been removed from the compatible shapes list.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: RemoveImageShapeCompatibilityEntry
tags:
- compute
x-related-resource: '#/definitions/ImageShapeCompatibilityEntry'
get:
description: Retrieves an image shape compatibility entry.
operationId: GetImageShapeCompatibilityEntry
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/ShapeNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The image shape compatibility entry was retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ImageShapeCompatibilityEntry'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetImageShapeCompatibilityEntry
tags:
- compute
x-obmcs-client-retries-enabled: true
put:
description: Adds a shape to the compatible shapes list for the image.
operationId: AddImageShapeCompatibilityEntry
parameters:
- $ref: '#/components/parameters/ImageIdPathParam'
- $ref: '#/components/parameters/ShapeNamePathParam'
responses:
200:
description: The shape has been added to the compatible shapes list.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ImageShapeCompatibilityEntry'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AddImageShapeCompatibilityEntry
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddImageShapeCompatibilityEntryDetails'
description: Image shape compatibility details
/instanceConsoleConnections:
get:
description: 'Lists the console connections for the specified compartment or instance.
For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).
'
operationId: ListInstanceConsoleConnections
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/InstanceConsoleConnection'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListInstanceConsoleConnections
tags:
- compute
x-example: 'GET /20160918/instanceConsoleConnections?compartmentId=ocid1.compartment.oc1..<unique_ID>
'
post:
description: 'Creates a new console connection to the specified instance.
After the console connection has been created and is available,
you connect to the console using SSH.
For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).
'
operationId: CreateInstanceConsoleConnection
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The instance console connection is being configured.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceConsoleConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CreateInstanceConsoleConnection
tags:
- compute
x-example: "POST /20160918/instanceConsoleConnections\n{\n \"instanceId\":\"ocid1.instance.oc1.phx.<unique_ID>\",\n \"publicKey\":\"ssh-rsa <your_public_SSH_key>== rsa-key-20160227\"\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInstanceConsoleConnectionDetails'
description: Request object for creating an InstanceConsoleConnection
required: true
/instanceConsoleConnections/{instanceConsoleConnectionId}:
delete:
description: Deletes the specified instance console connection.
operationId: DeleteInstanceConsoleConnection
parameters:
- $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The instance console connection is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteInstanceConsoleConnection
tags:
- compute
x-example: 'DELETE /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID>
'
x-related-resource: '#/definitions/InstanceConsoleConnection'
get:
description: Gets the specified instance console connection's information.
operationId: GetInstanceConsoleConnection
parameters:
- $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam'
responses:
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
'200':
description: The instance console connection was retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceConsoleConnection'
default:
$ref: '#/components/responses/DefaultError'
summary: GetInstanceConsoleConnection
tags:
- compute
x-example: 'GET /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID>
'
put:
description: Updates the defined tags and free-form tags for the specified instance console connection.
operationId: UpdateInstanceConsoleConnection
parameters:
- $ref: '#/components/parameters/InstanceConsoleConnectionIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
'200':
description: The instance console connection was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceConsoleConnection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateInstanceConsoleConnection
tags:
- compute
x-example: 'PUT /20160918/instanceConsoleConnections/ocid1.instanceconsoleconnection.iad.<unique_ID>
'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInstanceConsoleConnectionDetails'
description: Update instanceConsoleConnection tags
required: true
/instanceConsoleHistories/:
get:
description: 'Lists the console history metadata for the specified compartment or instance.
'
operationId: ListConsoleHistories
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: 'A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-obmcs-enumref: '#/definitions/ConsoleHistory/lifecycleState'
schema:
type: string
responses:
200:
description: The metadata is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ConsoleHistory'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListConsoleHistories
tags:
- compute
post:
description: 'Captures the most recent serial console data (up to a megabyte) for the
specified instance.
The `CaptureConsoleHistory` operation works with the other console history operations
as described below.
1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the
most recent console history. This call returns a `ConsoleHistory`
object. The object will have a state of REQUESTED.
2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with
the identifier of the console history metadata. The state of the
`ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and
then SUCCEEDED (or FAILED).
3. Use `GetConsoleHistoryContent` to get the actual console history data (not the
metadata).
4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata
and the console history data.
'
operationId: CaptureConsoleHistory
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The console history is being captured.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleHistory'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: CaptureConsoleHistory
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaptureConsoleHistoryDetails'
description: Console history details
required: true
/instanceConsoleHistories/{instanceConsoleHistoryId}:
delete:
description: 'Deletes the specified console history metadata and the console history data.
'
operationId: DeleteConsoleHistory
parameters:
- $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The information is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DeleteConsoleHistory
tags:
- compute
x-related-resource: '#/definitions/ConsoleHistory'
get:
description: 'Shows the metadata for the specified console history.
See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)
for details about using the console history operations.
'
operationId: GetConsoleHistory
parameters:
- $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam'
responses:
200:
description: Console history metadata
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleHistory'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetConsoleHistory
tags:
- compute
put:
description: Updates the specified console history metadata.
operationId: UpdateConsoleHistory
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam'
responses:
200:
description: The request was accepted by the server
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ConsoleHistory'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateConsoleHistory
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConsoleHistoryDetails'
description: Update instance fields
required: true
/instanceConsoleHistories/{instanceConsoleHistoryId}/data:
get:
description: 'Gets the actual console history data (not the metadata).
See [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)
for details about using the console history operations.
'
operationId: GetConsoleHistoryContent
parameters:
- $ref: '#/components/parameters/InstanceConsoleHistoryIdPathParam'
- description: Offset of the snapshot data to retrieve.
in: query
name: offset
schema:
type: integer
format: int32
minimum: 0
- description: Length of the snapshot data to retrieve.
in: query
name: length
schema:
type: integer
format: int32
minimum: 10240
responses:
200:
description: The information is being retrieved.
headers:
opc-bytes-remaining:
description: The number of bytes remaining in the snapshot.
schema:
type: integer
format: int32
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetConsoleHistoryContent
tags:
- compute
x-related-resource: '#/definitions/ConsoleHistory'
/instanceMaintenanceEvents:
get:
description: 'Gets a list of all the maintenance events for the given compartment.
'
operationId: ListInstanceMaintenanceEvents
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/InstanceMaintenanceEventLifecycleStateQueryParam'
- $ref: '#/components/parameters/InstanceMaintenanceEventCorrelationTokenQueryParam'
- $ref: '#/components/parameters/InstanceMaintenanceEventInstanceActionQueryParam'
- $ref: '#/components/parameters/TimeWindowStartGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeWindowStartLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of maintenance events.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/InstanceMaintenanceEventSummary'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListInstanceMaintenanceEvents
tags:
- compute
/instanceMaintenanceEvents/{instanceMaintenanceEventId}:
get:
description: 'Gets the maintenance event for the given instance.
'
operationId: GetInstanceMaintenanceEvent
parameters:
- $ref: '#/components/parameters/MaintenanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Maintenance event of an instance.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceMaintenanceEvent'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetInstanceMaintenanceEvent
tags:
- compute
put:
description: 'Updates the maintenance event for the given instance.
'
operationId: UpdateInstanceMaintenanceEvent
parameters:
- $ref: '#/components/parameters/MaintenanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Updating the InstanceMaintenanceEvent will be completed asynchronously.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateInstanceMaintenanceEvent
tags:
- compute
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/InstanceMaintenanceEvent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInstanceMaintenanceEventDetails'
description: Update instance maintenance event due date.
required: true
/instances/:
get:
description: 'Lists the instances in the specified compartment and the specified availability domain.
You can filter the results by specifying an instance name (the list will include all the identically-named
instances in the compartment).
**Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)
operation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.
'
operationId: ListInstances
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/ComputeCapacityReservationIdQueryParam'
- $ref: '#/components/parameters/ComputeClusterIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- description: 'A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-obmcs-enumref: '#/definitions/Instance/lifecycleState'
schema:
type: string
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Instance'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/Instance'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListInstances
tags:
- compute
post:
description: "Creates a new instance in the specified compartment and the specified availability domain.\nFor general information about instances, see\n[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).\n\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see\n[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nAll Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned,\nunique ID called an Oracle Cloud Identifier (OCID).\nWhen you create a resource, you can find its OCID in the response. You can\nalso retrieve a resource's OCID by using a List API operation\non that resource type, or by viewing the resource in the Console.\n\nTo launch an instance using an image or a boot volume use the `sourceDetails` parameter in [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails).\n\nWhen you launch an instance, it is automatically attached to a virtual\nnetwork interface card (VNIC), called the *primary VNIC*. The VNIC\nhas a private IP address from the subnet's CIDR. You can either assign a\nprivate IP address of your choice or let Oracle automatically assign one.\nYou can choose whether the instance has a public IP address. To retrieve the\naddresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call\n[GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.\n\nYou can later add secondary VNICs to an instance. For more information, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n\nTo launch an instance from a Marketplace image listing, you must provide the image ID of the\nlisting resource version that you want, but you also must subscribe to the listing before you try\nto launch the instance. To subscribe to the listing, use the [GetAppCatalogListingAgreements](#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements)\noperation to get the signature for the terms of use agreement for the desired listing resource version.\nThen, call [CreateAppCatalogSubscription](#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription)\nwith the signature. To get the image ID for the LaunchInstance operation, call\n[GetAppCatalogListingResourceVersion](#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion).\n\nWhen launching an instance, you may provide the `securityAttributes` parameter in\n[LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails) to manage security attributes via the instance, \nor in the embedded [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/) to manage security attributes\nvia the VNIC directly, but not both. Providing `securityAttributes` in both locations will return a\n400 Bad Request response.\n\nTo determine whether capacity is available for a specific shape before you create an instance,\nuse the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport)\noperation.\n"
operationId: LaunchInstance
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The instance is being launched.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: LaunchInstance
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LaunchInstanceDetails'
description: Instance details
required: true
/instances/{instanceId}:
delete:
description: 'Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached
when the instance terminates.
To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`.
To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.
To preserve data volumes created with the instance, specify `true` or do not specify a value for `PreserveDataVolumesQueryParam`.
To delete the data volumes when the instance itself is deleted, specify `false` for `PreserveDataVolumesQueryParam`.
This is an asynchronous operation. The instance''s `lifecycleState` changes to TERMINATING temporarily
until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances
with the state TERMINATED for at least 12 hours, but no further action is needed.
'
operationId: TerminateInstance
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/PreserveBootVolumeQueryParam'
- $ref: '#/components/parameters/PreserveDataVolumesQueryParam'
- $ref: '#/components/parameters/RecycleLevelQueryParam'
responses:
204:
description: The instance is being terminated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: TerminateInstance
tags:
- compute
get:
description: 'Gets information about the specified instance.
**Note:** To retrieve public and private IP addresses for an instance, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)
operation to get the VNIC ID for the instance, and then call [GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.
'
operationId: GetInstance
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
responses:
200:
description: The instance was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetInstance
tags:
- compute
post:
description: '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. **Caution: 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](/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm).
- **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on.
Before you send a diagnostic reboot, restart the instance''s OS, confirm that the instance and networking settings are configured
correctly, and try other [troubleshooting steps](/iaas/Content/Compute/References/troubleshooting-compute-instances.htm).
Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only.
For more information, see [Performing a Diagnostic Reboot](/iaas/Content/Compute/Tasks/diagnostic-reboot.htm).
- **REBOOTMIGRATE** - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see
[Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm).
For more information about managing instance lifecycle states, see
[Stopping and Starting an Instance](/iaas/Content/Compute/Tasks/restartinginstance.htm).
'
operationId: InstanceAction
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/InstanceActionQueryParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The action is being performed.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: InstanceAction
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstancePowerActionDetails'
description: Instance Power Action details
put:
description: 'Updates certain fields on the specified instance. Fields that are not provided in the
request will not be updated. Avoid entering confidential information.
Changes to metadata fields will be reflected in the instance metadata service (this may take
up to a minute).
The OCID of the instance remains the same.
'
operationId: UpdateInstance
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The instance was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateInstance
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateInstanceDetails'
description: Update instance fields
required: true
/instances/{instanceId}/actions/acceptShieldedIntegrityPolicy:
post:
description: Accept the changes to the PCR values in the measured boot report.
operationId: AcceptShieldedIntegrityPolicy
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The PCR values in the measured boot report have been updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AcceptShieldedIntegrityPolicy
tags:
- compute
x-related-resource: '#/definitions/MeasuredBootReport'
/instances/{instanceId}/actions/changeCompartment:
post:
description: 'Moves an instance into a different compartment within the same tenancy. For information about
moving resources between compartments, see
[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
When you move an instance to a different compartment, associated resources such as boot volumes and VNICs
are not moved.
'
operationId: ChangeInstanceCompartment
parameters:
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: The instance is being moved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ChangeInstanceCompartment
tags:
- compute
x-example: "POST /20160918/instances/<instance_OCID>/actions/changeCompartment\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
x-related-resource: '#/definitions/Instance'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeInstanceCompartmentDetails'
description: Request to change the compartment of a given instance.
required: true
/instances/{instanceId}/defaultCredentials:
get:
description: 'Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.
For certain operating systems, users will be forced to change the initial credentials.
'
operationId: GetInstanceDefaultCredentials
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
responses:
200:
description: The credentials were retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceCredentials'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetInstanceDefaultCredentials
tags:
- compute
/instances/{instanceId}/devices:
get:
description: Gets a list of all the devices for given instance. You can optionally filter results by device availability.
operationId: ListInstanceDevices
parameters:
- $ref: '#/components/parameters/FilterByDeviceAvailabilityQueryParam'
- $ref: '#/components/parameters/FilterByDeviceNameQueryParam'
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: List of devices
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Device'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListInstanceDevices
tags:
- compute
/instances/{instanceId}/initialCredentials:
get:
deprecated: true
description: 'Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead.
Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.
For certain operating systems, users will be forced to change the initial credentials.
'
operationId: GetWindowsInstanceInitialCredentials
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
responses:
200:
description: The credentials were retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceCredentials'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetWindowsInstanceInitialCredentials
tags:
- compute
/instances/{instanceId}/maintenanceReboot:
get:
description: 'Gets the maximum possible date that a maintenance reboot can be extended. For more information, see
[Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm).
'
operationId: GetInstanceMaintenanceReboot
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The maximum extension date for the maintenance reboot was retrieved.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceMaintenanceReboot'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetInstanceMaintenanceReboot
tags:
- compute
/instances/{instanceId}/measuredBootReport:
get:
description: Gets the measured boot report for this shielded instance.
operationId: GetMeasuredBootReport
parameters:
- $ref: '#/components/parameters/InstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The measured boot report was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MeasuredBootReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetMeasuredBootReport
tags:
- compute
/shapes:
get:
description: 'Lists the shapes that can be used to launch an instance within the specified compartment. You can
filter the list by compatibility with a specific image.
'
operationId: ListShapes
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/ImageIdQueryParam'
- $ref: '#/components/parameters/ShapeNameQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Shape'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListShapes
tags:
- compute
/vnicAttachments/:
get:
description: 'Lists the VNIC attachments in the specified compartment. A VNIC attachment
resides in the same compartment as the attached instance. The list can be
filtered by instance, VNIC, or availability domain.
'
operationId: ListVnicAttachments
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/VnicIdOptionalQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/VnicAttachment'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/VnicAttachment'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListVnicAttachments
tags:
- compute
post:
description: 'Creates a secondary VNIC and attaches it to the specified instance.
For more information about secondary VNICs, see
[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).
'
operationId: AttachVnic
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The VNIC is being attached.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VnicAttachment'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AttachVnic
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachVnicDetails'
description: Attach VNIC details.
required: true
/vnicAttachments/{vnicAttachmentId}:
delete:
description: 'Detaches and deletes the specified secondary VNIC.
This operation cannot be used on the instance''s primary VNIC.
When you terminate an instance, all attached VNICs (primary
and secondary) are automatically detached and deleted.
**Important:** If the VNIC has a
[private IP](#/en/iaas/latest/PrivateIp/) that is the
[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),
deleting the VNIC causes that route rule to blackhole and the traffic
will be dropped.
'
operationId: DetachVnic
parameters:
- $ref: '#/components/parameters/VnicAttachmentIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The VNIC is being detached.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DetachVnic
tags:
- compute
x-related-resource: '#/definitions/VnicAttachment'
get:
description: 'Gets the information for the specified VNIC attachment.
'
operationId: GetVnicAttachment
parameters:
- $ref: '#/components/parameters/VnicAttachmentIdPathParam'
responses:
200:
description: The VNIC attachment was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VnicAttachment'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetVnicAttachment
tags:
- compute
/volumeAttachments/:
get:
description: 'Lists the volume attachments in the specified compartment. You can filter the
list by specifying an instance OCID, volume OCID, or both.
Currently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and
[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).
'
operationId: ListVolumeAttachments
parameters:
- $ref: '#/components/parameters/AvailabilityDomainQueryParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/InstanceIdQueryParam'
- $ref: '#/components/parameters/VolumeIdQueryParam'
responses:
200:
description: The list is being retrieved.
headers:
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
items:
$ref: '#/components/schemas/VolumeAttachment'
type: array
application/x-json-stream:
schema:
items:
$ref: '#/components/schemas/VolumeAttachment'
type: array
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: ListVolumeAttachments
tags:
- compute
post:
description: 'Attaches the specified storage volume to the specified instance.
'
operationId: AttachVolume
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The volume is being attached.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeAttachment'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: AttachVolume
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttachVolumeDetails'
description: Attach volume request
required: true
/volumeAttachments/{volumeAttachmentId}:
delete:
description: 'Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.
This is an asynchronous operation. The attachment''s `lifecycleState` will change to DETACHING temporarily
until the attachment is completely removed.
'
operationId: DetachVolume
parameters:
- $ref: '#/components/parameters/VolumeAttachmentIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The request was accepted by the server
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
schema:
type: string
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: DetachVolume
tags:
- compute
x-related-resource: '#/definitions/VolumeAttachment'
get:
description: Gets information about the specified volume attachment.
operationId: GetVolumeAttachment
parameters:
- $ref: '#/components/parameters/VolumeAttachmentIdPathParam'
responses:
200:
description: The volume attachment was retrieved.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeAttachment'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: GetVolumeAttachment
tags:
- compute
put:
description: Updates information about the specified volume attachment.
operationId: UpdateVolumeAttachment
parameters:
- $ref: '#/components/parameters/VolumeAttachmentIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The volume attachment was updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/VolumeAttachment'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/DefaultError'
summary: UpdateVolumeAttachment
tags:
- compute
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVolumeAttachmentDetails'
description: Update information about the specified volume attachment.
required: true
components:
parameters:
ComputeHostInSubtreeQueryParam:
description: 'When set to true, all the compartments in the tenancy are traversed
and the hosts in the specified tenancy and its compartments are fetched.
Default is false.
'
in: query
name: computeHostInSubtree
required: false
schema:
type: boolean
default: false
AvailabilityDomainQueryParam:
description: 'The name of the availability domain.
Example: `Uocm:PHX-AD-1`
'
in: query
name: availabilityDomain
required: false
schema:
type: string
InstanceConsoleConnectionIdPathParam:
description: The OCID of the instance console connection.
in: path
name: instanceConsoleConnectionId
required: true
schema:
type: string
ComputeGlobalImageCapabilitySchemaIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema
in: path
name: computeGlobalImageCapabilitySchemaId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ShapeNamePathParam:
description: Shape name.
in: path
name: shapeName
required: true
schema:
type: string
maxLength: 255
minLength: 1
VnicIdOptionalQueryParam:
description: The OCID of the VNIC.
in: query
name: vnicId
required: false
schema:
type: string
BootVolumeAttachmentIdPathParam:
description: The OCID of the boot volume attachment.
in: path
name: bootVolumeAttachmentId
required: true
schema:
type: string
InstanceMaintenanceEventCorrelationTokenQueryParam:
description: A filter to only return resources that have a matching correlationToken.
in: query
name: correlationToken
required: false
x-default-description: The correlationToken from an InstanceMaintenanceEvent
schema:
type: string
IfMatchHeader:
description: 'For 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.
'
in: header
name: if-match
schema:
type: string
FilterByPublisherNameQueryParam:
description: 'A filter to return only the publisher that matches the given publisher name exactly.
'
in: query
name: publisherName
required: false
schema:
type: string
maxLength: 64
minLength: 1
ComputeGpuMemoryFabricIdPathParam:
description: The OCID of the compute GPU memory fabric.
in: path
name: computeGpuMemoryFabricId
required: true
schema:
type: string
SortOrderQueryParam:
description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order
is case sensitive.
'
in: query
name: sortOrder
required: false
x-default-description: The default sort order varies by API.
schema:
type: string
enum:
- ASC
- DESC
default: ASC
ComputeGlobalImageCapabilitySchemaVersionNamePathParam:
description: The name of the compute global image capability schema version
in: path
name: computeGlobalImageCapabilitySchemaVersionName
required: true
schema:
type: string
maxLength: 255
minLength: 1
ShapeNameQueryParam:
description: Shape name.
in: query
name: shape
schema:
type: string
ComputeHostHealthParam:
description: 'A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.
'
in: query
name: computeHostHealth
x-default-description: 'null'
schema:
type: string
IsMemoryEncryptionEnabledQueryParam:
description: 'A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.
'
in: query
name: isMemoryEncryptionEnabled
required: false
schema:
type: boolean
RequestIdHeader:
description: 'Unique identifier for the request.
If you need to contact Oracle about a particular request, please provide the request ID.
'
in: header
name: opc-request-id
schema:
type: string
pattern: '[A-Za-z0-9\-_\.]+'
CompartmentIdOptionalQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
VnicAttachmentIdPathParam:
description: The OCID of the VNIC attachment.
in: path
name: vnicAttachmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ComputeHostGroupIdQueryParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.
'
in: query
name: computeHostGroupId
required: false
x-default-description: 'null'
schema:
type: string
VolumeIdQueryParam:
description: The OCID of the volume.
in: query
name: volumeId
schema:
type: string
SortByQueryParam:
description: '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.
**Note:** In general, some "List" operations (for example, `ListInstances`) let you
optionally filter by availability domain if the scope of the resource type is within a
single availability domain. If you call one of these "List" operations without specifying
an availability domain, the resources are grouped by availability domain, then sorted.
'
in: query
name: sortBy
required: false
x-default-description: The default field to sort by varies by API.
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
ComputeHostIdPathParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host.
'
in: path
name: computeHostId
required: true
schema:
type: string
ComputeGpuMemoryFabricIdQueryParam:
description: 'A filter to return only the listings that matches the given GPU memory fabric id.
'
in: query
name: computeGpuMemoryFabricId
required: false
schema:
type: string
maxLength: 255
minLength: 1
MaintenanceIdPathParam:
description: The OCID of the instance maintenance event.
in: path
name: instanceMaintenanceEventId
required: true
schema:
type: string
CapacityReservationLifecycleStateQueryParam:
description: A filter to only return resources that match the given lifecycle state.
in: query
name: lifecycleState
required: false
x-default-description: The default value varies for this API
x-obmcs-enumref: '#/definitions/ComputeCapacityReservation/lifecycleState'
schema:
type: string
RemainingOcpusGreaterThanOrEqualToQueryParam:
description: The available OCPUs of the dedicated VM host.
in: query
name: remainingOcpusGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: number
format: float
minimum: 0.0
ImageIdQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.
in: query
name: imageId
schema:
type: string
ImageIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.
in: path
name: imageId
required: true
schema:
type: string
ComputeImageCapabilitySchemaIdPathParam:
description: The id of the compute image capability schema or the image ocid
in: path
name: computeImageCapabilitySchemaId
required: true
schema:
type: string
maxLength: 255
minLength: 1
RequiredAvailabilityDomainQueryParam:
description: 'The name of the availability domain.
Example: `Uocm:PHX-AD-1`
'
in: query
name: availabilityDomain
required: true
schema:
type: string
ResourceVersionQueryParam:
description: Listing Resource Version.
in: query
name: resourceVersion
required: true
schema:
type: string
InstanceMaintenanceEventLifecycleStateQueryParam:
description: A filter to only return resources that match the given lifecycle state.
in: query
name: lifecycleState
required: false
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/lifecycleState'
schema:
type: string
FilterByDisplayNameQueryParam:
description: 'A filter to return only resources that match the given display name exactly.
'
in: query
name: displayName
required: false
schema:
type: string
maxLength: 255
minLength: 1
TimeWindowStartGreaterThanOrEqualToQueryParam:
description: Starting range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format).
in: query
name: timeWindowStartGreaterThanOrEqualTo
required: false
schema:
type: string
format: date-time
maxLength: 255
minLength: 1
TimeWindowStartLessThanOrEqualToQueryParam:
description: Ending range to return the maintenances which are not completed (date-time is in [RFC3339](https://tools.ietf.org/html/rfc3339) format).
in: query
name: timeWindowStartLessThanOrEqualTo
required: false
schema:
type: string
format: date-time
maxLength: 255
minLength: 1
DedicatedVmHostIdPathParam:
description: The OCID of the dedicated VM host.
in: path
name: dedicatedVmHostId
required: true
schema:
type: string
ComputeGpuMemoryClusterIdPathParam:
description: The OCID of the compute GPU memory cluster.
in: path
name: computeGpuMemoryClusterId
required: true
schema:
type: string
InstanceShapeNameQueryParam:
description: 'The name for the instance''s shape.
'
in: query
name: instanceShapeName
required: false
schema:
type: string
FilterByLifecycleStateQueryParam:
description: 'A filter to return only resources that match the given lifecycle state name exactly.
'
in: query
name: lifecycleState
required: false
schema:
type: string
maxLength: 255
minLength: 1
ComputeHostNetworkResourceQueryParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host network resoruce.
- Customer-unique HPC island ID
- Customer-unique network block ID
- Customer-unique local block ID
'
in: query
name: networkResourceId
required: false
schema:
type: string
ComputeClusterIdPathParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory
access (RDMA) network group.
'
in: path
name: computeClusterId
required: true
schema:
type: string
FirmwareBundleIdPathParam:
description: Unique identifier for the firmware bundle.
in: path
name: firmwareBundleId
required: true
schema:
type: string
DefaultBundleQueryParam:
description: If true, return only the default firmware bundle for a given platform. Default is false.
in: query
name: isDefaultBundle
required: false
schema:
type: boolean
default: false
PaginationTokenQueryParam:
description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"
call. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
in: query
name: page
schema:
type: string
maxLength: 4096
minLength: 1
ComputeGpuMemoryFabricHealthQueryParam:
description: 'A filter to return ComputeGpuMemoryFabricSummary resources that match the given fabric health.
'
in: query
name: computeGpuMemoryFabricHealth
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/fabricHealth'
schema:
type: string
ComputeImageCapabilityCompartmentIdQueryParam:
description: 'A filter to return only resources that match the given compartment OCID exactly.
'
in: query
name: compartmentId
required: false
x-default-description: publicCompartment
schema:
type: string
maxLength: 255
minLength: 1
FilterByListingIdQueryParam:
description: 'A filter to return only the listings that matches the given listing id.
'
in: query
name: listingId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ComputeClusterIdQueryParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory
access (RDMA) network group.
'
in: query
name: computeClusterId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RecycleLevelQueryParam:
description: 'This optional parameter overrides recycle level for hosts. The parameter can be used when hosts are associated
with a Capacity Reservation.
* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.
'
in: query
name: recycleLevel
required: false
x-default-description: 'null'
schema:
type: string
enum:
- FULL_RECYCLE
ListingIdPathParam:
description: The OCID of the listing.
in: path
name: listingId
required: true
schema:
type: string
ComputeCapacityTopologyIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
in: path
name: computeCapacityTopologyId
required: true
schema:
type: string
FilterByDeviceNameQueryParam:
description: 'A filter to return only devices that match the given name exactly.
'
in: query
name: name
required: false
schema:
type: string
maxLength: 9
minLength: 3
ComputeNetworkBlockIdQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
in: query
name: computeNetworkBlockId
required: false
schema:
type: string
ComputeHostLifecycleStateParam:
description: 'A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.
'
in: query
name: computeHostLifecycleState
x-default-description: 'null'
schema:
type: string
InstanceMaintenanceEventInstanceActionQueryParam:
description: A filter to only return resources that match the given instance action.
in: query
name: instanceAction
required: false
schema:
type: string
RetryTokenHeader:
description: 'A 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).
'
in: header
name: opc-retry-token
schema:
type: string
maxLength: 64
minLength: 1
RemainingMemoryInGBsGreaterThanOrEqualToQueryParam:
description: The remaining memory of the dedicated VM host, in GBs.
in: query
name: remainingMemoryInGBsGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: number
format: float
minimum: 0.0
PreserveDataVolumesQueryParam:
description: "Specifies whether to delete or preserve the data volumes created during launch when\nterminating an instance. When set to `true`, the data volumes are preserved. The \ndefault value is `true`.\n"
in: query
name: preserveDataVolumesCreatedAtLaunch
required: false
schema:
type: boolean
default: true
InstanceActionQueryParam:
description: The action to perform on the instance.
in: query
name: action
required: true
x-obmcs-inline-enum: false
schema:
type: string
enum:
- STOP
- START
- SOFTRESET
- RESET
- SOFTSTOP
- SENDDIAGNOSTICINTERRUPT
- DIAGNOSTICREBOOT
- REBOOTMIGRATE
ResourceVersionPathParam:
description: Listing Resource Version.
in: path
name: resourceVersion
required: true
schema:
type: string
FilterByPublisherTypeQueryParam:
description: 'A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.
'
in: query
name: publisherType
required: false
schema:
type: string
maxLength: 64
minLength: 1
ComputeGpuMemoryFabricLifecycleStateQueryParam:
description: 'A filter to return ComputeGpuMemoryFabricSummary resources that match the given lifecycle state.
'
in: query
name: computeGpuMemoryFabricLifecycleState
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/lifecycleState'
schema:
type: string
DevicePlatformQueryParam:
description: platform name
in: query
name: platform
required: true
schema:
type: string
InstanceIdQueryParam:
description: The OCID of the instance.
in: query
name: instanceId
schema:
type: string
InstanceConsoleHistoryIdPathParam:
description: The OCID of the console history.
in: path
name: instanceConsoleHistoryId
required: true
schema:
type: string
ComputeGpuMemoryClusterIdQueryParam:
description: 'A filter to return only the listings that matches the given GPU memory cluster id.
'
in: query
name: computeGpuMemoryClusterId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ListingIdQueryParam:
description: The OCID of the listing.
in: query
name: listingId
required: true
schema:
type: string
OperatingSystemQueryParam:
description: 'The image''s operating system.
Example: `Oracle Linux`
'
in: query
name: operatingSystem
schema:
type: string
VolumeAttachmentIdPathParam:
description: The OCID of the volume attachment.
in: path
name: volumeAttachmentId
required: true
schema:
type: string
ComputeHostGroupIdParam:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.
'
in: path
name: computeHostGroupId
required: true
schema:
type: string
ComputeCapacityReservationIdPathParam:
description: The OCID of the compute capacity reservation.
in: path
name: capacityReservationId
required: true
schema:
type: string
ComputeHpcIslandIdQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
in: query
name: computeHpcIslandId
required: false
schema:
type: string
CompartmentIdQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DedicatedVmHostLifecycleStateQueryParam:
description: A filter to only return resources that match the given lifecycle state.
in: query
name: lifecycleState
required: false
schema:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
DedicatedVmHostShapeNameQueryParam:
description: 'Dedicated VM host shape name
'
in: query
name: dedicatedVmHostShape
required: false
schema:
type: string
ComputeLocalBlockIdQueryParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block.
in: query
name: computeLocalBlockId
required: false
schema:
type: string
PaginationLimitQueryParam:
description: 'For list pagination. The maximum number of results per page, or items to return in a paginated
"List" call. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
Example: `50`
'
in: query
name: limit
x-default-description: The default maximum results per page varies by API.
schema:
type: integer
maximum: 100
minimum: 1
BootVolumeIdQueryParam:
description: The OCID of the boot volume.
in: query
name: bootVolumeId
schema:
type: string
ComputeCapacityReservationIdQueryParam:
description: The OCID of the compute capacity reservation.
in: query
name: capacityReservationId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
FilterByDeviceAvailabilityQueryParam:
description: 'A filter to return only available devices or only used devices.
'
in: query
name: isAvailable
required: false
schema:
type: boolean
OperatingSystemVersionQueryParam:
description: 'The image''s operating system version.
Example: `7.2`
'
in: query
name: operatingSystemVersion
schema:
type: string
InstanceIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance.
in: path
name: instanceId
required: true
schema:
type: string
ComputeImageCapabilityMergeQueryParam:
description: 'Merge the image capability schema with the global image capability schema
'
in: query
name: isMergeEnabled
required: false
schema:
type: boolean
default: false
maxLength: 64
minLength: 1
PreserveBootVolumeQueryParam:
description: 'Specifies whether to delete or preserve the boot volume when terminating an instance.
When set to `true`, the boot volume is preserved. The default value is `false`.
'
in: query
name: preserveBootVolume
required: false
schema:
type: boolean
default: false
schemas:
CapacityReportInstanceShapeConfig:
description: 'The shape configuration for a shape in a capacity report.
'
properties:
baselineOcpuUtilization:
description: 'The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a
non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.
The following values are supported:
- `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
- `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
- `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.
'
enum:
- BASELINE_1_8
- BASELINE_1_2
- BASELINE_1_1
type: string
memoryInGBs:
description: 'The total amount of memory available to the instance, in gigabytes.
'
format: float
minimum: 0.0
type: number
nvmes:
description: 'The number of NVMe drives to be used for storage.
'
format: int32
maximum: 7
minimum: 1
type: integer
ocpus:
description: 'The total number of OCPUs available to the instance.
'
format: float
minimum: 0.0
type: number
UpdateComputeGpuMemoryFabricDetails:
description: 'Updates compute GPU memory fabric details.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
memoryFabricPreferences:
$ref: '#/components/schemas/MemoryFabricPreferencesDescriptor'
PlatformConfig:
description: 'The platform configuration for the instance.
'
discriminator:
propertyName: type
properties:
isMeasuredBootEnabled:
default: false
description: 'Whether the Measured Boot feature is enabled on the instance.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`.
'
type: boolean
isSecureBootEnabled:
default: false
description: 'Whether Secure Boot is enabled on the instance.
'
type: boolean
isTrustedPlatformModuleEnabled:
default: false
description: 'Whether the Trusted Platform Module (TPM) is enabled on the instance.
'
type: boolean
type:
description: 'The type of platform being configured.
'
enum:
- AMD_MILAN_BM
- AMD_MILAN_BM_GPU
- AMD_ROME_BM
- AMD_ROME_BM_GPU
- GENERIC_BM
- INTEL_ICELAKE_BM
- INTEL_SKYLAKE_BM
- AMD_VM
- INTEL_VM
type: string
required:
- type
Error:
properties:
code:
description: 'A short error code that defines the error, meant for programmatic parsing. See
[API Errors](/iaas/Content/API/References/apierrors.htm).
'
type: string
message:
description: A human-readable error message.
type: string
messageArguments:
additionalProperties:
type: string
description: 'The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map.
'
type: object
originalMessage:
description: A human-readable error string in English. This value might be different from the `message` field.
type: string
originalMessageTemplate:
description: 'The template for the `originalMessage` in ICU message format, but without the values to be substituted.
'
type: string
required:
- code
- message
UpdateComputeClusterDetails:
description: "The data to update a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm).\n\nUse `COMPUTE_CLUSTER` type when using placementConstraintDetails.\n\n`placementConstraintDetails.hpcIslandId` is create-only and cannot be part of this update request.\n\nAll other fields in `placementConstraintDetails` are optional, and only the fields provided will be updated.\n\nIf `placementConstraintDetails.targetNetworkBlockIds` or `placementConstraintDetails.targetMemoryFabricIds` is \nprovided, then the target compute cluster must already have `hpcIslandId` persisted.\n"
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
ChangeComputeHostGroupCompartmentDetails:
description: Specifies the compartment to move the compute host group to.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
to move the compute host group to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ChangeComputeGpuMemoryFabricCompartmentDetails:
description: Specifies the compartment to move the compute GPU memory fabric to.
properties:
compartmentId:
description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute GPU \nmemory fabric to.\n"
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ComputeGpuMemoryFabricSummary:
description: 'Summary information for a compute GPU memory fabric.
'
properties:
availableHostCount:
description: The total number of available bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
compartmentId:
description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the \nroot compartment.\n"
maxLength: 255
minLength: 1
type: string
computeHpcIslandId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
'
maxLength: 255
minLength: 1
type: string
computeLocalBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
'
maxLength: 255
minLength: 1
type: string
computeNetworkBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
'
maxLength: 255
minLength: 1
type: string
currentFirmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
fabricHealth:
description: 'The health state of the GPU memory fabric
'
type: string
x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/fabricHealth'
firmwareUpdateState:
description: 'The state of Memory Fabric Firmware update
'
enum:
- WILL_UPDATE
- NO_UPDATE
- SKIP_RECYCLE_ENABLED
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
healthyHostCount:
description: The total number of healthy bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
hostPlatformName:
description: 'The host platform identifier used for bundle queries
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The lifecycle state of the GPU memory fabric
'
type: string
x-obmcs-enumref: '#/definitions/ComputeGpuMemoryFabric/lifecycleState'
memoryFabricPreferences:
$ref: '#/components/schemas/MemoryFabricPreferencesDescriptor'
switchPlatformName:
description: 'The switch platform identifier used for bundle queries
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
targetFirmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339]
(https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalHostCount:
description: The total number of bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
required:
- id
- compartmentId
- computeHpcIslandId
- computeNetworkBlockId
- computeLocalBlockId
- lifecycleState
- fabricHealth
- totalHostCount
- timeCreated
UpdateInstanceDetails:
properties:
agentConfig:
$ref: '#/components/schemas/UpdateInstanceAgentConfigDetails'
availabilityConfig:
$ref: '#/components/schemas/UpdateInstanceAvailabilityConfigDetails'
capacityReservationId:
description: 'The OCID of the compute capacity reservation this instance is launched under.
You can remove the instance from a reservation by specifying an empty string as input for this field.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
maxLength: 255
minLength: 0
type: string
x-default-description: 'If you specify a reservation ID, the instance is launched under the associated compute capacity reservation.
Using an empty string for this field value causes the instance to be moved out of the capacity reservation.
If you do not specify this parameter, the instance is launched under its current capacity reservation.
'
dedicatedVmHostId:
description: 'The OCID of the dedicated virtual machine host to place the instance on.
Supported only if this VM instance was already placed on a dedicated virtual machine host
- that is, you can''t move an instance from on-demand capacity to dedicated capacity,
nor can you move an instance from dedicated capacity to on-demand capacity.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
extendedMetadata:
additionalProperties:
type: object
description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and
functionality as fields in the `metadata` object.
They are distinguished from `metadata` fields in that these can be nested JSON objects
(whereas `metadata` fields are string/string maps only).
The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance
has launched. Any request that updates, removes, or adds either of these fields will be
rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that
already exist on the instance.
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of
32,000 bytes.
'
type: object
faultDomain:
description: 'A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
To get a list of fault domains, use the
[ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the
Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
instanceOptions:
$ref: '#/components/schemas/InstanceOptions'
isAIEnterpriseEnabled:
default: false
description: 'Whether to enable AI enterprise on the instance.
'
type: boolean
launchOptions:
$ref: '#/components/schemas/UpdateLaunchOptions'
metadata:
additionalProperties:
type: string
description: 'Custom metadata key/value string pairs that you provide. Any set of key/value pairs
provided here will completely replace the current set of key/value pairs in the `metadata`
field on the instance.
The "user_data" field and the "ssh_authorized_keys" field cannot be changed after an instance
has launched. Any request that updates, removes, or adds either of these fields will be
rejected. You must provide the same values for "user_data" and "ssh_authorized_keys" that
already exist on the instance.
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of
32,000 bytes.
'
type: object
securityAttributes:
additionalProperties:
additionalProperties:
description: 'The value of the tag.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).
'
type: object
description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`
'
type: object
shape:
description: 'The shape of the instance. The shape determines the number of CPUs and the amount of memory
allocated to the instance. For more information about how to change shapes, and a list of
shapes that are supported, see
[Editing an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm).
For details about the CPUs, memory, and other properties of each shape, see
[Compute Shapes](/iaas/Content/Compute/References/computeshapes.htm).
The new shape must be compatible with the image that was used to launch the instance. You
can enumerate all available shapes and determine image compatibility by calling
[ListShapes](#/en/iaas/latest/Shape/ListShapes).
To determine whether capacity is available for a specific shape before you change the shape of an instance,
use the [CreateComputeCapacityReport](#/en/iaas/latest/ComputeCapacityReport/CreateComputeCapacityReport)
operation.
If the instance is running when you change the shape, the instance is rebooted.
Example: `VM.Standard2.1`
'
maxLength: 255
minLength: 1
type: string
shapeConfig:
$ref: '#/components/schemas/UpdateInstanceShapeConfigDetails'
sourceDetails:
$ref: '#/components/schemas/UpdateInstanceSourceDetails'
timeMaintenanceRebootDue:
description: 'For a VM instance, resets the scheduled time that the instance will be reboot migrated for
infrastructure maintenance, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
If the instance hasn''t been rebooted after this date, Oracle reboots the instance within 24 hours of the time
and date that maintenance is due.
To get the maximum possible date that a maintenance reboot can be extended,
use [GetInstanceMaintenanceReboot](#/en/iaas/latest/InstanceMaintenanceReboot/GetInstanceMaintenanceReboot).
Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches the
Stopped state.
To reboot migrate a bare metal instance, use the [InstanceAction](#/en/iaas/latest/Instance/InstanceAction) operation.
For more information, see
[Infrastructure Maintenance](/iaas/Content/Compute/References/infrastructure-maintenance.htm).
Example: `2018-05-25T21:10:29.600Z`
'
format: date-time
type: string
updateOperationConstraint:
description: "The parameter acts as a fail-safe to prevent unwanted downtime when updating a running instance.\nThe default is ALLOW_DOWNTIME.\n* `ALLOW_DOWNTIME` - Compute might reboot the instance while updating the instance if a reboot is required.\n* `AVOID_DOWNTIME` - If the instance is in running state, Compute tries to update the instance without rebooting\n it. If the instance requires a reboot to be updated, an error is returned and the instance\n is not updated. If the instance is stopped, it is updated and remains in the stopped state.\n"
enum:
- ALLOW_DOWNTIME
- AVOID_DOWNTIME
type: string
ChangeComputeImageCapabilitySchemaCompartmentDetails:
description: The configuration details for the move operation.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to
move the instance configuration to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
PreemptibleInstanceConfigDetails:
description: 'Configuration options for preemptible instances.
'
properties:
preemptionAction:
$ref: '#/components/schemas/PreemptionAction'
required:
- preemptionAction
type: object
DedicatedVmHostSummary:
description: 'A dedicated virtual machine (VM) host lets you host multiple instances on a dedicated server that is not shared with other tenancies.
'
properties:
availabilityDomain:
description: 'The availability domain the dedicated VM host is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment that contains the dedicated VM host.
'
maxLength: 255
minLength: 1
type: string
dedicatedVmHostShape:
description: 'The shape of the dedicated VM host. The shape determines the number of CPUs and
other resources available for VMs.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'The fault domain for the dedicated VM host''s assigned instances. For more information, see Fault Domains.
If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated VM host,
delete it and create a new dedicated VM host in the preferred fault domain.
To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host.
'
maxLength: 255
minLength: 1
type: string
isBurstable:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched.
'
type: boolean
lifecycleState:
description: 'The current state of the dedicated VM host.
'
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
remainingMemoryInGBs:
description: 'The current available memory of the dedicated VM host, in GBs.
'
format: float
minimum: 0.0
type: number
remainingOcpus:
description: 'The current available OCPUs of the dedicated VM host.
'
format: float
minimum: 0.0
type: number
timeCreated:
description: 'The date and time the dedicated VM host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalMemoryInGBs:
description: 'The current total memory of the dedicated VM host, in GBs.
'
format: float
minimum: 0.0
type: number
totalOcpus:
description: 'The current total OCPUs of the dedicated VM host.
'
format: float
minimum: 0.0
type: number
required:
- availabilityDomain
- compartmentId
- dedicatedVmHostShape
- displayName
- id
- lifecycleState
- timeCreated
- remainingOcpus
- totalOcpus
ComputeHost:
description: 'The customer facing object includes host details.
'
properties:
additionalData:
additionalProperties:
type: object
description: 'Additional data that can be exposed to the customer. Will include raw fault codes for strategic customers
'
type: object
availabilityDomain:
description: 'The availability domain of the compute host.
Example: `Uocm:US-CHICAGO-1-AD-2`
'
maxLength: 255
minLength: 1
type: string
capacityReservationId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root
compartment.
'
maxLength: 255
minLength: 1
type: string
computeHostGroupId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group associated with the Compute Bare Metal Host.
'
maxLength: 255
minLength: 1
type: string
configurationData:
$ref: '#/components/schemas/ComputeHostConfigurationData'
configurationState:
description: 'Configuration state of the Compute Bare Metal Host.
'
enum:
- CONFORMANT
- NON_CONFORMANT
- CHECKING
- PRE_APPLYING
- APPLYING
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigurationState'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
This field is the Fault domain of the host
'
maxLength: 255
minLength: 1
type: string
firmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryFabricId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric
'
maxLength: 255
minLength: 1
type: string
health:
description: 'The heathy state of the host
'
enum:
- HEALTHY
- UNHEALTHY
type: string
hpcIslandId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host
'
maxLength: 255
minLength: 1
type: string
impactedComponentDetails:
additionalProperties:
type: object
description: "A list that contains impacted components related to an unhealthy host. An impacted component will be a \nfree-form structure of key values pairs that will provide more or less details based on data tiering\n"
type: object
instanceId:
description: 'The public [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance
'
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
additionalProperties:
type: object
description: 'A free-form description detailing why the host is in its current state.
'
type: object
lifecycleState:
description: 'The lifecycle state of the host
'
enum:
- AVAILABLE
- OCCUPIED
- PROVISIONING
- REPAIR
- UNAVAILABLE
type: string
localBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
'
maxLength: 255
minLength: 1
type: string
networkBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
'
maxLength: 255
minLength: 1
type: string
platform:
description: 'The platform of the host
'
maxLength: 255
minLength: 1
type: string
recycleDetails:
$ref: '#/components/schemas/RecycleDetails'
shape:
description: 'The shape of host
'
maxLength: 255
minLength: 1
type: string
timeConfigurationCheck:
description: 'The date and time that the compute bare metal host configuration check was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeCreated:
description: 'The date and time that the compute host record was created, in the format defined by [RFC3339](https://tools
.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute host record was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- availabilityDomain
- id
- faultDomain
- shape
- health
- lifecycleState
- timeCreated
- timeUpdated
LaunchOptions:
description: 'Options for tuning the compatibility and performance of VM shapes. The values that you specify override any
default values.
'
properties:
bootVolumeType:
description: 'Emulation type for the boot volume.
* `ISCSI` - ISCSI attached block storage device.
* `SCSI` - Emulated SCSI disk.
* `IDE` - Emulated IDE disk.
* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data
volumes on platform images.
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block
storage volumes on platform images.
'
enum:
- ISCSI
- SCSI
- IDE
- VFIO
- PARAVIRTUALIZED
type: string
firmware:
description: 'Firmware used to boot VM. Select the option that matches your operating system.
* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating
systems that boot using MBR style bootloaders.
* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the
default for platform images.
'
enum:
- BIOS
- UEFI_64
type: string
isConsistentVolumeNamingEnabled:
description: Whether to enable consistent volume naming feature. Defaults to false.
type: boolean
isPvEncryptionInTransitEnabled:
description: 'Deprecated. Instead use `isPvEncryptionInTransitEnabled` in
[LaunchInstanceDetails](#/en/iaas/latest/datatypes/LaunchInstanceDetails).
'
type: boolean
networkType:
description: 'Emulation type for the physical network interface card (NIC).
* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type
when you launch an instance using hardware-assisted (SR-IOV) networking.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
'
enum:
- E1000
- VFIO
- PARAVIRTUALIZED
- ACCELERATEDPV
type: string
remoteDataVolumeType:
description: 'Emulation type for volume.
* `ISCSI` - ISCSI attached block storage device.
* `SCSI` - Emulated SCSI disk.
* `IDE` - Emulated IDE disk.
* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data
volumes on platform images.
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block
storage volumes on platform images.
'
enum:
- ISCSI
- SCSI
- IDE
- VFIO
- PARAVIRTUALIZED
type: string
UpdateConsoleHistoryDetails:
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
ComputeGpuMemoryClusterInstanceCollection:
description: 'A list of compute GPU Memory Cluster instances.
'
properties:
items:
description: The list of compute GPU Memory Cluster instances.
items:
$ref: '#/components/schemas/ComputeGpuMemoryClusterInstanceSummary'
type: array
required:
- items
type: object
InstanceAvailabilityConfig:
description: 'Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
'
properties:
isLiveMigrationPreferred:
description: 'Whether to live migrate supported VM instances to a healthy physical VM host without
disrupting running instances during infrastructure maintenance events. If null, Oracle
chooses the best option for migrating the VM during infrastructure maintenance events.
'
type: boolean
recoveryAction:
default: RESTORE_INSTANCE
description: 'The lifecycle state for an instance when it is recovered after infrastructure maintenance.
* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event.
If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
* `STOP_INSTANCE` - The instance is recovered in the stopped state.
'
enum:
- RESTORE_INSTANCE
- STOP_INSTANCE
type: string
AttachVnicDetails:
properties:
createVnicDetails:
$ref: '#/components/schemas/CreateVnicDetails'
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
instanceId:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
nicIndex:
description: 'Which physical network interface card (NIC) the VNIC will use. Defaults to 0.
Certain bare metal instance shapes have two active physical NICs (0 and 1). If
you add a secondary VNIC to one of these instances, you can specify which NIC
the VNIC will use. For more information, see
[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).
'
format: int32
maximum: 31
minimum: 0
type: integer
required:
- instanceId
- createVnicDetails
InstanceReservationShapeConfigDetails:
description: 'The shape configuration requested when launching instances in a compute capacity reservation.
If the parameter is provided, the reservation is created with the resources that you specify. If some
properties are missing or the parameter is not provided, the reservation is created
with the default configuration values for the `shape` that you specify.
Each shape only supports certain configurable values. If the values that you provide are not valid for the
specified `shape`, an error is returned.
For more information about customizing the resources that are allocated to flexible shapes,
see [Flexible Shapes](/iaas/Content/Compute/References/computeshapes.htm#flexible).
'
properties:
memoryInGBs:
description: 'The total amount of memory available to the instance, in gigabytes.
'
format: float
minimum: 0.0
type: number
ocpus:
description: 'The total number of OCPUs available to the instance.
'
format: float
minimum: 0.0
type: number
ComputeGpuMemoryClusterScaleConfig:
description: 'Configuration settings for GPU Memory Cluster scaling.
'
properties:
isDownsizeEnabled:
description: 'Whether downsizing is enabled.
'
type: boolean
isUpsizeEnabled:
description: 'Whether upsizing is enabled.
'
type: boolean
targetSize:
description: 'The configured target size for the GPU Memory Cluster.
'
format: int64
minimum: 0
type: integer
AppCatalogListingResourceVersionAgreements:
description: Agreements for a listing resource version.
properties:
eulaLink:
description: EULA link
maxLength: 1024
minLength: 1
type: string
listingId:
description: The OCID of the listing associated with these agreements.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Listing resource version associated with these agreements.
maxLength: 64
minLength: 1
type: string
oracleTermsOfUseLink:
description: Oracle TOU link
maxLength: 1024
minLength: 1
type: string
signature:
description: 'A generated signature for this agreement retrieval operation which should be used in the create subscription call.
'
maxLength: 255
minLength: 1
type: string
timeRetrieved:
description: 'Date and time the agreements were retrieved, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
ComputeGpuMemoryCluster:
description: 'The customer facing object includes GPU Memory Cluster details.
'
properties:
availabilityDomain:
description: 'The availability domain of the GPU Memory Cluster.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU
memory cluster.
'
maxLength: 255
minLength: 1
type: string
computeClusterId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryClusterScaleConfig:
$ref: '#/components/schemas/ComputeGpuMemoryClusterScaleConfig'
gpuMemoryFabricId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster
'
maxLength: 255
minLength: 1
type: string
instanceConfigurationId:
description: The OCID of the Instance Configuration used to source launch details for this instance.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The lifecycle state of the GPU Memory Cluster
'
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
type: string
privateIpIds:
description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster
items:
maxLength: 255
minLength: 1
type: string
maxItems: 255
type: array
uniqueItems: true
size:
description: 'The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching.
'
format: int64
minimum: 0
type: integer
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: 'The date and time the GPU Memory Cluster was created.
Example: `2016-09-15T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- computeClusterId
- instanceConfigurationId
- size
- availabilityDomain
- id
- lifecycleState
- timeCreated
FirmwareBundleTransitions:
description: A map of firmware bundle upgrades/downgrades validated by OCI.
properties:
downgrades:
description: An array of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades.
items:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the downgrade firmware bundle.
maxLength: 255
minLength: 1
type: string
type: array
upgrades:
description: An array of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades.
items:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the upgrade firmware bundle.
maxLength: 255
minLength: 1
type: string
type: array
type: object
ComputeCapacityTopologyCollection:
description: 'A list of compute capacity topologies.
'
properties:
items:
description: The list of compute capacity topologies.
items:
$ref: '#/components/schemas/ComputeCapacityTopologySummary'
type: array
required:
- items
type: object
LaunchInstanceLicensingConfig:
description: The license config requested for the instance.
discriminator:
propertyName: type
properties:
licenseType:
default: OCI_PROVIDED
description: 'License Type for the OS license.
* `OCI_PROVIDED` - OCI provided license (e.g. metered $/OCPU-hour).
* `BRING_YOUR_OWN_LICENSE` - Bring your own license.
'
enum:
- OCI_PROVIDED
- BRING_YOUR_OWN_LICENSE
type: string
type:
description: Operating System type of the Configuration.
enum:
- WINDOWS
type: string
required:
- type
ChangeComputeCapacityTopologyCompartmentDetails:
description: Specifies the compartment to move the compute capacity topology to.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
to move the compute capacity topology to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
RecycleDetails:
description: 'Shows details about the last recycle performed on this host.
'
properties:
computeHostGroupId:
description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group this host was attached to at the time of recycle. \n"
maxLength: 255
minLength: 1
type: string
recycleLevel:
description: 'Preferred recycle level for hosts associated with the reservation config.
* `SKIP_RECYCLE` - Skips host wipe.
* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.
'
enum:
- SKIP_RECYCLE
- FULL_RECYCLE
type: string
ShapeMemoryOptions:
description: 'For a flexible shape, the amount of memory available for instances that use this shape.
If this field is null, then this shape has a fixed amount of memory equivalent to `memoryInGBs`.
'
properties:
defaultPerOcpuInGBs:
description: 'The default amount of memory per OCPU available for this shape, in gigabytes.
'
format: float
minimum: 0.0
type: number
maxInGBs:
description: 'The maximum amount of memory, in gigabytes.
'
format: float
minimum: 0.0
type: number
maxPerOcpuInGBs:
description: 'The maximum amount of memory per OCPU available for this shape, in gigabytes.
'
format: float
type: number
exclusiveMinimum: 0.0
minInGBs:
description: 'The minimum amount of memory, in gigabytes.
'
format: float
minimum: 0.0
type: number
minPerOcpuInGBs:
description: 'The minimum amount of memory per OCPU available for this shape, in gigabytes.
'
format: float
type: number
exclusiveMinimum: 0.0
AppCatalogListingResourceVersionSummary:
description: Listing Resource Version summary
properties:
listingId:
description: The OCID of the listing this resource version belongs to.
maxLength: 255
minLength: 1
type: string
listingResourceId:
description: OCID of the listing resource.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Resource Version.
maxLength: 64
minLength: 1
type: string
timePublished:
description: 'Date and time the listing resource version was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
AppCatalogListingResourceVersion:
description: Listing Resource Version
properties:
accessiblePorts:
description: List of accessible ports for instances launched with this listing resource version.
items:
format: int32
type: integer
type: array
allowedActions:
description: Allowed actions for the listing resource.
items:
enum:
- SNAPSHOT
- BOOT_VOLUME_DETACH
- PRESERVE_BOOT_VOLUME
- SERIAL_CONSOLE_ACCESS
- BOOT_RECOVERY
- BACKUP_BOOT_VOLUME
- CAPTURE_CONSOLE_HISTORY
type: string
type: array
availableRegions:
description: 'List of regions that this listing resource version is available.
For information about regions, see
[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).
Example: `["us-ashburn-1", "us-phoenix-1"]`
'
items:
type: string
type: array
compatibleShapes:
description: 'Array of shapes compatible with this resource.
You can enumerate all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes).
Example: `["VM.Standard1.1", "VM.Standard1.2"]`
'
items:
type: string
type: array
listingId:
description: The OCID of the listing this resource version belongs to.
maxLength: 255
minLength: 1
type: string
listingResourceId:
description: OCID of the listing resource.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Resource Version.
maxLength: 64
minLength: 1
type: string
timePublished:
description: 'Date and time the listing resource version was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
PlatformVersions:
description: A platform's pinned firmware versions.
properties:
platform:
description: The name of the platform supported by this bundle.
type: string
versions:
description: An array of pinned components and their respective firmware versions.
items:
$ref: '#/components/schemas/ComponentVersion'
type: array
type: object
ShapeAccessControlServiceEnabledPlatformOptions:
description: 'Configuration options for the Access Control Service.
'
properties:
allowedValues:
description: 'Whether the Access Control Service can be enabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether the Access Control Service is enabled by default.
'
type: boolean
AddImageShapeCompatibilityEntryDetails:
description: Image shape compatibility details.
properties:
memoryConstraints:
$ref: '#/components/schemas/ImageMemoryConstraints'
ocpuConstraints:
$ref: '#/components/schemas/ImageOcpuConstraints'
UpdateComputeGpuMemoryClusterDetails:
description: 'Updates compute GPU Memory Cluster details.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryClusterScaleConfig:
$ref: '#/components/schemas/UpdateComputeGpuMemoryClusterScaleConfig'
instanceConfigurationId:
description: 'Instance Configuration to be used for this GPU Memory Cluster
'
maxLength: 255
minLength: 1
type: string
privateIpIds:
description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster
items:
maxLength: 255
minLength: 1
type: string
maxItems: 255
type: array
uniqueItems: true
size:
description: 'The desired number of instances for the GPU Memory Cluster.
'
format: int64
minimum: 0
type: integer
ChangeInstanceCompartmentDetails:
description: The configuration details for the move operation.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the instance to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
CreateInstanceConsoleConnectionDetails:
description: 'The details for creating a instance console connection.
The instance console connection is created in the same compartment as the instance.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
instanceId:
description: The OCID of the instance to create the console connection to.
type: string
publicKey:
description: The SSH public key used to authenticate the console connection.
format: ssh-authorized-key
type: string
required:
- instanceId
- publicKey
DedicatedVmHostShapeSummary:
description: 'The shape used to launch the dedicated virtual machine (VM) host.
'
properties:
availabilityDomain:
description: 'The shape''s availability domain.
'
maxLength: 255
minLength: 1
type: string
capacityConfigs:
description: 'A list of capacity configs that are supported by this dedicated VM host shape.
'
items:
$ref: '#/components/schemas/CapacityConfig'
maxItems: 25
minItems: 1
type: array
dedicatedVmHostShape:
description: 'The name of the dedicated VM host shape. You can enumerate all available shapes by calling
[ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes).
'
maxLength: 255
minLength: 1
type: string
required:
- dedicatedVmHostShape
CapacityConfig:
description: 'Specifies the capacity configs that the Dedicated Virtual Machine Host (DVMH) Shape could support.
'
properties:
capacityBins:
description: 'A list of total CPU and memory per capacity bucket.
'
items:
$ref: '#/components/schemas/CapacityBinPreview'
maxItems: 25
minItems: 0
type: array
capacityConfigName:
description: 'The name of each capacity config.
'
maxLength: 255
minLength: 1
type: string
isDefault:
default: false
description: 'Whether this capacity config is the default config.
'
type: boolean
supportedCapabilities:
$ref: '#/components/schemas/SupportedCapabilities'
CreateComputeCapacityReservationDetails:
description: 'The details for creating a new compute capacity reservation.
'
properties:
availabilityDomain:
description: 'The availability domain of this compute capacity reservation.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capacity reservation.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
instanceReservationConfigs:
description: 'The capacity configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and
optionally the fault domain where you want this configuration.
'
items:
$ref: '#/components/schemas/InstanceReservationConfigDetails'
type: array
isDefaultReservation:
default: false
description: 'Whether this capacity reservation is the default.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
type: boolean
required:
- compartmentId
- availabilityDomain
ShapeVirtualInstructionsEnabledPlatformOptions:
description: 'Configuration options for the virtualization instructions.
'
properties:
allowedValues:
description: 'Whether virtualization instructions can be enabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether virtualization instructions are enabled by default.
'
type: boolean
DedicatedVmHostInstanceShapeSummary:
description: 'The shape used to launch instances associated with the dedicated VM host.
'
properties:
availabilityDomain:
description: 'The shape''s availability domain.
'
maxLength: 255
minLength: 1
type: string
instanceShapeName:
description: 'The name of the virtual machine instance shapes that can be launched on a dedicated VM host.
'
maxLength: 255
minLength: 1
type: string
supportedCapabilities:
$ref: '#/components/schemas/SupportedCapabilities'
required:
- instanceShapeName
CreateCapacityReportShapeAvailabilityDetails:
description: 'Information about the shapes in a capacity report.
'
properties:
faultDomain:
description: 'The fault domain for the capacity report.
If you do not specify a fault domain, the capacity report includes information about all fault domains.
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: 'The shape that you want to request a capacity report for. You can enumerate all available shapes by calling
[ListShapes](#/en/iaas/latest/Shape/ListShapes).
'
maxLength: 255
minLength: 1
type: string
instanceShapeConfig:
$ref: '#/components/schemas/CapacityReportInstanceShapeConfig'
required:
- instanceShape
ComputeBareMetalHostSummary:
description: 'Summary information for a compute bare metal host.
'
properties:
computeCapacityTopologyId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
maxLength: 255
minLength: 1
type: string
computeHpcIslandId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
maxLength: 255
minLength: 1
type: string
computeLocalBlockId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
maxLength: 255
minLength: 1
type: string
computeNetworkBlockId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute local block.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute bare metal host.
maxLength: 255
minLength: 1
type: string
instanceId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute instance that runs on the compute bare metal host.
maxLength: 255
minLength: 1
type: string
instanceShape:
description: The shape of the compute instance that runs on the compute bare metal host.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: The lifecycle state details of the compute bare metal host.
type: string
x-obmcs-enumref: '#/definitions/ComputeBareMetalHost/lifecycleDetails'
lifecycleState:
description: The current state of the compute bare metal host.
type: string
x-obmcs-enumref: '#/definitions/ComputeBareMetalHost/lifecycleState'
timeCreated:
description: 'The date and time that the compute bare metal host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute bare metal host was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- computeCapacityTopologyId
- id
- instanceShape
- lifecycleState
- timeCreated
- timeUpdated
CreateComputeImageCapabilitySchemaDetails:
description: 'Create Image Capability Schema for an image.
'
properties:
compartmentId:
description: The OCID of the compartment that contains the resource.
maxLength: 255
minLength: 1
type: string
computeGlobalImageCapabilitySchemaVersionName:
description: 'The name of the compute global image capability schema version
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
imageId:
description: 'The ocid of the image
'
maxLength: 255
minLength: 1
type: string
schemaData:
additionalProperties:
$ref: '#/components/schemas/ImageCapabilitySchemaDescriptor'
description: The map of each capability name to its ImageCapabilitySchemaDescriptor.
type: object
required:
- compartmentId
- computeGlobalImageCapabilitySchemaVersionName
- imageId
- schemaData
ComputeHostGroupCollection:
description: 'A list of compute host groups.
'
properties:
items:
description: The list of compute host groups.
items:
$ref: '#/components/schemas/ComputeHostGroupSummary'
type: array
required:
- items
type: object
ShapeSymmetricMultiThreadingEnabledPlatformOptions:
description: 'Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT).
'
properties:
allowedValues:
description: 'Whether symmetric multithreading can be enabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether symmetric multithreading is enabled by default.
'
type: boolean
FirmwareBundlesCollection:
description: Results of a firmwareBundles search. Contains FirmwareBundleSummary items.
properties:
items:
description: List of firmwareBundleSummary objects.
items:
$ref: '#/components/schemas/FirmwareBundleSummary'
type: array
required:
- items
type: object
ShapeNumaNodesPerSocketPlatformOptions:
description: 'Configuration options for NUMA nodes per socket.
'
properties:
allowedValues:
description: 'The supported values for this platform configuration property.
'
items:
enum:
- NPS0
- NPS1
- NPS2
- NPS4
- NPS6
type: string
maxItems: 5
minItems: 1
type: array
defaultValue:
description: 'The default NUMA nodes per socket configuration.
'
type: string
ComponentVersion:
description: Represents a specific component type and its associated firmware versions.
properties:
componentType:
description: The type of component.
type: string
version:
description: A list of firmware versions associated with this component type.
items:
type: string
type: array
required:
- componentType
- version
type: object
CreateComputeHostGroupDetails:
description: 'Detail information for a compute host group.
'
properties:
availabilityDomain:
description: 'The availability domain of a host group.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment that contains host group.
'
maxLength: 255
minLength: 1
type: string
configurations:
description: A list of HostGroupConfiguration objects
items:
$ref: '#/components/schemas/HostGroupConfiguration'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
isTargetedPlacementRequired:
description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.
type: boolean
required:
- availabilityDomain
- displayName
- compartmentId
- isTargetedPlacementRequired
ComputeCapacityReport:
description: 'A report of the host capacity within an availability domain that is available for you
to create compute instances. Host capacity is the physical infrastructure that resources such as compute
instances run on.
Use the capacity report to determine whether sufficient capacity is available for a shape before
you create an instance or change the shape of an instance.
'
properties:
availabilityDomain:
description: 'The availability domain for the capacity report.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root
compartment.
'
maxLength: 255
minLength: 1
type: string
shapeAvailabilities:
description: 'Information about the available capacity for each shape in a capacity report.
'
items:
$ref: '#/components/schemas/CapacityReportShapeAvailability'
type: array
timeCreated:
description: 'The date and time the capacity report was created, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- timeCreated
- availabilityDomain
- shapeAvailabilities
AppCatalogListingSummary:
description: A summary of a listing.
properties:
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
listingId:
description: the region free ocid of the listing resource.
maxLength: 255
minLength: 1
type: string
publisherName:
description: The name of the publisher who published this listing.
maxLength: 64
minLength: 1
type: string
summary:
description: The short summary for the listing.
maxLength: 255
minLength: 1
type: string
InstanceSourceDetails:
discriminator:
propertyName: sourceType
properties:
sourceType:
description: 'The source type for the instance.
Use `image` when specifying the image OCID. Use `bootVolume` when specifying
the boot volume OCID.
'
type: string
required:
- sourceType
UpdateImageDetails:
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
operatingSystem:
description: 'Operating system
Example: `Oracle Linux`
'
maxLength: 128
minLength: 1
type: string
operatingSystemVersion:
description: 'Operating system version
Example: `7.4`
'
maxLength: 128
minLength: 1
type: string
LaunchInstancePlatformConfig:
description: 'The platform configuration requested for the instance.
If you provide the parameter, the instance is created with the platform configuration that you specify.
For any values that you omit, the instance uses the default configuration values for the `shape` that you
specify. If you don''t provide the parameter, the default values for the `shape` are used.
Each shape only supports certain configurable values. If the values that you provide are not valid for the
specified `shape`, an error is returned.
For more information about shielded instances, see
[Shielded Instances](/iaas/Content/Compute/References/shielded-instances.htm).
For more information about BIOS settings for bare metal instances, see
[BIOS Settings for Bare Metal Instances](/iaas/Content/Compute/References/bios-settings.htm).
'
discriminator:
propertyName: type
properties:
isMeasuredBootEnabled:
default: false
description: 'Whether the Measured Boot feature is enabled on the instance.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Whether the instance is a confidential instance. If this value is `true`, the instance is a confidential instance. The default value is `false`.
'
type: boolean
isSecureBootEnabled:
default: false
description: 'Whether Secure Boot is enabled on the instance.
'
type: boolean
isTrustedPlatformModuleEnabled:
default: false
description: 'Whether the Trusted Platform Module (TPM) is enabled on the instance.
'
type: boolean
type:
description: 'The type of platform being configured.
'
enum:
- AMD_MILAN_BM
- AMD_MILAN_BM_GPU
- AMD_ROME_BM
- AMD_ROME_BM_GPU
- GENERIC_BM
- INTEL_ICELAKE_BM
- INTEL_SKYLAKE_BM
- AMD_VM
- INTEL_VM
type: string
required:
- type
InstanceAgentFeatures:
description: Oracle Cloud Agent features supported on the image.
properties:
isManagementSupported:
description: 'This attribute is not used.
'
type: boolean
isMonitoringSupported:
description: 'This attribute is not used.
'
type: boolean
ShapeSecureBootOptions:
description: 'Configuration options for Secure Boot.
'
properties:
allowedValues:
description: 'Boolean values that indicate whether Secure Boot can be enabled or disabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether Secure Boot is enabled by default.
'
type: boolean
ChangeComputeClusterCompartmentDetails:
description: The configuration details for the move operation.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute cluster to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
InstancePowerActionDetails:
description: A base object for all types of instance power action requests.
discriminator:
propertyName: actionType
properties:
actionType:
description: The type of power action to perform.
type: string
required:
- actionType
Ipv6AddressIpv6SubnetCidrPairDetails:
description: 'Details to assign an IPv6 subnet prefix and IPv6 address on VNIC creation.
'
properties:
ipv6Address:
description: 'An IPv6 address of your choice. Must be an available IPv6 address within the subnet''s prefix.
If an IPv6 address is not provided:
- Oracle will automatically assign an IPv6 address from the subnet''s IPv6 prefix if and only if there is only one IPv6 prefix on the subnet.
- Oracle will automatically assign an IPv6 address from the subnet''s IPv6 Oracle GUA prefix if it exists on the subnet.
'
maxLength: 45
minLength: 1
type: string
x-default-description: 'null'
ipv6Id:
description: 'An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.
'
maxLength: 255
minLength: 1
type: string
ipv6SubnetCidr:
description: 'The IPv6 prefix allocated to the subnet.
'
maxLength: 45
minLength: 1
type: string
x-default-description: 'null'
ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions:
description: 'Configuration options for the input-output memory management unit (IOMMU).
'
properties:
allowedValues:
description: 'Whether the input-output memory management unit can be enabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether the input-output memory management unit is enabled by default.
'
type: boolean
DedicatedVmHostInstanceSummary:
description: 'Condensed instance data when listing instances on a dedicated VM host.
'
properties:
availabilityDomain:
description: 'The availability domain the virtual machine instance is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment that contains the virtual machine instance.
'
maxLength: 255
minLength: 1
type: string
instanceId:
description: 'The OCID of the virtual machine instance.
'
maxLength: 255
minLength: 1
type: string
isBurstable:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Specifies whether the VM instance is confidential.
'
type: boolean
shape:
description: 'The shape of the VM instance.
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the virtual machine instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- instanceId
- shape
- timeCreated
UpdateComputeHostDetails:
description: 'The details for updating the compute host.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
HostGroupConfiguration:
description: Host group configuration
properties:
firmwareBundleId:
description: The OCID for firmware bundle
maxLength: 255
minLength: 1
type: string
recycleLevel:
description: 'Preferred recycle level for hosts associated with the reservation config.
* `SKIP_RECYCLE` - Skips host wipe.
* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.
'
enum:
- SKIP_RECYCLE
- FULL_RECYCLE
type: string
state:
description: The state of the host group configuration.
enum:
- VALID
- INVALID
type: string
target:
description: Either the platform name or compute shape that the configuration is targeting
maxLength: 255
minLength: 1
type: string
CapacityReportShapeAvailability:
description: 'Information about the available capacity for a shape.
'
properties:
availabilityStatus:
description: A flag denoting whether capacity is available.
enum:
- OUT_OF_HOST_CAPACITY
- HARDWARE_NOT_SUPPORTED
- AVAILABLE
type: string
availableCount:
description: The total number of new instances that can be created with the specified shape configuration.
format: int64
minimum: 0
type: integer
faultDomain:
description: 'The fault domain for the capacity report.
If you do not specify the fault domain, the capacity report includes information about all fault domains.
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: 'The shape that the capacity report was requested for.
'
maxLength: 255
minLength: 1
type: string
instanceShapeConfig:
$ref: '#/components/schemas/CapacityReportInstanceShapeConfig'
ImageShapeCompatibilityEntry:
description: An image and shape that are compatible.
properties:
imageId:
description: The image OCID.
maxLength: 255
minLength: 1
type: string
memoryConstraints:
$ref: '#/components/schemas/ImageMemoryConstraints'
ocpuConstraints:
$ref: '#/components/schemas/ImageOcpuConstraints'
shape:
description: The shape name.
maxLength: 255
minLength: 1
type: string
required:
- imageId
- shape
ShapeNetworkingBandwidthOptions:
description: 'For a flexible shape, the amount of networking bandwidth available for instances that use this shape.
If this field is null, then this shape has a fixed amount of bandwidth equivalent to `networkingBandwidthInGbps`.
'
properties:
defaultPerOcpuInGbps:
description: 'The default amount of networking bandwidth per OCPU, in gigabits per second.
'
format: float
minimum: 0.0
type: number
maxInGbps:
description: 'The maximum amount of networking bandwidth, in gigabits per second.
'
format: float
minimum: 0.0
type: number
minInGbps:
description: 'The minimum amount of networking bandwidth, in gigabits per second.
'
format: float
minimum: 0.0
type: number
CreateComputeClusterDetails:
description: "The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm).\n\nAfter the compute cluster is created, you can use the compute cluster's OCID to create Instance, GPU Memory \nCluster or Instance Pool resources within the compute cluster. These resources must be created in the same \ncompartment and availability domain as the cluster.\n\nUse `COMPUTE_CLUSTER` type when using placementConstraintDetails.\n"
properties:
availabilityDomain:
description: 'The availability domain to place the compute cluster in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
required:
- availabilityDomain
- compartmentId
FirmwareBundle:
description: A collection of pinned component firmware versions organized by platform.
properties:
allowableTransitions:
$ref: '#/components/schemas/FirmwareBundleTransitions'
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle.
'
maxLength: 255
minLength: 1
type: string
description:
description: A brief description or metadata about this firmware bundle.
type: string
displayName:
description: The user-friendly name of this firmware bundle.
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the firmware bundle.
enum:
- ACTIVE
- INACTIVE
- DELETE_SCHEDULED
type: string
platforms:
description: A map of platforms to pinned firmware versions.
items:
$ref: '#/components/schemas/PlatformVersions'
type: array
timeCreated:
description: 'The date and time the firmware bundle was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the firmware bundle was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- displayName
- description
- platforms
- compartmentId
- timeCreated
- timeUpdated
- lifecycleState
type: object
InstanceReservationConfig:
description: 'Data that defines the capacity configuration.
'
properties:
clusterConfig:
$ref: '#/components/schemas/ClusterConfigDetails'
clusterPlacementGroupId:
description: The OCID of the cluster placement group for this instance reservation capacity configuration.
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'The fault domain of this capacity configuration.
If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm).
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: 'The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory,
and other resources allocated to the instance.
You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).
'
maxLength: 255
minLength: 1
type: string
instanceShapeConfig:
$ref: '#/components/schemas/InstanceReservationShapeConfigDetails'
reservedCount:
description: The total number of instances that can be launched from the capacity configuration.
format: int64
minimum: 0
type: integer
usedCount:
description: The amount of capacity in use out of the total capacity reserved in this capacity configuration.
format: int64
minimum: 0
type: integer
required:
- instanceShape
- reservedCount
- usedCount
PreemptionAction:
description: 'The action to run when the preemptible instance is interrupted for eviction.
'
discriminator:
propertyName: type
properties:
type:
description: The type of action to run when the instance is interrupted for eviction.
enum:
- TERMINATE
type: string
required:
- type
ShapeAlternativeObject:
description: 'The shape that Oracle recommends you to use an alternative to the current shape.
'
properties:
shapeName:
description: 'The name of the shape.
'
type: string
required:
- shapeName
LicensingConfig:
description: Configuration of the Operating System license.
properties:
licenseType:
description: 'License Type for the OS license.
* `OCI_PROVIDED` - OCI provided license (e.g. metered $/OCPU-hour).
* `BRING_YOUR_OWN_LICENSE` - Bring your own license.
'
enum:
- OCI_PROVIDED
- BRING_YOUR_OWN_LICENSE
type: string
osVersion:
description: The Operating System version of the license config.
type: string
type:
description: Operating System type of the Configuration.
enum:
- WINDOWS
type: string
SupportedCapabilities:
description: 'Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support.
'
properties:
isBurstableSupported:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched.
'
type: boolean
isMemoryEncryptionSupported:
default: false
description: 'Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential.
'
type: boolean
required:
- isMemoryEncryptionSupported
UpdateInstanceShapeConfigDetails:
description: 'The shape configuration requested for the instance. If provided, the instance will be updated
with the resources specified. In the case where some properties are missing,
the missing values will be set to the default for the provided `shape`.
Each shape only supports certain configurable values. If the `shape` is provided
and the configuration values are invalid for that new `shape`, an error will be returned.
If no `shape` is provided and the configuration values are invalid for the instance''s
existing shape, an error will be returned.
'
properties:
baselineOcpuUtilization:
description: 'The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a
non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.
The following values are supported:
- `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
- `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
- `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.
'
enum:
- BASELINE_1_8
- BASELINE_1_2
- BASELINE_1_1
type: string
memoryInGBs:
description: 'The total amount of memory available to the instance, in gigabytes.
'
format: float
minimum: 0.0
type: number
nvmes:
description: 'The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
'
format: int32
maximum: 7
minimum: 1
type: integer
ocpus:
description: 'The total number of OCPUs available to the instance.
'
format: float
minimum: 0.0
type: number
resourceManagement:
description: 'This field is reserved for internal use.
'
enum:
- DYNAMIC
- STATIC
type: string
vcpus:
description: 'The total number of VCPUs available to the instance. This can be used instead of OCPUs,
in which case the actual number of OCPUs will be calculated based on this value
and the actual hardware. This must be a multiple of 2.
'
format: int32
minimum: 0
type: integer
ComputeClusterSummary:
description: 'Summary information for a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)
is a remote direct memory access (RDMA) network group.
'
properties:
availabilityDomain:
description: 'The availability domain the compute cluster is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute cluster.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute cluster.
type: string
x-obmcs-enumref: '#/definitions/ComputeCluster/lifecycleState'
timeCreated:
description: 'The date and time the compute cluster was created,
in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- id
- lifecycleState
- timeCreated
CreateCapacitySourceDetails:
description: 'A capacity source of bare metal hosts.
'
discriminator:
propertyName: capacityType
properties:
capacityType:
description: The capacity type of bare metal hosts.
type: string
x-obmcs-enumref: '#/definitions/CapacitySource/capacityType'
required:
- capacityType
CreateComputeGpuMemoryClusterDetails:
description: 'The customer facing object includes GPU Memory Cluster details.
'
properties:
availabilityDomain:
description: 'The availability domain of the GPU Memory Cluster.
'
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU Memory Cluster.
compartment.
'
maxLength: 255
minLength: 1
type: string
computeClusterId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryClusterScaleConfig:
$ref: '#/components/schemas/CreateComputeGpuMemoryClusterScaleConfig'
gpuMemoryFabricId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric.
'
maxLength: 255
minLength: 1
type: string
instanceConfigurationId:
description: 'Instance Configuration to be used for this GPU Memory Cluster
'
maxLength: 255
minLength: 1
type: string
privateIpIds:
description: Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster
items:
maxLength: 255
minLength: 1
type: string
maxItems: 255
type: array
uniqueItems: true
size:
description: 'The desired number of instances for the GPU Memory Cluster.
'
format: int64
minimum: 0
type: integer
required:
- availabilityDomain
- compartmentId
- computeClusterId
- instanceConfigurationId
ComputeBareMetalHostCollection:
description: 'A list of compute bare metal hosts.
'
properties:
items:
description: The list of compute bare metal hosts.
items:
$ref: '#/components/schemas/ComputeBareMetalHostSummary'
type: array
required:
- items
type: object
PercentageOfCoresEnabledOptions:
description: 'Configuration options for the percentage of cores enabled.
'
properties:
defaultValue:
description: 'The default percentage of cores enabled.
'
maximum: 100
minimum: 0
type: integer
max:
description: 'The maximum allowed percentage of cores enabled.
'
maximum: 100
minimum: 0
type: integer
min:
description: 'The minimum allowed percentage of cores enabled.
'
maximum: 100
minimum: 0
type: integer
CaptureConsoleHistoryDetails:
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
instanceId:
description: The OCID of the instance to get the console history from.
maxLength: 255
minLength: 1
type: string
required:
- instanceId
CreateDedicatedVmHostDetails:
description: 'The details for creating a new dedicated virtual machine host.
'
properties:
availabilityDomain:
description: 'The availability domain of the dedicated virtual machine host.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
capacityConfig:
description: "The capacity configuration selected to be configured for the Dedicated Virtual Machine host. \nRun [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API first to see the capacity configuration options.\n"
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
dedicatedVmHostShape:
description: 'The dedicated virtual machine host shape. The shape determines the number of CPUs and
other resources available for VM instances launched on the dedicated virtual machine host.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'The fault domain for the dedicated virtual machine host''s assigned instances.
For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault).
If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host,
delete it and create a new dedicated virtual machine host in the preferred fault domain.
To get a list of fault domains, use the `ListFaultDomains` operation in
the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/).
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
isBurstable:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched.
'
type: boolean
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
required:
- availabilityDomain
- compartmentId
- dedicatedVmHostShape
ComputeGpuMemoryClusterInstanceSummary:
description: 'The customer facing GPU Memory Cluster instance object details.
'
properties:
availabilityDomain:
description: 'The availability domain of the GPU Memory Cluster instance.
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment
compartment.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: The fault domain the GPU Memory Cluster instance is running in.
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster instance
'
maxLength: 255
minLength: 1
type: string
instanceConfigurationId:
description: 'Configuration to be used for this GPU Memory Cluster instance.
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: "The shape of an instance. The shape determines the number of CPUs, amount of memory, \nand other resources allocated to the instance. The shape determines the number of CPUs, \nthe amount of memory, and other resources allocated to the instance.\nYou can list all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes).\n"
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The lifecycle state of the GPU Memory Cluster instance
'
enum:
- MOVING
- PROVISIONING
- RUNNING
- STARTING
- STOPPING
- STOPPED
- SUSPENDING
- SUSPENDED
- CREATING_IMAGE
- TERMINATING
- TERMINATED
type: string
region:
description: The region that contains the availability domain the instance is running in.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the GPU Memory Cluster instance was created.
Example: `2016-09-15T21:10:29.600Z`
'
format: date-time
type: string
CreateComputeCapacityTopologyDetails:
description: 'The details for creating a new compute capacity topology.
'
properties:
availabilityDomain:
description: 'The availability domain of this compute capacity topology.
Example: `Uocm:US-CHICAGO-1-AD-2`
'
maxLength: 255
minLength: 1
type: string
capacitySource:
$ref: '#/components/schemas/CreateCapacitySourceDetails'
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains this compute capacity topology.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
required:
- availabilityDomain
- capacitySource
- compartmentId
Instance:
description: 'A compute host. The image used to launch the instance determines its operating system and other
software. The shape specified during the launch process determines the number of CPUs and memory
allocated to the instance.
When you launch an instance, it is automatically attached to a virtual
network interface card (VNIC), called the *primary VNIC*. The VNIC
has a private IP address from the subnet''s CIDR. You can either assign a
private IP address of your choice or let Oracle automatically assign one.
You can choose whether the instance has a public IP address. To retrieve the
addresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)
operation to get the VNIC ID for the instance, and then call
[GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.
For more information, see
[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).
To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized,
talk to an administrator. If you''re an administrator who needs to write policies to give users access, see
[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
properties:
agentConfig:
$ref: '#/components/schemas/InstanceAgentConfig'
availabilityConfig:
$ref: '#/components/schemas/InstanceAvailabilityConfig'
availabilityDomain:
description: 'The availability domain the instance is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
capacityReservationId:
description: 'The OCID of the compute capacity reservation this instance is launched under.
When this field contains an empty string or is null, the instance is not currently in a capacity reservation.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
maxLength: 255
minLength: 0
type: string
x-default-description: 'The default reservation here refers to the reservation which is enabled by default for your tenancy.
If the value of this field is empty that means you have opted out of the default reservation.
'
clusterPlacementGroupId:
description: The OCID of the cluster placement group of the instance.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment that contains the instance.
maxLength: 255
minLength: 1
type: string
dedicatedVmHostId:
description: 'The OCID of the dedicated virtual machine host that the instance is placed on.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
extendedMetadata:
additionalProperties:
type: object
description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and functionality
as fields in the `metadata` object.
They are distinguished from `metadata` fields in that these can be nested JSON objects (whereas `metadata`
fields are string/string maps only).
'
type: object
faultDomain:
description: 'The name of the fault domain the instance is running in.
A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
If you do not specify the fault domain, the system selects one for you.
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
imageId:
description: 'Deprecated. Use `sourceDetails` instead.
'
maxLength: 255
minLength: 1
type: string
instanceConfigurationId:
description: The OCID of the Instance Configuration used to source launch details for this instance. Any other fields supplied in the instance launch request override the details stored in the Instance Configuration for this instance launch.
type: string
instanceOptions:
$ref: '#/components/schemas/InstanceOptions'
ipxeScript:
description: 'When a bare metal or virtual machine
instance boots, the iPXE firmware that runs on the instance is
configured to run an iPXE script to continue the boot process.
If you want more control over the boot process, you can provide
your own custom iPXE script that will run when the instance boots.
Be aware that the same iPXE script will run
every time an instance boots, not only after the initial
LaunchInstance call.
The default iPXE script connects to the instance''s local boot
volume over iSCSI and performs a network boot. If you use a custom iPXE
script and want to network-boot from the instance''s local boot volume
over iSCSI the same way as the default iPXE script, use the
following iSCSI IP address: 169.254.0.2, and boot volume IQN:
iqn.2015-02.oracle.boot.
If your instance boot volume attachment type is paravirtualized,
the boot volume is attached to the instance through virtio-scsi and no iPXE script is used.
If your instance boot volume attachment type is paravirtualized
and you use custom iPXE to network boot into your instance,
the primary boot volume is attached as a data volume through virtio-scsi drive.
For more information about the Bring Your Own Image feature of
Oracle Cloud Infrastructure, see
[Bring Your Own Image](/iaas/Content/Compute/References/bringyourownimage.htm).
For more information about iPXE, see http://ipxe.org.
'
maxLength: 10240
minLength: 1
type: string
isAIEnterpriseEnabled:
default: false
description: 'Whether AI enterprise is enabled on the instance.
'
type: boolean
launchMode:
description: 'Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
'
enum:
- NATIVE
- EMULATED
- PARAVIRTUALIZED
- ACCELERATEDPV
- CUSTOM
type: string
x-obmcs-resolve-component-ref: true
launchOptions:
$ref: '#/components/schemas/LaunchOptions'
licensingConfigs:
description: List of licensing configurations associated with the instance.
items:
$ref: '#/components/schemas/LicensingConfig'
type: array
lifecycleState:
description: The current state of the instance.
enum:
- MOVING
- PROVISIONING
- RUNNING
- STARTING
- STOPPING
- STOPPED
- CREATING_IMAGE
- TERMINATING
- TERMINATED
type: string
metadata:
additionalProperties:
type: string
description: Custom metadata that you provide.
type: object
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
platformConfig:
$ref: '#/components/schemas/PlatformConfig'
preemptibleInstanceConfig:
$ref: '#/components/schemas/PreemptibleInstanceConfigDetails'
region:
description: 'The region that contains the availability domain the instance is running in.
For the us-phoenix-1 and us-ashburn-1 regions, `phx` and `iad` are returned, respectively.
For all other regions, the full region name is returned.
Examples: `phx`, `eu-frankfurt-1`
'
maxLength: 255
minLength: 1
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'The value of the tag.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).
'
type: object
description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`
'
type: object
securityAttributesState:
description: The lifecycle state of the `securityAttributes`
enum:
- STABLE
- UPDATING
type: string
shape:
description: 'The shape of the instance. The shape determines the number of CPUs and the amount of memory
allocated to the instance. You can enumerate all available shapes by calling
[ListShapes](#/en/iaas/latest/Shape/ListShapes).
'
maxLength: 255
minLength: 1
type: string
shapeConfig:
$ref: '#/components/schemas/InstanceShapeConfig'
sourceDetails:
$ref: '#/components/schemas/InstanceSourceDetails'
timeCreated:
description: 'The date and time the instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeMaintenanceRebootDue:
description: 'The date and time the instance is expected to be stopped / started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
After that time if instance hasn''t been rebooted, Oracle will reboot the instance within 24 hours of the due time.
Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state.
Example: `2018-05-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- shape
- region
- availabilityDomain
- lifecycleState
- timeCreated
UpdateComputeCapacityTopologyDetails:
description: 'The details for updating the compute capacity topology.
'
properties:
capacitySource:
$ref: '#/components/schemas/UpdateCapacitySourceDetails'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
InstanceReservationConfigDetails:
description: 'A template that contains the settings to use when defining the instance capacity configuration.
'
properties:
clusterConfig:
$ref: '#/components/schemas/ClusterConfigDetails'
clusterPlacementGroupId:
description: The OCID of the cluster placement group for this instance reservation capacity configuration.
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'The fault domain to use for instances created using this capacity configuration.
For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault).
If you do not specify the fault domain, the capacity is available for an instance
that does not specify a fault domain. To change the fault domain for a reservation,
delete the reservation and create a new one in the preferred fault domain.
To retrieve a list of fault domains, use the `ListFaultDomains` operation in
the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/).
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: 'The shape requested when launching instances using reserved capacity.
The shape determines the number of CPUs, amount of memory,
and other resources allocated to the instance.
You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).
'
maxLength: 255
minLength: 1
type: string
instanceShapeConfig:
$ref: '#/components/schemas/InstanceReservationShapeConfigDetails'
reservedCount:
description: The total number of instances that can be launched from the capacity configuration.
format: int64
minimum: 0
type: integer
required:
- instanceShape
- reservedCount
AttachBootVolumeDetails:
properties:
bootVolumeId:
description: The OCID of the boot volume.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
encryptionInTransitType:
default: NONE
description: 'Refer the top-level definition of encryptionInTransitType.
The default value is NONE.
'
enum:
- NONE
- BM_ENCRYPTION_IN_TRANSIT
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionInTransitType'
instanceId:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
required:
- instanceId
- bootVolumeId
InstanceMaintenanceReboot:
description: The maximum possible date and time that a maintenance reboot can be extended.
properties:
timeMaintenanceRebootDueMax:
description: 'The maximum extension date and time for the maintenance reboot, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
The range for the maintenance extension is between 1 and 14 days from the initial scheduled maintenance date.
Example: `2018-05-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- timeMaintenanceRebootDueMax
AppCatalogListing:
description: Listing details.
properties:
contactUrl:
description: Listing's contact URL.
maxLength: 255
minLength: 1
type: string
description:
description: Description of the listing.
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
listingId:
description: The OCID of the listing.
maxLength: 255
minLength: 1
type: string
publisherLogoUrl:
description: Publisher's logo URL.
maxLength: 255
minLength: 1
type: string
publisherName:
description: Name of the publisher who published this listing.
maxLength: 64
minLength: 1
type: string
summary:
description: Summary of the listing.
maxLength: 255
minLength: 1
type: string
timePublished:
description: 'Date and time the listing was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
UpdateComputeHostGroupDetails:
description: 'Update details information for a compute host group.
'
properties:
configurations:
description: A list of HostGroupConfiguration objects
items:
$ref: '#/components/schemas/HostGroupConfiguration'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
isTargetedPlacementRequired:
description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.
type: boolean
CreateAppCatalogSubscriptionDetails:
description: details for creating a subscription for a listing resource version.
properties:
compartmentId:
description: The compartmentID for the subscription.
maxLength: 255
minLength: 1
type: string
eulaLink:
description: EULA link
maxLength: 1024
minLength: 1
type: string
listingId:
description: The OCID of the listing.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Listing resource version.
maxLength: 255
minLength: 1
type: string
oracleTermsOfUseLink:
description: Oracle TOU link
maxLength: 1024
minLength: 1
type: string
signature:
description: A generated signature for this listing resource version retrieved the agreements API.
maxLength: 255
minLength: 1
type: string
timeRetrieved:
description: 'Date and time the agreements were retrieved, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
required:
- compartmentId
- listingId
- listingResourceVersion
- oracleTermsOfUseLink
- timeRetrieved
- signature
UpdateVolumeAttachmentDetails:
description: details for updating a volume attachment.
properties:
iscsiLoginState:
description: 'The iscsi login state of the volume attachment. For a multipath volume attachment,
all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
'
enum:
- UNKNOWN
- LOGGING_IN
- LOGIN_SUCCEEDED
- LOGIN_FAILED
- LOGGING_OUT
- LOGOUT_SUCCEEDED
- LOGOUT_FAILED
type: string
UpdateComputeGpuMemoryClusterScaleConfig:
description: 'Configuration settings for GPU Memory Cluster scaling.
'
properties:
isDownsizeEnabled:
description: 'Enables downsizing towards the target size.
'
type: boolean
isUpsizeEnabled:
description: 'Enables upsizing towards the target size.
'
type: boolean
targetSize:
description: 'The configured target size for the GPU Memory Cluster.
'
format: int64
minimum: 0
type: integer
ComputeNetworkBlockSummary:
description: 'Summary information for a compute network block.
'
properties:
computeCapacityTopologyId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
maxLength: 255
minLength: 1
type: string
computeHpcIslandId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute network block.
type: string
x-obmcs-enumref: '#/definitions/ComputeNetworkBlock/lifecycleState'
timeCreated:
description: 'The date and time that the compute network block was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute network block was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalComputeBareMetalHostCount:
description: The total number of compute bare metal hosts located in the compute network block.
format: int64
minimum: 0
type: integer
required:
- computeCapacityTopologyId
- computeHpcIslandId
- id
- lifecycleState
- timeCreated
- timeUpdated
- totalComputeBareMetalHostCount
AppCatalogSubscription:
description: a subscription for a listing resource version.
properties:
compartmentId:
description: The compartmentID of the subscription.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
listingId:
description: The ocid of the listing resource.
maxLength: 255
minLength: 1
type: string
listingResourceId:
description: Listing resource id.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Listing resource version.
maxLength: 255
minLength: 1
type: string
publisherName:
description: Name of the publisher who published this listing.
maxLength: 64
minLength: 1
type: string
summary:
description: The short summary to the listing.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'Date and time at which the subscription was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
ShapeTrustedPlatformModuleOptions:
description: 'Configuration options for the Trusted Platform Module (TPM).
'
properties:
allowedValues:
description: 'Boolean values that indicate whether the Trusted Platform Module can be enabled or disabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether the Trusted Platform Module is enabled by default.
'
type: boolean
InstanceCredentials:
description: The credentials for a particular instance.
properties:
password:
description: The password for the username.
maxLength: 255
minLength: 1
type: string
username:
description: The username.
maxLength: 255
minLength: 1
type: string
required:
- username
- password
ChangeDedicatedVmHostCompartmentDetails:
description: Specifies the compartment to move the dedicated virtual machine host to.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
to move the dedicated virtual machine host to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
AttachComputeHostGroupHostDetails:
description: Specifies the host group id
properties:
computeHostGroupId:
description: '''The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.''
'
maxLength: 255
minLength: 1
type: string
required:
- computeHostGroupId
ComputeHostCollection:
description: 'A list of compute hosts.
'
properties:
items:
description: The list of compute hosts.
items:
$ref: '#/components/schemas/ComputeHostSummary'
type: array
required:
- items
type: object
InstanceOptions:
description: Optional mutable instance options
properties:
areLegacyImdsEndpointsDisabled:
description: 'Whether to disable the legacy (/v1) instance metadata service endpoints.
Customers who have migrated to /v2 should set this to true for added security.
Default is false.
'
type: boolean
ComputeImageCapabilitySchema:
description: 'Compute Image Capability Schema is a set of capabilities that filter the compute global capability schema
version for an image.
'
properties:
compartmentId:
description: The OCID of the compartment that contains the resource.
maxLength: 255
minLength: 1
type: string
computeGlobalImageCapabilitySchemaId:
description: 'The ocid of the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
computeGlobalImageCapabilitySchemaVersionName:
description: 'The name of the compute global image capability schema version
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The id of the compute global image capability schema version
'
maxLength: 255
minLength: 1
type: string
imageId:
description: 'The OCID of the image associated with this compute image capability schema
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The ComputeImageCapabilitySchema current lifecycle state.
enum:
- CREATING
- ACTIVE
- DELETED
type: string
schemaData:
additionalProperties:
$ref: '#/components/schemas/ImageCapabilitySchemaDescriptor'
description: The map of each capability name to its ImageCapabilityDescriptor.
type: object
timeCreated:
description: 'The date and time the compute image capability schema was created, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- displayName
- imageId
- computeGlobalImageCapabilitySchemaId
- computeGlobalImageCapabilitySchemaVersionName
- schemaData
- timeCreated
ComputeCapacityReservationInstanceShapeSummary:
description: 'An available shape used to launch instances in a compute capacity reservation.
'
properties:
availabilityDomain:
description: 'The shape''s availability domain.
'
maxLength: 255
minLength: 1
type: string
instanceShape:
description: 'The name of the available shape used to launch instances in a compute capacity reservation.
'
maxLength: 255
minLength: 1
type: string
required:
- availabilityDomain
- instanceShape
LaunchInstanceDetails:
description: 'Instance launch details.
Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.
'
properties:
agentConfig:
$ref: '#/components/schemas/LaunchInstanceAgentConfigDetails'
availabilityConfig:
$ref: '#/components/schemas/LaunchInstanceAvailabilityConfigDetails'
availabilityDomain:
description: 'The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
capacityReservationId:
description: 'The OCID of the compute capacity reservation this instance is launched under.
You can opt out of all default reservations by specifying an empty string as input for this field.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
maxLength: 255
minLength: 0
type: string
x-default-description: 'A default reservation refers to the reservation into which all instance launches are first attempted.
If an instance is launched without specifying a reservation ID or if a reservation ID is not present in the JSON input,
the instance is automatically launched under this reservation. To opt out, include capacityReservationId: "" in your JSON input.
Using an empty string for this field value causes the instance to be launched as a normal instance and not under the default reservation.
'
clusterPlacementGroupId:
description: The OCID of the cluster placement group of the instance.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
computeClusterId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the
[compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.
'
maxLength: 255
minLength: 1
type: string
createVnicDetails:
$ref: '#/components/schemas/CreateVnicDetails'
dedicatedVmHostId:
description: 'The OCID of the dedicated virtual machine host to place the instance on.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
extendedMetadata:
additionalProperties:
type: object
description: 'Additional metadata key/value pairs that you provide. They serve the same purpose and
functionality as fields in the `metadata` object.
They are distinguished from `metadata` fields in that these can be nested JSON objects
(whereas `metadata` fields are string/string maps only).
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of
32,000 bytes.
'
type: object
faultDomain:
description: 'A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
If you do not specify the fault domain, the system selects one for you.
To get a list of fault domains, use the
[ListFaultDomains](#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the
Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
hostnameLabel:
description: 'Deprecated. Instead use `hostnameLabel` in
[CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/).
If you provide both, the values must match.
'
maxLength: 63
minLength: 1
type: string
imageId:
description: 'Deprecated. Use `sourceDetails` with [InstanceSourceViaImageDetails](#/en/iaas/latest/requests/InstanceSourceViaImageDetails)
source type instead. If you specify values for both, the values must match.
'
maxLength: 255
minLength: 1
type: string
instanceConfigurationId:
description: The OCID of the Instance Configuration containing instance launch details. Any other fields supplied in this instance launch request will override the details stored in the Instance Configuration for this instance launch.
type: string
instanceOptions:
$ref: '#/components/schemas/InstanceOptions'
ipxeScript:
description: 'This is an advanced option.
When a bare metal or virtual machine
instance boots, the iPXE firmware that runs on the instance is
configured to run an iPXE script to continue the boot process.
If you want more control over the boot process, you can provide
your own custom iPXE script that will run when the instance boots.
Be aware that the same iPXE script will run
every time an instance boots, not only after the initial
LaunchInstance call.
The default iPXE script connects to the instance''s local boot
volume over iSCSI and performs a network boot. If you use a custom iPXE
script and want to network-boot from the instance''s local boot volume
over iSCSI the same way as the default iPXE script, use the
following iSCSI IP address: 169.254.0.2, and boot volume IQN:
iqn.2015-02.oracle.boot.
If your instance boot volume attachment type is paravirtualized,
the boot volume is attached to the instance through virtio-scsi and no iPXE script is used.
If your instance boot volume attachment type is paravirtualized
and you use custom iPXE to network boot into your instance,
the primary boot volume is attached as a data volume through virtio-scsi drive.
For more information about the Bring Your Own Image feature of
Oracle Cloud Infrastructure, see
[Bring Your Own Image](/iaas/Content/Compute/References/bringyourownimage.htm).
For more information about iPXE, see http://ipxe.org.
'
maxLength: 10240
minLength: 1
type: string
isAIEnterpriseEnabled:
default: false
description: 'Whether to enable AI enterprise on the instance.
'
type: boolean
isPvEncryptionInTransitEnabled:
description: Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
type: boolean
launchMode:
description: 'Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
'
enum:
- NATIVE
- EMULATED
- PARAVIRTUALIZED
- ACCELERATEDPV
- CUSTOM
type: string
x-obmcs-resolve-component-ref: true
launchOptions:
$ref: '#/components/schemas/LaunchOptions'
launchVolumeAttachments:
description: Volume attachments to create as part of the launch instance operation.
items:
$ref: '#/components/schemas/LaunchAttachVolumeDetails'
type: array
licensingConfigs:
description: List of licensing configurations associated with target launch values.
items:
$ref: '#/components/schemas/LaunchInstanceLicensingConfig'
type: array
metadata:
additionalProperties:
type: string
description: "Custom metadata key/value pairs that you provide, such as the SSH public key\nrequired to connect to the instance.\n\nA metadata service runs on every launched instance. The service is an HTTP\nendpoint listening on 169.254.169.254. You can use the service to:\n\n* Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/)\n to be used for various system initialization tasks.\n\n* Get information about the instance, including the custom metadata that you\n provide when you launch the instance.\n\n **Providing Cloud-Init Metadata**\n\n You can use the following metadata key names to provide information to\n Cloud-Init:\n\n **\"ssh_authorized_keys\"** - Provide one or more public SSH keys to be\n included in the `~/.ssh/authorized_keys` file for the default user on the\n instance. Use a newline character to separate multiple keys. The SSH\n keys must be in the format necessary for the `authorized_keys` file, as shown\n in the example below.\n\n **\"user_data\"** - Provide your own base64-encoded data to be used by\n Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For\n information about how to take advantage of user data, see the\n [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).\n\n **Metadata Example**\n\n \"metadata\" : {\n \"quake_bot_level\" : \"Severe\",\n \"ssh_authorized_keys\" : \"ssh-rsa == rsa-key-20160227\",\n \"user_data\" : \"==\"\n }\n **Getting Metadata on the Instance**\n\n To get information about your instance, connect to the instance using SSH and issue any of the\n following GET requests:\n\n curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/\n curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/\n curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/\n\n You'll get back a response that includes all the instance information; only the metadata information; or\n the metadata information for the specified key name, respectively.\n\n The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes.\n"
type: object
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
platformConfig:
$ref: '#/components/schemas/LaunchInstancePlatformConfig'
preemptibleInstanceConfig:
$ref: '#/components/schemas/PreemptibleInstanceConfigDetails'
securityAttributes:
additionalProperties:
additionalProperties:
description: 'The value of the tag.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).
'
type: object
description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`
'
type: object
shape:
description: 'The shape of an instance. The shape determines the number of CPUs, amount of memory,
and other resources allocated to the instance.
You can enumerate all available shapes by calling [ListShapes](#/en/iaas/latest/Shape/ListShapes).
'
maxLength: 255
minLength: 1
type: string
shapeConfig:
$ref: '#/components/schemas/LaunchInstanceShapeConfigDetails'
sourceDetails:
$ref: '#/components/schemas/InstanceSourceDetails'
subnetId:
description: 'Deprecated. Instead use `subnetId` in
[CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/).
At least one of them is required; if you provide both, the values must match.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
- availabilityDomain
ComputeCapacityTopology:
description: 'A compute capacity topology that allows you to query your bare metal hosts and their RDMA network topology.
'
properties:
availabilityDomain:
description: 'The availability domain of the compute capacity topology.
Example: `Uocm:US-CHICAGO-1-AD-2`
'
maxLength: 255
minLength: 1
type: string
capacitySource:
$ref: '#/components/schemas/CapacitySource'
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute capacity topology.
enum:
- ACTIVE
- CREATING
- UPDATING
- DELETED
- DELETING
type: string
timeCreated:
description: 'The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute capacity topology was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- capacitySource
- compartmentId
- id
- lifecycleState
- timeCreated
- timeUpdated
CapacityBinPreview:
description: 'Total CPU and memory capacity for each capacity bucket.
'
properties:
capacityIndex:
description: 'Zero-based index for the corresponding capacity bucket.
'
format: int32
maximum: 24
minimum: 0
type: integer
supportedShapes:
description: 'List of VMI shapes supported on each capacity bucket.
'
items:
type: string
maxItems: 25
minItems: 1
type: array
totalMemoryInGBs:
description: 'The total memory of the capacity bucket, in GBs.
'
format: float
minimum: 0.0
type: number
totalOcpus:
description: 'The total OCPUs of the capacity bucket.
'
format: float
minimum: 0.0
type: number
required:
- capacityIndex
- totalOcpus
- totalMemoryInGBs
- supportedShapes
UpdateDedicatedVmHostDetails:
description: 'Details for updating the dedicated virtual machine host details.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
ChangeComputeGpuMemoryClusterCompartmentDetails:
description: Specifies the compartment to move the compute GPU Memory Cluster to.
properties:
compartmentId:
description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the compute GPU \nmemory cluster to.\n"
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ComputeGlobalImageCapabilitySchemaVersion:
description: 'Compute Global Image Capability Schema Version is a set of all possible capabilities for a collection of images.
'
properties:
computeGlobalImageCapabilitySchemaId:
description: 'The ocid of the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
name:
description: 'The name of the compute global image capability schema version
'
maxLength: 255
minLength: 1
type: string
schemaData:
additionalProperties:
$ref: '#/components/schemas/ImageCapabilitySchemaDescriptor'
description: The map of each capability name to its ImageCapabilityDescriptor.
type: object
timeCreated:
description: 'The date and time the compute global image capability schema version was created, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- name
- displayName
- computeGlobalImageCapabilitySchemaId
- schemaData
- timeCreated
CreateComputeCapacityReportDetails:
description: 'The data to create a report of available Compute capacity.
'
properties:
availabilityDomain:
description: 'The availability domain for the capacity report.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root
compartment.
'
maxLength: 255
minLength: 1
type: string
shapeAvailabilities:
description: 'Information about the shapes in the capacity report.
'
items:
$ref: '#/components/schemas/CreateCapacityReportShapeAvailabilityDetails'
type: array
required:
- compartmentId
- availabilityDomain
- shapeAvailabilities
ComputeCapacityTopologySummary:
description: 'Summary information for a compute capacity topology.
'
properties:
availabilityDomain:
description: 'The availability domain of the compute capacity topology.
Example: `Uocm:US-CHICAGO-1-AD-2`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute capacity topology.
type: string
x-obmcs-enumref: '#/definitions/ComputeCapacityTopology/lifecycleState'
timeCreated:
description: 'The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute capacity topology was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- id
- lifecycleState
- timeCreated
- timeUpdated
CapacitySource:
description: 'A capacity source of bare metal hosts.
'
discriminator:
propertyName: capacityType
properties:
capacityType:
description: The capacity type of bare metal hosts.
enum:
- DEDICATED
type: string
required:
- capacityType
ComputeGpuMemoryFabricCollection:
description: 'A list of compute GPU memory fabrics.
'
properties:
items:
description: The list of compute GPU memory fabrics.
items:
$ref: '#/components/schemas/ComputeGpuMemoryFabricSummary'
type: array
required:
- items
type: object
UpdateComputeImageCapabilitySchemaDetails:
description: 'Create Image Capability Schema for an image.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
schemaData:
additionalProperties:
$ref: '#/components/schemas/ImageCapabilitySchemaDescriptor'
description: The map of each capability name to its ImageCapabilitySchemaDescriptor.
type: object
MemoryFabricPreferencesDescriptor:
description: 'The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel.
'
properties:
customerDesiredFirmwareBundleId:
description: 'The desired firmware bundle id on the GPU memory fabric.
'
type: string
fabricRecycleLevel:
description: 'The recycle level of GPU memory fabric.
'
enum:
- FULL_RECYCLE
- SKIP_RECYCLE
- OPPORTUNISTIC_FULL_RECYCLE
type: string
ChangeComputeHostCompartmentDetails:
description: Specifies the compartment to move the compute host to.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
to move the compute host to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ComputeHostSummary:
description: 'Summary information for a compute host.
'
properties:
availabilityDomain:
description: 'The availability domain of the compute host.
Example: `Uocm:US-CHICAGO-1-AD-2`
'
maxLength: 255
minLength: 1
type: string
capacityReservationId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root
compartment.
'
maxLength: 255
minLength: 1
type: string
computeHostGroupId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
This field is the Fault domain of the host
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryFabricId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric
'
maxLength: 255
minLength: 1
type: string
hasImpactedComponents:
description: "While listing a host the user will know if they have an impacted component or not. \nThe user will have to issue a get host to see details.\n"
type: boolean
health:
description: 'The heathy state of the host
'
type: string
x-obmcs-enumref: '#/definitions/ComputeHost/health'
hpcIslandId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host
'
maxLength: 255
minLength: 1
type: string
instanceId:
description: 'The public [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The lifecycle state of the host
'
type: string
x-obmcs-enumref: '#/definitions/ComputeHost/lifecycleState'
localBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
'
maxLength: 255
minLength: 1
type: string
networkBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
'
maxLength: 255
minLength: 1
type: string
platform:
description: 'The platform of the host
'
maxLength: 255
minLength: 1
type: string
recycleDetails:
$ref: '#/components/schemas/RecycleDetails'
shape:
description: 'The shape of host
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time that the compute host record was created, in the format defined by [RFC3339](https://tools
.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: "The date and time that the compute host record was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n \nExample: `2016-08-25T21:10:29.600Z`\n"
format: date-time
type: string
required:
- compartmentId
- availabilityDomain
- id
- faultDomain
- shape
- health
- lifecycleState
- hasImpactedComponents
- timeCreated
- timeUpdated
Image:
description: 'A boot disk image for launching an instance. For more information, see
[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).
To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized,
talk to an administrator. If you''re an administrator who needs to write policies to give users access, see
[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
properties:
agentFeatures:
$ref: '#/components/schemas/InstanceAgentFeatures'
baseImageId:
description: The OCID of the image originally used to launch the instance.
maxLength: 255
minLength: 1
type: string
billableSizeInGBs:
description: 'The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes).
Example: `100`
'
format: int64
type: integer
compartmentId:
description: 'The OCID of the compartment containing the instance you want to use as the basis for the image.
'
maxLength: 255
minLength: 1
type: string
createImageAllowed:
description: 'Whether instances launched with this image can be used to create new images.
For example, you cannot create an image of an Oracle Database instance.
Example: `true`
'
type: boolean
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name for the image. It does not have to be unique, and it''s changeable.
Avoid entering confidential information.
You cannot use a platform image name as a custom image name.
Example: `My custom Oracle Linux image`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The OCID of the image.
maxLength: 255
minLength: 1
type: string
launchMode:
description: 'Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
'
enum:
- NATIVE
- EMULATED
- PARAVIRTUALIZED
- ACCELERATEDPV
- CUSTOM
type: string
x-obmcs-resolve-component-ref: true
launchOptions:
$ref: '#/components/schemas/LaunchOptions'
lifecycleState:
enum:
- PROVISIONING
- IMPORTING
- AVAILABLE
- EXPORTING
- DISABLED
- DELETED
type: string
operatingSystem:
description: 'The image''s operating system.
Example: `Oracle Linux`
'
maxLength: 255
minLength: 1
type: string
operatingSystemVersion:
description: 'The image''s operating system version.
Example: `7.2`
'
maxLength: 255
minLength: 1
type: string
sizeInMBs:
description: 'The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes).
Note this is not the same as the size of the image when it was exported or the actual size of the image.
Example: `47694`
'
format: int64
type: integer
timeCreated:
description: 'The date and time the image was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- compartmentId
- id
- lifecycleState
- timeCreated
- operatingSystem
- operatingSystemVersion
- createImageAllowed
x-example: "Example 1\n{\n \"baseImageId\": \"ocid1.image.oc1.phx.<unique_ID>\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"createImageAllowed\": true,\n \"displayName\": \"MyCustomImage\",\n \"id\": \"ocid1.image.oc1.phx.<unique_ID>\",\n \"lifecycleState\": \"PROVISIONING\",\n \"timeCreated\": \"2016-10-03T17:04:47.627Z\"\n}\n\nExample 2\n{\n \"baseImageId\": null,\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"createImageAllowed\": true,\n \"displayName\": \"MyCustomImage\",\n \"id\": \"ocid1.image.oc1.phx.<unique_ID>\",\n \"lifecycleState\": \"IMPORTING\",\n \"timeCreated\": \"2016-10-03T17:04:47.627Z\"\n}\n"
ComputeGpuMemoryFabric:
description: 'The customer facing object includes GPU memory fabric details.
'
properties:
additionalData:
additionalProperties:
type: object
description: 'Additional data that can be exposed to the customer. Right now it will include the switch tray ids.
'
type: object
availableHostCount:
description: The total number of available bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the compartment. This should always be the root
compartment.
'
maxLength: 255
minLength: 1
type: string
computeGpuMemoryClusters:
description: List of GPU memory clusters within this GPU memory fabric.
items:
maxLength: 255
minLength: 1
type: string
maxItems: 255
type: array
uniqueItems: true
computeHpcIslandId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island
'
maxLength: 255
minLength: 1
type: string
computeLocalBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block
'
maxLength: 255
minLength: 1
type: string
computeNetworkBlockId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block
'
maxLength: 255
minLength: 1
type: string
currentFirmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
fabricHealth:
description: 'The health state of the GPU memory fabric
'
enum:
- HEALTHY
- UNHEALTHY
type: string
firmwareUpdateReason:
description: 'The reason for updating firmware bundle version of the GPU memory fabric.
'
maxLength: 255
minLength: 1
type: string
firmwareUpdateState:
description: 'The state of Memory Fabric Firmware update
'
enum:
- WILL_UPDATE
- NO_UPDATE
- SKIP_RECYCLE_ENABLED
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
healthyHostCount:
description: The total number of healthy bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
hostPlatformName:
description: 'The host platform identifier used for bundle queries
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The lifecycle state of the GPU memory fabric
'
enum:
- AVAILABLE
- OCCUPIED
- PROVISIONING
- DEGRADED
- UNAVAILABLE
type: string
memoryFabricPreferences:
$ref: '#/components/schemas/MemoryFabricPreferencesDescriptor'
switchPlatformName:
description: 'The switch platform identifier used for bundle queries
'
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
targetFirmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339]
(https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalHostCount:
description: The total number of bare metal hosts located in this compute GPU memory fabric.
format: int64
minimum: 0
type: integer
required:
- id
- compartmentId
- computeHpcIslandId
- computeNetworkBlockId
- computeLocalBlockId
- lifecycleState
- fabricHealth
- healthyHostCount
- totalHostCount
- timeCreated
UpdateCapacitySourceDetails:
description: 'A capacity source of bare metal hosts.
'
discriminator:
propertyName: capacityType
properties:
capacityType:
description: The capacity type of bare metal hosts.
type: string
x-obmcs-enumref: '#/definitions/CapacitySource/capacityType'
required:
- capacityType
UpdateComputeCapacityReservationDetails:
description: 'Details for updating the compute capacity reservation.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
instanceReservationConfigs:
description: 'The capacity configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and
optionally the fault domain where you want this configuration.
'
items:
$ref: '#/components/schemas/InstanceReservationConfigDetails'
type: array
isDefaultReservation:
description: 'Whether this capacity reservation is the default.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
type: boolean
PlacementConstraintDetails:
description: 'The details for providing placement constraints.
'
discriminator:
propertyName: type
properties:
type:
description: 'The type for the placement constraints.
Use `COMPUTE_BARE_METAL_HOST` when specifying the compute bare metal host OCID.
Use `HOST_GROUP` when specifying the compute host group OCID.
Use `COMPUTE_CLUSTER` when specifying compute cluster placement constraints.
'
type: string
required:
- type
ComputeHostConfigurationData:
description: 'Compute Host Configuration Data
'
properties:
checkDetails:
$ref: '#/components/schemas/ComputeHostConfigurationCheckDetails'
timeLastApply:
description: The time that was last applied.
format: date-time
type: string
CapacityReservationInstanceSummary:
description: Condensed instance data when listing instances in a compute capacity reservation.
properties:
availabilityDomain:
description: The availability domain the instance is running in.
maxLength: 255
minLength: 1
type: string
clusterPlacementGroupId:
description: The OCID of the cluster placement group of the instance.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment that contains the instance.
maxLength: 255
minLength: 1
type: string
faultDomain:
description: The fault domain the instance is running in.
maxLength: 255
minLength: 1
type: string
id:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
shape:
description: 'The shape of the instance. The shape determines the number of CPUs, amount of memory,
and other resources allocated to the instance.
You can enumerate all available shapes by calling [ListComputeCapacityReservationInstanceShapes](#/en/iaas/latest/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).
'
maxLength: 255
minLength: 1
type: string
shapeConfig:
$ref: '#/components/schemas/InstanceReservationShapeConfigDetails'
required:
- id
- availabilityDomain
- compartmentId
- shape
AppCatalogSubscriptionSummary:
description: a subscription summary for a listing resource version.
properties:
compartmentId:
description: The compartmentID of the subscription.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
listingId:
description: The ocid of the listing resource.
maxLength: 255
minLength: 1
type: string
listingResourceId:
description: Listing resource id.
maxLength: 255
minLength: 1
type: string
listingResourceVersion:
description: Listing resource version.
maxLength: 255
minLength: 1
type: string
publisherName:
description: Name of the publisher who published this listing.
maxLength: 64
minLength: 1
type: string
summary:
description: The short summary to the listing.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'Date and time at which the subscription was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
Example: `2018-03-20T12:32:53.532Z`
'
format: date-time
type: string
ChangeImageCompartmentDetails:
description: The configuration details for the move operation.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the image to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ImageMemoryConstraints:
description: For a flexible image and shape, the amount of memory supported for instances that use this image.
properties:
maxInGBs:
description: The maximum amount of memory, in gigabytes.
minimum: 0
type: integer
minInGBs:
description: The minimum amount of memory, in gigabytes.
minimum: 0
type: integer
MeasuredBootReport:
description: The measured boot report for a shielded instance.
properties:
isPolicyVerificationSuccessful:
description: 'Whether the verification succeeded, and the new values match the expected values.
'
type: boolean
measurements:
$ref: '#/components/schemas/MeasuredBootReportMeasurements'
required:
- isPolicyVerificationSuccessful
ImageOcpuConstraints:
description: OCPU options for an image and shape.
properties:
max:
description: The maximum number of OCPUs supported for this image and shape.
minimum: 0
type: integer
min:
description: The minimum number of OCPUs supported for this image and shape.
minimum: 0
type: integer
LaunchInstanceAgentConfigDetails:
description: Configuration options for the Oracle Cloud Agent software running on the instance.
properties:
areAllPluginsDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all the available plugins.
This includes the management and monitoring plugins.
To get a list of available plugins, use the
[ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information about the available plugins, see
[Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm).
'
type: boolean
isManagementDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all the available management plugins.
Default value is false (management plugins are enabled).
These are the management plugins: OS Management Service Agent and Compute Instance
Run Command.
The management plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of
the per-plugin configuration.
- If `isManagementDisabled` is false, all of the management plugins are enabled. You
can optionally disable individual management plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
isMonitoringDisabled:
default: false
description: 'Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the
monitoring plugins. Default value is false (monitoring plugins are enabled).
These are the monitoring plugins: Compute Instance Monitoring
and Custom Logs Monitoring.
The monitoring plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of
the per-plugin configuration.
- If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You
can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
pluginsConfig:
description: The configuration of plugins associated with this instance.
items:
$ref: '#/components/schemas/InstanceAgentPluginConfigDetails'
maxLength: 128
type: array
ComputeClusterCollection:
description: 'A list of compute clusters that match filter criteria, if any. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm)
is a remote direct memory access (RDMA) network group.
'
properties:
items:
description: The list of compute clusters.
items:
$ref: '#/components/schemas/ComputeClusterSummary'
type: array
required:
- items
type: object
LaunchAttachVolumeDetails:
description: The details of the volume to attach.
discriminator:
propertyName: type
properties:
device:
description: The device name. To retrieve a list of devices for a given instance, see [ListInstanceDevices](#/en/iaas/latest/Device/ListInstanceDevices).
maxLength: 100
minLength: 3
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
isReadOnly:
description: Whether the attachment was created in read-only mode.
type: boolean
isShareable:
default: false
description: 'Whether the attachment should be created in shareable mode. If an attachment
is created in shareable mode, then other instances can attach the same volume, provided
that they also create their attachments in shareable mode. Only certain volume types can
be attached in shareable mode. Defaults to false if not specified.
'
type: boolean
launchCreateVolumeDetails:
$ref: '#/components/schemas/LaunchCreateVolumeDetails'
type:
description: The type of volume attachment. Currently, the only supported values are "iscsi" and "paravirtualized".
maxLength: 255
minLength: 1
type: string
volumeId:
description: 'The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
'
maxLength: 255
minLength: 1
type: string
required:
- type
MeasuredBootReportMeasurements:
description: 'A list of Trusted Platform Module (TPM) Platform Configuration Register (PCR) entries.
'
properties:
actual:
description: The list of actual PCR entries measured during boot.
items:
$ref: '#/components/schemas/MeasuredBootEntry'
type: array
policy:
description: The list of expected PCR entries to use during verification.
items:
$ref: '#/components/schemas/MeasuredBootEntry'
type: array
MeasuredBootEntry:
description: 'One Trusted Platform Module (TPM) Platform Configuration Register (PCR) entry. The entry might be measured during boot,
or specified in a policy.
'
properties:
hashAlgorithm:
description: The type of algorithm used to calculate the hash.
type: string
pcrIndex:
description: The index of the policy.
type: string
value:
description: The hashed PCR value.
type: string
ComputeCapacityReservationSummary:
description: 'Summary information for a compute capacity reservation.
'
properties:
availabilityDomain:
description: The availability domain of the capacity reservation.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The OCID of the instance reservation configuration.
maxLength: 255
minLength: 1
type: string
isDefaultReservation:
default: false
description: 'Whether this capacity reservation is the default.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
type: boolean
lifecycleState:
description: The current state of the capacity reservation.
type: string
x-obmcs-enumref: '#/definitions/ComputeCapacityReservation/lifecycleState'
reservedInstanceCount:
description: 'The number of instances for which capacity will be held in this
compute capacity reservation. This number is the sum of the values of the `reservedCount` fields
for all of the instance capacity configurations under this reservation.
The purpose of this field is to calculate the percentage usage of the reservation.
'
format: int64
minimum: 0
type: integer
timeCreated:
description: 'The date and time the capacity reservation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
usedInstanceCount:
description: 'The total number of instances currently consuming space in
this compute capacity reservation. This number is the sum of the values of the `usedCount` fields
for all of the instance capacity configurations under this reservation.
The purpose of this field is to calculate the percentage usage of the reservation.
'
format: int64
minimum: 0
type: integer
required:
- id
- timeCreated
- availabilityDomain
LaunchInstanceShapeConfigDetails:
description: 'The shape configuration requested for the instance.
If the parameter is provided, the instance is created with the resources that you specify. If some
properties are missing or the entire parameter is not provided, the instance is created
with the default configuration values for the `shape` that you specify.
Each shape only supports certain configurable values. If the values that you provide are not valid for the
specified `shape`, an error is returned.
'
properties:
baselineOcpuUtilization:
description: 'The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a
non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.
The following values are supported:
- `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
- `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
- `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.
'
enum:
- BASELINE_1_8
- BASELINE_1_2
- BASELINE_1_1
type: string
memoryInGBs:
description: 'The total amount of memory available to the instance, in gigabytes.
'
format: float
minimum: 0.0
type: number
nvmes:
description: 'The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
'
format: int32
maximum: 7
minimum: 1
type: integer
ocpus:
description: 'The total number of OCPUs available to the instance.
'
format: float
minimum: 0.0
type: number
resourceManagement:
description: 'This field is reserved for internal use.
'
enum:
- DYNAMIC
- STATIC
type: string
vcpus:
description: 'The total number of VCPUs available to the instance. This can be used instead of OCPUs,
in which case the actual number of OCPUs will be calculated based on this value
and the actual hardware. This must be a multiple of 2.
'
format: int32
minimum: 0
type: integer
ConsoleHistory:
description: 'An instance''s serial console data. It includes configuration messages that occur when the
instance boots, such as kernel and BIOS messages, and is useful for checking the status of
the instance or diagnosing problems. The console data is minimally formatted ASCII text.
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
properties:
availabilityDomain:
description: 'The availability domain of an instance.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The OCID of the console history metadata object.
maxLength: 255
minLength: 1
type: string
instanceId:
description: The OCID of the instance this console history was fetched from.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the console history.
enum:
- REQUESTED
- GETTING-HISTORY
- SUCCEEDED
- FAILED
type: string
timeCreated:
description: 'The date and time the history was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- lifecycleState
- availabilityDomain
- timeCreated
- instanceId
DetachComputeHostGroupHostDetails:
description: Specifies the host group id
properties:
computeHostGroupId:
description: '''The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.''
'
maxLength: 255
minLength: 1
type: string
required:
- computeHostGroupId
InstanceAgentConfig:
description: Configuration options for the Oracle Cloud Agent software running on the instance.
properties:
areAllPluginsDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all of the available plugins.
This includes the management and monitoring plugins.
For more information about the available plugins, see
[Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm).
'
type: boolean
isManagementDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all the available management plugins.
These are the management plugins: OS Management Service Agent and Compute Instance
Run Command.
The management plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of
the per-plugin configuration.
- If `isManagementDisabled` is false, all of the management plugins are enabled. You
can optionally disable individual management plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
isMonitoringDisabled:
default: false
description: 'Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the
monitoring plugins.
These are the monitoring plugins: Compute Instance Monitoring
and Custom Logs Monitoring.
The monitoring plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of
the per-plugin configuration.
- If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You
can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
pluginsConfig:
description: The configuration of plugins associated with this instance.
items:
$ref: '#/components/schemas/InstanceAgentPluginConfigDetails'
maxLength: 128
type: array
ShapeMaxVnicAttachmentOptions:
description: 'For a flexible shape, the number of VNIC attachments that are available for instances that use this shape.
If this field is null, then this shape has a fixed maximum number of VNIC attachments equal to `maxVnicAttachments`.
'
properties:
defaultPerOcpu:
description: 'The default number of VNIC attachments allowed per OCPU.
'
format: float
minimum: 0.0
type: number
max:
description: 'The highest maximum value of VNIC attachments.
'
format: float
minimum: 0
type: number
min:
description: 'The lowest maximum value of VNIC attachments.
'
minimum: 0
type: integer
InstanceConsoleConnection:
description: 'The `InstanceConsoleConnection` API provides you with console access to Compute instances,
enabling you to troubleshoot malfunctioning instances remotely.
For more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).
'
properties:
compartmentId:
description: The OCID of the compartment to contain the console connection.
maxLength: 255
minLength: 1
type: string
connectionString:
description: The SSH connection string for the console connection.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
fingerprint:
description: The SSH public key's fingerprint for client authentication to the console connection.
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The OCID of the console connection.
type: string
instanceId:
description: The OCID of the instance the console connection connects to.
type: string
lifecycleState:
description: The current state of the console connection.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
type: string
serviceHostKeyFingerprint:
description: The SSH public key's fingerprint for the console connection service host.
type: string
vncConnectionString:
description: 'The SSH connection string for the SSH tunnel used to
connect to the console connection over VNC.
'
type: string
x-example: "{\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"connectionString\": \"ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>@instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.<unique_ID>\",\n \"vncConnectionString\": \"ssh -L 5900:ocid1.instance.oc1.iad.<unique_ID> -N ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>@instance-console.us-ashburn-1.oraclecloud.com \",\n \"fingerprint\": \"00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:aa\",\n \"id\": \"ocid1.instanceconsoleconnection.oc1.iad.<unique_ID>\",\n \"instanceId\": \"ocid1.instance.oc1.iad.<unique_ID>\",\n \"lifecycleState\": \"ACTIVE\",\n}\n"
Shape:
description: 'A compute instance shape that can be used in [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance).
For more information, see [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm) and
[Compute Shapes](/iaas/Content/Compute/References/computeshapes.htm).
'
properties:
availabilityDomain:
description: The shape's availability domain.
maxLength: 255
minLength: 1
type: string
baselineOcpuUtilizations:
description: 'For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.
'
items:
enum:
- BASELINE_1_8
- BASELINE_1_2
- BASELINE_1_1
minimum: 0
type: string
type: array
billingType:
description: 'How instances that use this shape are charged.
'
enum:
- ALWAYS_FREE
- LIMITED_FREE
- PAID
type: string
gpuDescription:
description: 'A short description of the graphics processing unit (GPU) available for this shape.
If the shape does not have any GPUs, this field is `null`.
'
type: string
gpus:
description: 'The number of GPUs available for this shape.
'
minimum: 0
type: integer
isBilledForStoppedInstance:
description: 'Whether billing continues when the instances that use this shape are in the stopped state.
'
type: boolean
isFlexible:
description: 'Whether the shape supports creating flexible instances. A [flexible shape](/iaas/Content/Compute/References/computeshapes.htm#flexible)
is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance.
'
type: boolean
isLiveMigrationSupported:
description: 'Whether live migration is supported for this shape.
'
type: boolean
isSubcore:
description: 'Whether the shape supports creating subcore or burstable instances. A [burstable instance](/iaas/Content/Compute/References/burstable-instances.htm)
is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional
spikes in usage.
'
type: boolean
localDiskDescription:
description: 'A short description of the local disks available for this shape.
If the shape does not have any local disks, this field is `null`.
'
maxLength: 255
minLength: 1
type: string
localDisks:
description: 'The number of local disks available for this shape.
'
minimum: 0
type: integer
localDisksTotalSizeInGBs:
description: 'The aggregate size of the local disks available for this shape, in gigabytes.
If the shape does not have any local disks, this field is `null`.
'
format: float
minimum: 0.0
type: number
maxVnicAttachmentOptions:
$ref: '#/components/schemas/ShapeMaxVnicAttachmentOptions'
maxVnicAttachments:
description: 'The maximum number of VNIC attachments available for this shape.
'
minimum: 0
type: integer
memoryInGBs:
description: 'The default amount of memory available for this shape, in gigabytes.
'
format: float
minimum: 0.0
type: number
memoryOptions:
$ref: '#/components/schemas/ShapeMemoryOptions'
minTotalBaselineOcpusRequired:
description: 'For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to
baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen.
'
format: int32
minimum: 0
type: number
networkPorts:
description: 'The number of physical network interface card (NIC) ports available for this shape.
'
minimum: 0
type: integer
networkingBandwidthInGbps:
description: 'The networking bandwidth available for this shape, in gigabits per second.
'
format: float
minimum: 0.0
type: number
networkingBandwidthOptions:
$ref: '#/components/schemas/ShapeNetworkingBandwidthOptions'
ocpuOptions:
$ref: '#/components/schemas/ShapeOcpuOptions'
ocpus:
description: 'The default number of OCPUs available for this shape.
'
format: float
minimum: 0.0
type: number
platformConfigOptions:
$ref: '#/components/schemas/ShapePlatformConfigOptions'
platformNames:
description: 'The list of platform names that can be used for this shapes
'
items:
type: string
type: array
processorDescription:
description: 'A short description of the shape''s processor (CPU).
'
maxLength: 255
minLength: 1
type: string
quotaNames:
description: 'The list of of compartment quotas for the shape.
'
items:
type: string
type: array
rdmaBandwidthInGbps:
description: 'The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in
gigabits per second.
'
minimum: 0
type: integer
rdmaPorts:
description: 'The number of networking ports available for the remote direct memory access (RDMA) network between nodes in
a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this
value is `0`.
'
minimum: 0
type: integer
recommendedAlternatives:
description: 'The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.
'
items:
$ref: '#/components/schemas/ShapeAlternativeObject'
type: array
resizeCompatibleShapes:
description: 'The list of compatible shapes that this shape can be changed to. For more information,
see [Changing the Shape of an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm).
'
items:
type: string
type: array
shape:
description: 'The name of the shape. You can enumerate all available shapes by calling
[ListShapes](#/en/iaas/latest/Shape/ListShapes).
'
maxLength: 255
minLength: 1
type: string
required:
- shape
ChangeComputeCapacityReservationCompartmentDetails:
description: Specifies the compartment to move the compute capacity reservation to.
properties:
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
to move the compute capacity reservation to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
ComputeNetworkBlockCollection:
description: 'A list of compute network blocks.
'
properties:
items:
description: The list of compute network blocks.
items:
$ref: '#/components/schemas/ComputeNetworkBlockSummary'
type: array
required:
- items
type: object
DedicatedVmHost:
description: 'A dedicated virtual machine host lets you host multiple VM instances
on a dedicated server that is not shared with other tenancies.
'
properties:
availabilityDomain:
description: 'The availability domain the dedicated virtual machine host is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
capacityBins:
items:
$ref: '#/components/schemas/CapacityBin'
maxItems: 25
minItems: 0
type: array
capacityConfig:
description: "The capacity configuration selected to be configured for the Dedicated Virtual Machine host. \nRun [ListDedicatedVmHostShapes](#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API to see details of this capacity configuration.\n"
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment that contains the dedicated virtual machine host.
maxLength: 255
minLength: 1
type: string
computeBareMetalHostId:
description: 'The compute bare metal host OCID of the dedicated virtual machine host.
'
maxLength: 255
minLength: 1
type: string
dedicatedVmHostShape:
description: 'The dedicated virtual machine host shape. The shape determines the number of CPUs and
other resources available for VMs.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
faultDomain:
description: 'The fault domain for the dedicated virtual machine host''s assigned instances.
For more information, see [Fault Domains](/iaas/Content/General/Concepts/regions.htm#fault).
If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host,
delete it, and then create a new dedicated virtual machine host in the preferred fault domain.
To get a list of fault domains, use the `ListFaultDomains` operation in the [Identity and Access Management Service API](/iaas/api/#/en/identity/20160918/).
Example: `FAULT-DOMAIN-1`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host.
maxLength: 255
minLength: 1
type: string
isBurstable:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is to running only Burstable VMs. If `true`, only Burstable VMs can be launched. If `false`, Burstable VMs cannot be launched.
'
type: boolean
isMemoryEncryptionEnabled:
default: false
description: 'Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If `true`, only Confidential VMs can be launched. If `false`, Confidential VMs cannot be launched.
'
type: boolean
lifecycleState:
description: 'The current state of the dedicated VM host.
'
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
remainingMemoryInGBs:
description: 'The remaining memory of the dedicated VM host, in GBs.
'
format: float
minimum: 0.0
type: number
remainingOcpus:
description: 'The available OCPUs of the dedicated VM host.
'
format: float
minimum: 0.0
type: number
timeCreated:
description: 'The date and time the dedicated VM host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalMemoryInGBs:
description: 'The total memory of the dedicated VM host, in GBs.
'
format: float
minimum: 0.0
type: number
totalOcpus:
description: 'The total OCPUs of the dedicated VM host.
'
format: float
minimum: 0.0
type: number
required:
- availabilityDomain
- compartmentId
- dedicatedVmHostShape
- displayName
- id
- lifecycleState
- remainingOcpus
- timeCreated
- totalOcpus
CreateVnicDetails:
description: 'Contains properties for a VNIC. You use this object when creating the
primary VNIC during instance launch or when creating a secondary VNIC.
For more information about VNICs, see
[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).
'
properties:
assignIpv6Ip:
default: false
description: 'Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled
subnet. Default: False. When provided you may optionally provide an IPv6 prefix
(`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr`
is not provided then an IPv6 prefix is chosen
for you.
'
type: boolean
assignPrivateDnsRecord:
description: 'Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record
registration for the VNIC. If set to true, the DNS record will be registered. The default
value is true.
If you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.
'
type: boolean
assignPublicIp:
description: 'Whether the VNIC should be assigned a public IP address. Defaults to whether
the subnet is public or private. If not set and the VNIC is being created
in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the
[Subnet](#/en/iaas/latest/Subnet/)), then no public IP address is assigned.
If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then
a public IP address is assigned. If set to true and
`prohibitPublicIpOnVnic` = true, an error is returned.
**Note:** This public IP address is associated with the primary private IP
on the VNIC. For more information, see
[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).
**Note:** There''s a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/)
a VNIC or instance can have. If you try to create a secondary VNIC
with an assigned public IP for an instance that has already
reached its public IP limit, an error is returned. For information
about the public IP limits, see
[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).
Example: `false`
If you specify a `vlanId`, then `assignPublicIp` must be set to false. See
[Vlan](#/en/iaas/latest/Vlan).
'
type: boolean
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
hostnameLabel:
description: 'The hostname for the VNIC''s primary private IP. Used for DNS. The value is the hostname
portion of the primary private IP''s fully qualified domain name (FQDN)
(for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).
Must be unique across all VNICs in the subnet and comply with
[RFC 952](https://tools.ietf.org/html/rfc952) and
[RFC 1123](https://tools.ietf.org/html/rfc1123).
The value appears in the [Vnic](#/en/iaas/latest/Vnic/) object and also the
[PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by
[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and
[GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp).
For more information, see
[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).
When launching an instance, use this `hostnameLabel` instead
of the deprecated `hostnameLabel` in
[LaunchInstanceDetails](#/en/iaas/latest/requests/LaunchInstanceDetails).
If you provide both, the values must match.
Example: `bminstance1`
If you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN
can not be assigned a hostname. See [Vlan](#/en/iaas/latest/Vlan).
'
maxLength: 63
minLength: 1
type: string
ipv6AddressIpv6SubnetCidrPairDetails:
description: 'A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address.
You can provide only the prefix ranges from which OCI selects an available
address from the range. You can optionally choose to leave the prefix range empty
and instead provide the specific IPv6 address within that range to use.
'
items:
$ref: '#/components/schemas/Ipv6AddressIpv6SubnetCidrPairDetails'
type: array
nsgIds:
description: 'A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more
information about NSGs, see
[NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).
If a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId`
indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs,
all VNICs in the VLAN belong to the NSGs that are associated with the VLAN.
See [Vlan](#/en/iaas/latest/Vlan).
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
privateIp:
description: 'A private IP address of your choice to assign to the VNIC. Must be an
available IP address within the subnet''s CIDR. If you don''t specify a
value, Oracle automatically assigns a private IP address from the subnet.
This is the VNIC''s *primary* private IP address. The value appears in
the [Vnic](#/en/iaas/latest/Vnic/) object and also the
[PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by
[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and
[GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp).
If you specify a `vlanId`, the `privateIp` cannot be specified.
See [Vlan](#/en/iaas/latest/Vlan).
If you specify a ''privateIpId'', the ''privateIp'' cannot be specified.
Example: `10.0.3.3`
'
maxLength: 46
minLength: 1
type: string
privateIpId:
description: 'An [OCID](/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC.
'
maxLength: 255
minLength: 1
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'The value of the tag.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).
'
type: object
description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`
'
type: object
skipSourceDestCheck:
description: 'Whether the source/destination check is disabled on the VNIC.
Defaults to `false`, which means the check is performed. For information
about why you would skip the source/destination check, see
[Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).
If you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the
source/destination check is always disabled for VNICs in a VLAN. See
[Vlan](#/en/iaas/latest/Vlan).
Example: `true`
'
type: boolean
subnetCidr:
description: 'One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range
from which the VNIC''s private IP address will be assigned if `privateIp` or
`privateIpId` is not specified.
Either this field or the `privateIp` (or `privateIpId`, if applicable) field
must be provided, but not both simultaneously.
Example: `192.168.1.0/28`
'
maxLength: 18
minLength: 9
type: string
subnetId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC in. When launching an instance,
use this `subnetId` instead of the deprecated `subnetId` in
[LaunchInstanceDetails](#/en/iaas/latest/requests/LaunchInstanceDetails).
At least one of them is required; if you provide both, the values must match.
If you are an Oracle Cloud VMware Solution customer and creating a secondary
VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`.
If you provide both a `vlanId` and `subnetId`, the request fails.
'
maxLength: 255
minLength: 1
type: string
vlanId:
description: 'Provide this attribute only if you are an Oracle Cloud VMware Solution
customer and creating a secondary VNIC in a VLAN. The value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN.
See [Vlan](#/en/iaas/latest/Vlan).
Provide a `vlanId` instead of a `subnetId`. If you provide both a
`vlanId` and `subnetId`, the request fails.
'
maxLength: 255
minLength: 1
type: string
ImageCapabilitySchemaDescriptor:
description: 'Image Capability Schema Descriptor is a type of capability for an image.
'
discriminator:
propertyName: descriptorType
properties:
descriptorType:
description: 'The image capability schema descriptor type for the capability
'
type: string
source:
enum:
- GLOBAL
- IMAGE
type: string
required:
- descriptorType
- source
ComputeGlobalImageCapabilitySchema:
description: 'Compute Global Image Capability Schema is a container for a set of compute global image capability schema versions
'
properties:
compartmentId:
description: The OCID of the compartment that contains the resource.
maxLength: 255
minLength: 1
type: string
currentVersionName:
description: The name of the global capabilities version resource that is considered the current version.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the compute global image capability schema was created, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- displayName
- timeCreated
FirmwareBundleSummary:
description: Summary of a firmware bundle, returned in list operations.
properties:
allowableTransitions:
$ref: '#/components/schemas/FirmwareBundleTransitions'
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this firmware bundle.
'
maxLength: 255
minLength: 1
type: string
description:
description: A brief description or metadata about this firmware bundle.
type: string
displayName:
description: The user-friendly name of this firmware bundle.
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the firmware bundle.
type: string
x-obmcs-enumref: '#/definitions/FirmwareBundle/lifecycleState'
platforms:
description: A map of platforms to pinned firmware versions.
items:
$ref: '#/components/schemas/PlatformVersions'
type: array
timeCreated:
description: 'The date and time the firmware bundle was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the firmware bundle was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- displayName
- platforms
- compartmentId
- timeCreated
- timeUpdated
- lifecycleState
type: object
AttachVolumeDetails:
discriminator:
propertyName: type
properties:
device:
description: The device name. To retrieve a list of devices for a given instance, see [ListInstanceDevices](#/en/iaas/latest/Device/ListInstanceDevices).
maxLength: 100
minLength: 3
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
instanceId:
description: 'The OCID of the instance. For AttachVolume operation, this is a required field for the request,
see [AttachVolume](#/en/iaas/latest/VolumeAttachment/AttachVolume).
'
maxLength: 255
minLength: 1
type: string
isReadOnly:
description: Whether the attachment was created in read-only mode.
type: boolean
isShareable:
description: 'Whether the attachment should be created in shareable mode. If an attachment
is created in shareable mode, then other instances can attach the same volume, provided
that they also create their attachments in shareable mode. Only certain volume types can
be attached in shareable mode. Defaults to false if not specified.
'
type: boolean
type:
description: 'The type of volume. The only supported values are "iscsi" and "paravirtualized".
'
maxLength: 255
minLength: 1
type: string
volumeId:
description: 'The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
'
maxLength: 255
minLength: 1
type: string
required:
- instanceId
- volumeId
- type
InstanceMaintenanceEventSummary:
description: 'It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.
'
properties:
alternativeResolutionActions:
description: 'These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
'
items:
enum:
- REBOOT_MIGRATION
- TERMINATE
type: string
x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions'
type: array
canReschedule:
description: 'Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
'
type: boolean
compartmentId:
description: 'The OCID of the compartment that contains the instance.
'
maxLength: 255
minLength: 1
type: string
correlationToken:
description: 'A unique identifier that will group Instances that have a relationship with one another and must be scheduled
together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance
perspective will have a matching correlationToken.
'
maxLength: 255
minLength: 1
type: string
createdBy:
description: 'The creator of the maintenance event.
'
type: string
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/createdBy'
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
description:
description: 'It is the descriptive information about the maintenance taking place on the customer instance.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
estimatedDuration:
description: 'This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
'
format: x-obmcs-duration
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event.
'
maxLength: 255
minLength: 1
type: string
instanceAction:
description: 'This is the action that will be performed on the Instance by OCI when the Maintenance begins.
'
type: string
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/instanceAction'
instanceId:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: 'The current state of the maintenance event.
'
type: string
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/lifecycleState'
maintenanceCategory:
description: 'This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have
tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled,
deferred, or even cancelled. Please see the
[Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.
'
type: string
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/maintenanceCategory'
maintenanceReason:
description: 'This is the reason that Maintenance is being performed. See
[Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.
'
type: string
x-obmcs-enumref: '#/definitions/InstanceMaintenanceEvent/maintenanceReason'
startWindowDuration:
description: 'The duration of the time window Maintenance is scheduled to begin within.
'
format: x-obmcs-duration
type: string
timeCreated:
description: 'The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeFinished:
description: 'The time at which the Maintenance actually finished.
'
format: date-time
type: string
timeHardDueDate:
description: 'It is the scheduled hard due date and time of the maintenance event.
The maintenance event will happen at this time and the due date will not be extended.
'
format: date-time
type: string
timeStarted:
description: 'The time at which the Maintenance actually started.
'
format: date-time
type: string
timeWindowStart:
description: 'The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before
this time.
'
format: date-time
type: string
required:
- id
- instanceId
- compartmentId
- instanceAction
- timeWindowStart
- timeCreated
- canReschedule
- maintenanceReason
- lifecycleState
- createdBy
- maintenanceCategory
- alternativeResolutionActions
UpdateInstanceConsoleConnectionDetails:
description: 'Specifies the properties for updating tags for an instance console connection.
'
properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
ComputeHostGroup:
description: 'Detail information for a compute host group.
'
properties:
availabilityDomain:
description: 'The availability domain of a host group.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment that contains host group.
'
maxLength: 255
minLength: 1
type: string
configurations:
description: A list of HostGroupConfiguration objects
items:
$ref: '#/components/schemas/HostGroupConfiguration'
type: array
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group
'
maxLength: 255
minLength: 1
type: string
isTargetedPlacementRequired:
description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.
type: boolean
lifecycleState:
description: 'The lifecycle state of the host group
'
enum:
- ACTIVE
- DELETED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
timeCreated:
description: 'The date and time the host group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the host group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- timeCreated
- availabilityDomain
- displayName
- compartmentId
- lifecycleState
ComputeGlobalImageCapabilitySchemaSummary:
description: Summary information for a compute global image capability schema
properties:
compartmentId:
description: 'The OCID of the compartment containing the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
currentVersionName:
description: The name of the global capabilities version resource that is considered the current version.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The compute global image capability schema [OCID](/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the compute global image capability schema was created, in the format defined by
[RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- displayName
- timeCreated
ComputeHpcIslandCollection:
description: 'A list of compute HPC islands.
'
properties:
items:
description: The list of compute HPC islands.
items:
$ref: '#/components/schemas/ComputeHpcIslandSummary'
type: array
required:
- items
type: object
ComputeImageCapabilitySchemaSummary:
description: Summary information for a compute image capability schema
properties:
compartmentId:
description: 'The OCID of the compartment containing the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
computeGlobalImageCapabilitySchemaVersionName:
description: 'The name of the compute global image capability schema version
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The compute image capability schema [OCID](/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
imageId:
description: 'The OCID of the image associated with this compute image capability schema
'
maxLength: 255
minLength: 1
type: string
schemaData:
additionalProperties:
$ref: '#/components/schemas/ImageCapabilitySchemaDescriptor'
description: A mapping of each capability name to its ImageCapabilityDescriptor.
type: object
timeCreated:
description: 'The date and time the compute image capability schema was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- computeGlobalImageCapabilitySchemaVersionName
- imageId
- displayName
- timeCreated
LaunchCreateVolumeDetails:
description: Define a volume that will be created and attached or attached to an instance on creation.
discriminator:
propertyName: volumeCreationType
properties:
volumeCreationType:
description: Specifies the method for volume creation.
enum:
- ATTRIBUTES
type: string
required:
- volumeCreationType
ComputeHostConfigurationCheckDetails:
description: 'Compute Host Group Configuration Details Check
'
properties:
configurationState:
description: 'The current state of the host configuration. The Host is either |
CONFORMANT - current state matches the desired configuration
NON_CONFORMANT - current state does not match the desired configuration
PRE_APPLYING, APPLYING, CHECKING- transitional states
UNKNOWN - current state is unknown
'
enum:
- CONFORMANT
- NON_CONFORMANT
- CHECKING
- PRE_APPLYING
- APPLYING
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/ConfigurationState'
firmwareBundleId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host Configuration.
'
maxLength: 255
minLength: 1
type: string
recycleLevel:
description: 'Preferred recycle level for hosts associated with the reservation config.
* `SKIP_RECYCLE` - Skips host wipe.
* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.
'
enum:
- SKIP_RECYCLE
- FULL_RECYCLE
type: string
type:
description: The type of configuration
enum:
- FIRMWARE
- RECYCLE
type: string
BootVolumeAttachment:
description: 'Represents an attachment between a boot volume and an instance.
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
properties:
availabilityDomain:
description: 'The availability domain of an instance.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
bootVolumeId:
description: The OCID of the boot volume.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
encryptionInTransitType:
default: NONE
description: 'Refer the top-level definition of encryptionInTransitType.
The default value is NONE.
'
enum:
- NONE
- BM_ENCRYPTION_IN_TRANSIT
type: string
x-obmcs-top-level-enum: '#/definitions/EncryptionInTransitType'
id:
description: The OCID of the boot volume attachment.
maxLength: 255
minLength: 1
type: string
instanceId:
description: The OCID of the instance the boot volume is attached to.
maxLength: 255
minLength: 1
type: string
isPvEncryptionInTransitEnabled:
description: 'Whether in-transit encryption for the boot volume''s paravirtualized attachment is enabled or not.
'
type: boolean
lifecycleState:
description: The current state of the boot volume attachment.
enum:
- ATTACHING
- ATTACHED
- DETACHING
- DETACHED
type: string
timeCreated:
description: 'The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the boot volume attachment was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- instanceId
- bootVolumeId
- lifecycleState
- compartmentId
- availabilityDomain
- timeCreated
ShapeMeasuredBootOptions:
description: 'Configuration options for the Measured Boot feature.
'
properties:
allowedValues:
description: 'Boolean values that indicate whether the Measured Boot feature can be enabled or disabled.
'
items:
type: boolean
maxItems: 2
minItems: 1
type: array
isDefaultEnabled:
description: 'Whether the Measured Boot feature is enabled by default.
'
type: boolean
ShapeMemoryEncryptionOptions:
description: 'Configuration options for memory encryption.
'
properties:
allowedValues:
description: 'Whether memory encryption can be enabled.
'
items:
type: boolean
type: array
isDefaultEnabled:
description: 'Whether memory encryption is enabled by default.
'
type: boolean
UpdateInstanceMaintenanceEventDetails:
description: 'Specifies the properties for updating maintenance due date.
'
properties:
alternativeResolutionAction:
description: 'One of the alternativeResolutionActions that was provided in the InstanceMaintenanceEvent.
'
enum:
- REBOOT_MIGRATION
- TERMINATE
type: string
x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions'
canDeleteLocalStorage:
description: 'This field is only applicable when setting the alternativeResolutionAction.
For Instances that have local storage, this must be set to true to verify that the local storage
will be deleted during the migration. For instances without, this parameter has no effect.
In cases where the local storage will be lost, this parameter must be set or the request will fail.
'
type: boolean
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
timeWindowStart:
description: 'The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before
this time.
The timeWindowEnd is automatically calculated based on the maintenanceReason and the instanceAction.
'
format: date-time
type: string
ComputeCluster:
description: "The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm).\n\nAfter the compute cluster is created, you can use the compute cluster's OCID to create Instance, GPU Memory \nCluster or Instance Pool resources within the compute cluster. These resources must be created in the same \ncompartment and availability domain as the cluster.\n\nUse `COMPUTE_CLUSTER` type when using placementConstraintDetails.\n"
properties:
availabilityDomain:
description: 'The availability domain the compute cluster is running in.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute cluster.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute cluster.
enum:
- ACTIVE
- DELETED
type: string
placementConstraintDetails:
$ref: '#/components/schemas/PlacementConstraintDetails'
timeCreated:
description: 'The date and time the compute cluster was created,
in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the compute cluster was updated,
in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- compartmentId
- id
- lifecycleState
- timeCreated
ComputeGlobalImageCapabilitySchemaVersionSummary:
description: Summary information for a compute global image capability schema
properties:
computeGlobalImageCapabilitySchemaId:
description: 'The OCID of the compute global image capability schema
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
name:
description: The compute global image capability schema version name
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the compute global image capability schema version was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- name
- computeGlobalImageCapabilitySchemaId
- timeCreated
InstanceShapeConfig:
description: 'The shape configuration for an instance. The shape configuration determines
the resources allocated to an instance.
'
properties:
baselineOcpuUtilization:
description: 'The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a
non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.
The following values are supported:
- `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.
- `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.
- `BASELINE_1_1` - baseline usage is the entire OCPU. This represents a non-burstable instance.
'
enum:
- BASELINE_1_8
- BASELINE_1_2
- BASELINE_1_1
type: string
gpuDescription:
description: 'A short description of the instance''s graphics processing unit (GPU).
If the instance does not have any GPUs, this field is `null`.
'
type: string
gpus:
description: 'The number of GPUs available to the instance.
'
minimum: 0
type: integer
localDiskDescription:
description: 'A short description of the local disks available to this instance.
If the instance does not have any local disks, this field is `null`.
'
maxLength: 255
minLength: 1
type: string
localDisks:
description: 'The number of local disks available to the instance.
'
minimum: 0
type: integer
localDisksTotalSizeInGBs:
description: 'The aggregate size of all local disks, in gigabytes.
If the instance does not have any local disks, this field is `null`.
'
format: float
minimum: 0.0
type: number
maxVnicAttachments:
description: 'The maximum number of VNIC attachments for the instance.
'
minimum: 0
type: integer
memoryInGBs:
description: 'The total amount of memory available to the instance, in gigabytes.
'
format: float
minimum: 0.0
type: number
networkingBandwidthInGbps:
description: 'The networking bandwidth available to the instance, in gigabits per second.
'
format: float
minimum: 0.0
type: number
ocpus:
description: 'The total number of OCPUs available to the instance.
'
format: float
minimum: 0.0
type: number
processorDescription:
description: 'A short description of the instance''s processor (CPU).
'
maxLength: 255
minLength: 1
type: string
resourceManagement:
description: 'This field is reserved for internal use.
'
enum:
- DYNAMIC
- STATIC
type: string
vcpus:
description: 'The total number of VCPUs available to the instance. This can be used instead of OCPUs,
in which case the actual number of OCPUs will be calculated based on this value
and the actual hardware. This must be a multiple of 2.
'
format: int32
minimum: 0
type: integer
UpdateInstanceSourceDetails:
description: The details for updating the instance source.
discriminator:
propertyName: sourceType
properties:
isPreserveBootVolumeEnabled:
default: true
description: 'Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume.
'
type: boolean
sourceType:
description: 'The source type for the instance.
Use `image` when specifying the image OCID. Use `bootVolume` when specifying
the boot volume OCID.
'
type: string
required:
- sourceType
LaunchInstanceAvailabilityConfigDetails:
description: 'Options for VM migration during infrastructure maintenance events and for defining
the availability of a VM instance after a maintenance event that impacts the underlying hardware.
'
properties:
isLiveMigrationPreferred:
description: 'Whether to live migrate supported VM instances to a healthy physical VM host without
disrupting running instances during infrastructure maintenance events. If null, Oracle
chooses the best option for migrating the VM during infrastructure maintenance events.
'
type: boolean
recoveryAction:
default: RESTORE_INSTANCE
description: 'The lifecycle state for an instance when it is recovered after infrastructure maintenance.
* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event.
If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
* `STOP_INSTANCE` - The instance is recovered in the stopped state.
'
enum:
- RESTORE_INSTANCE
- STOP_INSTANCE
type: string
ComputeGpuMemoryClusterSummary:
description: Summary model for listing Compute GPU Memory Clusters.
properties:
availabilityDomain:
description: 'The availability domain of GPU Memory Cluster.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute GPU Memory Cluster.
compartment.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
gpuMemoryFabricId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric.
'
maxLength: 255
minLength: 1
type: string
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster
'
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute GPU Memory Cluster.
type: string
x-obmcs-enumref: '#/definitions/ComputeGpuMemoryCluster/lifecycleState'
size:
description: 'The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching.
'
format: int64
minimum: 0
type: integer
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
timeCreated:
description: 'The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- id
- compartmentId
- availabilityDomain
- lifecycleState
- timeCreated
UpdateInstanceAgentConfigDetails:
description: Configuration options for the Oracle Cloud Agent software running on the instance.
properties:
areAllPluginsDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all the available plugins.
This includes the management and monitoring plugins.
To get a list of available plugins, use the
[ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information about the available plugins, see
[Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm).
'
type: boolean
isManagementDisabled:
default: false
description: 'Whether Oracle Cloud Agent can run all the available management plugins.
These are the management plugins: OS Management Service Agent and Compute Instance
Run Command.
The management plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of
the per-plugin configuration.
- If `isManagementDisabled` is false, all of the management plugins are enabled. You
can optionally disable individual management plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
isMonitoringDisabled:
default: false
description: 'Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the
monitoring plugins.
These are the monitoring plugins: Compute Instance Monitoring
and Custom Logs Monitoring.
The monitoring plugins are controlled by this parameter and by the per-plugin
configuration in the `pluginsConfig` object.
- If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of
the per-plugin configuration.
- If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You
can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig`
object.
'
type: boolean
pluginsConfig:
description: The configuration of plugins associated with this instance.
items:
$ref: '#/components/schemas/InstanceAgentPluginConfigDetails'
maxLength: 128
type: array
UpdateLaunchOptions:
description: 'Options for tuning the compatibility and performance of VM shapes.
'
properties:
bootVolumeType:
description: 'Emulation type for the boot volume.
* `ISCSI` - ISCSI attached block storage device.
* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block
storage volumes on platform images.
Before you change the boot volume attachment type, detach all block volumes and VNICs except for
the boot volume and the primary VNIC.
If the instance is running when you change the boot volume attachment type, it will be rebooted.
**Note:** Some instances might not function properly if you change the boot volume attachment type. After
the instance reboots and is running, connect to it. If the connection fails or the OS doesn''t behave
as expected, the changes are not supported. Revert the instance to the original boot volume attachment type.
'
enum:
- ISCSI
- PARAVIRTUALIZED
type: string
isPvEncryptionInTransitEnabled:
description: 'Whether to enable in-transit encryption for the volume''s paravirtualized attachment.
To enable in-transit encryption for block volumes and boot volumes, this field must be set to `true`.
Data in transit is transferred over an internal and highly secure network. If you have specific
compliance requirements related to the encryption of the data while it is moving between the
instance and the boot volume or the block volume, you can enable in-transit encryption.
In-transit encryption is not enabled by default.
All boot volumes and block volumes are encrypted at rest.
For more information, see [Block Volume Encryption](/iaas/Content/Block/Concepts/overview.htm#Encrypti).
'
type: boolean
networkType:
description: 'Emulation type for the physical network interface card (NIC).
* `VFIO` - Direct attached Virtual Function network controller. This is the networking type
when you launch an instance using hardware-assisted (SR-IOV) networking.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
Before you change the networking type, detach all VNICs and block volumes except for the primary
VNIC and the boot volume.
The image must have paravirtualized drivers installed. For more information, see
[Editing an Instance](/iaas/Content/Compute/Tasks/resizinginstances.htm).
If the instance is running when you change the network type, it will be rebooted.
**Note:** Some instances might not function properly if you change the networking type. After
the instance reboots and is running, connect to it. If the connection fails or the OS doesn''t behave
as expected, the changes are not supported. Revert the instance to the original networking type.
'
enum:
- VFIO
- PARAVIRTUALIZED
- ACCELERATEDPV
type: string
ImageSourceDetails:
discriminator:
propertyName: sourceType
properties:
operatingSystem:
maxLength: 255
minLength: 1
type: string
operatingSystemVersion:
maxLength: 255
minLength: 1
type: string
sourceImageType:
description: 'The format of the image to be imported. Only monolithic
images are supported. This attribute is not used for exported Oracle images with the OCI image format.
'
enum:
- QCOW2
- VMDK
type: string
sourceType:
description: 'The source type for the image. Use `objectStorageTuple` when specifying the namespace,
bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL.
'
type: string
required:
- sourceType
InstanceMaintenanceEvent:
description: 'It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.
'
properties:
additionalDetails:
additionalProperties:
type: string
description: 'Additional details of the maintenance in the form of json.
'
type: object
alternativeResolutionActions:
description: 'These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.
'
items:
enum:
- REBOOT_MIGRATION
- TERMINATE
type: string
x-obmcs-top-level-enum: '#/definitions/InstanceMaintenanceAlternativeResolutionActions'
type: array
canDeleteLocalStorage:
description: 'For Instances that have local storage, this field is set to true when local storage
will be deleted as a result of the Maintenance.
'
type: boolean
canReschedule:
description: 'Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.
'
type: boolean
compartmentId:
description: 'The OCID of the compartment that contains the instance.
'
maxLength: 255
minLength: 1
type: string
correlationToken:
description: 'A unique identifier that will group Instances that have a relationship with one another and must be scheduled
together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance
perspective will have a matching correlationToken.
'
maxLength: 255
minLength: 1
type: string
createdBy:
description: 'The creator of the maintenance event.
'
enum:
- CUSTOMER
- SYSTEM
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
description:
description: 'It is the descriptive information about the maintenance taking place on the customer instance.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
estimatedDuration:
description: 'This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.
'
format: x-obmcs-duration
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event.
'
maxLength: 255
minLength: 1
type: string
instanceAction:
description: 'This is the action that will be performed on the Instance by OCI when the Maintenance begins.
'
enum:
- REBOOT_MIGRATION
- TERMINATE
- STOP
- NONE
type: string
instanceId:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
lifecycleDetails:
description: 'Provides more details about the state of the maintenance event.
'
type: string
lifecycleState:
description: 'The current state of the maintenance event.
'
enum:
- SCHEDULED
- QUEUED
- STARTED
- PROCESSING
- SUCCEEDED
- FAILED
- CANCELED
type: string
maintenanceCategory:
description: 'This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have
tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled,
deferred, or even cancelled. Please see the
[Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.
'
enum:
- EMERGENCY
- MANDATORY
- FLEXIBLE
- OPTIONAL
- NOTIFICATION
type: string
maintenanceReason:
description: 'This is the reason that Maintenance is being performed. See
[Instance Maintenance](/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.
'
enum:
- EVACUATION
- ENVIRONMENTAL_FACTORS
- DECOMMISSION
- HARDWARE_REPLACEMENT
- FIRMWARE_UPDATE
- SECURITY_UPDATE
type: string
startWindowDuration:
description: 'The duration of the time window Maintenance is scheduled to begin within.
'
format: x-obmcs-duration
type: string
timeCreated:
description: 'The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeFinished:
description: 'The time at which the Maintenance actually finished.
'
format: date-time
type: string
timeHardDueDate:
description: 'It is the scheduled hard due date and time of the maintenance event.
The maintenance event will happen at this time and the due date will not be extended.
'
format: date-time
type: string
timeStarted:
description: 'The time at which the Maintenance actually started.
'
format: date-time
type: string
timeWindowStart:
description: 'The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before
this time.
'
format: date-time
type: string
required:
- id
- instanceId
- compartmentId
- instanceAction
- timeWindowStart
- timeCreated
- canReschedule
- maintenanceReason
- lifecycleState
- createdBy
- maintenanceCategory
- alternativeResolutionActions
ExportImageDetails:
description: 'The destination details for the image export.
Set `destinationType` to `objectStorageTuple`
and use [ExportImageViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ExportImageViaObjectStorageTupleDetails)
when specifying the namespace, bucket name, and object name.
Set `destinationType` to `objectStorageUri` and
use [ExportImageViaObjectStorageUriDetails](#/en/iaas/latest/requests/ExportImageViaObjectStorageUriDetails)
when specifying the Object Storage URL.
'
discriminator:
propertyName: destinationType
properties:
destinationType:
description: 'The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.
Use `objectStorageUri` when specifying the Object Storage URL.
'
type: string
exportFormat:
description: 'The format to export the image to. The default value is `OCI`.
The following image formats are available:
- `OCI` - Oracle Cloud Infrastructure file with a QCOW2 image and Oracle Cloud Infrastructure metadata (.oci).
Use this format to export a custom image that you want to import into other tenancies or regions.
- `QCOW2` - QEMU Copy On Write (.qcow2)
- `VDI` - Virtual Disk Image (.vdi) for Oracle VM VirtualBox
- `VHD` - Virtual Hard Disk (.vhd) for Hyper-V
- `VMDK` - Virtual Machine Disk (.vmdk)
'
enum:
- QCOW2
- VMDK
- OCI
- VHD
- VDI
type: string
required:
- destinationType
CreateImageDetails:
description: 'Either instanceId or imageSourceDetails must be provided in addition to other required parameters.
'
properties:
compartmentId:
description: The OCID of the compartment you want the image to be created in.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name for the image. It does not have to be unique, and it''s changeable.
Avoid entering confidential information.
You cannot use a platform image name as a custom image name.
Example: `My Oracle Linux image`
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
imageSourceDetails:
$ref: '#/components/schemas/ImageSourceDetails'
instanceId:
description: 'The OCID of the instance you want to use as the basis for the image.
'
maxLength: 255
minLength: 1
type: string
launchMode:
description: 'Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.
* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.
* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.
'
enum:
- NATIVE
- EMULATED
- PARAVIRTUALIZED
- ACCELERATEDPV
- CUSTOM
type: string
x-obmcs-resolve-component-ref: true
launchOptions:
$ref: '#/components/schemas/LaunchOptions'
required:
- compartmentId
ComputeHpcIslandSummary:
description: 'Summary information for a compute HPC island.
'
properties:
computeCapacityTopologyId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the compute HPC island.
type: string
x-obmcs-enumref: '#/definitions/ComputeHpcIsland/lifecycleState'
timeCreated:
description: 'The date and time that the compute HPC island was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time that the compute HPC island was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
totalComputeBareMetalHostCount:
description: The total number of compute bare metal hosts located in this compute HPC island.
format: int64
minimum: 0
type: integer
required:
- computeCapacityTopologyId
- id
- lifecycleState
- timeCreated
- timeUpdated
- totalComputeBareMetalHostCount
ComputeCapacityReservation:
description: 'A template that defines the settings to use when creating compute capacity reservations.
'
properties:
availabilityDomain:
description: 'The availability domain of the compute capacity reservation.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment
containing the compute capacity reservation.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation.
maxLength: 255
minLength: 1
type: string
instanceReservationConfigs:
description: 'The capacity configurations for the capacity reservation.
To use the reservation for the desired shape, specify the shape, count, and
optionally the fault domain where you want this configuration.
'
items:
$ref: '#/components/schemas/InstanceReservationConfig'
type: array
isDefaultReservation:
default: false
description: 'Whether this capacity reservation is the default.
For more information, see [Capacity Reservations](/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).
'
type: boolean
lifecycleState:
description: The current state of the compute capacity reservation.
enum:
- ACTIVE
- CREATING
- UPDATING
- MOVING
- DELETED
- DELETING
type: string
reservedInstanceCount:
description: 'The number of instances for which capacity will be held with this
compute capacity reservation. This number is the sum of the values of the `reservedCount` fields
for all of the instance capacity configurations under this reservation.
The purpose of this field is to calculate the percentage usage of the reservation.
'
format: int64
type: integer
timeCreated:
description: 'The date and time the compute capacity reservation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the compute capacity reservation was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
usedInstanceCount:
description: 'The total number of instances currently consuming space in
this compute capacity reservation. This number is the sum of the values of the `usedCount` fields
for all of the instance capacity configurations under this reservation.
The purpose of this field is to calculate the percentage usage of the reservation.
'
format: int64
type: integer
required:
- id
- compartmentId
- lifecycleState
- timeCreated
- availabilityDomain
VnicAttachment:
description: 'Represents an attachment between a VNIC and an instance. For more information, see
[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
properties:
availabilityDomain:
description: 'The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment the VNIC attachment is in, which is the same
compartment the instance is in.
'
maxLength: 255
minLength: 1
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
id:
description: The OCID of the VNIC attachment.
maxLength: 255
minLength: 1
type: string
instanceId:
description: The OCID of the instance.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the VNIC attachment.
enum:
- ATTACHING
- ATTACHED
- DETACHING
- DETACHED
type: string
nicIndex:
description: 'Which physical network interface card (NIC) the VNIC uses.
Certain bare metal instance shapes have two active physical NICs (0 and 1). If
you add a secondary VNIC to one of these instances, you can specify which NIC
the VNIC will use. For more information, see
[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).
'
format: int32
maximum: 31
minimum: 0
type: integer
subnetId:
description: The OCID of the subnet to create the VNIC in.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: 'The date and time the VNIC attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
vlanId:
description: 'The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead
of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer.
See [Vlan](#/en/iaas/latest/Vlan).
An error is returned if the instance already has a VNIC attached to it from this VLAN.
'
maxLength: 255
minLength: 1
type: string
vlanTag:
description: 'The Oracle-assigned VLAN tag of the attached VNIC. Available after the
attachment process is complete.
However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution,
the `vlanTag` value is instead the value of the `vlanTag` attribute for the VLAN.
See [Vlan](#/en/iaas/latest/Vlan).
Example: `0`
'
format: int32
type: integer
vnicId:
description: 'The OCID of the VNIC. Available after the attachment process is complete.
'
maxLength: 255
minLength: 1
type: string
required:
- id
- compartmentId
- instanceId
- lifecycleState
- availabilityDomain
- timeCreated
InstanceAgentPluginConfigDetails:
description: The configuration of plugins associated with this instance.
properties:
desiredState:
description: 'Whether the plugin should be enabled or disabled.
To enable the monitoring and management plugins, the `isMonitoringDisabled` and
`isManagementDisabled` attributes must also be set to false.
'
enum:
- ENABLED
- DISABLED
type: string
name:
description: 'The plugin name. To get a list of available plugins, use the
[ListInstanceagentAvailablePlugins](#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins)
operation in the Oracle Cloud Agent API. For more information about the available plugins, see
[Managing Plugins with Oracle Cloud Agent](/iaas/Content/Compute/Tasks/manage-plugins.htm).
'
maxLength: 255
minLength: 1
type: string
required:
- name
- desiredState
type: object
UpdateInstanceAvailabilityConfigDetails:
description: 'Options for defining the availability of a VM instance after a maintenance event that impacts the underlying
hardware, including whether to live migrate supported VM instances when possible without sending a prior customer notification.
'
properties:
isLiveMigrationPreferred:
description: 'Whether to live migrate supported VM instances to a healthy physical VM host without
disrupting running instances during infrastructure maintenance events. If null, Oracle
chooses the best option for migrating the VM during infrastructure maintenance events.
'
type: boolean
recoveryAction:
default: RESTORE_INSTANCE
description: 'The lifecycle state for an instance when it is recovered after infrastructure maintenance.
* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event.
If the instance was running, it is automatically rebooted. This is the default action when a value is not set.
* `STOP_INSTANCE` - The instance is recovered in the stopped state.
'
enum:
- RESTORE_INSTANCE
- STOP_INSTANCE
type: string
VolumeAttachment:
description: 'A base object for all types of attachments between a storage volume and an instance.
For specific details about iSCSI attachments, see
[IScsiVolumeAttachment Reference](#/en/iaas/latest/IScsiVolumeAttachment/).
For general information about volume attachments, see
[Overview of Block Volume Storage](/iaas/Content/Block/Concepts/overview.htm).
**Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
'
discriminator:
propertyName: attachmentType
properties:
attachmentType:
description: The type of volume attachment.
maxLength: 255
minLength: 1
type: string
availabilityDomain:
description: 'The availability domain of an instance.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The OCID of the compartment.
maxLength: 255
minLength: 1
type: string
device:
description: The device name.
maxLength: 100
minLength: 3
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
id:
description: The OCID of the volume attachment.
maxLength: 255
minLength: 1
type: string
instanceId:
description: The OCID of the instance the volume is attached to.
maxLength: 255
minLength: 1
type: string
isMultipath:
description: Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment.
type: boolean
isPvEncryptionInTransitEnabled:
description: 'Whether in-transit encryption for the data volume''s paravirtualized attachment is enabled or not.
'
type: boolean
isReadOnly:
description: Whether the attachment was created in read-only mode.
type: boolean
isShareable:
description: 'Whether the attachment should be created in shareable mode. If an attachment
is created in shareable mode, then other instances can attach the same volume, provided
that they also create their attachments in shareable mode. Only certain volume types can
be attached in shareable mode. Defaults to false if not specified.
'
type: boolean
isVolumeCreatedDuringLaunch:
description: 'Flag indicating if this volume was created for the customer as part of a simplified launch.
Used to determine whether the volume requires deletion on instance termination.
'
type: boolean
iscsiLoginState:
description: 'The iscsi login state of the volume attachment. For a Iscsi volume attachment,
all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state.
'
enum:
- UNKNOWN
- LOGGING_IN
- LOGIN_SUCCEEDED
- LOGIN_FAILED
- LOGGING_OUT
- LOGOUT_SUCCEEDED
- LOGOUT_FAILED
type: string
lifecycleState:
description: The current state of the volume attachment.
enum:
- ATTACHING
- ATTACHED
- DETACHING
- DETACHED
type: string
timeCreated:
description: 'The date and time the volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
volumeId:
description: The OCID of the volume.
maxLength: 255
minLength: 1
type: string
required:
- id
- attachmentType
- instanceId
- volumeId
- lifecycleState
- compartmentId
- availabilityDomain
- timeCreated
ImageShapeCompatibilitySummary:
description: Summary information for a compatible image and shape.
properties:
imageId:
description: The image [OCID](/iaas/Content/General/Concepts/identifiers.htm).
maxLength: 255
minLength: 1
type: string
memoryConstraints:
$ref: '#/components/schemas/ImageMemoryConstraints'
ocpuConstraints:
$ref: '#/components/schemas/ImageOcpuConstraints'
shape:
description: The shape name.
maxLength: 255
minLength: 1
type: string
required:
- imageId
- shape
x-example: "{\n \"imageId\":\"ocid1.image.oc1.phx.<unique_ID>\",\n \"shape\":\"VM.Standard.E3.Flex\",\n \"memoryConstraints\": {\n \"minInGBs\":1,\n \"maxInGBs\":1024\n },\n \"ocpuConstraints\": {\n \"min\":1,\n \"max\":64\n }\n}\n"
ComputeGpuMemoryClusterCollection:
description: 'A list of compute GPU Memory Clusters.
'
properties:
items:
description: The list of compute GPU Memory Clusters.
items:
$ref: '#/components/schemas/ComputeGpuMemoryClusterSummary'
type: array
required:
- items
type: object
ComputeHostGroupSummary:
description: 'Summary information for a compute host group.
'
properties:
availabilityDomain:
description: 'The availability domain of a host group.
Example: `Uocm:PHX-AD-1`
'
maxLength: 255
minLength: 1
type: string
compartmentId:
description: 'The OCID of the compartment that contains host group.
'
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group
'
maxLength: 255
minLength: 1
type: string
isTargetedPlacementRequired:
description: A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.
type: boolean
lifecycleState:
description: The current state of the compute host group
type: string
x-obmcs-enumref: '#/definitions/ComputeHostGroup/lifecycleState'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
'
type: object
timeCreated:
description: 'The date and time the host group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
timeUpdated:
description: 'The date and time the host group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
'
format: date-time
type: string
required:
- availabilityDomain
- id
- displayName
- compartmentId
- timeCreated
- lifecycleState
- isTargetedPlacementRequired
ClusterConfigDetails:
description: 'The HPC cluster configuration requested when launching instances in a compute capacity reservation.
If the parameter is provided, the reservation is created with the HPC island and a list of HPC blocks that you
specify. If a list of HPC blocks are missing or not provided, the reservation is created with any HPC blocks in
the HPC island that you specify. If the values of HPC island or HPC block that you provide are not valid, an error
is returned.
'
properties:
hpcIslandId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the HPC island.
'
maxLength: 255
minLength: 1
type: string
networkBlockIds:
description: The list of OCIDs of the network blocks.
items:
type: string
type: array
required:
- hpcIslandId
ShapeOcpuOptions:
description: 'For a flexible shape, the number of OCPUs available for instances that use this shape.
If this field is null, then this shape has a fixed number of OCPUs equal to `ocpus`.
'
properties:
max:
description: 'The maximum number of OCPUs.
'
format: float
minimum: 0.0
type: number
min:
description: 'The minimum number of OCPUs.
'
format: float
minimum: 0.0
type: number
CreateComputeGpuMemoryClusterScaleConfig:
description: 'Configuration settings for GPU Memory Cluster scaling.
'
properties:
isDownsizeEnabled:
description: 'Enables downsizing towards the target size.
'
type: boolean
isUpsizeEnabled:
description: 'Enables upsizing towards the target size.
'
type: boolean
targetSize:
description: 'The configured target size for the GPU Memory Cluster.
'
format: int64
minimum: 0
type: integer
required:
- isUpsizeEnabled
CapacityBin:
description: 'Total and remaining CPU and memory capacity for each capacity bucket.
'
properties:
capacityIndex:
description: 'Zero-based index for the corresponding capacity bucket.
'
format: int32
maximum: 24
minimum: 0
type: integer
remainingMemoryInGBs:
description: 'The remaining memory of the capacity bucket, in GBs.
'
format: float
minimum: 0.0
type: number
remainingOcpus:
description: 'The available OCPUs of the capacity bucket.
'
format: float
minimum: 0.0
type: number
supportedShapes:
description: 'List of VMI shapes supported on each capacity bucket.
'
items:
type: string
maxItems: 25
minItems: 1
type: array
totalMemoryInGBs:
description: 'The total memory of the capacity bucket, in GBs.
'
format: float
minimum: 0.0
type: number
totalOcpus:
description: 'The total OCPUs of the capacity bucket.
'
format: float
minimum: 0.0
type: number
required:
- capacityIndex
- totalOcpus
- remainingOcpus
- totalMemoryInGBs
- remainingMemoryInGBs
- supportedShapes
ShapePlatformConfigOptions:
description: 'The list of supported platform configuration options for this shape.
'
properties:
accessControlServiceOptions:
$ref: '#/components/schemas/ShapeAccessControlServiceEnabledPlatformOptions'
inputOutputMemoryManagementUnitOptions:
$ref: '#/components/schemas/ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions'
measuredBootOptions:
$ref: '#/components/schemas/ShapeMeasuredBootOptions'
memoryEncryptionOptions:
$ref: '#/components/schemas/ShapeMemoryEncryptionOptions'
numaNodesPerSocketPlatformOptions:
$ref: '#/components/schemas/ShapeNumaNodesPerSocketPlatformOptions'
percentageOfCoresEnabledOptions:
$ref: '#/components/schemas/PercentageOfCoresEnabledOptions'
secureBootOptions:
$ref: '#/components/schemas/ShapeSecureBootOptions'
symmetricMultiThreadingOptions:
$ref: '#/components/schemas/ShapeSymmetricMultiThreadingEnabledPlatformOptions'
trustedPlatformModuleOptions:
$ref: '#/components/schemas/ShapeTrustedPlatformModuleOptions'
type:
description: 'The type of platform being configured.
'
enum:
- AMD_MILAN_BM
- AMD_MILAN_BM_GPU
- AMD_ROME_BM
- AMD_ROME_BM_GPU
- GENERIC_BM
- INTEL_ICELAKE_BM
- INTEL_SKYLAKE_BM
- AMD_VM
- INTEL_VM
type: string
virtualInstructionsOptions:
$ref: '#/components/schemas/ShapeVirtualInstructionsEnabledPlatformOptions'
Device:
description: Device Path corresponding to the block devices attached to instances having a name and isAvailable flag.
properties:
isAvailable:
description: The flag denoting whether device is available.
type: boolean
name:
description: The device name.
maxLength: 100
minLength: 3
type: string
required:
- name
- isAvailable
responses:
DefaultError:
description: An error has occurred.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
data-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the resource.
'
type: string
displayName:
description: 'A user-friendly name. Does not have to be unique, and it''s changeable.
Avoid entering confidential information.
'
maxLength: 255
minLength: 1
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
lifecycle-state:
description: The IpInventory API current state.
enum:
- IN_PROGRESS
- DONE
type: string
location:
description: 'Location of the resource.
'
type: string
opc-next-page:
description: 'For list pagination. When this header appears in the response, additional pages
of results remain. For important details about how pagination works, see
[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
'
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
type: string
opc-total-items:
description: 'For list pagination. A pagination token to get the total number of results available.
'
type: integer
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest)
with this ID to track the status of the request.
'
type: string
x-platform-config-properties:
amdNumaNodesPerSocketNps1:
default: NPS1
description: 'The number of NUMA nodes per socket (NPS).
'
enum:
- NPS0
- NPS1
- NPS2
- NPS4
- NPS6
type: string
amdNumaNodesPerSocketNps4:
default: NPS4
description: 'The number of NUMA nodes per socket (NPS).
'
enum:
- NPS0
- NPS1
- NPS2
- NPS4
- NPS6
type: string
areVirtualInstructionsEnabledFalse:
default: false
description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes
or VT-x for Intel shapes.
'
type: boolean
areVirtualInstructionsEnabledTrue:
default: true
description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes
or VT-x for Intel shapes.
'
type: boolean
configMap:
additionalProperties:
type: string
description: 'Instance Platform Configuration Configuration Map for flexible setting input.
'
type: object
definedTagsFilter:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Filter based on these defined tags. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
'
type: object
imageVolumeIndex:
description: 'When launching from a Compute Image, it is possible for more than one volume to be defined in the Image definition.
If the relative index of one of these volumes is provided in this field, then the provided createVolumeDetails
descriptor will be utilized to modify the default creation/attachment parameters for this volume rather than the
defaults.
If this field is provided, then CreateVolumeDetails must be specified.
'
minimum: 1
type: integer
x-default-description: 'null'
intelNumaNodesPerSocketNps1:
default: NPS1
description: 'The number of NUMA nodes per socket (NPS).
'
enum:
- NPS1
- NPS2
type: string
isAccessControlServiceEnabledFalse:
default: false
description: 'Whether the Access Control Service is enabled on the instance. When enabled,
the platform can enforce PCIe device isolation, required for VFIO device pass-through.
'
type: boolean
isAccessControlServiceEnabledTrue:
default: true
description: 'Whether the Access Control Service is enabled on the instance. When enabled,
the platform can enforce PCIe device isolation, required for VFIO device pass-through.
'
type: boolean
isInputOutputMemoryManagementUnitEnabledFalse:
default: false
description: 'Whether the input-output memory management unit is enabled.
'
type: boolean
isInputOutputMemoryManagementUnitEnabledTrue:
default: true
description: 'Whether the input-output memory management unit is enabled.
'
type: boolean
isSymmetricMultiThreadingEnabledTrue:
default: true
description: 'Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also
called simultaneous multithreading (SMT) or Intel Hyper-Threading.
Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple
independent threads of execution, to better use the resources and increase the efficiency
of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which
can provide higher or more predictable performance for some workloads.
'
type: boolean
percentageOfCoresEnabled:
default: 100
description: 'The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage
results in a fractional number of cores, the system rounds up the number of cores across processors
and provisions an instance with a whole number of cores.
If the applications that you run on the instance use a core-based licensing model and need fewer cores
than the full size of the shape, you can disable cores to reduce your licensing costs. The instance
itself is billed for the full shape, regardless of whether all cores are enabled.
'
maximum: 100
minimum: 25
multipleOf: 25
type: integer
x-properties:
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
freeformTags:
additionalProperties:
type: string
description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Department": "Finance"}`
'
type: object
recycleLevel:
description: 'Preferred recycle level for hosts associated with the reservation config.
* `SKIP_RECYCLE` - Skips host wipe.
* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.
'
enum:
- SKIP_RECYCLE
- FULL_RECYCLE
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'The value of the tag.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces).
'
type: object
description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels
for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm)
(ZPR) policy to control access to ZPR-supported resources.
Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`
'
type: object
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.
Example: `{"bar-key": "value"}`
'
type: object
description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.
Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }`
'
type: object
x-network-ip-lifetime-default-properties:
lifetime:
default: EPHEMERAL
description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n"
enum:
- EPHEMERAL
- RESERVED
type: string
x-network-ip-lifetime-properties:
lifetime:
description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n"
enum:
- EPHEMERAL
- RESERVED
type: string
x-network-ip-state-properties:
ipState:
description: 'State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE.
'
enum:
- ASSIGNED
- AVAILABLE
type: string
x-obmcs-client-circuit-breaker-table:
dummy:
enabled: false
x-obmcs-client-retries-table:
blockStorage:
enabled: true
c3:
enabled: true
pnp:
enabled: true
x-route-table-id-properties:
routeTableId:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see
[Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing).
'
maxLength: 255
minLength: 0
type: string