openapi: 3.2.0 info: description: A description of the Container Instance API title: Container Instance API version: '20210415' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/e5e08e24c115c4eff777875590976f80db595b1fd232d210b5e956e3d4888caf.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Container Instance 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/e5e08e24c115c4eff777875590976f80db595b1fd232d210b5e956e3d4888caf.yaml what: the harvested document for Container Instance API servers: - url: http://127.0.0.1/20210415 - url: https://127.0.0.1/20210415 tags: - name: containerInstance paths: /containerInstanceShapes: get: description: Lists the shapes that can be used to create container instances. operationId: ListContainerInstanceShapes parameters: - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ContainerInstanceShapeSummary objects. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ContainerInstanceShapeCollection' 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 shapes that can be used to create container instances. tags: - containerInstance x-related-resource: '#/definitions/ContainerInstanceShapeCollection' /containerInstances: get: description: 'Returns a list of container instances. ' operationId: ListContainerInstances parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CiLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: A page of ContainerInstanceSummary objects. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ContainerInstanceCollection' 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 list of all ContainerInstances in a compartment tags: - containerInstance x-related-resource: '#/definitions/ContainerInstanceCollection' post: description: 'Creates a container instance and deploys the containers on it. ' operationId: CreateContainerInstance parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The container instance was created. Container instance object is returned in response body. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ContainerInstance' 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 new ContainerInstance tags: - containerInstance x-related-resource: '#/definitions/ContainerInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateContainerInstanceDetails' description: Details for the new container instance. required: true /containerInstances/{containerInstanceId}: delete: description: Deletes a container instance and its containers. operationId: DeleteContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The container instance 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned ContainerInstance tags: - containerInstance x-related-resource: '#/definitions/ContainerInstance' get: description: Gets information about the specified container instance. operationId: GetContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the container instance with the given ID. 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/ContainerInstance' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get ContainerInstance tags: - containerInstance put: description: Updates a container instance. operationId: UpdateContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The container instance 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the ContainerInstance identified by the id tags: - containerInstance x-related-resource: '#/definitions/ContainerInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContainerInstanceDetails' description: The information to be updated. required: true /containerInstances/{containerInstanceId}/actions/changeCompartment: post: description: Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeContainerInstanceCompartment parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The container instance resource 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - containerInstance x-related-resource: '#/definitions/ContainerInstance' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeContainerInstanceCompartmentDetails' description: The information to be updated. required: true /containerInstances/{containerInstanceId}/actions/restart: post: description: Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance. operationId: RestartContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the restart power action for the container instance. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Restart container instance. tags: - containerInstance x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/ContainerInstance' /containerInstances/{containerInstanceId}/actions/start: post: description: Starts a container instance if it is "inactive". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance. operationId: StartContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the start power action for the container instance. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Starts an inactive container instance. tags: - containerInstance x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/ContainerInstance' /containerInstances/{containerInstanceId}/actions/stop: post: description: Stops a container instance if it is "active". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance. operationId: StopContainerInstance parameters: - $ref: '#/components/parameters/ContainerInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the stop power action for the container instance. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Stops an active container instance. tags: - containerInstance x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/ContainerInstance' /containers: get: description: 'Returns a list of containers in a compartment. ' operationId: ListContainers parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ContainerLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ContainerInstanceIdentifierQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: The list was retrieved. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ContainerCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of Containers in a compartment tags: - containerInstance x-related-resource: '#/definitions/ContainerCollection' /containers/{containerId}: get: description: Get details about a single container by the container ID. operationId: GetContainer parameters: - $ref: '#/components/parameters/ContainerIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The container with the given ID 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/Container' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a single Container. tags: - containerInstance put: description: Updates a container. operationId: UpdateContainer parameters: - $ref: '#/components/parameters/ContainerIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The container was 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates a Container. tags: - containerInstance x-related-resource: '#/definitions/Container' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateContainerDetails' description: The information to be updated. required: true /containers/{containerId}/actions/retrieveLogs: post: description: 'Returns the most recent 256 KB of logs from the specified container. ' operationId: RetrieveLogs parameters: - $ref: '#/components/parameters/ContainerIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsPreviousLogsQueryParam' responses: 200: description: Gets information about the specified container log with the given container ID. 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: format: binary type: string text/plain: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Retrieve recent log from a container. tags: - containerInstance x-related-resource: '#/definitions/Container' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/WorkRequestSortOrderQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: List Work Requests tags: - containerInstance x-related-resource: '#/definitions/WorkRequestSummaryCollection' /workRequests/{workRequestId}: get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. 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 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: GET Work Request Status tags: - containerInstance x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a paginated list of 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/WorkRequestSortOrderQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: Lists work request errors tags: - containerInstance x-related-resource: '#/definitions/WorkRequestErrorCollection' /workRequests/{workRequestId}/logs: get: description: 'Returns a paginated list of 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/WorkRequestSortOrderQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: Lists work request logs tags: - containerInstance x-related-resource: '#/definitions/WorkRequestLogEntryCollection' components: parameters: AvailabilityDomainQueryParam: description: 'The name of the availability domain. Example: `Uocm:PHX-AD-1` ' in: query name: availabilityDomain required: false x-default-description: 'null' 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 SortByQueryParam: description: 'The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don''t specify a value, timeCreated is the default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The OCID of the resource affected by the work request. in: query name: resourceId 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 required: true 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 WorkRequestStatusQueryParam: description: A filter to return resources with a lifecycleState that matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED ContainerInstanceIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance. in: query name: containerInstanceId 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 WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use (ASC) or (DESC). in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: ASC WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string IsPreviousLogsQueryParam: description: 'Returns the logs for the previous run of the container in a pod. If the container fails, this parameter can help you to determine the root cause of the failure. ' in: query name: isPrevious required: false schema: type: boolean default: false WorkRequestLogAndErrorSortByQueryParam: description: The field to sort by. You can provide one sort order. Default order for timestamp is descending. in: query name: sortBy schema: type: string enum: - timestamp default: timestamp RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 CiLifecycleStateQueryParam: description: A filter to only return resources that match the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/ContainerInstance/lifecycleState' schema: type: string WorkRequestSortOrderQueryParam: description: The sort order to use, either ascending (ASC) or descending (DESC). in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: DESC DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkRequestSortByQueryParam: description: The field to sort by. You can provide one sort order. Default order for timeAccepted is descending. in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted ContainerInstanceIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance. in: path name: containerInstanceId required: true schema: type: string pattern: ^\S+$ RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string ContainerIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container. in: path name: containerId required: true schema: type: string ContainerLifecycleStateQueryParam: description: A filter to only return resources that match the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Container/lifecycleState' schema: type: string schemas: CreateVolumeMountDetails: description: 'Defines the mapping from volume to a mount path in a container. ' properties: isReadOnly: default: false description: Whether the volume was mounted in read-only mode. By default, the volume is not read-only. type: boolean mountPath: description: The volume access path. maxLength: 4096 minLength: 1 type: string partition: default: 1 description: 'If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm ' format: int32 maximum: 128 minimum: 1 type: integer subPath: default: null description: A subpath inside the referenced volume. maxLength: 4096 minLength: 1 type: string volumeName: description: The name of the volume. Avoid entering confidential information. maxLength: 256 minLength: 1 type: string required: - mountPath - volumeName 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 string. type: string required: - code - message ContainerInstanceContainer: description: 'A container on a container instance. ' properties: containerId: description: The OCID of the container. type: string displayName: description: Display name for the Container. type: string required: - containerId type: object CreateContainerResourceConfigDetails: description: 'The size and amount of resources available to the container. ' properties: memoryLimitInGBs: default: null description: 'The maximum amount of memory that can be consumed by the container''s process. If you do not set a value, then the process may use all available memory on the instance. ' format: float minimum: 0.0 type: number vcpusLimit: default: null description: 'The maximum amount of CPUs that can be consumed by the container''s process. If you do not set a value, then the process can use all available CPU resources on the instance. CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0. A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity. ' format: float minimum: 0.0 type: number CreateContainerInstanceSecurityContextDetails: description: Security context for all containers in a container instance. discriminator: propertyName: securityContextType properties: securityContextType: default: LINUX description: The type of security context type: string x-obmcs-enumref: '#/definitions/ContainerInstanceSecurityContext/securityContextType' ContainerInstanceSummary: description: 'A set of details about a single container instance returned by list APIs. ' properties: availabilityDomain: description: The availability domain where the container instance runs. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment to create the container instance in. maxLength: 255 minLength: 1 type: string containerCount: description: The number of containers in the container instance. type: integer containerRestartPolicy: description: Container Restart Policy type: string x-obmcs-enumref: '#/definitions/ContainerInstance/containerRestartPolicy' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string faultDomain: description: The fault domain where the container instance runs. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracefulShutdownTimeoutInSeconds: description: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted. format: int64 maximum: 300 minimum: 0 type: integer id: description: OCID that cannot be changed. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message that describes the current state of the container instance in more detail. Can be used to provide actionable information. ' type: string lifecycleState: description: The current state of the container instance. type: string x-obmcs-enumref: '#/definitions/ContainerInstance/lifecycleState' securityContext: $ref: '#/components/schemas/ContainerInstanceSecurityContext' shape: description: The shape of the container instance. The shape determines the resources available to the container instance. type: string shapeConfig: $ref: '#/components/schemas/ContainerInstanceShapeConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeCreated: description: The time the container instance was created, in the format defined by RFC3339. format: date-time type: string timeUpdated: description: The time the container instance was updated, in the format defined by RFC3339. format: date-time type: string volumeCount: description: The number of volumes that are attached to the container instance. type: integer required: - id - displayName - compartmentId - availabilityDomain - lifecycleState - timeCreated - shape - shapeConfig - containerCount - containerRestartPolicy type: object ContainerCollection: description: 'A list of containers. ' properties: items: description: List of containers. items: $ref: '#/components/schemas/ContainerSummary' maxItems: 10 minItems: 1 type: array required: - items type: object CreateContainerVnicDetails: description: 'Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN). You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer. The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: 'A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostnameLabel: description: 'The hostname for the VNIC''s primary private IP. Used for DNS. ' type: string x-default-description: A value is set with the format `-`. isPublicIpAssigned: description: 'Whether the VNIC should be assigned a public IP address. ' type: boolean x-default-description: True if the subnet is public, false if the subnet is private. nsgIds: default: null description: 'A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateIp: description: 'A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet''s CIDR. ' type: string x-default-description: A available IP address from the subnet will be automatically selected. skipSourceDestCheck: default: false description: 'Whether the source/destination check is disabled on the VNIC. ' type: boolean subnetId: description: 'The OCID of the subnet to create the VNIC in. ' maxLength: 255 minLength: 1 type: string required: - subnetId type: object VolumeMount: description: 'Define the mapping from volume to a mount path in container. ' properties: isReadOnly: default: false description: Whether the volume was mounted in read-only mode. By default, the volume is mounted with write access. type: boolean mountPath: description: Describes the volume access path. maxLength: 4096 minLength: 1 type: string partition: default: 1 description: 'If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm ' format: int32 maximum: 128 minimum: 1 type: integer subPath: default: null description: A sub-path inside the referenced volume. maxLength: 4096 minLength: 1 type: string volumeName: description: The name of the volume. maxLength: 256 minLength: 1 type: string required: - mountPath - volumeName SecurityContext: description: Security context for container. discriminator: propertyName: securityContextType properties: securityContextType: default: LINUX description: The type of security context enum: - LINUX type: string CreateContainerVolumeDetails: description: 'A volume represents a directory with data that is accessible across multiple containers in a container instance. ' discriminator: propertyName: volumeType properties: name: description: 'The name of the volume. This must be unique within a single container instance. ' maxLength: 256 minLength: 1 type: string volumeType: default: null description: The type of volume. enum: - EMPTYDIR - CONFIGFILE - OCI_FSS_FILE_SYSTEM type: string x-obmcs-top-level-enum: '#/definitions/ContainerVolumeType' required: - name - volumeType ContainerDnsConfig: description: DNS settings for containers. properties: nameservers: description: IP address of the name server.. items: type: string type: array options: description: Options allows certain internal resolver variables to be modified. items: type: string type: array searches: description: Search list for hostname lookup. items: type: string type: array type: object ContainerVnic: description: 'An interface to a virtual network available to containers on a container instance. ' properties: vnicId: description: 'The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network. ' type: string type: object UpdateContainerDetails: description: The container information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted remains in the IN_PROGRESS state until work is complete for that resource, at which point it updates 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 the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The ID of the resource the work request affects. type: string required: - actionType - entityType - identifier ContainerInstanceShapeConfig: description: 'The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers. ' properties: memoryInGBs: description: 'The total amount of memory available to the container instance, in gigabytes. ' format: float minimum: 0.0 type: number networkingBandwidthInGbps: description: 'The networking bandwidth available to the container instance, in gigabits per second. ' format: float minimum: 0.0 type: number ocpus: description: 'The total number of OCPUs available to the container instance. ' format: float minimum: 0.0 type: number x-default-description: If you do not provide one, this is calculated from container resource configuration. processorDescription: description: 'A short description of the container instance''s processor (CPU). ' maxLength: 255 minLength: 1 type: string required: - ocpus - memoryInGBs - processorDescription - networkingBandwidthInGbps type: object CreateImagePullSecretDetails: description: 'The image pull secrets for accessing private registry to pull images for containers ' discriminator: propertyName: secretType properties: registryEndpoint: description: The registry endpoint of the container image. type: string secretType: description: The type of ImagePullSecret. enum: - BASIC - VAULT type: string required: - secretType - registryEndpoint type: object ContainerInstance: description: 'A container instance to host containers. If you delete a container instance, the record remains visible for a short period of time before being permanently removed. ' properties: availabilityDomain: description: The availability domain to place the container instance. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 pattern: ^\S+$ type: string containerCount: description: The number of containers on the container instance. type: integer containerRestartPolicy: description: The container restart policy is applied for all containers in container instance. enum: - ALWAYS - NEVER - ON_FAILURE type: string containers: description: The containers on the container instance. items: $ref: '#/components/schemas/ContainerInstanceContainer' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string dnsConfig: $ref: '#/components/schemas/ContainerDnsConfig' faultDomain: description: The fault domain to place the container instance. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracefulShutdownTimeoutInSeconds: description: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted. format: int64 maximum: 300 minimum: 0 type: integer id: description: An OCID that cannot be changed. maxLength: 255 minLength: 1 type: string imagePullSecrets: description: The image pulls secrets so you can access private registry to pull container images. items: $ref: '#/components/schemas/ImagePullSecret' type: array lifecycleDetails: description: 'A message that describes the current state of the container in more detail. Can be used to provide actionable information. ' type: string lifecycleState: description: The current state of the container instance. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string securityContext: $ref: '#/components/schemas/ContainerInstanceSecurityContext' shape: description: The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance. type: string shapeConfig: $ref: '#/components/schemas/ContainerInstanceShapeConfig' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object tenantId: description: TenantId id of the container instance. type: string timeCreated: description: The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string vnics: description: The virtual networks available to the containers in the container instance. items: $ref: '#/components/schemas/ContainerVnic' type: array volumeCount: description: The number of volumes that are attached to the container instance. type: integer volumes: description: 'A volume is a directory with data that is accessible across multiple containers in a container instance. ' items: $ref: '#/components/schemas/ContainerVolume' type: array required: - id - displayName - compartmentId - availabilityDomain - lifecycleState - timeCreated - shape - shapeConfig - vnics - containers - containerCount - containerRestartPolicy type: object WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object CreateContainerDnsConfigDetails: description: 'Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet. ' properties: nameservers: description: 'IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions. ' items: maxLength: 50 minLength: 1 type: string maxItems: 3 type: array uniqueItems: true x-default-description: 'null' options: description: 'Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"]. ' items: maxLength: 25 minLength: 1 type: string maxItems: 16 type: array uniqueItems: true x-default-description: 'null' searches: description: Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios. items: maxLength: 253 minLength: 1 type: string maxItems: 6 type: array uniqueItems: true x-default-description: 'null' type: object ContainerResourceConfig: description: 'The resource configuration for a container. The resource configuration determines the amount of resources allocated to the container and the maximum allowed resources for a container. ' properties: memoryLimitInGBs: default: null description: 'The maximum amount of memory that can be consumed by the container''s process. If you do not set a value, then the process may use all available memory on the instance. ' format: float minimum: 0.0 type: number vcpusLimit: default: null description: 'The maximum amount of CPUs that can be consumed by the container''s process. If you do not set a value, then the process may use all available CPU resources on the container instance. CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0. ' format: float minimum: 0.0 type: number 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.0 type: number maxInGbps: description: 'The maximum amount of networking bandwidth, in gigabits per second. ' format: float minimum: 0.0 type: number minInGbps: description: 'The minimum amount of networking bandwidth, in gigabits per second. ' format: float minimum: 0.0 type: number required: - minInGbps - maxInGbps - defaultPerOcpuInGbps ShapeOcpuOptions: description: 'For a flexible shape, the number of OCPUs available for container instances that use this shape. ' properties: max: description: 'The maximum number of OCPUs. ' format: float minimum: 0.0 type: number min: description: 'The minimum number of OCPUs. ' format: float minimum: 0.0 type: number required: - min - max UpdateContainerInstanceDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object ContainerHealthCheck: description: Type of container health check which could be either HTTP, TCP, or Command. discriminator: propertyName: healthCheckType properties: failureAction: default: KILL description: 'The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy. ' enum: - KILL - NONE type: string x-obmcs-top-level-enum: '#/definitions/ContainerHealthCheckFailureAction' failureThreshold: description: Number of consecutive failures at which we consider the check failed. type: integer healthCheckType: description: Container health check type. enum: - HTTP - TCP type: string x-obmcs-top-level-enum: '#/definitions/ContainerHealthCheckType' initialDelayInSeconds: description: The initial delay in seconds before start checking container health status. type: integer intervalInSeconds: description: Number of seconds between two consecutive runs for checking container health. type: integer name: description: Health check name. maxLength: 4096 minLength: 1 type: string status: default: UNKNOWN description: Status of container enum: - HEALTHY - UNHEALTHY - UNKNOWN type: string statusDetails: description: A message describing the current status in more details. maxLength: 4096 minLength: 1 type: string successThreshold: description: Number of consecutive successes at which we consider the check succeeded again after it was in failure state. type: integer timeoutInSeconds: description: Length of waiting time in seconds before marking health check failed. type: integer required: - healthCheckType CreateSecurityContextDetails: description: Security context for container. discriminator: propertyName: securityContextType properties: securityContextType: default: LINUX description: The type of security context type: string x-obmcs-enumref: '#/definitions/SecurityContext/securityContextType' WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object ImagePullSecret: description: 'The image pull secrets for accessing private registry to pull images for containers ' discriminator: propertyName: secretType properties: registryEndpoint: description: The registry endpoint of the container image. type: string secretType: description: The type of ImagePullSecret. enum: - BASIC - VAULT type: string required: - secretType - registryEndpoint type: object ChangeContainerInstanceCompartmentDetails: 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 container instance to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ContainerInstanceShapeCollection: description: A collection of container instance shapes. properties: items: description: A list of shapes. items: $ref: '#/components/schemas/ContainerInstanceShapeSummary' type: array required: - items type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object CreateContainerDetails: description: 'Information to create a new container within a container instance. The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance. The container is created in the same compartment, availability domain, and fault domain as its container instance. ' properties: arguments: default: null description: 'A list of string arguments for a container''s ENTRYPOINT process. Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process. The total size of all arguments combined must be 64 KB or smaller. ' items: type: string type: array command: default: null description: 'An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used. ' items: type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. If you don''t provide a name, a name is generated automatically. ' maxLength: 255 minLength: 1 type: string environmentVariables: additionalProperties: type: string default: null description: 'A map of additional environment variables to set in the environment of the container''s ENTRYPOINT process. These variables are in addition to any variables already defined in the container''s image. The total size of all environment variables combined, name and values, must be 64 KB or smaller. ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object healthChecks: description: 'list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP. ' items: $ref: '#/components/schemas/CreateContainerHealthCheckDetails' type: array imageUrl: description: 'A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest. If no registry is provided, will default the registry to public docker hub `docker.io/library`. The registry used for container image must be reachable over the Container Instance''s VNIC. ' maxLength: 1024 minLength: 1 type: string isResourcePrincipalDisabled: default: false description: 'Determines if the container will have access to the container instance resource principal. This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal. ' type: boolean resourceConfig: $ref: '#/components/schemas/CreateContainerResourceConfigDetails' securityContext: $ref: '#/components/schemas/CreateSecurityContextDetails' volumeMounts: default: null description: 'List of the volume mounts. ' items: $ref: '#/components/schemas/CreateVolumeMountDetails' type: array workingDirectory: default: null description: 'The working directory within the container''s filesystem for the container process. If not specified, the default working directory from the image is used. ' maxLength: 4096 minLength: 1 type: string required: - imageUrl type: object ContainerInstanceShapeSummary: description: 'Details about a shape for a container instance. ' properties: memoryOptions: $ref: '#/components/schemas/ShapeMemoryOptions' name: description: 'The name identifying the shape. ' 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 ShapeMemoryOptions: description: 'For a flexible shape, 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.0 type: number maxInGBs: description: 'The maximum amount of memory (GB). ' format: float minimum: 0.0 type: number maxPerOcpuInGBs: description: 'The maximum amount of memory per OCPU available for this shape (GB). ' format: float type: number exclusiveMinimum: 0.0 minInGBs: description: 'The minimum amount of memory (GB). ' format: float minimum: 0.0 type: number minPerOcpuInGBs: description: 'The minimum amount of memory per OCPU available for this shape (GB). ' format: float type: number exclusiveMinimum: 0.0 required: - minInGBs - maxInGBs - defaultPerOcpuInGBs - minPerOcpuInGBs - maxPerOcpuInGBs WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. See [API Errors](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) for a list of error codes. ' type: string message: description: A description of the issue encountered. type: string timestamp: description: The time the error occured, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - code - message - timestamp WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. ' type: string id: description: The ID of the work request. type: string operationType: description: Type of work request. enum: - CREATE_CONTAINER_INSTANCE - UPDATE_CONTAINER_INSTANCE - DELETE_CONTAINER_INSTANCE - MOVE_CONTAINER_INSTANCE - START_CONTAINER_INSTANCE - STOP_CONTAINER_INSTANCE - RESTART_CONTAINER_INSTANCE - UPDATE_CONTAINER type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted ContainerInstanceSecurityContext: description: Security context for all containers in a container instance. discriminator: propertyName: securityContextType properties: securityContextType: default: LINUX description: The type of security context enum: - LINUX type: string CreateContainerInstanceShapeConfigDetails: description: 'The size and amount of resources available to the container instance. ' properties: memoryInGBs: description: 'The total amount of memory available to the container instance (GB). ' format: float minimum: 0.0 type: number x-default-description: A default value is chosen based on the number of OCPUs selected. ocpus: description: 'The total number of OCPUs available to the container instance. ' format: float minimum: 0.0 type: number required: - ocpus Container: description: 'A single container on a container instance. If you delete a container, the record remains visible for a short period of time before being permanently removed. ' properties: arguments: description: 'A list of string arguments for the ENTRYPOINT process of the container. Many containers use an ENTRYPOINT process pointing to a shell `/bin/bash`. For those containers, you can use the argument list to specify the main command in the container process. ' items: type: string type: array availabilityDomain: description: The availability domain where the container instance that hosts the container runs. maxLength: 255 minLength: 1 type: string command: description: 'This command overrides ENTRYPOINT process of the container. If you do not specify this command, the existing ENTRYPOINT process defined in the image is the default. ' items: type: string type: array compartmentId: description: The OCID of the compartment that contains the container. maxLength: 255 minLength: 1 type: string containerInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance that the container is running on. maxLength: 255 minLength: 1 type: string containerRestartAttemptCount: description: The number of container restart attempts. Depending on the restart policy, a restart might be attempted after a health check failure or a container exit. type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string environmentVariables: additionalProperties: type: string description: 'A map of additional environment variables to set in the environment of the ENTRYPOINT process of the container. These variables are in addition to any variables already defined in the container''s image. ' type: object exitCode: description: The exit code of the container process when it stopped running. type: integer faultDomain: description: The fault domain of the container instance that hosts the container runs. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object healthChecks: description: List of container health checks items: $ref: '#/components/schemas/ContainerHealthCheck' type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container. maxLength: 255 minLength: 1 type: string imageUrl: description: 'The container image information. Currently only supports public Docker registry. You can provide either the image name (containerImage), image name with version (containerImagev1), or complete Docker image URL `docker.io/library/containerImage:latest`. If you do not provide a registry, the registry defaults to public Docker hub `docker.io/library`. The registry used for the container image must be reachable over the VNIC of the container instance. ' maxLength: 1024 minLength: 1 type: string isResourcePrincipalDisabled: description: 'Determines if the container will have access to the container instance resource principal. This method utilizes resource principal version 2.2. For more information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal. ' type: boolean lifecycleDetails: description: 'A message that describes the current state of the container in more detail. Can be used to provide actionable information. ' type: string lifecycleState: description: The current state of the container. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string resourceConfig: $ref: '#/components/schemas/ContainerResourceConfig' securityContext: $ref: '#/components/schemas/SecurityContext' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeCreated: description: The time the container was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeTerminated: description: The time when the container last deleted (terminated), in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string x-default-description: 'null' timeUpdated: description: The time the container was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string volumeMounts: description: 'List of the volume mounts. ' items: $ref: '#/components/schemas/VolumeMount' type: array workingDirectory: description: 'The working directory within the container''s filesystem for the container process. If not specified, the default working directory from the image is used. ' maxLength: 4096 minLength: 1 type: string required: - id - displayName - compartmentId - availabilityDomain - lifecycleState - timeCreated - containerInstanceId - imageUrl type: object CreateContainerInstanceDetails: description: Information to create a container instance. properties: availabilityDomain: description: The availability domain where the container instance runs. maxLength: 255 minLength: 1 type: string compartmentId: description: The compartment OCID. maxLength: 255 minLength: 1 type: string containerRestartPolicy: default: ALWAYS description: Container restart policy type: string x-obmcs-enumref: '#/definitions/ContainerInstance/containerRestartPolicy' containers: description: The containers to create on this container instance. items: $ref: '#/components/schemas/CreateContainerDetails' maxItems: 60 minItems: 1 type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. If you don''t provide a name, a name is generated automatically. ' maxLength: 255 minLength: 1 type: string dnsConfig: $ref: '#/components/schemas/CreateContainerDnsConfigDetails' faultDomain: description: 'The fault domain where the container instance runs. ' maxLength: 255 minLength: 1 type: string x-default-description: If you do not specify the fault domain, the system selects one for you. freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gracefulShutdownTimeoutInSeconds: default: 0 description: The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted. format: int64 maximum: 300 minimum: 0 type: integer imagePullSecrets: default: null description: The image pulls secrets so you can access private registry to pull container images. items: $ref: '#/components/schemas/CreateImagePullSecretDetails' type: array securityContext: $ref: '#/components/schemas/CreateContainerInstanceSecurityContextDetails' shape: description: The shape of the container instance. The shape determines the resources available to the container instance. type: string shapeConfig: $ref: '#/components/schemas/CreateContainerInstanceShapeConfigDetails' vnics: description: The networks available to containers on this container instance. items: $ref: '#/components/schemas/CreateContainerVnicDetails' maxItems: 1 minItems: 1 type: array volumes: default: null description: 'A volume is a directory with data that is accessible across multiple containers in a container instance. You can attach up to 32 volumes to single container instance. ' items: $ref: '#/components/schemas/CreateContainerVolumeDetails' maxItems: 32 type: array required: - compartmentId - availabilityDomain - shape - shapeConfig - containers - vnics type: object WorkRequestLogEntry: description: A log message from a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - message - timestamp ContainerVolume: description: 'A volume represents a directory with data that is accessible across multiple containers in a container instance. ' discriminator: propertyName: volumeType properties: name: description: 'The name of the volume. This must be unique within a single container instance. ' maxLength: 256 minLength: 1 type: string volumeType: description: The type of volume. enum: - EMPTYDIR - CONFIGFILE - OCI_FSS_FILE_SYSTEM type: string x-obmcs-top-level-enum: '#/definitions/ContainerVolumeType' required: - name - volumeType ContainerSummary: description: 'Summary information about a container. ' properties: availabilityDomain: description: The availability domain where the container instance that hosts this container runs. maxLength: 255 minLength: 1 type: string compartmentId: description: The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string containerInstanceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance on which the container is running. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object displayName: description: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string faultDomain: description: The fault domain where the container instance that hosts the container runs. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container. maxLength: 255 minLength: 1 type: string imageUrl: description: 'A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest. If no registry is provided, will default the registry to public docker hub `docker.io/library`. The registry used for container image must be reachable over the Container Instance''s VNIC. ' maxLength: 1024 minLength: 1 type: string isResourcePrincipalDisabled: description: 'Determines whether the container will have access to the container instance resource principal. This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal. ' type: boolean lifecycleDetails: description: 'A message that describes the current state of the container in more detail. Can be used to provide actionable information. ' type: string lifecycleState: description: The current state of the container. type: string x-obmcs-enumref: '#/definitions/Container/lifecycleState' resourceConfig: $ref: '#/components/schemas/ContainerResourceConfig' securityContext: $ref: '#/components/schemas/SecurityContext' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object timeCreated: description: The time the the container was created in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string timeUpdated: description: The time the container was updated in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - id - displayName - compartmentId - availabilityDomain - lifecycleState - timeCreated - containerInstanceId - imageUrl type: object CreateContainerHealthCheckDetails: description: 'Container Health Check is used to check and report the status of a container. ' discriminator: propertyName: healthCheckType properties: failureAction: default: KILL description: 'The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy. ' enum: - KILL - NONE type: string x-obmcs-top-level-enum: '#/definitions/ContainerHealthCheckFailureAction' failureThreshold: default: 3 description: Number of consecutive failures at which we consider the check failed. minimum: 1 type: integer healthCheckType: description: Container health check type. enum: - HTTP - TCP type: string x-obmcs-top-level-enum: '#/definitions/ContainerHealthCheckType' initialDelayInSeconds: default: 0 description: The initial delay in seconds before start checking container health status. minimum: 0 type: integer intervalInSeconds: default: 10 description: Number of seconds between two consecutive runs for checking container health. minimum: 1 type: integer name: description: Health check name. maxLength: 255 minLength: 1 type: string x-default-description: A default value will be generated from our backend code successThreshold: default: 1 description: Number of consecutive successes at which we consider the check succeeded again after it was in failure state. minimum: 1 type: integer timeoutInSeconds: default: 1 description: Length of waiting time in seconds before marking health check failed. minimum: 1 type: integer required: - healthCheckType ContainerInstanceCollection: description: Summary information about a list of container instances. properties: items: description: List of container instances. items: $ref: '#/components/schemas/ContainerInstanceSummary' type: array required: - items type: object WorkRequest: description: A description of the work request status. properties: compartmentId: description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. ' type: string id: description: The ID of the work request. type: string operationType: description: Type of work request. enum: - CREATE_CONTAINER_INSTANCE - UPDATE_CONTAINER_INSTANCE - DELETE_CONTAINER_INSTANCE - MOVE_CONTAINER_INSTANCE - START_CONTAINER_INSTANCE - STOP_CONTAINER_INSTANCE - RESTART_CONTAINER_INSTANCE - UPDATE_CONTAINER type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted 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: container-instance-id: description: 'Unique identifier assigned by Oracle for the container instance. You can use this to query status and details of the container instance. ' type: string displayName: description: 'A user-friendly name. Does not have to be unique, and can be changed. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' 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-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`. ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`. ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`. ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.container