openapi: 3.2.0 info: description: Use the Batch Control Plane API to encapsulate and manage all aspects of computationally intensive jobs. title: Batch Batch Computing API version: '20251031' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/81faaa3b802ca82267267132f80a3fb6853cf757ead7ea176f37ace489308ef0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Batch 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/81faaa3b802ca82267267132f80a3fb6853cf757ead7ea176f37ace489308ef0.yaml what: the harvested document for Batch API servers: - url: http://127.0.0.1/20251031 - url: https://127.0.0.1/20251031 tags: - name: batchComputing paths: /batchContextShapes: get: description: Lists the shapes allowed to be specified during batch context creation. Ordered by the shape name. operationId: ListBatchContextShapes parameters: - $ref: '#/components/parameters/CompartmentIdRequiredQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ShapeTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of batch context shapes was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchContextShapeCollection' 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: Lists the list of batch context shapes. tags: - batchComputing x-related-resource: '#/definitions/BatchContextShapeCollection' /batchContexts: get: description: Lists the batch contexts by compartment or context [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchContext to get the full details on a specific context operationId: ListBatchContexts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchContextLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BatchContextIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchContextSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch contexts. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchContextCollection' 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: Gets the batch contexts. tags: - batchComputing x-related-resource: '#/definitions/BatchContextCollection' post: description: Creates a batch context. operationId: CreateBatchContext parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The batch context will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created batch context. The batch context OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchContext' 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: Creates a batch context. tags: - batchComputing x-related-resource: '#/definitions/BatchContext' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchContextDetails' description: Details for the new batch context. required: true /batchContexts/{batchContextId}: delete: description: Deletes a batch context. All batch job pools associated with the batch context must be deleted beforehand. operationId: DeleteBatchContext parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch context will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 204: description: No Content. The batch context has already been (softly) deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a batch context. tags: - batchComputing x-related-resource: '#/definitions/BatchContext' get: description: Gets information about a batch context. operationId: GetBatchContext parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch context was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchContext' 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: Gets a batch context. tags: - batchComputing put: description: Updates a batch context. operationId: UpdateBatchContext parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch context will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a batch context. tags: - batchComputing x-related-resource: '#/definitions/BatchContext' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBatchContextDetails' description: The information to be updated. required: true /batchContexts/{batchContextId}/actions/changeCompartment: post: description: Moves a batch context into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeBatchContextCompartment parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch context will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a batch context into a different compartment. tags: - batchComputing x-related-resource: '#/definitions/BatchContext' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBatchContextCompartmentDetails' description: The information to be updated. required: true /batchContexts/{batchContextId}/actions/start: post: description: Activates a batch context to accept new jobs. operationId: StartBatchContext parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch context will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Activates a batch context to accept new jobs. tags: - batchComputing x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/BatchContext' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartBatchContextDetails' description: Information needed to start the batch context. required: true /batchContexts/{batchContextId}/actions/stop: post: description: Stops a batch context from accepting new jobs. operationId: StopBatchContext parameters: - $ref: '#/components/parameters/BatchContextIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch context will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Stops a batch context from accepting new jobs. tags: - batchComputing x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/BatchContext' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopBatchContextDetails' description: Information needed to stop the batch context. required: true /batchJobPools: get: description: Lists the batch job pools by compartment or job pool [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context operationId: ListBatchJobPools parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchJobPoolLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BatchJobPoolIdentifierQueryParam' - $ref: '#/components/parameters/BatchContextIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchJobPoolSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch job pools. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobPoolCollection' 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: Lists the batch job pools. tags: - batchComputing x-related-resource: '#/definitions/BatchJobPoolCollection' post: description: Creates a batch job pool. operationId: CreateBatchJobPool parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch job pool was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobPool' 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: Creates a batch job pool. tags: - batchComputing x-related-resource: '#/definitions/BatchJobPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchJobPoolDetails' description: Details for the new batch job pool. required: true /batchJobPools/{batchJobPoolId}: delete: description: Deletes a batch job pool. All batch jobs associated with the batch job pool must be canceled beforehand. operationId: DeleteBatchJobPool parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: No Content. The batch job pool was (softly) deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a batch job pool. tags: - batchComputing x-related-resource: '#/definitions/BatchJobPool' get: description: Gets information about a batch job pool. operationId: GetBatchJobPool parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch job pool was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobPool' 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: Gets a batch job pool. tags: - batchComputing put: description: Updates a batch job pool. operationId: UpdateBatchJobPool parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job pool will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a batch job pool. tags: - batchComputing x-related-resource: '#/definitions/BatchJobPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBatchJobPoolDetails' description: The information to be updated. required: true /batchJobPools/{batchJobPoolId}/actions/changeCompartment: post: description: Moves a batch job pool into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeBatchJobPoolCompartment parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job pool will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a batch job pool into a different compartment. tags: - batchComputing x-related-resource: '#/definitions/BatchJobPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBatchJobPoolCompartmentDetails' description: The information to be updated. required: true /batchJobPools/{batchJobPoolId}/actions/start: post: description: Activates the batch job pool. operationId: StartBatchJobPool parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job pool will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Activates the batch job pool. tags: - batchComputing x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/BatchJobPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartBatchJobPoolDetails' description: Information needed to start the batch job pool. required: true /batchJobPools/{batchJobPoolId}/actions/stop: post: description: Deactivates the batch job pool. operationId: StopBatchJobPool parameters: - $ref: '#/components/parameters/BatchJobPoolIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job pool will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deactivates the batch job pool. tags: - batchComputing x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/BatchJobPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopBatchJobPoolDetails' description: Information needed to stop the batch job pool. required: true /batchJobs: get: description: Lists the batch jobs by compartment or job [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJob to get the full details on a specific context operationId: ListBatchJobs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchJobLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BatchJobIdentifierQueryParam' - $ref: '#/components/parameters/BatchJobPoolQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchJobSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch jobs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJobCollection' 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: Lists the list of batch jobs. tags: - batchComputing x-related-resource: '#/definitions/BatchJobCollection' post: description: Creates a batch job. operationId: CreateBatchJob parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The batch job will be created. headers: content-location: description: Same as location. schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URL for the created batch job. The batch job OCID is generated after this request is sent. schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJob' 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: Creates a batch job. tags: - batchComputing x-related-resource: '#/definitions/BatchJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchJobDetails' description: Details for the new batch job. required: true /batchJobs/tasks: get: description: Lists the batch tasks associated with batch jobs. operationId: ListBatchTasks parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchJobIdentifierExplicitQueryParam' - $ref: '#/components/parameters/BatchTaskLifecycleStateQueryParam' - $ref: '#/components/parameters/BatchTaskNameQueryParam' - $ref: '#/components/parameters/BatchTaskIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchTaskSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch tasks. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskCollection' 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: Lists the list of batch tasks. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskCollection' /batchJobs/{batchJobId}: delete: description: Cancels a batch job. operationId: CancelBatchJob parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job will be cancelled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 204: description: No Content. The batch job has already been cancelled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancels a batch job. tags: - batchComputing x-related-resource: '#/definitions/BatchJob' get: description: Gets information about a batch job. operationId: GetBatchJob parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch job was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchJob' 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: Gets a batch job. tags: - batchComputing put: description: Updates a batch job. operationId: UpdateBatchJob parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a batch job. tags: - batchComputing x-related-resource: '#/definitions/BatchJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBatchJobDetails' description: The information to be updated. required: true /batchJobs/{batchJobId}/actions/changeCompartment: post: description: Moves a batch job into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeBatchJobCompartment parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a batch job into a different compartment. tags: - batchComputing x-related-resource: '#/definitions/BatchJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBatchJobCompartmentDetails' description: The information to be updated. required: true /batchJobs/{batchJobId}/actions/pause: post: description: Pauses the batch job and all its tasks. operationId: PauseBatchJob parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job will be paused. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 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: Pauses the batch job and all its tasks. tags: - batchComputing x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/BatchJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/PauseBatchJobDetails' description: Information needed to pause the batch job. required: true /batchJobs/{batchJobId}/actions/unpause: post: description: Resumes the batch job and all its tasks. operationId: UnpauseBatchJob parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch job will be unpaused. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 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: Resumes the batch job and all its tasks. tags: - batchComputing x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/BatchJob' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnpauseBatchJobDetails' description: Information needed to unpause the batch job. required: true /batchJobs/{batchJobId}/tasks: get: description: 'Lists the batch tasks by batch job [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context List is incomplete until jobs lifecycle is in_progress' operationId: ListBatchJobTasks parameters: - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/BatchTaskLifecycleStateQueryParam' - $ref: '#/components/parameters/BatchTaskNameQueryParam' - $ref: '#/components/parameters/BatchTaskIdentifierQueryParam' - $ref: '#/components/parameters/BatchGroupTaskNameQueryParam' - $ref: '#/components/parameters/BatchTaskTypeQueryParam' - $ref: '#/components/parameters/BatchTaskHierarchyViewQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchTaskSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch tasks. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskCollection' 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: Lists the batch tasks by batch job. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskCollection' /batchJobs/{batchJobId}/tasks/{taskName}: get: description: Gets a specific batch task associated with a batch job by its name. operationId: GetBatchTask parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/BatchJobIdentifierPathParam' - $ref: '#/components/parameters/BatchTaskNamePathParam' responses: 200: description: The batch task was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTask' 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: Gets a specific batch task by its name. tags: - batchComputing x-related-resource: '#/definitions/BatchTask' /batchTaskEnvironments: get: description: Lists the task environments by compartment or environment [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskEnvironment to get the full details on a specific context operationId: ListBatchTaskEnvironments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchTaskEnvironmentLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BatchTaskEnvironmentIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchTaskEnvironmentSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch task environments. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskEnvironmentCollection' 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: Lists the task environments. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskEnvironmentCollection' post: description: Creates a batch task environment. operationId: CreateBatchTaskEnvironment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task environment was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskEnvironment' 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: Creates a batch task environment. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskEnvironment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchTaskEnvironmentDetails' description: Details for the new batch task environment. required: true /batchTaskEnvironments/{batchTaskEnvironmentId}: delete: description: Deletes a batch task environment. All batch tasks associated with the batch task environment must be canceled beforehand. operationId: DeleteBatchTaskEnvironment parameters: - $ref: '#/components/parameters/BatchTaskEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: No Content. The batch task environment was (softly) deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a batch task environment. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskEnvironment' get: description: Gets information about a batch task environment. operationId: GetBatchTaskEnvironment parameters: - $ref: '#/components/parameters/BatchTaskEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task environment was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskEnvironment' 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: Gets a batch task environment tags: - batchComputing put: description: Updates a batch task environment. operationId: UpdateBatchTaskEnvironment parameters: - $ref: '#/components/parameters/BatchTaskEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task environment was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskEnvironment' 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: Updates a batch task environment. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskEnvironment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBatchTaskEnvironmentDetails' description: The information to be updated. required: true /batchTaskEnvironments/{batchTaskEnvironmentId}/actions/changeCompartment: post: description: Moves a batch task environment into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeBatchTaskEnvironmentCompartment parameters: - $ref: '#/components/parameters/BatchTaskEnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch task environment will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a batch task environment into a different compartment. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskEnvironment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBatchTaskEnvironmentCompartmentDetails' description: The information to be updated. required: true /batchTaskProfiles: get: description: Lists the task profiles by compartment or profile [OCID](/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskProfile to get the full details on a specific context operationId: ListBatchTaskProfiles parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/BatchTaskProfileLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BatchTaskProfileIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/BatchTaskProfileSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of records summarizing batch task profiles. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskProfileCollection' 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: Lists the task profiles. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskProfileCollection' post: description: Creates a batch task profile. operationId: CreateBatchTaskProfile parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task profile was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskProfile' 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: Creates a batch task profile. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBatchTaskProfileDetails' description: Details for the new batch task profile. required: true /batchTaskProfiles/{batchTaskProfileId}: delete: description: Deletes a batch task profile. All batch tasks associated with the batch task profile must be canceled beforehand. operationId: DeleteBatchTaskProfile parameters: - $ref: '#/components/parameters/BatchTaskProfileIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: No Content. The batch task profile was (softly) deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a batch task profile. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskProfile' get: description: Gets information about a batch task profile. operationId: GetBatchTaskProfile parameters: - $ref: '#/components/parameters/BatchTaskProfileIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task profile was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskProfile' 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: Gets a batch task profile tags: - batchComputing put: description: Updates a batch task profile. operationId: UpdateBatchTaskProfile parameters: - $ref: '#/components/parameters/BatchTaskProfileIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The batch task profile was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/BatchTaskProfile' 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: Updates a batch task profile. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBatchTaskProfileDetails' description: The information to be updated. required: true /batchTaskProfiles/{batchTaskProfileId}/actions/changeCompartment: post: description: Moves a batch task profile into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). operationId: ChangeBatchTaskProfileCompartment parameters: - $ref: '#/components/parameters/BatchTaskProfileIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The batch task profile will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a batch task profile into a different compartment. tags: - batchComputing x-related-resource: '#/definitions/BatchTaskProfile' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBatchTaskProfileCompartmentDetails' description: The information to be updated. required: true /workRequests: get: description: Lists the work requests in a compartment. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work requests was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestSummaryCollection' 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: Lists the work requests. tags: - batchComputing x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets the details of a work request. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number 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: Gets the work request status. tags: - batchComputing x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: Lists the errors for a work request. operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors was retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/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: List the work request errors. tags: - batchComputing x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: Lists the logs for a work request. operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/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: List the work request logs. tags: - batchComputing x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: BatchJobPoolSummary: description: Summary information about a batch job pool. properties: batchContextId: description: The OCID of batch context. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch job pool. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the batch job pool. ' type: string x-obmcs-enumref: '#/definitions/BatchJobPool/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch job pool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch job pool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - batchContextId - displayName - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message StopBatchJobPoolDetails: description: Information needed to stop the batch job pool. type: object BatchJobCollection: description: Results of a batch job search. Contains both batch job summary items and other information, such as metadata. properties: items: description: List of batch jobs. items: $ref: '#/components/schemas/BatchJobSummary' type: array required: - items type: object WorkRequestSummaryCollection: description: A list of work requests. Can contain both work requests and other information, such as metadata. properties: items: description: A list of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UpdateBatchJobDetails: description: 'The data to update a batch job. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description that provides additional context next to the displayName. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Can''t be set to null. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object PauseBatchJobDetails: description: Information needed to pause the batch job. type: object BatchJobPool: description: 'A batch job pool represents an abstract group for jobs. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: batchContextId: description: The OCID of batch context. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch job pool. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the batch job pool. ' enum: - ACTIVE - INACTIVE - UPDATING - NEEDS_ATTENTION - DELETED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch job pool was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch job pool was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - batchContextId - displayName - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object StopBatchContextDetails: description: Information needed to stop the batch context. type: object BatchTaskProfileExtendedInformation: description: Extended information for the task profile. discriminator: propertyName: type properties: type: description: Type of extended information. enum: - CPU_ARCHITECTURE_TASK_PROFILE_EXTENDED_INFORMATION - CPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION - GPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION type: string required: - type WorkRequestSummary: description: Summary information about an asynchronous work request. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_BATCH_CONTEXT - UPDATE_BATCH_CONTEXT - DELETE_BATCH_CONTEXT - START_BATCH_CONTEXT - STOP_BATCH_CONTEXT - MOVE_BATCH_CONTEXT - CREATE_BATCH_JOB - UPDATE_BATCH_JOB - DELETE_BATCH_JOB - MOVE_BATCH_JOB - PAUSE_BATCH_JOB - UNPAUSE_BATCH_JOB - MOVE_BATCH_JOB_POOL - UPDATE_BATCH_JOB_POOL - START_BATCH_JOB_POOL - STOP_BATCH_JOB_POOL - MOVE_BATCH_TASK_ENVIRONMENT - MOVE_BATCH_TASK_PROFILE - INTERNAL type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted ShapeMemoryOptions: description: The amount of memory available for container instances that use this shape. properties: defaultPerOcpuInGBs: description: The default amount of memory per OCPU available for this shape (GB). format: float minimum: 0 type: number maxInGBs: description: The maximum amount of memory (GB). format: float minimum: 0 type: number maxPerOcpuInGBs: description: For a flexible shape, the maximum amount of memory per OCPU available for this shape (GB). format: float minimum: 0 type: number minInGBs: description: The minimum amount of memory (GB). format: float minimum: 0 type: number minPerOcpuInGBs: description: The minimum amount of memory per OCPU available for this shape (GB). format: float minimum: 0 type: number required: - defaultPerOcpuInGBs - maxInGBs - maxPerOcpuInGBs - minInGBs - minPerOcpuInGBs type: object JobPriorityConfiguration: description: Job priority configuration to instruct the service on how to use priority tags. example: tagKey: StudioPriority tagNamespace: PrioritizationTags values: HIGH: 5 LOW: 0 MED: 2 POSTPONE: -10 weight: 100 properties: tagKey: description: Name of the tag key. maxLength: 100 minLength: 1 type: string tagNamespace: description: Name of the corresponding tag namespace. maxLength: 100 minLength: 1 type: string values: additionalProperties: description: Priority value as an integer. type: integer description: Mapping of tag value to its priority. maxProperties: 10 minProperties: 1 type: object x-extra-annotations: '@jakarta.validation.constraints.Size(min = 1, max = 10)' weight: description: Weight associated with the tag key. Percentage point is the unit of measurement. example: 33 maximum: 100 minimum: -100 type: integer required: - tagNamespace - tagKey - weight - values type: object StartBatchContextDetails: description: Information needed to start the batch context. type: object BatchContextSummary: description: Summary information about a batch context. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch context. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: 'The current state of the batch context. ' type: string x-obmcs-enumref: '#/definitions/BatchContext/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch context was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch context was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object Network: description: Network configuration of the batch context. properties: nsgIds: description: 'A list of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups. ' items: maxLength: 255 minLength: 1 type: string maxItems: 10 type: array uniqueItems: true x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10) @io.micronaut.validation.annotation.UniqueElements' subnetId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of associated subnet. ' maxLength: 255 minLength: 1 type: string vnics: description: 'A list of private endpoint''s VNICs. ' items: $ref: '#/components/schemas/Vnic' maxItems: 10 type: array required: - subnetId - nsgIds - vnics type: object BatchTaskProfileSummary: description: Summary information about a batch task profile. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task profile description. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string extendedInformation: $ref: '#/components/schemas/BatchTaskProfileExtendedInformation' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile. type: string lifecycleState: description: 'The current state of the batch task profile. ' type: string x-obmcs-enumref: '#/definitions/BatchTaskProfile/lifecycleState' minMemoryInGBs: default: 0 description: The minimum required memory. minimum: 0 type: integer minOcpus: default: 0 description: The minimum required OCPUs. minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch task profile was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch task profile was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object BatchJob: description: 'A batch job represents the execution unit that is invoked on a batch''s pools of compute resources. A job is composed of one or more tasks, which are the executable commands. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: batchContextId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch context of the parent job pool. maxLength: 255 minLength: 1 type: string batchJobPoolId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description that provides additional context next to the displayName. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string environmentVariables: description: An environment variables to use for the job's tasks (can be overridden by task's environment variables). items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the batch job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: 'The current state of the batch job. ' enum: - ACCEPTED - WAITING - IN_PROGRESS - SUCCEEDED - NEEDS_ATTENTION - FAILED - CANCELING - CANCELED type: string priority: description: A value calculated by the system based on the priority tags. minimum: 0 type: integer progressDetails: description: A more detailed textual representation of the job completion. maxLength: 255 type: string progressPercentage: description: A percentage value (0..100) of the job completion. maximum: 100 minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - batchJobPoolId - batchContextId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags type: object BatchContextShapeSummary: description: Details about a shape for a container instance. properties: memoryOptions: $ref: '#/components/schemas/ShapeMemoryOptions' name: description: The name identifying the shape. maxLength: 255 minLength: 1 type: string networkingBandwidthOptions: $ref: '#/components/schemas/ShapeNetworkingBandwidthOptions' ocpuOptions: $ref: '#/components/schemas/ShapeOcpuOptions' processorDescription: description: A short description of the container instance's processor (CPU). maxLength: 255 minLength: 1 type: string required: - name - processorDescription type: object Fleet: description: Fleet configuration of the batch context. discriminator: propertyName: type properties: type: description: Type of the fleet. Also serves as a discriminator for sub-entities. enum: - SERVICE_MANAGED_FLEET - SERVICE_MANAGED_GPU_FLEET type: string required: - type type: object CreateBatchTaskProfileDetails: description: 'The data to create a batch task profile. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task profile description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskprofile20250914115623. ' maxLength: 255 type: string extendedInformation: $ref: '#/components/schemas/CreateBatchTaskProfileExtendedInformationDetails' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object minMemoryInGBs: default: 0 description: The minimum required memory. minimum: 0 type: integer minOcpus: default: 0 description: The minimum required OCPUs. minimum: 0 type: integer required: - compartmentId type: object BatchTaskEnvironmentCollection: description: Results of a batch task environment search. Contains both batch task environment summary items and other information, such as metadata. properties: items: description: List of batch task environments. items: $ref: '#/components/schemas/BatchTaskEnvironmentSummary' type: array required: - items type: object CreateBatchJobDetails: description: 'The data to create a batch job. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: batchJobPoolId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description that provides additional context next to the displayName. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it will be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchjob20250914115623. ' maxLength: 255 type: string environmentVariables: description: An environment variables to use for the job's tasks (can be overridden by task's environment variables). items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object tasks: description: 'A list of tasks to be executed within this job. Maximum number of tasks a job can have in total, across all nested levels, is 1000. ' items: $ref: '#/components/schemas/CreateBatchTaskDetails' maxItems: 1000 minItems: 1 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(min = 1, max = 1000)' required: - compartmentId - batchJobPoolId - tasks type: object UpdateBatchJobPoolDetails: description: 'The data to update a batch job pool. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch job pool. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Can''t be set to null. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object UpdateBatchTaskProfileDetails: description: 'The data to update a batch task profile. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task profile description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Can''t be set to null. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object BatchTaskProfile: description: 'A batch task profile resource describes the minimum hardware requirements requested for a task. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task profile description. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string extendedInformation: $ref: '#/components/schemas/BatchTaskProfileExtendedInformation' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile. type: string lifecycleState: description: 'The current state of the batch task profile. ' enum: - ACTIVE - DELETED type: string minMemoryInGBs: default: 0 description: The minimum required memory. minimum: 0 type: integer minOcpus: default: 0 description: The minimum required OCPUs. minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch task profile was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch task profile was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - minOcpus - minMemoryInGBs - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object BatchContextCollection: description: Results of a batch context search. Contains both batch context summary items and other information, such as metadata. properties: items: description: List of batch contexts. items: $ref: '#/components/schemas/BatchContextSummary' type: array required: - items type: object ShapeNetworkingBandwidthOptions: description: For a flexible shape, the amount of networking bandwidth available for container instances that use this shape. properties: defaultPerOcpuInGbps: description: The default amount of networking bandwidth per OCPU, in gigabits per second. format: float minimum: 0 type: number maxInGbps: description: The maximum amount of networking bandwidth, in gigabits per second. format: float minimum: 0 type: number minInGbps: description: The minimum amount of networking bandwidth, in gigabits per second. format: float minimum: 0 type: number required: - defaultPerOcpuInGbps - maxInGbps - minInGbps type: object CreateFleetDetails: description: Fleet configuration of the batch context. discriminator: propertyName: type properties: type: description: Type of the fleet. Also serves as a discriminator for sub-entities. enum: - SERVICE_MANAGED_FLEET - SERVICE_MANAGED_GPU_FLEET type: string required: - type type: object BatchTaskSummary: description: Summary information about a batch task. discriminator: propertyName: type properties: description: description: An optional description that provides additional context next to the displayName. maxLength: 255 type: string groupTaskName: description: The hierarchical name of the group task. Null for top-level tasks. type: string hierarchicalName: description: 'The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName' example: groupTaskA.nestedGroupTaskB.thisTaskName type: string id: description: The UUID of batch task. maxLength: 255 minLength: 1 type: string jobId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job to which this task belongs. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: The current state of the batch task. type: string x-obmcs-enumref: '#/definitions/BatchTask/lifecycleState' name: description: The name of the batch task. It must be unique within its parent batch job. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string type: description: Type of the batch task. Also serves as a discriminator for sub-entities. type: string x-obmcs-enumref: '#/definitions/BatchTask/type' required: - id - jobId - name - type BatchTaskEnvironment: description: 'A batch task environment resource defines the software that is used to execute tasks. It mainly contains a URL to a container image along with other configurations that are needed by the image. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task environment description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment. type: string imageUrl: description: The URL of the ocir image. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the batch task environment. ' enum: - ACTIVE - DELETED type: string securityContext: $ref: '#/components/schemas/SecurityContext' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch task environment was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch task environment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string volumes: description: 'List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output. ' items: $ref: '#/components/schemas/BatchTaskEnvironmentVolume' maxItems: 10 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10)' workingDirectory: description: Container's working directory. maxLength: 1024 minLength: 1 type: string required: - id - compartmentId - displayName - imageUrl - volumes - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object BatchTaskEnvironmentSummary: description: Summary information about a batch task environment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task environment description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment. type: string imageUrl: description: The URL of the ocir image. maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of the batch task environment. ' type: string x-obmcs-enumref: '#/definitions/BatchTaskEnvironment/lifecycleState' securityContext: $ref: '#/components/schemas/SecurityContext' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch task environment was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch task environment was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string workingDirectory: description: Container's working directory. maxLength: 1024 minLength: 1 type: string required: - id - compartmentId - displayName - imageUrl - lifecycleState - timeCreated - freeformTags - definedTags - systemTags type: object BatchTaskCollection: description: Results of a batch task search. Contains both batch task summary items and other information, such as metadata. properties: items: description: List of batch task summaries. items: $ref: '#/components/schemas/BatchTaskSummary' type: array required: - items type: object WorkRequestLogEntry: description: A log message from performing an operation that is tracked by a work request. properties: message: description: A human-readable log message. type: string timestamp: description: 'The date and time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - message - timestamp ChangeBatchTaskEnvironmentCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch task environment to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequest: description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation''s progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_BATCH_CONTEXT - UPDATE_BATCH_CONTEXT - DELETE_BATCH_CONTEXT - START_BATCH_CONTEXT - STOP_BATCH_CONTEXT - MOVE_BATCH_CONTEXT - CREATE_BATCH_JOB - UPDATE_BATCH_JOB - DELETE_BATCH_JOB - MOVE_BATCH_JOB - PAUSE_BATCH_JOB - UNPAUSE_BATCH_JOB - MOVE_BATCH_JOB_POOL - UPDATE_BATCH_JOB_POOL - START_BATCH_JOB_POOL - STOP_BATCH_JOB_POOL - MOVE_BATCH_TASK_ENVIRONMENT - MOVE_BATCH_TASK_PROFILE - INTERNAL type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work that must be performed. ' format: float type: number resources: description: The resources that are affected by the work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of the work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request was finished, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeUpdated: description: 'The date and time the work request was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CreateBatchTaskDetails: description: A batch task contains common properties for all types of job tasks. discriminator: propertyName: type properties: dependencies: description: A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' description: description: An optional description that provides additional context next to the displayName. maxLength: 255 type: string entitlementClaims: description: A list of resources (for example licences) this task needs for its execution. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' environmentVariables: description: Environment variables to use for the task execution. items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' name: description: The name of the batch task. It must be unique within its parent batch job. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string type: description: Type of the batch task. Also serves as a discriminator for sub-entities. enum: - COMPUTE - GROUP type: string required: - name - type type: object CreateBatchTaskEnvironmentDetails: description: 'The data to create a batch task environment. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task environment description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object imageUrl: description: The URL of the ocir image. maxLength: 255 minLength: 1 type: string securityContext: $ref: '#/components/schemas/SecurityContext' volumes: description: 'List of volumes attached to the image. The use cases of the volumes are but not limited to: read the input of the task and write the output. ' items: $ref: '#/components/schemas/BatchTaskEnvironmentVolume' maxItems: 10 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10)' workingDirectory: description: Container's working directory. maxLength: 1024 minLength: 1 type: string required: - compartmentId - imageUrl type: object CreateNetworkDetails: description: Network configuration of the batch context. properties: nsgIds: description: 'A list of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups. ' items: maxLength: 255 minLength: 1 type: string maxItems: 10 type: array uniqueItems: true x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10) @io.micronaut.validation.annotation.UniqueElements' subnetId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of associated subnet. ' maxLength: 255 minLength: 1 type: string required: - subnetId type: object ChangeBatchContextCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch context to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SecurityContext: description: 'Security context for container runtime configuration. See also [docs](https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/datatypes/LinuxSecurityContext). ' properties: fsGroup: description: A special supplemental group ID that applies to all containers in a pod. type: integer runAsGroup: description: Group ID for running processes inside the container. type: integer runAsUser: description: User ID for running processes inside the container. type: integer LoggingConfiguration: description: Logging configuration of the batch context. discriminator: propertyName: type properties: type: description: Type of the logging configuration. Discriminator for sub-entities. enum: - OCI_LOGGING type: string required: - type 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 operation 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, at which point it transitions to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that you can use for a GET request to access the resource metadata. type: string identifier: description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier Vnic: description: Private endpoint's VNIC. properties: id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint''s VNIC, which resides in the customer''s VCN. ' maxLength: 255 minLength: 1 type: string sourceIps: description: 'A list of private IP addresses (in the customer''s VCN) that represent access points for the service. ' items: maxLength: 46 minLength: 1 type: string maxItems: 10 type: array required: - id - sourceIps type: object StartBatchJobPoolDetails: description: Information needed to start the batch job pool. type: object BatchTask: description: A batch task contains common properties for all types of job tasks. discriminator: propertyName: type properties: dependencies: description: A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' description: description: An optional description that provides additional context next to the displayName. maxLength: 255 type: string entitlementClaims: description: A list of resources (for example licences) this task needs for its execution. items: maxLength: 255 minLength: 1 type: string maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' environmentVariables: description: Environment variables to use for the task execution. items: $ref: '#/components/schemas/EnvironmentVariable' maxItems: 100 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' groupTaskName: description: The hierarchical name of the group task. Null for top-level tasks. type: string hierarchicalName: description: 'The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName' example: groupTaskA.nestedGroupTaskB.thisTaskName type: string id: description: The UUID of batch task. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: The current state of the batch task. enum: - ACCEPTED - WAITING - IN_PROGRESS - SUCCEEDED - FAILED - CANCELING - CANCELED type: string name: description: The name of the batch task. It must be unique within its parent batch job. format: x-obmcs-ascii-identifier maxLength: 255 minLength: 1 pattern: ^[a-zA-Z_](-?[a-zA-Z_0-9])*$ type: string type: description: Type of the batch task. Also serves as a discriminator for sub-entities. enum: - COMPUTE - GROUP type: string required: - id - name - type - entitlementClaims - dependencies - environmentVariables WorkRequestError: description: An error encountered while performing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occurred. For a list of error codes, see [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string timestamp: description: 'The date and time the error occurred, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string required: - code - message - timestamp EnvironmentVariable: description: OS environment variable. properties: name: description: The name of the environment variable. maxLength: 255 minLength: 1 pattern: ^[-._a-zA-Z][-._a-zA-Z0-9]*$ type: string value: description: The value of the environment variable. maxLength: 2048 minLength: 1 type: string required: - name - value type: object CreateBatchJobPoolDetails: description: 'The data to create a batch job pool. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: batchContextId: description: The OCID of batch context. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch job pool. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchjobpool20250914115623. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - batchContextId type: object CreateBatchTaskProfileExtendedInformationDetails: description: Extended information for the task profile. discriminator: propertyName: type properties: type: description: Type of extended information. enum: - CPU_ARCHITECTURE_TASK_PROFILE_EXTENDED_INFORMATION - CPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION - GPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION type: string required: - type ChangeBatchJobCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateBatchContextDetails: description: 'The data to create a batch context. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch context. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. If not specified or provided as null or empty string, it will be generated as "", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchcontext20250914115623. ' maxLength: 255 type: string entitlements: additionalProperties: description: Value of the limit. minimum: 0 type: integer description: Mapping of concurrent/shared resources used in job tasks to their limits. maxProperties: 100 type: object x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' fleets: description: List of fleet configurations related to the batch context. items: $ref: '#/components/schemas/CreateFleetDetails' maxItems: 5 minItems: 1 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(min = 0, max = 5)' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobPriorityConfigurations: description: List of job priority configurations related to the batch context. items: $ref: '#/components/schemas/JobPriorityConfiguration' maxItems: 10 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10)' loggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' network: $ref: '#/components/schemas/CreateNetworkDetails' required: - compartmentId - fleets - network type: object BatchContextShapeCollection: description: A collection of container instance shapes. properties: items: description: List of shapes. items: $ref: '#/components/schemas/BatchContextShapeSummary' type: array required: - items type: object UpdateBatchContextDetails: description: 'The data to update a batch context. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch context. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Can''t be set to null. ' maxLength: 255 minLength: 1 type: string entitlements: additionalProperties: description: Value of the limit. minimum: 0 type: integer description: Mapping of concurrent/shared resources used in job tasks to their limits. maxProperties: 100 type: object x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object jobPriorityConfigurations: description: List of job priority configurations related to the batch context. items: $ref: '#/components/schemas/JobPriorityConfiguration' maxItems: 10 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10)' loggingConfiguration: $ref: '#/components/schemas/UpdateLoggingConfigurationDetails' type: object UnpauseBatchJobDetails: description: Information needed to unpause the batch job. type: object UpdateBatchTaskEnvironmentDetails: description: 'The data to update a batch task environment. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The batch task environment description. maxLength: 400 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Can''t be set to null. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object BatchJobSummary: description: Summary information about a batch job. properties: batchContextId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch context of the parent job pool. maxLength: 255 minLength: 1 type: string batchJobPoolId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: An optional description that provides additional context next to the displayName. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the batch job in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: 'The current state of the batch job. ' type: string x-obmcs-enumref: '#/definitions/BatchJob/lifecycleState' priority: description: A value calculated by the system based on the priority tags. minimum: 0 type: integer progressDetails: description: A more detailed textual representation of the job completion. maxLength: 255 type: string progressPercentage: description: A percentage value (0..100) of the job completion. maximum: 100 minimum: 0 type: integer systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - batchJobPoolId - batchContextId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags type: object BatchJobPoolCollection: description: Results of a batch job pool search. Contains both batch job pool summary items and other information, such as metadata. properties: items: description: List of batch job pools. items: $ref: '#/components/schemas/BatchJobPoolSummary' type: array required: - items type: object WorkRequestErrorCollection: description: A list of work request errors. Can contain both errors and other information, such as metadata. properties: items: description: A list of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ChangeBatchJobPoolCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateLoggingConfigurationDetails: description: The data to update logging configuration of the batch context. discriminator: propertyName: type properties: type: description: Type of the logging configuration. Discriminator for sub-entities. enum: - OCI_LOGGING type: string required: - type BatchContext: description: 'Representation of a batch context and its configurations. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Summarized information about the batch context. maxLength: 400 type: string displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. maxLength: 255 minLength: 1 type: string entitlements: additionalProperties: description: Value of the limit. minimum: 0 type: integer description: Mapping of concurrent/shared resources used in job tasks to their limits. maxProperties: 100 type: object x-extra-annotations: '@jakarta.validation.constraints.Size(max = 100)' fleets: description: List of fleet configurations related to the batch context. items: $ref: '#/components/schemas/Fleet' maxItems: 5 minItems: 1 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context. maxLength: 255 minLength: 1 type: string jobPriorityConfigurations: description: List of job priority configurations related to the batch context. items: $ref: '#/components/schemas/JobPriorityConfiguration' maxItems: 10 type: array x-extra-annotations: '@jakarta.validation.constraints.Size(max = 10)' lifecycleDetails: description: 'A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state. ' maxLength: 255 type: string lifecycleState: description: 'The current state of the batch context. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string loggingConfiguration: $ref: '#/components/schemas/LoggingConfiguration' network: $ref: '#/components/schemas/Network' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the batch context was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the batch context was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - lifecycleState - timeCreated - freeformTags - definedTags - systemTags - network - fleets - jobPriorityConfigurations - entitlements type: object ShapeOcpuOptions: description: For a flexible shape, the number of OCPUs available for container instances that use this shape. properties: maxOcpus: description: The maximum number of OCPUs. format: float minimum: 0 type: number minOcpus: description: The minimum number of OCPUs. format: float minimum: 0 type: number required: - maxOcpus - minOcpus type: object BatchTaskProfileCollection: description: Results of a batch task profile search. Contains both batch task profile summary items and other information, such as metadata. properties: items: description: List of batch task profiles. items: $ref: '#/components/schemas/BatchTaskProfileSummary' type: array required: - items type: object BatchTaskEnvironmentVolume: description: A base type for volume for batch task environment. discriminator: propertyName: type properties: type: description: Discriminator for sub-entities. enum: - NFS type: string required: - type type: object ChangeBatchTaskProfileCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch task profile to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequestLogEntryCollection: description: A list of work request logs. Can contain both logs and other information, such as metadata. properties: items: description: A list of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: AvailabilityDomainQueryParam: description: The name of the availability domain. in: query name: availabilityDomain x-default-description: 'null' schema: type: string BatchTaskTypeQueryParam: description: 'Filter tasks by type. Valid values are: COMPUTE, GROUP.' in: query name: type required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchTask/type' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string BatchJobLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchJob/lifecycleState' schema: type: string BatchJobPoolLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchJobPool/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC BatchJobPoolSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string BatchTaskNameQueryParam: description: 'The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can''t pass both.' in: query name: name required: false x-default-description: 'null' schema: type: string BatchJobPoolIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. in: path name: batchJobPoolId required: true schema: type: string BatchTaskSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `name` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/BatchTaskSortBy' schema: type: string enum: - name default: name BatchJobPoolQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. in: query name: batchJobPoolId x-default-description: 'null' schema: type: string ResourceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string WorkRequestStatusQueryParam: description: A filter to return only the resources that match the given lifecycle state. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - NEEDS_ATTENTION - FAILED - SUCCEEDED - CANCELING - CANCELED WorkRequestIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: path name: workRequestId required: true schema: type: string BatchTaskProfileIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile. in: query name: id x-default-description: 'null' schema: type: string BatchJobSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated BatchTaskHierarchyViewQueryParam: description: Defines the hierarchical scope of the tasks to be returned. When set to SHALLOW, which is default, only tasks contained directly (non-recursively) within current hierarchy entry are returned. When set to DEEP, tasks contained within current hierarchy entry and all its descendants recursively are returned. The default hierarchy entry is root, i.e. batch job itself. To use a different hierarchy entry, provide the group task name as a query parameter. The specified group task becomes the entry point instead of the batch job. in: query name: hierarchyView required: false x-obmcs-top-level-enum: '#/definitions/BatchTaskHierarchyView' schema: type: string enum: - SHALLOW - DEEP default: SHALLOW BatchTaskProfileSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated BatchJobIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job. in: query name: id x-default-description: 'null' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the given display name exactly. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 BatchTaskEnvironmentLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchTaskEnvironment/lifecycleState' schema: type: string BatchTaskNamePathParam: description: 'The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can''t pass both.' in: path name: taskName required: true schema: type: string PaginationTokenQueryParam: description: 'For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string minLength: 1 BatchTaskEnvironmentIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment. in: query name: id x-default-description: 'null' schema: type: string BatchTaskIdentifierQueryParam: description: 'The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can''t pass both.' in: query name: taskId required: false x-default-description: 'null' schema: type: string BatchTaskEnvironmentIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment. in: path name: batchTaskEnvironmentId required: true schema: type: string BatchContextIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context. in: query name: id x-default-description: 'null' schema: type: string WorkRequestIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/WorkRequestLogAndErrorSortBy' schema: type: string enum: - timeCreated default: timeCreated ShapeTypeQueryParam: description: The type of a shape. in: query name: shapeType required: false x-obmcs-top-level-enum: '#/definitions/ShapeType' schema: type: string enum: - CPU - GPU default: CPU BatchContextIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context. in: query name: batchContextId x-default-description: 'null' schema: type: string BatchTaskLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchTask/lifecycleState' schema: type: string BatchContextSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 BatchTaskProfileLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchTaskProfile/lifecycleState' schema: type: string BatchJobIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job. in: path name: batchJobId required: true schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/WorkRequestSortBy' schema: type: string enum: - timeAccepted default: timeAccepted BatchContextIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch context. in: path name: batchContextId required: true schema: type: string BatchTaskEnvironmentSortByQueryParam: description: 'The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending. ' in: query name: sortBy x-obmcs-top-level-enum: '#/definitions/SortBy' schema: type: string enum: - timeCreated - displayName default: timeCreated BatchTaskProfileIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile. in: path name: batchTaskProfileId required: true schema: type: string BatchGroupTaskNameQueryParam: description: 'Hierarchical name of the group task. A filter to return only tasks contained within the selected group task. Omit to return top-level tasks only. Can be combined with task name query parameter, in which case task name becomes a hierarchical name relative to the selected group task, e.g. ?groupTaskName=A.B&taskName=C.D is equal to ?taskName=A.B.C.D. Mutually exclusive with the task id query parameter: you can''t pass both.' in: query name: groupTaskName required: false x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 BatchContextLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/BatchContext/lifecycleState' schema: type: string CompartmentIdRequiredQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string BatchJobPoolIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool. in: query name: id x-default-description: 'null' schema: type: string BatchJobIdentifierExplicitQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job. in: query name: batchJobId x-default-description: 'null' schema: type: string responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-obmcs-splat-quota-family-name: batch-computing x-obmcs-splat-quota-public-name-batch-a10-count: '''batch-a10-count''' x-obmcs-splat-quota-public-name-batch-context-count: '''batch-context-count''' x-obmcs-splat-quota-public-name-batch-environment-count: '''batch-environment-count''' x-obmcs-splat-quota-public-name-batch-job-count: '''batch-job-count''' x-obmcs-splat-quota-public-name-batch-jobpool-count: '''batch-jobpool-count''' x-obmcs-splat-quota-public-name-batch-memory-count: '''batch-memory-count''' x-obmcs-splat-quota-public-name-batch-ocpu-count: '''batch-ocpu-count''' x-obmcs-splat-quota-public-name-batch-task-count: '''batch-task-count''' x-obmcs-splat-quota-public-name-batch-task-profile-count: '''batch-task-profile-count''' x-obmcs-splat-search-metadata-scope: customer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' example: string type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.computefarm.cp