openapi: 3.2.0 info: description: 'API for Data Infrastructure Cloud@Customer Service. Use this API to manage Data Infrastructure VM clusters, Application VMs, and related resources. ' title: Data Infrastructure Cloud@Customer Service Datainfracc API version: '20251101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/f72685a7fe34bb274be4a3363ddba0f481a7a588bfc8b903268a9edd61af4295.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Infrastructure Cloud@Customer Service 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/f72685a7fe34bb274be4a3363ddba0f481a7a588bfc8b903268a9edd61af4295.yaml what: the harvested document for Data Infrastructure Cloud@Customer Service API servers: - url: http://127.0.0.1/20251101 - url: https://127.0.0.1/20251101 tags: - name: datainfracc paths: /infrastructures: get: description: 'Obtain a list of Data Infrastructures. ' operationId: ListInfrastructures parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/InfrastructureLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of Data Infrastructures. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/InfrastructureCollection' 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/default' summary: Obtain a list of Data Infrastructures. tags: - datainfracc x-obmcs-cli-action: list x-related-resource: '#/definitions/InfrastructureSummary' post: description: 'Create a Data Infrastructure using the specified details. ' operationId: CreateInfrastructure parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully accepted the request to create a Data Infrastructure. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Infrastructure' 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/default' summary: Create a Data Infrastructure. tags: - datainfracc requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInfrastructureDetails' description: New Data Infrastructure details. required: true /infrastructures/{infrastructureId}: delete: description: 'Delete the Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete. ' operationId: DeleteInfrastructure parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsForceDeleteInfrastructureQueryParam' responses: 202: description: Request Accepted. The virtual machine is being deleted. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string 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/default' summary: Delete the Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/Infrastructure' get: description: 'Obtain the Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: GetInfrastructure parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Data Infrastructure details. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Infrastructure' 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/default' summary: Obtain the Data Infrastructure. tags: - datainfracc put: description: 'Update the Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: UpdateInfrastructure parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The Data Infrastructure is being updated. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Infrastructure' 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/default' summary: Update the Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/Infrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateInfrastructureDetails' description: The updated Data Infrastructure details. required: true /infrastructures/{infrastructureId}/actions/activate: post: description: 'Activate an Data Infrastructure using the specified details. ' operationId: ActivateInfrastructure parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully accepted the request to activate an Data Infrastructure. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Infrastructure' 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/default' summary: Activate Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/Infrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateInfrastructureDetails' description: The activation details for the Data Infrastructure. required: true /infrastructures/{infrastructureId}/actions/changeCompartment: post: description: 'Change the Data Infrastructure Cloud@Customer Compartment to the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ChangeInfrastructureCompartment parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted. The compartment details are being changed. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Change the compartment for the specified Data Infrastructure Cloud@Customer. tags: - datainfracc x-related-resource: '#/definitions/Infrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeInfrastructureCompartmentDetails' description: Updated Compartment details. required: true /infrastructures/{infrastructureId}/actions/downloadConfigFile: get: description: Downloads the configuration file for the specified Data Infrastructure Cloud@Customer. operationId: DownloadInfrastructureConfigFile parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The configuration file for the specified Data Infrastructure Cloud@Customer. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string last-modified: description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 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/default' summary: Downloads the configuration file for the specified Data Infrastructure Cloud@Customer. tags: - datainfracc x-obmcs-cli-action: download-config-file x-related-resource: '#/definitions/Infrastructure' /infrastructures/{infrastructureId}/actions/downloadValidationScript: get: description: Downloads the validation script for the specified Data Infrastructure Cloud@Customer. operationId: DownloadInfrastructureValidationScript parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The validation script for the specified Data Infrastructure Cloud@Customer. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string last-modified: description: The date and time the configuration file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 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/default' summary: Downloads the validation script for the specified Data Infrastructure Cloud@Customer. tags: - datainfracc x-obmcs-cli-action: download-validation-script x-related-resource: '#/definitions/Infrastructure' /infrastructures/{infrastructureId}/actions/scaleStorage: post: description: 'Scale storage for the specified infrastructure using the specified details. ' operationId: ScaleInfrastructureStorage parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request to scale infrastructure storage. headers: location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Scale storage for the given infrastructure. tags: - datainfracc x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Infrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScaleInfrastructureStorageDetails' description: The scale storage details for the Data Infrastructure. required: true /infrastructures/{infrastructureId}/actions/validate: post: description: 'Validate an Data Infrastructure using the specified details. ' operationId: ValidateInfrastructure parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully accepted the request to validate a Data Infrastructure. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Infrastructure' 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/default' summary: Validate Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/Infrastructure' requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateInfrastructureDetails' description: The validation details for the Data Infrastructure. required: true /infrastructures/{infrastructureId}/scaleOptions: get: description: 'Get the available scale options for the infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: GetInfrastructureScaleOption parameters: - $ref: '#/components/parameters/InfrastructureIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The available scale options for the infrastructure. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/InfrastructureScaleOption' 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/default' summary: Get the available scale options for the infrastructure. tags: - datainfracc /maintenanceExecutions: get: description: 'Gets a list of the maintenance executions in the specified compartment. ' operationId: ListMaintenanceExecutions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/optionalDataInfrastructureIdQueryParam' - $ref: '#/components/parameters/MaintenanceRunIdQueryParam' - $ref: '#/components/parameters/MaintenanceRunLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalMaintenanceRunTypeQueryParam' - $ref: '#/components/parameters/TimeAcceptedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeAcceptedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TypeQueryParam' - $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 executions. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceExecutionCollection' 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/default' summary: Obtain a list of maintenance executions. tags: - datainfracc x-related-resource: '#/definitions/MaintenanceExecution' /maintenanceExecutions/{maintenanceExecutionId}: get: description: Gets information about the specified [OCID](/Content/General/Concepts/identifiers.htm). operationId: GetMaintenanceExecution parameters: - $ref: '#/components/parameters/maintenanceExecutionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Information about the specified maintenance run. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceExecution' 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/default' summary: Obtain the maintenance execution. tags: - datainfracc /maintenanceRuns: get: description: 'Gets a list of the maintenance runs in the specified compartment. ' operationId: ListMaintenanceRuns parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/optionalDataInfrastructureIdQueryParam' - $ref: '#/components/parameters/MaintenanceRunLifecycleStateQueryParam' - $ref: '#/components/parameters/OptionalMaintenanceRunTypeQueryParam' - $ref: '#/components/parameters/TimeAcceptedLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeAcceptedGreaterThanOrEqualToQueryParam' - $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 runs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceRunCollection' 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/default' summary: Obtain a list of maintenance runs. tags: - datainfracc x-related-resource: '#/definitions/MaintenanceRun' /maintenanceRuns/{maintenanceRunId}: get: description: Gets information about the specified [OCID](/Content/General/Concepts/identifiers.htm). operationId: GetMaintenanceRun parameters: - $ref: '#/components/parameters/maintenanceRunIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Information about the specified maintenance run. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceRun' 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/default' summary: Obtain the maintenance run. tags: - datainfracc put: description: 'Update maintenance run attributes. ' operationId: UpdateMaintenanceRun parameters: - $ref: '#/components/parameters/maintenanceRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The maintenance run is being updated. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceRun' 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/default' summary: Update maintenance run attributes. tags: - datainfracc x-related-resource: '#/definitions/MaintenanceRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMaintenanceRunDetails' description: The updated maintenance run details. required: true /maintenanceRuns/{maintenanceRunId}/actions/reschedule: post: description: 'Reschedules the specified maintenance run by providing a new `timeScheduled` value. Only maintenance runs in SCHEDULED state may be rescheduled. ' operationId: RescheduleMaintenanceRun parameters: - $ref: '#/components/parameters/maintenanceRunIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request to reschedule the maintenance run has been accepted. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MaintenanceRun' 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/default' summary: Reschedule a maintenance run. tags: - datainfracc x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/MaintenanceRun' requestBody: content: application/json: schema: $ref: '#/components/schemas/RescheduleMaintenanceRunDetails' description: The new scheduled time for the maintenance run. required: true /vmClusterNetworks: get: description: 'Obtain a list of VM cluster networks on Data Infrastructure. ' operationId: ListVmClusterNetworks parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/VmClusterNetworkLifecycleStateQueryParam' - $ref: '#/components/parameters/IsScanEnabledParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/InfrastructureIdQueryParam' - $ref: '#/components/parameters/VmClusterNetworkNodeCountQueryParam' - $ref: '#/components/parameters/VmNetworkConsumerTypeQueryParam' responses: 200: description: List of VM cluster networks. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetworkCollection' 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/default' summary: Obtain a list of VM cluster networks on Data Infrastructure. tags: - datainfracc x-obmcs-cli-action: list x-related-resource: '#/definitions/VmClusterNetworkSummary' post: description: 'Create a VM cluster network on Data Infrastructure using the specified details. ' operationId: CreateVmClusterNetwork parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully accepted the request to create a VM cluster. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 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/default' summary: Create a VM cluster network on Data Infrastructure. tags: - datainfracc requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVmClusterNetworkDetails' description: New VM cluster network details. required: true /vmClusterNetworks/actions/generateRecommendedVmClusterNetwork: post: description: 'Generates a VM cluster network configuration using the specified details. ' operationId: GenerateRecommendedVmClusterNetwork parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 201: description: Successfully accepted the request to create a VM cluster network configuration. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CreateVmClusterNetworkDetails' 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/default' summary: Generates a recommended VM cluster network configuration. tags: - datainfracc x-related-resource: '#/definitions/VmClusterNetwork' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateRecommendedVmClusterNetworkDetails' description: Request to generate a recommended VM cluster network details configuration. required: true /vmClusterNetworks/{vmClusterNetworkId}: delete: description: 'Delete the VM cluster network on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete. ' operationId: DeleteVmClusterNetwork parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The virtual machine network is being deleted. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string 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/default' summary: Delete the VM cluster network on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmClusterNetwork' get: description: 'Obtain the VM cluster network on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: GetVmClusterNetwork parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VM cluster network details. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 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/default' summary: Obtain the VM cluster network on Data Infrastructure. tags: - datainfracc put: description: 'Update the VM cluster network on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: UpdateVmClusterNetwork parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The virtual machine cluster network is being updated. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmClusterNetwork' 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/default' summary: Update the VM cluster network on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmClusterNetwork' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVmClusterNetworkDetails' description: The updated VM cluster details. required: true /vmClusterNetworks/{vmClusterNetworkId}/actions/changeCompartment: post: description: 'Change the VM cluster network Compartment to the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ChangeVmClusterNetworkCompartment parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The compartment details are being changed. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Change the compartment for the VM cluster network on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmClusterNetwork' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVmClusterNetworkCompartmentDetails' description: Updated Compartment details. required: true /vmClusterNetworks/{vmClusterNetworkId}/actions/downloadValidationScript: get: description: Download the validation script for the specified VM network. operationId: GetVmClusterNetworkActionDownloadValidationScript parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The validation script for the specified VM network. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string last-modified: description: The date and time the validation file was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 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/default' summary: Download the validation script for the specified VM network. tags: - datainfracc x-obmcs-cli-action: download-validation-script x-related-resource: '#/definitions/VmClusterNetwork' /vmClusterNetworks/{vmClusterNetworkId}/actions/validateVmClusterNetwork: post: description: 'Validates a VM cluster network on Data Infrastructure. ' operationId: ValidateVmClusterNetwork parameters: - $ref: '#/components/parameters/VmClusterNetworkIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Successfully accepted the request to validate a VM cluster network. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Validates a recommended VM cluster network on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmClusterNetwork' /vmInstances: get: description: 'Obtain a list of VM instances. ' operationId: ListVmInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/VmInstanceLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/InfrastructureIdQueryParam' - $ref: '#/components/parameters/BaseServerIdQueryParam' responses: 200: description: List of VM instances. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmInstanceCollection' 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/default' summary: Obtain a list of VM instances. tags: - datainfracc x-obmcs-cli-action: list x-related-resource: '#/definitions/VmInstanceSummary' post: description: 'Create a VM instance on Data Infrastructure using the specified details. ' operationId: CreateVmInstance parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Successfully accepted the request to create a VM instance. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmInstance' 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/default' summary: Create a VM instance on Data Infrastructure. tags: - datainfracc requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVmInstanceDetails' description: New VM instance details. required: true /vmInstances/{vmInstanceId}: delete: description: 'Delete the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). It must be called once the resource usage is complete. ' operationId: DeleteVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The instance is being deleted. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string 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/default' summary: Delete the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' get: description: 'Obtain the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: GetVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VM instance details. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmInstance' 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/default' summary: Obtain the VM instance on Data Infrastructure. tags: - datainfracc put: description: 'Update the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: UpdateVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The VM instance is being updated. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string location: description: 'The full URI of the resource. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VmInstance' 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/default' summary: Update the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVmInstanceDetails' description: The updated VM instance details. required: true /vmInstances/{vmInstanceId}/actions/changeCompartment: post: description: 'Change the VM instance on Data Infrastructure Compartment to the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ChangeVmInstanceCompartment parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The compartment details are being changed. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Change the compartment for VM instance. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVmInstanceCompartmentDetails' description: Updated Compartment details. required: true /vmInstances/{vmInstanceId}/actions/migrate: post: description: 'Migrate the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: MigrateVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request accepted. The VM instance is being migrated. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Migrate the VM instance on Data Infrastructure to other node. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' /vmInstances/{vmInstanceId}/actions/restart: post: description: 'Restart the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: RestartVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The VM instance is being restarted. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Restart the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' /vmInstances/{vmInstanceId}/actions/scale: post: description: 'Scale the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ScaleVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The VM instance is being scaled. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Scale the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScaleVmInstanceDetails' description: Scale the VM instance. required: true /vmInstances/{vmInstanceId}/actions/start: post: description: 'Start the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: StartVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The VM instance is being started. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Start the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' /vmInstances/{vmInstanceId}/actions/stop: post: description: 'Stop the VM instance on Data Infrastructure that has the specified [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: StopVmInstance parameters: - $ref: '#/components/parameters/VmInstanceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request Accepted. The VM instance is being stopped. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' 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/default' summary: Stop the VM instance on Data Infrastructure. tags: - datainfracc x-related-resource: '#/definitions/VmInstance' /workRequests: get: description: 'View a list of work request details in the specified compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A page of work request details. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 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/default' summary: Get a list of work request details. tags: - datainfracc x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Get the status of the work request having the specified work request [OCID](/Content/General/Concepts/identifiers.htm). operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request details. headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string retry-after: description: An integer representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 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/default' summary: Get the status of a work request. tags: - datainfracc x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'View the list of errors for the work request that have the specified work request [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A page of work request error details. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 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/default' summary: Get errors for a work request. tags: - datainfracc x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'View the log entries for the work request that have the specified work request [OCID](/Content/General/Concepts/identifiers.htm). ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: A page of work request log entries. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' schema: type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 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/default' summary: Get logs for a work request. tags: - datainfracc x-obmcs-cli-action: list x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: MaintenanceRun: description: 'Details of a maintenance run. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each server update operation. Supported values are 15 to 120 minutes. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Description of the maintenance run. type: string displayName: description: The user-friendly name for the maintenance run. type: string effectiveMaintenanceMethod: description: 'The maintenance method ultimately applied to the maintenance run. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' estimatedMaintenanceTimeInMins: description: 'The estimated end-to-end maintenance duration (minutes). ' type: integer freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure on which the maintenance run execution occurs. type: string isCustomActionTimeoutEnabled: description: Whether a custom action timeout (waiting period) is configured for the server update operations. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the maintenance run. ' enum: - CREATING - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED - PARTIAL_SUCCESS type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunLifecycleState' maintenanceRunType: description: Maintenance run type. enum: - QUARTERLY - PLANNED - MANDATORY - SECURITY_MONTHLY type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunTypeEnum' preferredMaintenanceMethod: description: 'The maintenance method preference for the maintenance run, as selected by the user. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' sourceVersion: description: The Oracle Data Infrastructure version from which the maintenance is performed. 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object targetVersion: description: The Data Infrastructure version that will be applied as the outcome of the maintenance operation. type: string timeEnded: description: The date and time the maintenance run was completed. format: date-time type: string timeScheduled: description: The date and time the maintenance run is scheduled to occur. format: date-time type: string timeStarted: description: The date and time the maintenance run starts. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeScheduled type: object Error: description: Error details. properties: code: description: A short error code that defines the error, which is used for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateVmClusterNetworkDetails: description: 'Details for a VM cluster network. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. example: Sample-update-vm-cluster-network maxLength: 255 minLength: 1 type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. example: - 192.0.2.22 - 192.0.2.23 - 192.0.2.24 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object listenerPort: description: The listener TCP/IP port. example: 1520 maximum: 8999 minimum: 1024 type: integer listenerPortSsl: description: The listener TCP/IP SSL port. Default is 2484. maximum: 8999 minimum: 1024 type: integer ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. example: - 192.0.2.25 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' maxItems: 3 type: array vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array ScanDetails: description: 'The Single Client Access Name (SCAN) details. ' properties: hostname: description: The SCAN hostname. example: scan-host maxLength: 255 minLength: 1 type: string ips: description: The list of SCAN IP addresses. Three addresses should be provided. example: - 192.0.2.12 - 192.0.2.14 - 192.0.2.13 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array required: - hostname - ips UpdateVmInstanceDetails: description: Updated VM instance details. properties: dataStorageSizeInGBs: description: Data storage to be allocated in GBs. format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: VM instance description. example: Test Update Application VM maxLength: 400 minLength: 1 type: string displayName: description: 'VM instance display name. This name does not have to be unique, and is changeable. ' example: Sample-update-app-vm maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object type: object InfrastructureCollection: description: A collection of Data Infrastructure resources. properties: items: description: A list of Data Infrastructure resources. items: $ref: '#/components/schemas/InfrastructureSummary' type: array required: - items type: object InfrastructureSummary: description: 'Data Infrastructure resource summary. ' properties: acfsFileSystemStorageInGbs: description: 'The amount of storage (in GB) in the DATA disk group that is reserved for creating local storage for VM Clusters and application VMs. ' format: double type: number acfsFileSystemUsedStorageInGbs: description: 'The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. This attribute is deprecated and will be removed in a subsequent release. Please read from systemStorageCapacity instead. ' format: double type: number adminNetworkcidr: description: The CIDR block for the system network. The system network is a private network in Data Infrastructure and is not connected to your corporate network. The system network is used for storage (ASM) traffic, high-performance interconnect traffic and administration of infrastructure components. type: string backupNetworkBondingInterface: description: The network bonding interface for backup network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' backupNetworkBondingMode: description: The network bonding mode for Backup networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' clientNetworkBondingInterface: description: The network bonding interface for client network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' clientNetworkBondingMode: description: The network bonding mode for Client networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' cloudControlPlaneServer1: description: The IP address for the first control plane server. type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. ' type: string computeCapacity: $ref: '#/components/schemas/ComputeCapacityDetails' contacts: description: The list of contacts for the Data Infrastructure. items: $ref: '#/components/schemas/InfrastructureContact' type: array corporateProxy: description: 'The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. ' type: string cpsNetworkBondingInterface: description: The network bonding interface for CPS network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' cpsNetworkBondingMode: description: The network bonding mode for CPS networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Data Infrastructure description. type: string displayName: description: 'The user-friendly name for the Data Infrastructure. The name does not need to be unique. ' type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object gateway: description: The gateway for the control plane network. type: string id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. ' type: string lifecycleState: description: The current state of the Data Infrastructure. enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - REQUIRES_ACTIVATION - ACTIVATING - ACTIVE - UPDATING - DELETING - DELETED - DISCONNECTED - MAINTENANCE_IN_PROGRESS - REQUIRES_MAINTENANCE type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureLifecycleState' lifecycleStateDetails: description: Lifecycle state details of the Data Infrastructure. type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' netmask: description: The netmask for the control plane network. type: string ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: type: string type: array shape: description: 'The shape of the Data Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' ssdConfigurationRequested: description: SSD configuration requested for the infrastructure. enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' storageCapacity: description: 'Capacity details of the Storage disk group. This attribute is deprecated and will be removed in a subsequent release. Please use systemStorageCapacity instead. ' items: $ref: '#/components/schemas/StorageCapacityDetails' type: array subscriptionPlanNumber: description: The unique identifier for the subscription plan number. maxLength: 255 minLength: 1 type: string systemModel: description: 'Data Infrastructure System Model specification. The system model determines the model of the Data Infrastructure hardware to be used. ' enum: - X11_HA_768 - X10_HA_512 - X8_HA_384 type: string x-obmcs-top-level-enum: '#/definitions/SystemModelEnum' systemStorageCapacity: $ref: '#/components/schemas/SystemStorageCapacityDetails' 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeActivated: description: 'The time, in RFC3339 format, when the Data Infrastructure was activated. ' format: date-time type: string timeCreated: description: 'The time that the Data Infrastructure cluster was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeLastStateUpdated: description: 'The time, in RFC3339 format, when the lifecycle state was last updated. ' format: date-time type: string timeUpdated: description: 'The time that the Data Infrastructure was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string timeValidated: description: 'The time, in RFC3339 format, when the Data Infrastructure network was validated. ' format: date-time type: string version: description: 'The version of the system software on the Data Infrastructure. ' type: string required: - id - compartmentId - displayName - systemModel - shape - cloudControlPlaneServer1 - cloudControlPlaneServer2 - netmask - gateway - adminNetworkcidr - dnsServers - ntpServers type: object InfoVmNetworkDetails: description: 'Details of the client or backup networks in a VM cluster. ' properties: domainName: description: The network domain name. example: us.oracle.com maxLength: 255 minLength: 1 type: string gateway: description: The network gateway. example: 192.0.2.18 maxLength: 255 minLength: 1 type: string netmask: description: The network netmask. example: 192.0.2.17 maxLength: 255 minLength: 1 type: string networkType: description: The network type. enum: - CLIENT - BACKUP example: CLIENT type: string x-obmcs-top-level-enum: '#/definitions/VmClusterNetworkType' prefix: description: The network domain name prefix. example: Test maxLength: 255 minLength: 1 type: string startingIp: description: Starting ip address of the virtual machines. example: 192.0.2.19 maxLength: 255 minLength: 1 type: string vlanId: description: The network VLAN ID. example: 100 type: string required: - networkType - domainName - netmask - gateway DiskGroupCapacityDetails: description: Capacity details of the storage disk group. properties: freeSpaceInGbs: description: The total amount of logical disk space that is currently available for use, in gigabytes (GB). format: double type: number reservedSpaceInGbs: description: The total amount of logical disk space that is reserved for system use, in gigabytes (GB). format: double type: number storageType: description: The storage type for the Cloud Data Infrastructure. type: string totalSpaceInGbs: description: The total amount of logical disk space available, in gigabytes (GB). format: double type: number type: object ShapeEnum: description: Model Shapes for Data Infrastructure. enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string VmInstance: description: VM instance details. properties: bootStorageSizeInGBs: description: Boot storage memory to be allocated in GBs. format: double type: number compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM instance. ' type: string cpusEnabled: description: The number of CPU cores enabled for each VM instance. type: integer dataStorageSizeInGBs: description: Data storage to be allocated in GBs. format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: VM instance description. type: string displayName: description: 'VM instance display name. This name does not have to be unique, and is changeable. ' type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: type: string type: array domainName: description: The domain name of the VM instance. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object gateway: description: The gateway IP address of the VM instance network. maxLength: 255 minLength: 1 type: string hostname: description: The host name of the instance. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance. type: string imageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM custom instance uploaded. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. type: string ipAddress: description: The IP address of the instance. maxLength: 255 type: string isHaEnabled: description: Indicates whether high availability is enabled for the VM instance. type: boolean lifecycleDetails: description: Lifecycle state details of the VM instance. type: string lifecycleState: description: The current state of the VM instance. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmInstanceLifecycleState' memorySizeInGBs: description: The memory to be allocated in GBs. format: double type: number metadata: additionalProperties: type: string description: 'Custom metadata key/value pairs which can be used to: - Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks. - Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration. ' type: object netmask: description: The netmask of the VM instance network. maxLength: 255 minLength: 1 type: string ntpServers: description: The list of NTP server addresses. Maximum of 3 allowed. items: type: string type: array serverId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compute node on which VM instance should be launched. type: string sshPublicKeys: description: List of public key used for SSH access to the VM instance. items: type: string type: array 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeCreated: description: 'The time that the VM instance was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time that the VM instance was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string timeZone: description: The time zone to use for the VM instance. type: string userdata: description: "Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. \nFor information about how to take advantage of user data, see the [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).\n" type: string vlanId: description: The network VLAN ID. type: string vmNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Network. type: string required: - id - compartmentId - lifecycleState - cpusEnabled - sshPublicKeys - timeCreated - timeUpdated - timeZone - infrastructureId type: object VmClusterNetwork: description: 'Details of the VM cluster network on Data Infrastructure. ' properties: associatedResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated resource. type: string baseVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM cluster. type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM cluster network. ' type: string consumerType: description: Consumer type for the VM cluster network. enum: - INSTANCE - CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/VmNetworkConsumerType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. type: string isScanEnabled: description: 'Indicates whether Single Client Access Name (SCAN) is enabled on the VM cluster. ' type: boolean lifecycleDetails: description: Lifecycle state details of the VM cluster network. type: string lifecycleState: description: The current state of the virtual machine cluster network. enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmClusterNetworkLifecycleState' listenerPort: description: The listener TCP/IP port. maximum: 8999 minimum: 1024 type: integer listenerPortSsl: description: The listener TCP/IP SSL port. maximum: 8999 minimum: 1024 type: integer nodeCount: description: Count of virtual machines in this VM cluster. type: integer ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: type: string type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' type: array 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeCreated: description: 'The time that the VM cluster network was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time that the VM cluster network was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array required: - id - compartmentId - displayName - infrastructureId - scans - vmNetworks CreateVmInstanceDetails: description: Create VM instance details. properties: bootStorageSizeInGBs: description: Boot storage memory to be allocated in GBs. example: 100 format: double minimum: 50 type: number compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM instance. ' example: ocid.compartment.oc1.. maxLength: 255 minLength: 1 type: string cpusEnabled: description: The number of CPU cores enabled for each VM instance. example: 2 minimum: 1 type: integer dataStorageSizeInGBs: description: Data storage to be allocated in GBs. example: 100 format: double minimum: 1 type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: VM instance description. example: Test Create Application VM maxLength: 400 type: string displayName: description: 'VM instance display name. This name does not have to be unique, and is changeable. ' example: Sample-app-vm maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object imageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM custom instance uploaded. maxLength: 255 minLength: 1 type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. example: ocid.baseinfrastructure.oc1.iad. maxLength: 255 minLength: 1 type: string isHaEnabled: default: true description: 'If true, high availability is enabled for the VM instance. If false, high availability is not enabled for the VM instance. ' example: true type: boolean memorySizeInGBs: description: The memory to be allocated in GBs. example: 8 format: double type: number metadata: additionalProperties: type: string description: 'Custom metadata key/value pairs which can be used to: - Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks. - Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration. ' type: object serverId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compute node on which VM instance should be launched. example: ocid.baseserver.oc1.iad. maxLength: 255 minLength: 1 type: string sshPublicKeys: description: List of public key used for SSH access to the VM instance. example: - '-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQE...\n...\n-----END PUBLIC KEY-----' items: maxLength: 1024 minLength: 1 type: string type: array 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeZone: description: The time zone to use for the VM instance. example: UTC type: string userdata: description: "Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. \nFor information about how to take advantage of user data, see the [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).\n" type: string vmNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Network. example: ocid.basevmclusternetwork.oc1.iad. maxLength: 255 minLength: 1 type: string required: - compartmentId - cpusEnabled - infrastructureId - sshPublicKeys RescheduleMaintenanceRunDetails: description: Request parameters for rescheduling a maintenance run. properties: reason: description: The reason for rescheduling the maintenance run. example: '' type: string timeScheduled: description: The new date and time for the scheduled maintenance run. example: '2025-09-10T18:00:00.000Z' format: date-time type: string required: - timeScheduled type: object Infrastructure: description: 'Details about Data Infrastructure resource. ' properties: acfsFileSystemStorageInGbs: description: 'The amount of storage (in GB) in the DATA disk group that is reserved for creating local storage for VM Clusters and application VMs. ' format: double type: number acfsFileSystemUsedStorageInGbs: description: 'The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. This attribute is deprecated and will be removed in a subsequent release. Please read from systemStorageCapacity instead. ' format: double type: number adminNetworkcidr: description: The CIDR block for the system network. The system network is a private network in Data Infrastructure and is not connected to your corporate network. The system network is used for storage (ASM) traffic, high-performance interconnect traffic and administration of infrastructure components. type: string backupNetworkBondingInterface: description: The network bonding interface for backup network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' backupNetworkBondingMode: description: The network bonding mode for Backup networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' clientNetworkBondingInterface: description: The network bonding interface for client network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' clientNetworkBondingMode: description: The network bonding mode for Client networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' cloudControlPlaneServer1: description: The IP address for the first control plane server. type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. ' type: string computeCapacity: $ref: '#/components/schemas/ComputeCapacityDetails' contacts: description: The list of contacts for the Data Infrastructure. items: $ref: '#/components/schemas/InfrastructureContact' type: array corporateProxy: description: 'The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. ' type: string cpsNetworkBondingInterface: description: The network bonding interface for CPS network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' cpsNetworkBondingMode: description: The network bonding mode for CPS networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' dataDiskPercentage: description: Percentage of disk space assigned for DATA disk group. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Data Infrastructure description. type: string displayName: description: 'The user-friendly name for the Data Infrastructure. The name does not need to be unique. ' type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object gateway: description: The gateway for the control plane network. type: string id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. ' type: string lifecycleState: description: The current state of the Data Infrastructure. enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - REQUIRES_ACTIVATION - ACTIVATING - ACTIVE - UPDATING - DELETING - DELETED - DISCONNECTED - MAINTENANCE_IN_PROGRESS - REQUIRES_MAINTENANCE type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureLifecycleState' lifecycleStateDetails: description: Lifecycle state details of the Data Infrastructure. type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' netmask: description: The netmask for the control plane network. type: string networkAdapterConfiguration: description: 'The network adapter, transceiver and cable configuration for the client and backup networks. ' type: string ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: type: string type: array rackSerialNumber: description: The serial number for the Data Infrastructure. type: string recoDiskPercentage: description: Percentage of disk space assigned for RECO disk group. type: integer servers: description: A list of Data Infrastructure nodes. items: $ref: '#/components/schemas/InfrastructureServer' type: array shape: description: 'The shape of the Data Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' ssdConfigurationRequested: description: SSD configuration requested for the infrastructure. enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' storageCapacity: description: 'Capacity details of the Storage disk group. This attribute is deprecated and will be removed in a subsequent release. Please use systemStorageCapacity instead. ' items: $ref: '#/components/schemas/StorageCapacityDetails' type: array subscriptionPlanNumber: description: The unique identifier for the subscription plan number. maxLength: 255 minLength: 1 type: string systemModel: description: 'Data Infrastructure System Model specification. The system model determines the model of the Data Infrastructure hardware to be used. ' enum: - X11_HA_768 - X10_HA_512 - X8_HA_384 type: string x-obmcs-top-level-enum: '#/definitions/SystemModelEnum' systemStorageCapacity: $ref: '#/components/schemas/SystemStorageCapacityDetails' 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeActivated: description: 'The time, in RFC3339 format, when the Data Infrastructure was activated. ' format: date-time type: string timeCreated: description: 'The time that the Data Infrastructure cluster was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeLastStateUpdated: description: 'The time, in RFC3339 format, when the lifecycle state was last updated. ' format: date-time type: string timeUpdated: description: 'The time that the Data Infrastructure was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string timeValidated: description: 'The time, in RFC3339 format, when the Data Infrastructure network was validated. ' format: date-time type: string version: description: 'The version of the system software on the Data Infrastructure. ' type: string vlanId: description: The CPS network VLAN ID. type: string required: - id - compartmentId - displayName - systemModel - shape - cloudControlPlaneServer1 - cloudControlPlaneServer2 - netmask - gateway - adminNetworkcidr - dnsServers - ntpServers type: object ScaleInfrastructureStorageDetails: description: The scale option to be selected for the infrastructure. properties: ssdConfigurationRequested: description: The scale option to be selected for the infrastructure. enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time that the log message was written. An RFC3339 formatted datetime string. format: date-time type: string required: - message - timestamp InfrastructureContact: description: Contact details for Data Infrastructure. properties: email: description: The email for the Data Infrastructure contact. example: john.smith@example.com maxLength: 255 minLength: 1 type: string isContactMosValidated: description: 'If `true`, this Data Infrastructure contact is a valid My Oracle Support (MOS) contact. If `false`, this Data Infrastructure contact is not a valid MOS contact. ' example: true type: boolean isPrimary: description: 'If `true`, this Data Infrastructure contact is a primary contact. If `false`, this Data Infrastructure is a secondary contact. ' example: true type: boolean name: description: The name of the Data Infrastructure contact. example: John Smith maxLength: 255 minLength: 1 type: string phoneNumber: description: The phone number for the Data Infrastructure contact. example: 1-630-678-3456 maxLength: 255 type: string required: - name - email - isPrimary GenerateRecommendedVmClusterNetworkDetails: description: 'Generates a recommended VM cluster network configuration for VM cluster. ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM cluster network. ' example: ocid.compartment.oc1.. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. example: sample-rec-vm-net-details type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. example: - 192.0.2.26 - 192.0.2.28 - 192.0.2.27 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. example: ocid.baseinfrastructure.oc1.iad. maxLength: 255 minLength: 1 type: string listenerPort: description: The listener TCP/IP port. example: 1520 maximum: 8999 minimum: 1024 type: integer listenerPortSsl: description: The listener TCP/IP SSL port. Default is 2484. maximum: 8999 minimum: 1024 type: integer nodeCount: default: 2 description: Count of virtual machines in this VM cluster. example: 2 maximum: 2 minimum: 1 type: integer ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. example: - 192.0.2.29 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/InfoVmNetworkDetails' type: array required: - compartmentId - infrastructureId - displayName - vmNetworks AcfsCapacityDetails: description: The amount of storage (in GB) in the DATA disk group that is currently utilized for creating local storage for VM Clusters and application VMs. properties: freeSpaceInGbs: description: The total amount of logical disk space that is currently available for use, in gigabytes (GB). format: double type: number totalSpaceInGbs: description: The total amount of logical disk space available, in gigabytes (GB). format: double type: number type: object VmClusterNetworkSummary: description: 'Summary of the VM cluster network on Data Infrastructure. ' properties: associatedResourceId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated resource. type: string baseVmClusterId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated VM cluster. type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM cluster network. ' type: string consumerType: description: Consumer type for the VM cluster network. enum: - INSTANCE - CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/VmNetworkConsumerType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. items: type: string type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. type: string isScanEnabled: description: 'Indicates whether Single Client Access Name (SCAN) is enabled on the VM cluster. ' type: boolean lifecycleDetails: description: Lifecycle state details of the VM cluster network. type: string lifecycleState: description: The current state of the virtual machine cluster network. enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmClusterNetworkLifecycleState' listenerPort: description: The listener TCP/IP port. maximum: 8999 minimum: 1024 type: integer listenerPortSsl: description: The listener TCP/IP SSL port. maximum: 8999 minimum: 1024 type: integer nodeCount: description: Count of virtual machines in this VM cluster. type: integer ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. items: type: string type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' type: array 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeCreated: description: 'The time that the VM cluster network was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time that the VM cluster network was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array required: - id - compartmentId - displayName - infrastructureId - scans - vmNetworks WorkRequest: description: Work request details. properties: compartmentId: description: '[OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. type: string opcRequestId: description: opc-request-id of the request that triggered the work request. type: string operationType: description: Type of the work request. enum: - CREATE_INSTANCE - DELETE_INSTANCE - UPDATE_INSTANCE - CHANGE_INSTANCE_COMPARTMENT - CREATE_INSTANCE_CONSOLE_CONNECTION - DELETE_INSTANCE_CONSOLE_CONNECTION - CREATE_BASE_VM_CLUSTER_NETWORK - DELETE_BASE_VM_CLUSTER_NETWORK - VALIDATE_BASE_VM_CLUSTER_NETWORK - UPDATE_BASE_VM_CLUSTER_NETWORK - CHANGE_BASE_VM_CLUSTER_NETWORK_COMPARTMENT - START_BASE_VM - STOP_BASE_VM - START_INSTANCE - STOP_INSTANCE - SCALE_INSTANCE - RESTART_INSTANCE - RESTART_BASE_VM - MIGRATE_INSTANCE - SCALE_BASE_VM - UPDATE_SOFTWARE_IMAGE - CHANGE_SOFTWARE_IMAGE_COMPARTMENT - VALIDATE_PROXY - CREATE_BASE_INFRA_CAPACITY - UPDATE_BASE_INFRA_CAPACITY - DELETE_BASE_INFRA_CAPACITY - ACTIVATE_BASE_INFRASTRUCTURE - CREATE_BASE_INFRASTRUCTURE - DELETE_BASE_INFRASTRUCTURE - UPDATE_BASE_INFRASTRUCTURE - UPDATE_BASE_INFRASTRUCTURE_SOFTWARE - VALIDATE_BASE_INFRASTRUCTURE - CHANGE_BASE_INFRASTRUCTURE_COMPARTMENT - ANALYZE_INFRASTRUCTURE - ANALYZE_BASE_INFRA_NETWORK - INFRASTRUCTURE_SRE_VALIDATION - CREATE_MAINTENANCE_RUN - UPDATE_MAINTENANCE_RUN - RESCHEDULE_MAINTENANCE_RUN - INFRASTRUCTURE_SCALE_STORAGE type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED - WAITING type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeAccepted: description: 'The date and time that the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time that the request completed, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time that the request started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CreateVmClusterNetworkDetails: description: 'Details for a VM cluster network. ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM cluster network. ' example: ocid.compartment.oc1.. maxLength: 255 minLength: 1 type: string consumerType: description: Consumer type for the VM cluster network. enum: - INSTANCE - CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/VmNetworkConsumerType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: The user-friendly name for the VM cluster network. The name does not need to be unique. example: Sample-vm-cluster-network maxLength: 255 minLength: 1 type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. example: - 192.0.2.8 - 192.0.2.9 - 192.0.2.10 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. example: ocid.baseinfrastructure.oc1.iad. maxLength: 255 minLength: 1 type: string listenerPort: default: 1521 description: The listener TCP/IP port. example: 1520 maximum: 8999 minimum: 1024 type: integer listenerPortSsl: description: The listener TCP/IP SSL port. Default is 2484. maximum: 8999 minimum: 1024 type: integer nodeCount: default: 2 description: Count of virtual machines in this VM cluster. example: 2 maximum: 2 minimum: 1 type: integer ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. example: - 192.0.2.11 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array scans: description: The SCAN details. items: $ref: '#/components/schemas/ScanDetails' maxItems: 3 type: array vmNetworks: description: Details of the client and backup networks. items: $ref: '#/components/schemas/VmNetworkDetails' type: array required: - compartmentId - displayName - infrastructureId - vmNetworks SystemStorageCapacityDetails: description: Capacity details of different storage types. properties: acfs: $ref: '#/components/schemas/AcfsCapacityDetails' diskGroups: description: List of storage disk group capacity details. items: $ref: '#/components/schemas/DiskGroupCapacityDetails' type: array type: object WorkRequestCollection: description: A collection of Work request resources. properties: items: description: A list of Work request resources. items: $ref: '#/components/schemas/WorkRequest' type: array required: - items type: object MaintenanceExecutionSummary: description: 'Summary of a maintenance executions. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Description of the maintenance run execution. type: string displayName: description: The user-friendly name for the maintenance run execution. type: string effectiveMaintenanceMethod: description: 'The maintenance method ultimately applied to the maintenance run. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run execution. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure on which the maintenance run execution occurred. type: string lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The state of the maintenance run execution. ' enum: - CREATING - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED - PARTIAL_SUCCESS type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunLifecycleState' maintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run to which this maintenance execution belongs. type: string maintenanceRunType: description: Maintenance run execution type. enum: - QUARTERLY - PLANNED - MANDATORY - SECURITY_MONTHLY type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunTypeEnum' sourceVersion: description: The Oracle Data Infrastructure version from which the maintenance is performed. 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object targetVersion: description: The Data Infrastructure version that will be applied as the outcome of the maintenance operation. type: string timeEnded: description: The date and time the maintenance run was completed. format: date-time type: string timeScheduled: description: The date and time the maintenance run is scheduled to occur. format: date-time type: string timeStarted: description: The date and time the maintenance run starts. format: date-time type: string workRequestId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request executed by this execution. type: string required: - id - displayName - lifecycleState type: object ChangeInfrastructureCompartmentDetails: description: Updated compartment details. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the Data Infrastructure Cloud@Customer is moving. example: ocid.compartment.oc1.. maxLength: 255 type: string required: - compartmentId type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource. When work is complete, the state transitions to CREATED, UPDATED, or DELETED. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - FAILED - RELATED - CANCELED_CREATE - CANCELED_UPDATE - CANCELED_DELETE type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The type of resource being acted on by the work request. type: string entityUri: description: The URI path for GET REST attachment to the resource metadata. type: string identifier: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource being acted on by the work request. type: string required: - actionType - entityType - identifier StorageCapacityDetails: description: Capacity details of the Storage disk group. properties: diskGroup: description: Disk group name. type: string logicalFreeSpaceInGBs: description: The total amount of logical disk space that is currently available for use in a disk group, in gigabytes (GB). format: int64 type: integer phyFreeSpaceInGBs: description: The total amount of physical disk space that is currently available for use in a disk group, in gigabytes (GB). format: int64 type: integer phyReservedSpaceInGBs: description: The total amount of physical disk space that is reserved for system use in a disk group, in gigabytes (GB). format: int64 type: integer phyTotalSpaceInGBs: description: The total amount of physical disk space available in a disk group, in gigabytes (GB). format: int64 type: integer storageDiskRedundancy: description: The Disk redundancy for Data Infrastructure storage. enum: - HIGH - MIRROR - FLEX type: string x-obmcs-top-level-enum: '#/definitions/StorageDiskRedundancy' type: object MaintenanceRunSummary: description: 'Summary of a maintenance run. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each server update operation. Supported values are 15 to 120 minutes. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Description of the maintenance run. type: string displayName: description: The user-friendly name for the maintenance run. type: string effectiveMaintenanceMethod: description: 'The maintenance method ultimately applied to the maintenance run. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' estimatedMaintenanceTimeInMins: description: 'The estimated end-to-end maintenance duration (minutes). ' type: integer freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure on which the maintenance run execution occurs. type: string isCustomActionTimeoutEnabled: description: Whether a custom action timeout (waiting period) is configured for the server update operations. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The current state of the maintenance run. ' enum: - CREATING - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED - PARTIAL_SUCCESS type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunLifecycleState' maintenanceRunType: description: Maintenance run type. enum: - QUARTERLY - PLANNED - MANDATORY - SECURITY_MONTHLY type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunTypeEnum' preferredMaintenanceMethod: description: 'The maintenance method preference for the maintenance run, as selected by the user. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' sourceVersion: description: The Oracle Data Infrastructure version from which the maintenance is performed. 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object targetVersion: description: The Data Infrastructure version that will be applied as the outcome of the maintenance operation. type: string timeEnded: description: The date and time the maintenance run was completed. format: date-time type: string timeScheduled: description: The date and time the maintenance run is scheduled to occur. format: date-time type: string timeStarted: description: The date and time the maintenance run starts. format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeScheduled type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: A human-readable description of the issue encountered. type: string timestamp: description: The time that the error occured. An RFC3339 standard formatted datetime string. format: date-time type: string required: - code - message - timestamp InfrastructureServer: description: Data Infrastructure Server details. properties: baseVmCount: description: Number of database virtual machines hosted on the server. type: integer computeCapacity: $ref: '#/components/schemas/ComputeCapacityDetails' id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Data Server of Infrastructure. type: string ilomIpAddress: description: Data Infrastructure Server ILOM IP address. type: string ilomName: description: Data Infrastructure Server ILOM name. type: string instanceVmCount: description: Number of instances hosted on the server. type: integer lifecycleState: description: The current state of the Data Infrastructure server. enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - REQUIRES_ACTIVATION - ACTIVATING - ACTIVE - UPDATING - DELETING - DELETED - DISCONNECTED - MAINTENANCE_IN_PROGRESS - REQUIRES_MAINTENANCE type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureServerLifecycleState' serverIpAddress: description: Data Infrastructure Server IP address. type: string serverName: description: Data Infrastructure Server name. type: string required: - id - serverName - serverIpAddress - ilomName - ilomIpAddress - lifecycleState VmClusterNetworkCollection: description: A collection of VM cluster network Data Infrastructure resources. properties: items: description: A list of VM cluster network resources. items: $ref: '#/components/schemas/VmClusterNetworkSummary' type: array required: - items type: object ActivateInfrastructureDetails: description: 'The activation details for the Data Infrastructure. ' properties: activationZipFile: description: The activation zip file. format: byte type: string required: - activationZipFile MaintenanceWindow: description: 'The scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window. ' properties: customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each Data Infrastructure server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ' example: 25 minimum: 15 type: integer daysOfWeek: description: Days during the week when maintenance should be performed. example: - MONDAY - THURSDAY - FRIDAY items: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string type: array uniqueItems: true isCustomActionTimeoutEnabled: description: If true, enables the configuration of a custom action timeout (waiting period) between Data Infrastructure server patching operations. example: true type: boolean patchingMode: default: NONROLLING description: 'Cloud Data Infrastructure node patching method. *IMPORTANT*: Non-rolling infrastructure patching involves system down time. See [Oracle-Managed Data Infrastructure Maintenance Updates](/iaas/Content/Database/Concepts/examaintenance.htm#Oracle) for more information. ' enum: - ROLLING - NONROLLING example: NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/BasePatchingMode' preference: default: NO_PREFERENCE description: The maintenance window scheduling preference. enum: - NO_PREFERENCE - CUSTOM_PREFERENCE example: NO_PREFERENCE type: string x-obmcs-top-level-enum: '#/definitions/MaintenancePreference' NodeDetails: description: Node details associated with a VM cluster network. properties: hostname: description: The node host name. example: sample-host maxLength: 255 minLength: 1 type: string ip: description: The node IP address. example: 192.0.2.20 maxLength: 255 minLength: 1 type: string vip: description: The node virtual IP (VIP) address. example: 192.0.2.21 maxLength: 255 minLength: 1 type: string vipHostname: description: The node virtual IP (VIP) host name. example: vip-host-name maxLength: 255 minLength: 1 type: string required: - hostname - ip ChangeVmClusterNetworkCompartmentDetails: description: Updated compartment details. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the VM cluster network is moving. example: ocid.compartment.oc1.. maxLength: 255 type: string required: - compartmentId type: object UpdateInfrastructureDetails: description: Request to update Data Infrastructure resource. properties: acfsFileSystemStorageInGbs: default: 4704 description: 'The amount of storage (in GB) in the DATA disk group that is reserved for creating local storage for VM Clusters and application VMs. ' example: 4704 format: double minimum: 225 type: number x-obmcs-cli-param: acfs-size-in-gbs adminNetworkcidr: description: The CIDR block for the system network. The system network is a private network in Data Infrastructure and is not connected to your corporate network. The system network is used for storage (ASM) traffic, high-performance interconnect traffic and administration of infrastructure components. example: 192.0.2.0/24 maxLength: 255 minLength: 1 type: string backupNetworkBondingInterface: description: The network bonding interface for backup network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: backup-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' backupNetworkBondingMode: description: The network bonding mode for Backup networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP example: LACP type: string x-obmcs-cli-param: backup-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' clientNetworkBondingInterface: description: The network bonding interface for client network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: client-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' clientNetworkBondingMode: description: The network bonding mode for Client networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP example: ACTIVE_BACKUP type: string x-obmcs-cli-param: client-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' cloudControlPlaneServer1: description: The IP address for the first control plane server. example: 192.0.2.37 maxLength: 255 minLength: 1 type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. example: 192.0.2.38 maxLength: 255 minLength: 1 type: string contacts: description: The list of contacts for the Data Infrastructure. items: $ref: '#/components/schemas/InfrastructureContact' maxItems: 10 minItems: 1 type: array corporateProxy: description: 'The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. ' example: http://192.0.2.45:8080 maxLength: 255 minLength: 1 type: string cpsNetworkBondingInterface: description: The network bonding interface for CPS network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: cps-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' cpsNetworkBondingMode: description: The network bonding mode for CPS networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-cli-param: cps-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' dataDiskPercentage: default: 80 description: Percentage of disk space assigned for DATA disk group. Remaining disk space will get assiged to RECO disk group example: 80 maximum: 90 minimum: 10 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Data Infrastructure description. example: Test Update Data Infrastructure maxLength: 255 minLength: 1 type: string displayName: description: 'The user-friendly name for the Data Infrastructure. The name does not need to be unique. ' example: Sample-update-data-infra maxLength: 255 minLength: 1 type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. example: - 192.0.2.41 - 192.0.2.42 - 192.0.2.43 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object gateway: description: The gateway for the control plane network. example: 192.0.2.40 maxLength: 255 minLength: 1 type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' netmask: description: The netmask for the control plane network. example: 192.0.2.39 maxLength: 255 minLength: 1 type: string ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. example: - 192.0.2.44 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array shape: description: 'The shape of the Data Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS example: SIX_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' systemModel: description: 'Data Infrastructure System Model specification. The system model determines the model of the Data Infrastructure hardware to be used. ' enum: - X11_HA_768 - X10_HA_512 - X8_HA_384 example: X11_HA_768 type: string x-obmcs-top-level-enum: '#/definitions/SystemModelEnum' vlanId: description: The CPS network VLAN ID. example: 100 type: string type: object MaintenanceExecutionCollection: description: A collection of maintenance run execution history. properties: items: description: A list of maintenance run execution history. items: $ref: '#/components/schemas/MaintenanceExecutionSummary' type: array required: - items type: object ComputeCapacityDetails: description: Capacity details of the Data Infrastructure. properties: allocatedCores: description: Total CPU cores count allocated.. type: integer availableCores: description: Total available CPU cores count. type: integer availableMemoryInGBs: description: Available memory, in gigabytes (GB). format: int64 type: integer reservedCores: description: Total Reserved CPU cores count. type: integer reservedMemoryInGBs: description: Reserved memory, in gigabytes (GB). format: int64 type: integer totalCores: description: Total CPU cores count. type: integer totalMemoryInGBs: description: Total memory allocated, in gigabytes (GB). format: int64 type: integer usedMemoryInGBs: description: Memory allocated to Oracle database virtual machine cluster or Instance, in gigabytes (GB). format: int64 type: integer type: object VmInstanceCollection: description: A collection of VM instance on Data Infrastructure summary resources. properties: items: description: A list of VM instance summary resources. items: $ref: '#/components/schemas/VmInstanceSummary' type: array required: - items type: object ChangeVmInstanceCompartmentDetails: description: Updated compartment details. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the VM instance is moving. example: ocid.compartment.oc1.. maxLength: 255 type: string required: - compartmentId type: object UpdateMaintenanceRunDetails: description: Request to update maintenance run resource. properties: customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each server update operation. Supported values are 15 to 120 minutes. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object isCustomActionTimeoutEnabled: description: If true, enables configuration of customActionTimeoutInMins for this maintenance run update request. type: boolean preferredMaintenanceMethod: description: 'The maintenance method ultimately applied to the maintenance run. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' required: - customActionTimeoutInMins type: object MaintenanceRunCollection: description: A collection of maintenance runs. properties: items: description: A list of maintenance runs. items: $ref: '#/components/schemas/MaintenanceRunSummary' type: array required: - items type: object WorkRequestErrorCollection: description: A collection of work request error resources. properties: items: description: A list of work request error resources. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ValidateInfrastructureDetails: description: 'The validation details for the Data Infrastructure. ' properties: validationZipFile: description: The validation zip file. format: byte type: string required: - validationZipFile InfrastructureScaleOption: description: The available scale options for the infrastructure. properties: possibleSsdConfigurations: description: The available scale options for the infrastructure. items: $ref: '#/components/schemas/ShapeEnum' type: array required: - possibleSsdConfigurations MaintenanceExecution: description: 'Details of a maintenance execution. ' properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string customActionTimeoutInMins: description: 'Determines the amount of time the system will wait before the start of each server update operation. Supported values are 15 to 120 minutes. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Description of the maintenance run execution. type: string displayName: description: The user-friendly name for the maintenance run execution. type: string effectiveMaintenanceMethod: description: 'The maintenance method ultimately applied to the maintenance run. ' enum: - ROLLING - NONROLLING type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceMethodEnum' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run execution. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure on which the maintenance run execution occurred. type: string isCustomActionTimeoutEnabled: description: At the time of execution whether the custom action time out is enabled for the maintenance run that is being executed. type: boolean lifecycleDetails: description: Additional information about the current lifecycle state. type: string lifecycleState: description: 'The state of the maintenance run execution. ' enum: - CREATING - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED - PARTIAL_SUCCESS type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunLifecycleState' maintenanceRunId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the maintenance run to which this maintenance execution belongs. type: string maintenanceRunType: description: Maintenance run execution type. enum: - QUARTERLY - PLANNED - MANDATORY - SECURITY_MONTHLY type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunTypeEnum' sourceVersion: description: The Oracle Data Infrastructure version from which the maintenance is performed. 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object targetVersion: description: The Data Infrastructure version that will be applied as the outcome of the maintenance operation. type: string timeEnded: description: The date and time the maintenance run was completed. format: date-time type: string timeScheduled: description: The date and time the maintenance run is scheduled to occur. format: date-time type: string timeStarted: description: The date and time the maintenance run starts. format: date-time type: string workRequestId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request executed by this execution. type: string required: - id - displayName - lifecycleState type: object CreateInfrastructureDetails: description: 'Request to create Data Infrastructure resource. ' properties: acfsFileSystemStorageInGbs: default: 4704 description: 'The amount of storage (in GB) in the DATA disk group that is reserved for creating local storage for VM Clusters and application VMs. ' example: 4704 format: double minimum: 225 type: number x-obmcs-cli-param: acfs-size-in-gbs adminNetworkcidr: description: The CIDR block for the system network. The system network is a private network in Data Infrastructure and is not connected to your corporate network. The system network is used for storage (ASM) traffic, high-performance interconnect traffic and administration of infrastructure components. example: 192.0.2.0/24 maxLength: 255 minLength: 1 type: string backupNetworkBondingInterface: default: BTBOND5 description: The network bonding interface for backup network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: backup-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' backupNetworkBondingMode: default: ACTIVE_BACKUP description: The network bonding mode for Backup networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP example: ACTIVE_BACKUP type: string x-obmcs-cli-param: backup-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' clientNetworkBondingInterface: default: BTBOND3 description: The network bonding interface for client network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: client-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' clientNetworkBondingMode: default: ACTIVE_BACKUP description: The network bonding mode for Client networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP example: LACP type: string x-obmcs-cli-param: client-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' cloudControlPlaneServer1: description: The IP address for the first control plane server. example: 192.0.2.28 maxLength: 255 minLength: 1 type: string cloudControlPlaneServer2: description: The IP address for the second control plane server. example: 192.0.2.29 maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. ' example: ocid.compartment.oc1.. maxLength: 255 minLength: 1 type: string contacts: description: The list of contacts for the Data Infrastructure. items: $ref: '#/components/schemas/InfrastructureContact' maxItems: 10 minItems: 1 type: array corporateProxy: description: 'The corporate network proxy for access to the control plane network. Oracle recommends using an HTTPS proxy when possible for enhanced security. ' example: http://192.0.2.36:8080 maxLength: 255 minLength: 1 type: string cpsNetworkBondingInterface: default: BTBOND1 description: The network bonding interface for CPS network for the Data Infrastructure. enum: - BTBOND1 - BTBOND2 - BTBOND3 - BTBOND4 - BTBOND5 - BTBOND6 type: string x-obmcs-cli-param: cps-bond-iface x-obmcs-top-level-enum: '#/definitions/NetworkBondingInterfaceEnum' cpsNetworkBondingMode: default: ACTIVE_BACKUP description: The network bonding mode for CPS networks for the Data Infrastructure. enum: - ACTIVE_BACKUP - LACP type: string x-obmcs-cli-param: cps-bond-mode x-obmcs-top-level-enum: '#/definitions/NetworkBondingMode' dataDiskPercentage: default: 80 description: Percentage of disk space assigned for DATA disk group. Remaining disk space will get assiged to RECO disk group example: 80 maximum: 90 minimum: 10 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: Data Infrastructure description. example: Test Create Data Infrastructure maxLength: 400 type: string displayName: description: 'The user-friendly name for the Data Infrastructure. The name does not need to be unique. ' example: Sample-data-infrastructure maxLength: 255 minLength: 1 type: string dnsServers: description: The list of DNS server IP addresses. Maximum of 3 allowed. example: - 192.0.2.32 - 192.0.2.33 - 192.0.2.34 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object gateway: description: The gateway for the control plane network. example: 192.0.2.31 maxLength: 255 minLength: 1 type: string maintenanceWindow: $ref: '#/components/schemas/MaintenanceWindow' netmask: description: The netmask for the control plane network. example: 192.0.2.30 maxLength: 255 minLength: 1 type: string ntpServers: description: The list of NTP server IP addresses. Maximum of 3 allowed. example: - 192.0.2.35 items: maxLength: 1024 minLength: 1 type: string maxItems: 3 type: array shape: description: 'The shape of the Data Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. ' enum: - SIX_SSDS - TWELVE_SSDS - EIGHTEEN_SSDS - TWENTY_FOUR_SSDS example: SIX_SSDS type: string x-obmcs-top-level-enum: '#/definitions/ShapeEnum' systemModel: description: 'Data Infrastructure System Model specification. The system model determines the model of the Data Infrastructure hardware to be used. ' enum: - X11_HA_768 - X10_HA_512 - X8_HA_384 example: X11_HA_768 type: string x-obmcs-top-level-enum: '#/definitions/SystemModelEnum' vlanId: description: The CPS network VLAN ID. example: 100 type: string required: - compartmentId - displayName - systemModel - shape - cloudControlPlaneServer1 - cloudControlPlaneServer2 - netmask - gateway - dnsServers - ntpServers VmInstanceSummary: description: VM instance on Data Infrastructure summary. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the VM instance. ' type: string cpusEnabled: description: The number of CPU cores enabled for each VM instance. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: VM instance description. type: string displayName: description: 'VM instance display name. This name does not have to be unique, and is changeable. ' type: string domainName: description: The domain name of the VM instance. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance. type: string imageId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM custom instance uploaded. type: string infrastructureId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. type: string isHaEnabled: description: Indicates whether high availability is enabled for the VM instance. type: boolean lifecycleDetails: description: Lifecycle state details of the VM instance. type: string lifecycleState: description: The current state of the VM instance. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmInstanceLifecycleState' memorySizeInGBs: description: The memory to be allocated in GBs. format: double type: number serverId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compute node on which VM instance should be launched. 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object timeCreated: description: 'The time that the VM instance was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time that the VM instance was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string timeZone: description: The time zone to use for the VM instance. type: string vmNetworkId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM Network. type: string required: - id - compartmentId - lifecycleState - cpusEnabled - timeCreated - timeUpdated - timeZone type: object VmNetworkDetails: description: 'Details of the client or backup networks in a VM cluster. ' properties: domainName: description: The network domain name. example: us.oracle.com maxLength: 255 minLength: 1 type: string gateway: description: The network gateway. example: 192.0.2.16 maxLength: 255 minLength: 1 type: string netmask: description: The network netmask. example: 192.0.2.15 maxLength: 255 minLength: 1 type: string networkType: description: The network type. enum: - CLIENT - BACKUP example: CLIENT type: string x-obmcs-top-level-enum: '#/definitions/VmClusterNetworkType' nodes: description: The list of node details. items: $ref: '#/components/schemas/NodeDetails' type: array prefix: description: The network domain name prefix. example: Test maxLength: 255 type: string vlanId: description: The network VLAN ID. example: 100 type: string required: - networkType - nodes - domainName - netmask - gateway WorkRequestLogEntryCollection: description: A collection of work request log entry resources. properties: items: description: A list of work request log entry resources. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object ScaleVmInstanceDetails: description: Scale the VM instance. properties: cpusEnabled: description: The number of CPU cores to be enabled for VM instance. example: 2 minimum: 1 type: integer memorySizeInGBs: description: The memory to be allocated in GBs. format: double type: number type: object parameters: 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 is updated or deleted only if the Etag that you provide matches the current Etag value for the resource. ' in: header name: if-match required: false schema: type: string IsScanEnabledParam: description: A filter to return VM cluster network resources that matches the specified value. in: query name: isScanEnabled required: false x-default-description: 'null' schema: type: boolean SortOrderQueryParam: description: The sort order that you want to use, which is either `ASC` or `DESC`. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC TimeAcceptedGreaterThanOrEqualToQueryParam: description: Filter maintenance run for after given time. in: query name: timeAcceptedGreaterThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time VmClusterNetworkIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster network. in: path name: vmClusterNetworkId required: true schema: type: string maintenanceRunIdPathParam: description: The maintenance run OCID. in: path name: maintenanceRunId required: true schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request identifier. in: header name: opc-request-id schema: type: string MaintenanceRunLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycle states. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - CREATING - SCHEDULED - IN_PROGRESS - SUCCEEDED - SKIPPED - FAILED - UPDATING - DELETING - DELETED - CANCELED - PARTIAL_SUCCESS type: string x-obmcs-top-level-enum: '#/definitions/MaintenanceRunLifecycleState' MaintenanceRunIdQueryParam: description: The maintenance run OCID. in: query name: maintenanceRunId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 SortByQueryParam: description: 'The field by which you want to sort. You can provide only one type of sort order. The default order for `timeCreated` is descending. The default order for `displayName` is ascending. If no value is specified, then `timeCreated` is the default. When listing software images within the same `version`, using `sortBy=buildIdentifier` is recommended. `buildIdentifier` is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName - buildIdentifier default: timeCreated optionalDataInfrastructureIdQueryParam: description: The Data Infrastructure ID. in: query name: infrastructureId required: false schema: type: string maxLength: 255 minLength: 1 VmNetworkConsumerTypeQueryParam: description: VM network consumer type. in: query name: vmNetworkConsumerType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/VmNetworkConsumerType' schema: type: string enum: - INSTANCE - CLUSTER WorkRequestIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string TypeQueryParam: description: The maintenance execution type. in: query name: type required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/TypeEnum' schema: type: string enum: - NOTIFY - EXECUTE DisplayNameQueryParam: description: A filter to return resources that match the entire display name given. The match is case sensitive. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 maintenanceExecutionIdPathParam: description: The maintenance execution OCID. in: path name: maintenanceExecutionId required: true schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: The page token representing the page at which you want to start retrieving results. This token is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request, so the request can be retried without risk of processing that same action again, in the event of a timeout or server error. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request can be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 BaseServerIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure Server Id. in: query name: baseServerId required: false x-default-description: 'null' schema: type: string InfrastructureIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. in: query name: infrastructureId required: false x-default-description: 'null' schema: type: string TimeAcceptedLessThanOrEqualToQueryParam: description: Filter maintenance run for before given time. in: query name: timeAcceptedLessThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time VmClusterNetworkLifecycleStateQueryParam: description: A filter to return resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - VALIDATED - VALIDATION_FAILED - UPDATING - ALLOCATED - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmClusterNetworkLifecycleState' CompartmentIdQueryParam: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller''s tenant and then treated as tenant scope (compartmentId filtering is not applied). ' in: query name: compartmentId required: true schema: type: string InfrastructureLifecycleStateQueryParam: description: A filter to return resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - CREATING - REQUIRES_VALIDATION - VALIDATING - REQUIRES_ACTIVATION - ACTIVATING - ACTIVE - UPDATING - DELETING - DELETED - DISCONNECTED - MAINTENANCE_IN_PROGRESS - REQUIRES_MAINTENANCE type: string x-obmcs-top-level-enum: '#/definitions/InfrastructureLifecycleState' VmClusterNetworkNodeCountQueryParam: description: Count of virtual machines in this VM cluster. in: query name: nodeCount required: false x-default-description: 'null' schema: type: integer VmInstanceIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VM instance. in: path name: vmInstanceId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return in a page. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 OptionalMaintenanceRunTypeQueryParam: description: The sub-type of the maintenance run. in: query name: maintenanceRunType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/MaintenanceRunTypeEnum' schema: type: string enum: - QUARTERLY - PLANNED - MANDATORY - SECURITY_MONTHLY ResourceIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request resource. in: query name: resourceId required: false x-default-description: 'null' schema: type: string IsForceDeleteInfrastructureQueryParam: description: "When set to `true`, infrastructure will be deleted even if it has dependent resources. \nIf set to `false`, deletion will fail if the infrastructure has dependent resources.\nDefault is `false`.\n" in: query name: isForceDeleteInfrastructure required: false x-obmcs-cli-param: is-force-delete schema: type: boolean default: false VmInstanceLifecycleStateQueryParam: description: A filter to return resources that match the specified lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED type: string x-obmcs-top-level-enum: '#/definitions/VmInstanceLifecycleState' InfrastructureIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Data Infrastructure. in: path name: infrastructureId required: true schema: type: string responses: default: description: Unknown Error. headers: opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For Optimistic concurrency control. See the `if-match`. ' type: string location: description: 'The full URI of the resource. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then it can mean that a partial list was returned. To obtain the next batch of items, include this value as the `page` parameter for your next GET request. ' type: string opc-request-id: description: 'Unique identifier assigned by Oracle for the request. If you need to contact Oracle about a particular request, then please provide the request ID. ' type: string opc-work-request-id: description: 'Unique identifier created by Oracle for the asynchronous request. You can use this identifier to query the status of the asynchronous operation. ' type: string retry-after: description: An integer representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tag keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value 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" } }` ' example: orcl-cloud: free-tier-retained: true type: object x-obmcs-client-circuit-breaker-enabled: true x-obmcs-client-retries-enabled: true