openapi: 3.2.0
info:
description: The APIs for the [Fleet Management](https://docs.oracle.com/en-us/iaas/jms/doc/fleet-management.html) feature of Java Management Service to monitor and manage the usage of Java in your enterprise. Use these APIs to manage fleets, configure managed instances to report to fleets, and gain insights into the Java workloads running on these instances by carrying out basic and advanced features.
title: Fleets Java Management Service API
version: '20210610'
x-provenance:
method: harvested
first_party: true
publisher: Oracle
source: https://docs.oracle.com/en-us/iaas/api/specs/756c07623c433632650cfadcb9ae28431b4fdfcf0d7def89e16cd697ac3d44a2.yaml
harvested: '2026-08-04'
note: Published by Oracle as the contract for the Java Management Service Fleets 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/756c07623c433632650cfadcb9ae28431b4fdfcf0d7def89e16cd697ac3d44a2.yaml
what: the harvested document for Java Management Service Fleets API
servers:
- url: /20210610
tags:
- description: 'Endpoints related to the Java Management Service
'
name: javaManagementService
paths:
/agentInstallers:
get:
description: 'Returns a list of the agent installer information.
'
operationId: ListAgentInstallers
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/AgentInstallerPlatformArchitectureQueryParam'
- $ref: '#/components/parameters/AgentInstallerOsFamilyQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/AgentInstallerSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Supported agent installer definition.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AgentInstallerCollection'
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 a list of the supported agent installer information.
tags:
- javaManagementService
x-example: 'GET /20210610/agentInstallers?compartmentId=<compartment_OCID>&limit=10
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/AgentInstallerSummary'
/agentInstallers/actions/generateAgentInstallerConfiguration:
post:
description: 'Generates the agent installer configuration using the information provided.
'
operationId: GenerateAgentInstallerConfiguration
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Agent Installer Configuration File
headers:
content-length:
description: The content size of the body in bytes.
schema:
type: integer
format: int64
content-type:
description: The content type of the body.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
text/plain:
schema:
format: binary
type: string
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: Generate Agent Installer Configuration for Fleet
tags:
- javaManagementService
x-example: "POST /20210610/agentInstallers/actions/generateAgentInstallerConfiguration\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"installKeyId\":\"ocid1.managementagentinstallkey.oc1.iad.<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\"\n}\n"
x-related-resource: '#/definitions/AgentInstallerSummary'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateAgentInstallerConfigurationDetails'
description: Details that are used to generate the installer configuration for a fleet.
required: true
/agentInstallers/{agentInstallerId}/content:
get:
description: 'Use this API to download an agent installer using a specified identifier. The API returns the HTTP response code `302` on success and uses redirects for the actual operation.
'
operationId: GetAgentInstallerContent
parameters:
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/AgentInstallerIdPathParam'
responses:
200:
description: OK
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
format: binary
type: string
302:
description: The redirect URL for the download.
headers:
Location:
description: URL to redirect to on returning a 3XX status code.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Download the Agent Installer
tags:
- javaManagementService
x-example: 'GET /agentInstallers/<agent_installer_id>/content?fleetId=≶fleet_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/AgentInstallerSummary'
/announcements:
get:
description: Return a list of AnnouncementSummary items
operationId: ListAnnouncements
parameters:
- $ref: '#/components/parameters/SummaryContainsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/AnnouncementSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of AnnouncementSummary
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AnnouncementCollection'
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: Retrieve JMS announcements
tags:
- javaManagementService
x-example: 'GET /20210610/announcements
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/fleetErrorAnalytics:
get:
description: Returns a high level summary of FleetErrors.
operationId: SummarizeFleetErrors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of fleet error aggregations.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrorAggregationCollection'
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: Returns a summary of FleetErrors.
tags:
- javaManagementService
x-example: 'GET /20210610/fleetErrorAnalytics?limit=10&compartmentId=<compartment_OCID>&compartmentIdInSubtree=false
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/FleetErrorAggregation'
/fleetErrors:
get:
description: Returns a list of fleet errors that describe all detected errors.
operationId: ListFleetErrors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/TimeErrorFirstSeenLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorFirstSeenGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorLastSeenLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorLastSeenGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FleetErrorSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of fleet errors.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetErrorCollection'
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: Returns a list of FleetErrors.
tags:
- javaManagementService
x-example: 'GET /20210610/fleetErrors?limit=10&compartmentId=<compartment_OCID>&compartmentIdInSubtree=false
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/FleetErrorSummary'
/fleets:
get:
description: 'Returns a list of all the Fleets contained by a compartment. The query parameter `compartmentId`
is required unless the query parameter `id` is specified.
'
operationId: ListFleets
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FleetSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DisplayNameContainsQueryParam'
responses:
200:
description: A page of FleetSummary objects.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetCollection'
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 a list of all Fleets in a compartment.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets?compartmentId=<compartment_OCID>&limit=10
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Fleet'
post:
description: 'Create a new Fleet using the information provided.
`inventoryLog` is now a required parameter for CreateFleet API.
Update existing applications using this API
before July 15, 2022 to ensure the applications continue to work.
See the [Service Change Notice](https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#JMS) for more details.
Migrate existing fleets using the `UpdateFleet` API to set the `inventoryLog` parameter.
'
operationId: CreateFleet
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The new Fleet will be created.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a new Fleet.
tags:
- javaManagementService
x-example: "POST /20210610/fleets\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"definedTags\":{},\n \"freeformTags\":{},\n \"compartmentId\":\"ocid1.compartment.oc1..<unique_id>\",\n \"displayName\":\"Created Fleet\",\n \"description\":\"Created Fleet\",\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false\n}\n"
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFleetDetails'
description: Details for the new Fleet.
required: true
/fleets/{fleetId}:
delete:
description: Deletes the Fleet specified by an identifier.
operationId: DeleteFleet
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Fleet 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete a Fleet.
tags:
- javaManagementService
x-example: 'DELETE /20210610/fleets/<fleet_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Fleet'
get:
description: Retrieve a Fleet with the specified identifier.
operationId: GetFleet
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the Fleet with the specified identifier.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Fleet'
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 a Fleet.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: Update the Fleet specified by an identifier.
operationId: UpdateFleet
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Fleet 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a Fleet.
tags:
- javaManagementService
x-example: "PUT /20210610/fleets/<fleet_OCID>\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"definedTags\":{},\n \"freeformTags\":{},\n \"displayName\":\"Updated Fleet\",\n \"description\":\"Updated Fleet\",\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false\n}\n"
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFleetDetails'
description: The new details for the Fleet.
required: true
/fleets/{fleetId}/actions/addInstallationSites:
post:
description: Add Java installation sites in a Fleet.
operationId: AddFleetInstallationSites
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Java Runtime installations will be added.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Add Java installation sites in a fleet.
tags:
- javaManagementService
x-related-resource: '#/definitions/InstallationSiteSummary'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddFleetInstallationSitesDetails'
description: List of installation sites to be added.
required: true
/fleets/{fleetId}/actions/changeCompartment:
post:
description: 'Move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.
'
operationId: ChangeFleetCompartment
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The compartment of the Fleet will be changed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the status of the asynchronous operation.
'
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: Move a Fleet into a different compartment.
tags:
- javaManagementService
x-example: "PUT /20210610/fleets/<fleet_OCID>/actions/changeCompartment\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"compartmentId\":\"ocid1.compartment.oc1..<compartment_OCID>\"\n}\n"
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeFleetCompartmentDetails'
description: Compartment identifier.
required: true
/fleets/{fleetId}/actions/disableDrs:
post:
description: 'Request to disable the DRS in the selected target in the Fleet.
'
operationId: DisableDrs
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Request to disable DRS.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DisableDrsDetails'
description: Detail information to disable DRS
required: true
/fleets/{fleetId}/actions/enableDrs:
post:
description: 'Request to enable the DRS in the selected target in the Fleet.
'
operationId: EnableDrs
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Request to enable DRS.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnableDrsDetails'
description: Detail information to enable DRS
required: true
/fleets/{fleetId}/actions/generateAgentDeployScript:
post:
description: 'Generates Agent Deploy Script for Fleet using the information provided.
'
operationId: GenerateAgentDeployScript
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Operating System specific Agent Deployment Script Source Code
headers:
content-length:
description: The content size of the body in bytes.
schema:
type: integer
format: int64
content-type:
description: The content type of the body.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
text/plain:
schema:
format: binary
type: string
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: Generate Agent Deploy Script for Fleet
tags:
- javaManagementService
x-example: "POST /20210610/fleets/<fleet_OCID>/actions/generateAgentDeployScript\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"installKeyId\":\"ocid1.managementagentinstallkey.oc1.iad.<unique_id>\",\n \"osFamily\":\"LINUX\",\n \"isUserNameEnabled\":true\n}\n"
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateAgentDeployScriptDetails'
description: Attributes to generate the agent deploy script for a Fleet.
required: true
/fleets/{fleetId}/actions/generateLoadPipelineScript:
post:
description: 'Generates Load Pipeline Script
'
operationId: GenerateLoadPipelineScript
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: "SQL script to create database tables and data pipelines for loading data from \nobject store into the database tables.\n"
headers:
content-length:
description: The content size of the body in bytes.
schema:
type: integer
format: int64
content-type:
description: The content type of the body.
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
text/plain:
schema:
format: binary
type: string
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: Generate Load Pipeline Script
tags:
- javaManagementService
x-example: "POST /20210610/fleets/<fleet_OCID>/actions/generateLoadPipelineScript\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"targetBucketName\":\"\",\n \"targetBucketNamespace\":\"\",\n \"targetBucketRegion\":\"us-ashburn-1\",\n \"intervalMinutes\": 15\n}\n"
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateLoadPipelineScriptDetails'
description: Attributes to generate the load pipeline script.
required: true
/fleets/{fleetId}/actions/removeInstallationSites:
post:
description: Remove Java installation sites in a Fleet.
operationId: RemoveFleetInstallationSites
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Java Runtime installations 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, 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 the 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'
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: Remove Java installation sites in a fleet.
tags:
- javaManagementService
x-related-resource: '#/definitions/InstallationSiteSummary'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveFleetInstallationSitesDetails'
description: List of installation sites to be deleted.
required: true
/fleets/{fleetId}/actions/requestCryptoAnalyses:
post:
description: 'Request to perform crypto analysis on one or more selected targets in the Fleet. The result of the crypto analysis will be uploaded to the object storage bucket created by JMS on enabling the Crypto Event Analysis feature in the Fleet.
'
operationId: RequestCryptoAnalyses
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Request to start crypto analyses on selected target.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestCryptoAnalysesDetails'
description: Detail information to start Crypto Analyses
required: true
/fleets/{fleetId}/actions/requestDeployedApplicationMigrationAnalyses:
post:
description: 'Request to perform a deployed Java migration analyses. The results of the deployed Java migration analyses will be uploaded to the
Object Storage bucket that you designate when you enable the Java Migration Analyses feature.
'
operationId: RequestDeployedApplicationMigrationAnalyses
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Request to start the Java migration analyses for selected deployed applications.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestDeployedApplicationMigrationAnalysesDetails'
description: Detail information that starts the deployed Java migration analyses
required: true
/fleets/{fleetId}/actions/requestJavaMigrationAnalyses:
post:
description: 'Request to perform a Java migration analysis. The results of the Java migration analysis will be uploaded to the
Object Storage bucket that you designate when you enable the Java Migration Analysis feature.
'
operationId: RequestJavaMigrationAnalyses
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Request to start the Java migration analysis for selected applications.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestJavaMigrationAnalysesDetails'
description: Detail information that starts the Java migration analysis
required: true
/fleets/{fleetId}/actions/requestJfrRecordings:
post:
description: 'Request to collect the JFR recordings on the selected target in the Fleet. The JFR files are uploaded to the object storage bucket created by JMS on enabling Generic JFR feature in the Fleet.
'
operationId: RequestJfrRecordings
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Request to collect JFR recordings.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestJfrRecordingsDetails'
description: Detail information to start JFR recordings.
required: true
/fleets/{fleetId}/actions/requestPerformanceTuningAnalyses:
post:
description: 'Request to perform performance tuning analyses. The result of performance tuning analysis will be uploaded to the
object storage bucket that you designated when you enabled the recording feature.
'
operationId: RequestPerformanceTuningAnalyses
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Request to start performance tuning analyses on selected target.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RequestPerformanceTuningAnalysesDetails'
description: Detail information to start Performance Tuning Analyses
required: true
/fleets/{fleetId}/actions/scanJavaServerUsage:
post:
description: Scan Java Server usage in a fleet.
operationId: ScanJavaServerUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The managed instances will be scanned.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Scan Java Server usage in a fleet.
tags:
- javaManagementService
x-example: "POST /20210610/fleets/<fleet_OCID>/actions/scanJavaServerUsage\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"items\":[\n \"<managed_instance_OCID_1>\",\n \"<managed_instance_OCID_2>\",\n \"<managed_instance_OCID_3>\",\n \"<managed_instance_OCID_4>\",\n \"<managed_instance_OCID_5>\",\n ]\n}\n"
x-related-resource: '#/definitions/JavaServerUsage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScanJavaServerUsageDetails'
description: List of managed instances to be scanned.
required: true
/fleets/{fleetId}/actions/scanLibraryUsage:
post:
description: Scan library usage in a fleet.
operationId: ScanLibraryUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The managed instances will be scanned.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Scan library usage in a fleet.
tags:
- javaManagementService
x-related-resource: '#/definitions/LibraryUsage'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScanLibraryUsageDetails'
description: List of managed instances to be scanned.
required: true
/fleets/{fleetId}/actions/summarizeApplicationInstallationUsage:
get:
description: 'Summarizes the application installation usage in a Fleet filtered by query parameters. In contrast to SummarizeApplicationUsage, which provides only information aggregated by application name, this operation provides installation details. This allows for better focusing of actions.
'
operationId: SummarizeApplicationInstallationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationInstallationIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/DisplayNameContainsQueryParam'
- $ref: '#/components/parameters/ApplicationTypeQueryParam'
- $ref: '#/components/parameters/ApplicationInstallationPathContainsQueryParam'
- $ref: '#/components/parameters/JreVendorQueryParam'
- $ref: '#/components/parameters/JreDistributionQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/InstallationPathQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ApplicationInstallationSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Java application installation usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationInstallationUsageSummaryCollection'
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: Summarize application installation usage in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeApplicationInstallationUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ApplicationInstallationUsageSummary'
/fleets/{fleetId}/actions/summarizeApplicationUsage:
get:
description: List application usage in a Fleet filtered by query parameters.
operationId: SummarizeApplicationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/ApplicationTypeQueryParam'
- $ref: '#/components/parameters/JreVendorQueryParam'
- $ref: '#/components/parameters/JreDistributionQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/InstallationPathQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/SummarizeApplicationUsageFieldsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ApplicationSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/DisplayNameContainsQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
responses:
200:
description: A list of Java application usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationUsageCollection'
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 application usage in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeApplicationUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ApplicationUsage'
/fleets/{fleetId}/actions/summarizeDeployedApplicationInstallationUsage:
get:
description: 'Summarize installation usage of an application deployed on Java servers in a fleet filtered by query parameters. In contrast to SummarizeDeployedApplicationUsage, which provides only information aggregated by the deployment information, this operation provides installation details and allows for better focusing of actions.
'
operationId: SummarizeDeployedApplicationInstallationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaServerIdentifierQueryParameter'
- $ref: '#/components/parameters/JavaServerInstanceIdentifierQueryParameter'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedAppInstallationIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationNameContainsQueryParam'
- $ref: '#/components/parameters/DeployedApplicationNameQueryParam'
- $ref: '#/components/parameters/DeployedApplicationSourcePathContainsQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DeployedApplicationInstallationSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of deployed application installation usages.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DeployedApplicationInstallationUsageSummaryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarize deployed application installation usage in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeDeployedApplicationInstallationUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DeployedApplicationInstallationUsageSummary'
/fleets/{fleetId}/actions/summarizeDeployedApplicationUsage:
get:
description: 'List of deployed applications in a Fleet filtered by query parameters.
'
operationId: SummarizeDeployedApplicationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaServerIdentifierQueryParameter'
- $ref: '#/components/parameters/JavaServerInstanceIdentifierQueryParameter'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationNameContainsQueryParam'
- $ref: '#/components/parameters/DeployedApplicationNameQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DeployedApplicationSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of deployed application usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DeployedApplicationUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List of deployed applications in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeDeployedApplicationUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DeployedApplicationUsage'
/fleets/{fleetId}/actions/summarizeInstallationUsage:
get:
description: List Java installation usage in a Fleet filtered by query parameters.
operationId: SummarizeInstallationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JreVendorQueryParam'
- $ref: '#/components/parameters/JreDistributionQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/PathQueryParam'
- $ref: '#/components/parameters/RelatedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/SummarizeInstallationUsageFieldsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/InstallationSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/PathContainsQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
responses:
200:
description: A list of Java installation usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstallationUsageCollection'
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 Java installation usage in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeInstallationUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/InstallationUsage'
/fleets/{fleetId}/actions/summarizeJavaServerInstanceUsage:
get:
description: 'List Java Server instances in a fleet filtered by query parameters.
'
operationId: SummarizeJavaServerInstanceUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaServerIdentifierQueryParameter'
- $ref: '#/components/parameters/JavaServerInstanceIdentifierQueryParameter'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
- $ref: '#/components/parameters/JavaServerInstanceNameContainsQueryParam'
- $ref: '#/components/parameters/JavaServerInstanceNameQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaServerInstanceSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Java Server instance usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaServerInstanceUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List of Java Server instances in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeJavaServerInstanceUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaServerInstanceUsage'
/fleets/{fleetId}/actions/summarizeJavaServerUsage:
get:
description: 'List of Java servers in a Fleet filtered by query parameters.
'
operationId: SummarizeJavaServerUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaServerIdentifierQueryParameter'
- $ref: '#/components/parameters/JavaServerNameContainsQueryParam'
- $ref: '#/components/parameters/JavaServerNameQueryParam'
- $ref: '#/components/parameters/JavaServerVersionQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaServerSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Java Server usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaServerUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List of Java Servers in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeJavaServerUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaServerUsage'
/fleets/{fleetId}/actions/summarizeJreUsage:
get:
description: List Java Runtime usage in a specified Fleet filtered by query parameters.
operationId: SummarizeJreUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JreIdentifierQueryParam'
- $ref: '#/components/parameters/VendorQueryParam'
- $ref: '#/components/parameters/DistributionQueryParam'
- $ref: '#/components/parameters/VersionQueryParam'
- $ref: '#/components/parameters/RelatedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/SummarizeJreUsageFieldsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JreSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
responses:
200:
description: A list of Java Runtime usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JreUsageCollection'
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 Java Runtime usage in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeJreUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JreUsage'
/fleets/{fleetId}/actions/summarizeLibraryUsage:
get:
description: 'List libraries in a fleet filtered by query parameters.
'
operationId: SummarizeLibraryUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaServerInstanceIdentifierQueryParameter'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/DeployedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
- $ref: '#/components/parameters/LibraryNameContainsQueryParam'
- $ref: '#/components/parameters/LibraryNameQueryParam'
- $ref: '#/components/parameters/CvssScoreGreaterThanQueryParam'
- $ref: '#/components/parameters/CvssScoreLessThanQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/LibrarySortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of library usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List libraries in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeLibraryUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/LibraryUsage'
/fleets/{fleetId}/actions/summarizeManagedInstanceUsage:
get:
description: List managed instance usage in a Fleet filtered by query parameters.
operationId: SummarizeManagedInstanceUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceTypeQueryParam'
- $ref: '#/components/parameters/JreVendorQueryParam'
- $ref: '#/components/parameters/JreDistributionQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/InstallationPathQueryParam'
- $ref: '#/components/parameters/RelatedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/SummarizeManagedInstanceUsageFieldsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ManagedInstanceSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/HostnameContainsQueryParam'
- $ref: '#/components/parameters/LibraryIdentifierQueryParam'
responses:
200:
description: A list of managed instance usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedInstanceUsageCollection'
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 managed instance usage in a Fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/actions/summarizeManagedInstanceUsage?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedInstanceUsage'
/fleets/{fleetId}/advancedFeatureConfiguration:
get:
description: 'Returns Fleet level advanced feature configuration.
'
operationId: GetFleetAdvancedFeatureConfiguration
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Return all advanced feature configurations for the Fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetAdvancedFeatureConfiguration'
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: Get fleet advanced feature config.
tags:
- javaManagementService
x-related-resource: '#/definitions/FleetAdvancedFeatureConfiguration'
put:
description: 'Update advanced feature configurations for the Fleet.
Ensure that the namespace and bucket storage are created prior to turning on the JfrRecording or CryptoEventAnalysis feature.
'
operationId: UpdateFleetAdvancedFeatureConfiguration
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Return all advanced feature configurations for the Fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetAdvancedFeatureConfiguration'
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: Update fleet advanced feature config.
tags:
- javaManagementService
x-related-resource: '#/definitions/FleetAdvancedFeatureConfiguration'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFleetAdvancedFeatureConfigurationDetails'
description: Update advanced feature configurations with new fields.
required: true
/fleets/{fleetId}/agentConfiguration:
get:
description: Retrieve a Fleet Agent Configuration for the specified Fleet.
operationId: GetFleetAgentConfiguration
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the Fleet Agent Configuration for the specified Fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetAgentConfiguration'
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 a Fleet Agent Configuration.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/agentConfig
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: Update the Fleet Agent Configuration for the specified Fleet.
operationId: UpdateFleetAgentConfiguration
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Fleet Agent Configuration 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a Fleet Agent Configuration.
tags:
- javaManagementService
x-example: "PUT /20210610/fleets/<fleet_OCID>/agentConfig\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"jreScanFrequencyInMinutes\": 180,\n \"javaUsageTrackerProcessingFrequencyInMinutes\": 5,\n \"linuxConfiguration\": {\n \"includePaths\": [\"/var/www/opc\", \"${HOME}/jdk\"],\n \"excludePaths\": [\"/home/etc\"]\n },\n \"windowsConfiguration\": {\n \"includePaths\": [\"C://path\"],\n \"excludePaths\": [\"E://path\", \"%windir%/System32\"]\n },\n \"macOsConfiguration\": {\n \"includePaths\": [\"/Library/Java\"],\n \"excludePaths\": [\"/home\"]\n }\n}\n"
x-related-resource: '#/definitions/FleetAgentConfiguration'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFleetAgentConfigurationDetails'
description: The new details for the Fleet Agent Configuration.
required: true
/fleets/{fleetId}/blocklists:
get:
description: 'Returns a list of blocklist entities contained by a fleet.
'
operationId: ListBlocklists
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/OperationQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/BlocklistSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A page of Blocklist objects.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/BlocklistCollection'
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 the blocklist of the fleet.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/blocklist
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Blocklist'
post:
description: 'Add a new record to the fleet blocklist.
'
operationId: CreateBlocklist
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A blocklist record is 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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Blocklist'
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: Add a new blocklist record.
tags:
- javaManagementService
x-example: "POST /20210610/fleets/<fleet_OCID>/blocklist\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"target\": {\n \"fleetId\": \"<fleet_OCID>\",\n \"managedInstanceId\": \"<managed_instance_OCID>\",\n \"installationKey\": \"<unique_id>\"\n },\n \"operation\": \"DELETE_JAVA_INSTALLATION\",\n \"reason\": \"Required for Java Management System agent.\"\n}\n"
x-related-resource: '#/definitions/Blocklist'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBlocklistDetails'
description: Details for the new blocklist record.
required: true
/fleets/{fleetId}/blocklists/{blocklistKey}:
delete:
description: Deletes the blocklist record specified by an identifier.
operationId: DeleteBlocklist
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/BlocklistIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The blocklist record is deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
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: Delete a blocklist record.
tags:
- javaManagementService
x-example: 'DELETE /20210610/fleets/<fleet_OCID>/blocklist/<unique_id>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Blocklist'
/fleets/{fleetId}/containers:
get:
description: List containers in a fleet filtered by query parameters.
operationId: ListContainers
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/ApplicationNameQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
- $ref: '#/components/parameters/TimeStartedGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeStartedLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/ContainerSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of containers.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, 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'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List containers in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/containers?managedInstanceId=<managed_instance_id>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ContainerSummary'
/fleets/{fleetId}/cryptoAnalysisResults:
get:
description: Lists the results of a Crypto event analysis.
operationId: ListCryptoAnalysisResults
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/CryptoAnalysisResultAggregationModeQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/HostnameQueryParam'
- $ref: '#/components/parameters/NonCompliantFindingCountQueryParam'
- $ref: '#/components/parameters/NonCompliantFindingCountGreaterThanQueryParam'
- $ref: '#/components/parameters/FindingCountQueryParam'
- $ref: '#/components/parameters/FindingCountGreaterThanQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/CryptoAnalysisResultSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of a Crypto event analysis result.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoAnalysisResultCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Crypto Event Analysis results.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/cryptoAnalysisResults?aggregationMode=MANAGED_INSTANCE
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CryptoAnalysisResult'
/fleets/{fleetId}/cryptoAnalysisResults/{cryptoAnalysisResultId}:
delete:
description: Deletes the metadata for the result of a Crypto event analysis. The actual report shall remain in the object storage.
operationId: DeleteCryptoAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/CryptoAnalysisResultIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The metadata of the Crypto event analysis 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete metadata of a Crypto Event Analysis result.
tags:
- javaManagementService
x-example: 'DELETE /20210610/fleets/<fleet_OCID>/cryptoAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CryptoAnalysisResult'
get:
description: Retrieve the metadata for the result of a Crypto event analysis.
operationId: GetCryptoAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/CryptoAnalysisResultIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Metadata of the Crypto event analysis result. The actual analysis result content is stored in the Object Storage.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CryptoAnalysisResult'
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 metadata of a Crypto Event Analysis result.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/cryptoAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/fleets/{fleetId}/diagnoses:
get:
description: 'List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.
'
operationId: ListFleetDiagnoses
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of a diagnoses.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/FleetDiagnosisCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List diagnoses on resources needed by the fleet.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/diagnoses
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/FleetDiagnosisSummary'
/fleets/{fleetId}/drsFiles:
get:
description: List the details about the created DRS files in the Fleet.
operationId: ListDrsFiles
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/DrsFileSortByQueryParam'
responses:
200:
description: Details of the Fleet specific DRS file in Object Storage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrsFileCollection'
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: List the DRS details.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/drsFiles
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrsFileCollection'
post:
description: 'Request to perform validation of the DRS file and create the file to the Object Storage.
'
operationId: CreateDrsFile
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Request to create DRS file in Object Store.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDrsFileDetails'
description: Detail information to create DRS
required: true
/fleets/{fleetId}/drsFiles/{drsFileKey}:
delete:
description: 'Request to delete the DRS file from the Object Storage.
'
operationId: DeleteDrsFile
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/DrsFileKeyPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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: Delete DRS file from object store.
tags:
- javaManagementService
x-related-resource: '#/definitions/DrsFile'
get:
description: Get the detail about the created DRS file in the Fleet.
operationId: GetDrsFile
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/DrsFileKeyPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
responses:
200:
description: Details of the Fleet specific DRS file in Object Storage.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DrsFile'
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: Get the DRS detail.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/drsFiles/<drs_file_key>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DrsFile'
put:
description: 'Request to perform validation of the DRS file and update the existing file in the Object Storage.
'
operationId: UpdateDrsFile
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/DrsFileKeyPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
202:
description: Accepted the request.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 the 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'
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: Request to update DRS to object store.
tags:
- javaManagementService
x-related-resource: '#/definitions/Fleet'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDrsFileDetails'
description: Detail information to update DRS
required: true
/fleets/{fleetId}/exportSetting:
get:
description: Returns export setting for the specified fleet.
operationId: GetExportSetting
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: An export setting for the specified fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExportSetting'
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: Retrieves export setting
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/exportSetting
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: Updates existing export setting for the specified fleet.
operationId: UpdateExportSetting
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: An export setting for the specified fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExportSetting'
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 existing Export setting.
tags:
- javaManagementService
x-example: "PUT /20210610/fleets/<fleet_OCID>/exportSetting\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n\n{\n \"exportDuration\": \"LAST_30_DAYS\",\n \"exportResources\":\"MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION\",\n \"isCrossRegionAcknowledged\": false,\n \"targetBucketName\":\"\",\n \"targetBucketNamespace\":\"\",\n \"targetBucketRegion\":\"us-phoenix-1\",\n \"exportFrequency\": \"DAILY\",\n \"exportDataFilters\": {\n \"javaVersions\": [\n \"1.8.0_381\",\n \"21.0.2\"\n ],\n \"javaMajorVersions\" : [\n \"11\",\n \"17\"\n ],\n \"javaVendors\": [\n \"Oracle Corporation\",\n \"OpenJDK\"\n ],\n \"applicationNameEqualTo\": [\n \"EchoClient\",\n \"SomeApp\"\n ],\n \"applicationNameContains\": [\n \"TestApp\",\n \"Echo\"\n ],\n \"securityStatuses\": [\n \"UPDATE_AVAILABLE\",\n \"UP_TO_DATE\"\n ]\n },\n \"isEnabled\": true\n}\n"
x-related-resource: '#/definitions/ExportSetting'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateExportSettingDetails'
description: The new details for the export setting.
required: true
/fleets/{fleetId}/exportStatus:
get:
description: Returns last export status for the specified fleet.
operationId: GetExportStatus
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Last export status for the specified fleet.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExportStatus'
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: Retrieves last export status
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/exportStatus
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/fleets/{fleetId}/installationSites:
get:
description: List Java installation sites in a Fleet filtered by query parameters.
operationId: ListInstallationSites
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JreVendorQueryParam'
- $ref: '#/components/parameters/JreDistributionQueryParam'
- $ref: '#/components/parameters/JreVersionQueryParam'
- $ref: '#/components/parameters/PathQueryParam'
- $ref: '#/components/parameters/RelatedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/InstallationSiteSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/OsFamilyQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
- $ref: '#/components/parameters/PathContainsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
responses:
200:
description: A list of Java installation sites.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/InstallationSiteCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Java installations in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/installationSites?jreVersion=<jre_version>&jreVendor=<jre_vendor>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/InstallationSiteSummary'
/fleets/{fleetId}/javaMigrationAnalysisResults:
get:
description: Lists the results of a Java migration analysis.
operationId: ListJavaMigrationAnalysisResults
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/HostnameQueryParam'
- $ref: '#/components/parameters/ApplicationNameQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaMigrationAnalysisResultSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of the Java migration analysis result.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaMigrationAnalysisResultCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists the Java migration analysis results.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/javaMigrationAnalysisResults
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaMigrationAnalysisResult'
/fleets/{fleetId}/javaMigrationAnalysisResults/{javaMigrationAnalysisResultId}:
delete:
description: Delete the Java migration analysis result. The actual report will remain in the Object Storage bucket.
operationId: DeleteJavaMigrationAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaMigrationAnalysisResultIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Java migration analysis 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete Java Migration Analysis result.
tags:
- javaManagementService
x-example: 'DELETE /20210610/fleets/<fleet_OCID>/javaMigrationAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaMigrationAnalysisResult'
get:
description: Retrieve Java Migration Analysis result.
operationId: GetJavaMigrationAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/JavaMigrationAnalysisResultIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Java migration analysis result. The actual analysis result is stored in the Object Storage bucket.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaMigrationAnalysisResult'
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 Java Migration Analysis result.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/javaMigrationAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/fleets/{fleetId}/libraries/{libraryKey}/applications:
get:
description: 'List applications where a library has been detected filtered by query parameters.
'
operationId: ListLibraryApplicationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/LibraryIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationNameQueryParam'
- $ref: '#/components/parameters/ApplicationNameContainsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LibraryApplicationSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of library application usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryApplicationUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'List applications where a library has been detected.
'
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/libraries/<unique_id>/applications?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/LibraryApplicationUsageSummary'
/fleets/{fleetId}/libraries/{libraryKey}/managedInstances:
get:
description: 'List managed instances where a library has been detected, filtered by query parameters.
'
operationId: ListLibraryManagedInstanceUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/LibraryIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/HostnameQueryParam'
- $ref: '#/components/parameters/HostnameContainsQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/LibraryManagedInstanceSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of library managed instance usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryManagedInstanceUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: 'List managed instances where a library has been detected.
'
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/libraries/<unique_id>/managedInstances?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/LibraryManagedInstanceUsageSummary'
/fleets/{fleetId}/performanceTuningAnalysisResults:
get:
description: List Performance Tuning Analysis results.
operationId: ListPerformanceTuningAnalysisResults
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationNameQueryParam'
- $ref: '#/components/parameters/HostnameQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PerformanceTuningAnalysisResultSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Performance Tuning Analysis result.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceTuningAnalysisResultCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Performance Tuning Analysis results.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/performanceTuningAnalysisResults
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PerformanceTuningAnalysisResult'
/fleets/{fleetId}/performanceTuningAnalysisResults/{performanceTuningAnalysisResultId}:
delete:
description: Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage.
operationId: DeletePerformanceTuningAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PerformanceTuningAnalysisResultIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The metadata of the Performance Tuning Analysis 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, 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 the status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete metadata of a Performance Tuning Analysis result.
tags:
- javaManagementService
x-example: 'DELETE /20210610/fleets/<fleet_OCID>/performanceTuningAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PerformanceTuningAnalysisResult'
get:
description: Retrieve metadata of the Performance Tuning Analysis result.
operationId: GetPerformanceTuningAnalysisResult
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PerformanceTuningAnalysisResultIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Metadata of the Performance Tuning Analysis result. The actual analysis result content is stored in the Object Storage.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceTuningAnalysisResult'
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 metadata of a Performance Tuning Analysis result.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/performanceTuningAnalysisResults/<result_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
/fleets/{fleetId}/summarizeLibraryInventory:
get:
description: 'Retrieve the inventory of libraries in the specified fleet: Statically detected library count, Dynamically detected library count, Uncorrelated package count, High, Medium and Low severity library count.
'
operationId: SummarizeLibraryInventory
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A summary of libraries inventory.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/LibraryInventory'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieves libraries inventory in a fleet, filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/summarizeLibraryInventory?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/LibraryInventory'
/fleets/{fleetId}/uncorrelatedPackages:
get:
description: 'List uncorrelated package summaries in a fleet, filtered by query parameters. Uncorrelated packages are Java packages which can''t be accurately correlated to a library during a library scan.
'
operationId: ListUncorrelatedPackageUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PackageIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PackageSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of uncorrelated package usage summaries.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UncorrelatedPackageUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List uncorrelated package summaries in a fleet, filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/uncorrelatedPackages?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/UncorrelatedPackageUsageSummary'
/fleets/{fleetId}/uncorrelatedPackages/{packageName}/applications:
get:
description: 'List applications where an uncorrelated package has been detected, filtered by query parameters.
'
operationId: ListUncorrelatedPackageApplicationUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PackageIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/UncorrelatedPackageApplicationSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of UncorrelatedPackageApplicationUsageSummaries.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UncorrelatedPackageApplicationUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List applications where an uncorrelated package has been detected.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/uncorrelatedPackages/<unique_id>/applications?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/UncorrelatedPackageApplicationUsageSummary'
/fleets/{fleetId}/uncorrelatedPackages/{packageName}/managedInstances:
get:
description: 'List managed instances where an uncorrelated package has been detected, filtered by query parameters.
'
operationId: ListUncorrelatedPackageManagedInstanceUsage
parameters:
- $ref: '#/components/parameters/FleetIdentifierPathParam'
- $ref: '#/components/parameters/PackageIdentifierPathParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/UncorrelatedPackageManagedInstanceSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of UncorrelatedPackageManagedInstanceUsageSummaries.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/UncorrelatedPackageManagedInstanceUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List uncorrelated Java package detection events for a Java application in a fleet filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/fleets/<fleet_OCID>/uncorrelatedPackages/<unique_id>/managedInstances?timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/UncorrelatedPackageManagedInstanceUsageSummary'
/javaFamilies:
get:
description: 'Returns a list of the Java release family information.
A Java release family is typically a major version in the Java version identifier.
'
operationId: ListJavaFamilies
parameters:
- $ref: '#/components/parameters/JavaFamilyVersionQueryParam'
- $ref: '#/components/parameters/JavaFamilyDisplayNameQueryParam'
- $ref: '#/components/parameters/SupportedVersionQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaFamilySortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of the Java release family information.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaFamilyCollection'
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 a list of the Java release family information.
tags:
- javaManagementService
x-example: 'GET /20210610/javaFamilies?limit=10
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaFamily'
/javaFamilies/{familyVersion}:
get:
description: 'Returns metadata associated with a specific Java release family.
'
operationId: GetJavaFamily
parameters:
- $ref: '#/components/parameters/JavaFamilyIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of a Java release family with specified version.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaFamily'
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 metadata associated with a specific Java release family.
tags:
- javaManagementService
x-example: 'GET /20210610/javaFamilies/<family_version_identifier>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaFamily'
/javaReleases:
get:
description: 'Returns a list of Java releases.
'
operationId: ListJavaReleases
parameters:
- $ref: '#/components/parameters/JavaReleaseVersionQueryParam'
- $ref: '#/components/parameters/JavaFamilyVersionQueryParam'
- $ref: '#/components/parameters/JavaReleaseTypeQueryParam'
- $ref: '#/components/parameters/SecurityStatusQueryParam'
- $ref: '#/components/parameters/JavaLicenseTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JavaReleaseSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of Java releases.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaReleaseCollection'
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 a list of Java releases.
tags:
- javaManagementService
x-example: 'GET /20210610/javaReleases?limit=10
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaRelease'
/javaReleases/{releaseVersion}:
get:
description: Returns detail of a Java release.
operationId: GetJavaRelease
parameters:
- $ref: '#/components/parameters/JavaReleaseIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of a specific release of Java.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JavaRelease'
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 complete details of a specific Java release including artifact information.
tags:
- javaManagementService
x-example: 'GET /20210610/javaReleases/<release_version_identifier>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JavaRelease'
/jmsPlugins:
get:
description: Lists the JmsPlugins.
operationId: ListJmsPlugins
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/JmsPluginIdentifierQueryParam'
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/AgentIdentifierQueryParam'
- $ref: '#/components/parameters/JmsPluginLifecycleStateQueryParam'
- $ref: '#/components/parameters/JmsPluginAvailabilityStatusQueryParam'
- $ref: '#/components/parameters/JmsPluginAgentTypeQueryParam'
- $ref: '#/components/parameters/TimeRegisteredLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeLastSeenLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JmsPluginSortByQueryParam'
- $ref: '#/components/parameters/HostnameContainsQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of JmsPlugins.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JmsPluginCollection'
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: Returns a list of JmsPlugins.
tags:
- javaManagementService
x-example: 'GET /20210610/jmsPlugins?limit=10&compartmentId=<compartment_OCID>&compartmentIdInSubtree=false
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JmsPlugin'
post:
description: 'Registers an agent''s JmsPlugin, optionally attaching to an existing fleet of the tenancy.
JmsPlugins registered fleet-less are created with lifecycle state INACTIVE.
For the operation to be authorized, the agent must exist, and the authorized user requires JMS_PLUGIN_CREATE permission for the agent''s compartment.
'
operationId: CreateJmsPlugin
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The JmsPlugin was successfully 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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JmsPlugin'
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: Creates a JmsPlugin.
tags:
- javaManagementService
x-related-resource: '#/definitions/JmsPlugin'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJmsPluginDetails'
description: Details for the new JmsPlugin.
required: true
/jmsPlugins/{jmsPluginId}:
delete:
description: 'Deletes a JmsPlugin. The JmsPlugin may be visible for some time with state DELETED.
Deleted plugins will not be able to communicate with the JMS service.
'
operationId: DeleteJmsPlugin
parameters:
- $ref: '#/components/parameters/JmsPluginIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The JmsPlugin has been DELETED.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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 JmsPlugin.
tags:
- javaManagementService
x-related-resource: '#/definitions/JmsPlugin'
get:
description: Returns the JmsPlugin.
operationId: GetJmsPlugin
parameters:
- $ref: '#/components/parameters/JmsPluginIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the JmsPlugin with the specified identifier.
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, 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: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/JmsPlugin'
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: Returns the JmsPlugin.
tags:
- javaManagementService
x-example: 'GET /20210610/jmsPlugin/<jmsplugin_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JmsPlugin'
put:
description: Updates the Fleet of a JmsPlugin.
operationId: UpdateJmsPlugin
parameters:
- $ref: '#/components/parameters/JmsPluginIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The JmsPlugin has been 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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JmsPlugin'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update a JmsPlugin.
tags:
- javaManagementService
x-related-resource: '#/definitions/JmsPlugin'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateJmsPluginDetails'
description: The new details for the JmsPlugin.
required: true
/listJreUsage:
get:
description: List Java Runtime usage in a specified host filtered by query parameters.
operationId: ListJreUsage
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/HostIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationIdentifierQueryParam'
- $ref: '#/components/parameters/ApplicationNameQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JreSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of Java Runtime usage.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JreUsageCollection'
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 Java Runtime usage in a specified host filtered by query parameters.
tags:
- javaManagementService
x-example: 'GET /20210610/listJreUsage?compartmentId=<compartment_OCID>&hostId=<host_OCID>&timeStart=<start_time>&timeEnd=<end_time>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JreUsage'
/pluginErrorAnalytics:
get:
description: Returns a high level summary of PluginErrors.
operationId: SummarizePluginErrors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of fleet error aggregations.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PluginErrorAggregationCollection'
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: Returns a summary of PluginErrors.
tags:
- javaManagementService
x-example: 'GET /20210610/pluginErrorAnalytics?limit=10&compartmentId=<compartment_OCID>&compartmentIdInSubtree=false
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PluginErrorAggregation'
/pluginErrors:
get:
description: Returns a list of plugin errors that describe all detected errors.
operationId: ListPluginErrors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/TimeErrorFirstSeenLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorFirstSeenGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorLastSeenLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TimeErrorLastSeenGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PluginErrorSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: List of PluginErrors.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PluginErrorCollection'
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: Returns a list of PluginErrors.
tags:
- javaManagementService
x-example: 'GET /20210610/pluginErrors?limit=10&compartmentId=<compartment_OCID>&compartmentIdInSubtree=false
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PluginErrorSummary'
/summarizeResourceInventory:
get:
description: 'Retrieve the inventory of JMS resources in the specified compartment: a list of the number of _active_ fleets, managed instances, Java Runtimes, Java installations, and applications.
'
operationId: SummarizeResourceInventory
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam'
- $ref: '#/components/parameters/TimeStartQueryParam'
- $ref: '#/components/parameters/TimeEndQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: An inventory of JMS resources in a compartment.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInventory'
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 the inventory of JMS resources in the specified compartment.
tags:
- javaManagementService
x-example: 'GET /20210610/summarizeResourceInventory?compartmentId=<compartment_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Fleet'
/taskSchedules:
get:
description: 'Returns a list of task schedules.
'
operationId: ListTaskSchedules
parameters:
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/TaskScheduleIdentifierQueryParam'
- $ref: '#/components/parameters/RelatedManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/TaskScheduleNameQueryParam'
- $ref: '#/components/parameters/TaskScheduleNameContainsQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/TaskScheduleSortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A list of task schedule.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TaskScheduleCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List the task schedule results.
tags:
- javaManagementService
x-example: 'GET /20210610/taskSchedules?fleetId=≶fleet_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/TaskSchedule'
post:
description: Create a task schedule using the information provided.
operationId: CreateTaskSchedule
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: A task schedule record is 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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSchedule'
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'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Create a task schedule.
tags:
- javaManagementService
x-example: "POST /20210610/taskSchedules\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n fleetId: \"<fleet_OCID>\",\n executionRecurrences: \"DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z\",\n taskDetails: {\n taskType: \"CRYPTO\",\n cryptoTaskRequest: {\n targets: [\n {\n managedInstanceId: \"<managed_instance_OCID>\"\n },\n {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }\n ],\n recordingDurationInMunites: \"180\",\n waitingPeriodInMinutes: \"10\"\n }\n }\n}\n"
x-related-resource: '#/definitions/TaskSchedule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTaskScheduleDetails'
description: Details for the new task schedule.
required: true
/taskSchedules/{taskScheduleId}:
delete:
description: Deletes the task schedule record specified by an identifier.
operationId: DeleteTaskSchedule
parameters:
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/TaskScheduleIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: A task schedule record is deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, provide the request ID.
'
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: Delete a task schedule record.
tags:
- javaManagementService
x-example: "DELETE /20210610/taskSchedules/<task_schedule_OCID>?fleetId=≶fleet_OCID> \nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n"
x-related-resource: '#/definitions/TaskSchedule'
get:
description: 'Returns a task schedule.
'
operationId: GetTaskSchedule
parameters:
- $ref: '#/components/parameters/FleetIdQueryParam'
- $ref: '#/components/parameters/TaskScheduleIdentifierPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Details of the task schedule.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSchedule'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
405:
$ref: '#/components/responses/405'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Retrieve a task schedule.
tags:
- javaManagementService
x-example: 'GET /20210610/taskSchedules/<task_schedule_OCID>?fleetId=≶fleet_OCID>
Host: javamanagement.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/TaskSchedule'
put:
description: 'Update the task schedule for the given task type.
'
operationId: UpdateTaskSchedule
parameters:
- $ref: '#/components/parameters/TaskScheduleIdentifierPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: An updated task schedule.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSchedule'
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: Update a task schedule.
tags:
- javaManagementService
x-example: "PUT /20210610/taskSchedules/<task_schedule_OCID>\nHost: javamanagement.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n fleetId: \"<fleet_OCID>\",\n executionRecurrences: \"DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z\",\n taskDetails: {\n taskType: \"CRYPTO\",\n cryptoTaskRequest: {\n targets: [\n {\n managedInstanceId: \"<managed_instance_OCID>\"\n },\n {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }\n ],\n recordingDurationInMunites: \"180\",\n waitingPeriodInMinutes: \"10\"\n }\n }\n}\n"
x-related-resource: '#/definitions/TaskSchedule'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTaskScheduleDetails'
description: Update task schedule details for a given task.
required: true
/workRequests:
get:
description: 'List the work requests in a compartment. The query parameter `compartmentId` is required unless the query parameter `id` or `fleetId` is specified.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/FleetFilterQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/ManagedInstanceIdentifierQueryParam'
- $ref: '#/components/parameters/OperationTypeQueryParam'
- $ref: '#/components/parameters/OperationStatusQueryParam'
responses:
200:
description: A list of work request descriptions.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Work Requests.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}:
delete:
description: Deletes the work request specified by an identifier.
operationId: CancelWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: Accepted the request. The work request will be canceled with best effort.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, 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: Cancel a work request.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkRequest'
get:
description: Retrieve the details of a work request with the specified ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A description of a work request.
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, 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: number
format: float
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: Retrieve Work Request description.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}/errors:
get:
description: 'Retrieve a (paginated) list of errors for a specified work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: A list of work request errors.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, 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 work request errors.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkRequestError'
/workRequests/{workRequestId}/logs:
get:
description: 'Retrieve a paginated list of logs for a specified work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: A 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.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, 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 work request logs.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkRequestLogEntry'
/workRequests/{workRequestId}/workItems:
get:
description: 'Retrieve a paginated list of work items for a specified work request.
'
operationId: ListWorkItems
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: A list of work items.
headers:
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/WorkItemCollection'
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 items of a work request.
tags:
- javaManagementService
x-related-resource: '#/definitions/WorkItemSummary'
components:
schemas:
CryptoAnalysisResultCollection:
description: List of Crypto event analysis results.
properties:
items:
description: A list of Crypto Event Analysis results.
items:
$ref: '#/components/schemas/CryptoAnalysisResultSummary'
type: array
required:
- items
type: object
DrsFile:
description: 'A Deployment Rule Set(DRS) is a JAR (Java ARchive) file used in Java applications to enforce security and manage compatibility
between different versions of Java applets and web start applications
(https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/deployment_rules.html).
'
properties:
bucketName:
description: The Object Storage bucket name where the DRS file is located.
type: string
checksumType:
description: The checksum type for the DRS file in Object Storage.
enum:
- SHA256
type: string
checksumValue:
description: The checksum value for the DRS file in Object Storage.
maxLength: 256
type: string
drsFileKey:
description: The unique identifier of the DRS file in Object Storage.
maxLength: 36
type: string
drsFileName:
description: The name of the DRS file in Object Store.
maxLength: 1024
type: string
isDefault:
default: false
description: To check if the DRS file is the detfault ones.
type: boolean
namespace:
description: The namespace for Object Storage.
type: string
required:
- bucketName
- namespace
- drsFileKey
- drsFileName
- checksumType
- checksumValue
- isDefault
JavaLicense:
description: Information about a license type for Java.
properties:
displayName:
description: Commonly used name for the license type.
type: string
licenseType:
description: License Type
enum:
- OTN
- NFTC
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
licenseUrl:
description: Publicly accessible license URL containing the detailed terms and conditions.
format: uri
maxLength: 512
type: string
required:
- displayName
- licenseType
- licenseUrl
type: object
x-example: "{\n \"displayName\": \"Oracle Technology Network\",\n \"licenseType\": \"OTN\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/javase-license1.html\"\n}\n"
LibraryUsage:
description: 'Library usage during a specified time period.
'
properties:
approximateApplicationCount:
description: 'The approximate count of applications using the library.
'
type: integer
approximateDeployedApplicationCount:
description: 'The approximate count of deployed applications using the library.
'
type: integer
approximateJavaServerInstanceCount:
description: 'The approximate count of Java Server instances using the library.
'
type: integer
approximateManagedInstanceCount:
description: 'The approximate count of managed instances using the library.
'
type: integer
confidenceLevel:
description: Confidence level of the assessed library's vulnerabilities.
enum:
- HIGH
- MEDIUM
- LOW
type: string
x-obmcs-top-level-enum: '#/definitions/ConfidenceLevel'
cveId:
description: 'Deprecated, use `vulnerabilities` instead.
The Common Vulnerabilities and Exposures (CVE) ID.
'
type: string
cvssScore:
description: 'Deprecated, use `highestVulnerabilityScore` instead.
The Common Vulnerability Scoring System (CVSS) score. If `cvssScore` is not available, it will be set to -1.0. It is set to 0.0 when `cveId` is null.
'
format: float
type: number
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related fleet.
'
type: string
highestVulnerabilityScore:
description: 'Highest CVSS score among the all vulnerabilities. If highest CVSS score is not available, it will be set to -1.0. It is set to 0.0 when there is no associated vulnerabilities.
'
format: float
type: number
isDynamicallyDetected:
description: 'Indicates whether the library was dynamically detected.
'
type: boolean
libraryKey:
description: 'The internal identifier of the library.
'
type: string
libraryName:
description: 'The name of the library.
'
type: string
libraryVersion:
description: 'The version of the library.
'
type: string
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastCveRefreshed:
description: 'Deprecated.
The date and time of the last CVEs refresh was completed.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
vulnerabilities:
description: The list of library vulnerabilities.
items:
$ref: '#/components/schemas/LibraryVulnerability'
type: array
required:
- libraryKey
- fleetId
- libraryName
- isDynamicallyDetected
type: object
x-example: "{\n \"libraryKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"libraryName\":\"Example library name\",\n \"libraryVersion\":\"1.0\",\n \"cveId\":\"CVE-2019-16163\",\n \"cvssScore\":3.0,\n \"highestVulnerabilityScore\":3.0\n \"vulnerabilities\": [\n {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":3.0\n }, {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":2.0\n }],\n \"confidenceLevel\":\"HIGH\",\n \"approximateApplicationCount\":10,\n \"approximateJavaServerInstanceCount\":2,\n \"approximateDeployedApplicationCount\":14,\n \"apporximateManagedInstanceCount\":1,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\",\n \"timeLastCveRefreshed\":\"2022-01-26T10:00:00.000Z\"\n}\n"
Error:
description: An error code and message from an API request failure.
properties:
code:
description: A short error code that describes the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm).
type: string
message:
description: A human-readable error string.
type: string
required:
- code
- message
JfrAttachmentTarget:
description: 'The target to collect JFR data. A target is a managed instance, with options to further limit to specific container and/or application and/or Java Runtime.
When the applicationKey isn''t specified, then all applications are selected.
When the jreKey isn''t specified, then all supported Java Runtime versions are selected.
When the applicationInstallationKey isn''t specified, then all application installations are selected.
When the containerKey isn''t specified, then all containers are selected.
Keys applicationKey and applicationInstallationKey are mutually exclusive.
'
properties:
applicationInstallationKey:
description: Unique key that identifies the application installation for JFR data collection.
maxLength: 255
minLength: 1
type: string
applicationKey:
description: Unique key that identifies the application for JFR data collection.
maxLength: 255
minLength: 1
type: string
containerKey:
description: Unique key that identifies the container for JFR data collection.
maxLength: 255
minLength: 1
type: string
jreKey:
description: Unique key that identify the JVM for JFR data collection.
maxLength: 255
minLength: 1
type: string
managedInstanceId:
description: OCID of the Managed Instance to collect JFR data.
maxLength: 255
minLength: 1
type: string
required:
- managedInstanceId
KeySizeAlgorithm:
description: The algorithm object with name and key size properties.
properties:
keySize:
description: 'Key size for the encryption algorithm.
Allowed values: 256 for EC, 2048 for DH/DSA/RSA
'
type: integer
name:
description: The algorithm name.
enum:
- RSA
- DSA
- EC
- DH
type: string
x-obmcs-top-level-enum: '#/definitions/Algorithms'
type: object
AddFleetInstallationSitesDetails:
description: The list of Java installation sites to add.
properties:
installationSites:
description: The list of installation sites to add.
items:
$ref: '#/components/schemas/NewInstallationSite'
maxItems: 32768
type: array
postInstallationActions:
description: Optional list of post java installation actions
items:
$ref: '#/components/schemas/PostInstallationActions'
maxItems: 100
type: array
required:
- installationSites
type: object
FleetSummary:
description: 'The summary of the Fleet.
A Fleet is the primary collection with which users interact when using Java Management Service.
'
properties:
approximateApplicationCount:
description: 'The approximate count of all unique applications in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateInstallationCount:
description: 'The approximate count of all unique Java Installations in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateJavaServerCount:
description: 'The approximate count of all unique Java servers in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateJreCount:
description: 'The approximate count of all unique Java Runtimes in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateLibraryCount:
description: 'The approximate count of all unique libraries in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateLibraryVulnerabilityCount:
description: 'The approximate count of all unique library vulnerabilities in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateManagedInstanceCount:
description: 'The approximate count of all unique managed instances in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Fleet.
'
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: The Fleet's description.
maxLength: 255
minLength: 1
type: string
displayName:
description: The name of the Fleet. The displayName must be unique for Fleets in the same compartment.
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
type: string
inventoryLog:
$ref: '#/components/schemas/CustomLog'
isAdvancedFeaturesEnabled:
description: 'Whether or not advanced features are enabled in this Fleet.
This flag is true if any one of the advanced features is turned on.
'
type: boolean
isExportSettingEnabled:
description: 'Whether or not export setting is enabled in this Fleet.
'
type: boolean
lifecycleState:
description: The lifecycle state of the Fleet.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
operationLog:
$ref: '#/components/schemas/CustomLog'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The creation date and time of the Fleet (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- displayName
- description
- compartmentId
- lifecycleState
- timeCreated
- approximateJreCount
- approximateInstallationCount
- approximateApplicationCount
- approximateManagedInstanceCount
- approximateJavaServerCount
- approximateLibraryCount
- approximateLibraryVulnerabilityCount
type: object
x-example: "{\n \"id\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"displayName\":\"Fleet display name\",\n \"description\":\"Fleet description\",\n \"compartmentId\":\"ocid1.compartment.oc1..<unique_id>\",\n \"approximateJreCount\":1,\n \"approximateInstallationCount\":3,\n \"approximateApplicationCount\":2,\n \"approximateManagedInstanceCount\":2,\n \"approximateJavaServerCount\":10,\n \"approximateLibraryCount\":500,\n \"approximateLibraryVulnerabilityCount\":40,\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false,\n \"isExportSettingEnabled\": false,\n \"timeCreated\":\"2021-01-26T15:58:25.748Z\",\n \"lifecycleState\":\"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{\n \"orcl-cloud\":{\n \"free-tier-retained\":\"false\"\n }\n }\n}\n"
GenerateAgentInstallerConfigurationDetails:
description: Attributes to generate agent installer parameters for a fleet.
properties:
agentType:
description: The JMS plugin type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet for which to generate the configuration file.
maxLength: 255
type: string
installKeyId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent install key for which to generate the configuration file.
maxLength: 255
type: string
required:
- installKeyId
- fleetId
type: object
x-example: "{\n \"agentType\":\"OCMA\",\n \"installKeyId\":\"ocid1.managementagentinstallkey.oc1.iad.<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\"\n}\n"
PerformanceTuningAnalysisResult:
allOf:
- $ref: '#/components/schemas/PerformanceTuningAnalysisResultSummary'
description: Metadata of a Performance Tuning Analysis result. The analysis result is stored as the Object Storage object.
JavaFamily:
allOf:
- $ref: '#/components/schemas/JavaFamilySummary'
- properties:
latestReleaseArtifacts:
description: 'List of artifacts for the latest Java release version in this family.
The script URLs in the response can be used from a command line, or in scripts and dockerfiles to always get the artifacts corresponding to the latest update release version.
'
items:
$ref: '#/components/schemas/JavaArtifact'
maxItems: 50
minItems: 1
type: array
type: object
description: 'Metadata associated with a specific Java release family.
A Java release family is typically a major version in the Java version identifier.
'
x-example: "{\n \"licenseTypes\": [\"NFTC\", \"OTN\"],\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2030-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"latestReleaseVersion\": \"17.0.6\",\n \"isSupportedVersion\": true,\n \"latestReleaseArtifacts\": [\n {\n \"artifactId\": 1001,\n \"artifactDescription\": \"Linux x64 Debian Package\",\n \"approximateFileSizeInBytes\": 134222,\n \"sha256\": \"5d5a13db89571840cf9e3935a82a7f457c9d2ea7857d9e794f239e3f94285b45\",\n \"artifactContentType\": \"JDK\",\n \"artifactFileName\": \"jdk-17.0.6_linux-x64_bin.deb\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"deb\",\n \"packageTypeDetail\": \"Debian Package\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.deb\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.deb.sha256\"\n },\n {\n \"artifactId\": 1002,\n \"artifactDescription\": \"Linux x64 RPM Package\",\n \"approximateFileSizeInBytes\": 14033,\n \"sha256\": \"52c446709d01ff77504d5a4b13ce1ec16808329d576e690bb0f0f8ac4c4f6300\",\n \"artifactContentType\": \"JDK\",\n \"artifactFileName\": \"jdk-17.0.6_linux-x64_bin.rpm\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"rpm\",\n \"packageTypeDetail\": \"RPM Package\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.rpm\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.rpm.sha256\"\n },\n {\n \"artifactId\": 1003,\n \"artifactDescription\": \"Linux x64 Compressed Archive\",\n \"approximateFileSizeInBytes\": 15667,\n \"sha256\": \"5f42a2f7f94920befc166ba0e12cb628f9606c9f440126cc063ca23efef41a5c\",\n \"artifactContentType\": \"JDK\",\n \"artifactFileName\": \"jdk-17.0.6_linux-x64_bin.tar.gz\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"tar.gz\",\n \"packageTypeDetail\": \"Compressed Archive\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.tar.gz\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/17/latest/jdk-17_linux-x64_bin.tar.gz.sha256\"\n }\n ]\n}\n"
FleetErrorAggregation:
description: Aggregation of FleetErrors
properties:
count:
description: Number of FleetErrors encountered for the specific reason.
type: integer
reason:
description: Enum that uniquely identifies the fleet error.
enum:
- NO_MANAGED_INSTANCES
- INVENTORY_LOG
type: string
x-obmcs-top-level-enum: '#/definitions/FleetErrorReason'
required:
- reason
- count
type: object
Blocklist:
description: The blocklist record to prevent a target resource from certain operation with reason.
properties:
key:
description: The unique identifier of this blocklist record.
type: string
operation:
description: The operation type
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
reason:
description: The reason why the operation is blocklisted.
type: string
target:
$ref: '#/components/schemas/BlocklistTarget'
required:
- key
- target
- operation
type: object
x-example: "{\n \"key\": \"<unique_id>\",\n \"target\": {\n \"fleetId\": \"<fleet_OCID>\",\n \"managedInstanceId\": \"<managed_instance_OCID>\",\n \"installationKey\": \"<unique_id>\"\n },\n \"operation\": \"DELETE_JAVA_INSTALLATION\",\n \"reason\": \"Required for Java Management System agent.\"\n}\n"
UpdateFleetDetails:
description: Attributes to update a Fleet.
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: The Fleet's description.
type: string
displayName:
description: The name of the Fleet. The displayName must be unique for Fleets in the same compartment.
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
inventoryLog:
$ref: '#/components/schemas/CustomLog'
isAdvancedFeaturesEnabled:
description: 'Whether or not advanced features are enabled in this Fleet.
Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` API instead.
'
type: boolean
operationLog:
$ref: '#/components/schemas/CustomLog'
type: object
WorkItemCollection:
description: A list of WorkItem.
properties:
items:
description: A list of work request items.
items:
$ref: '#/components/schemas/WorkItemSummary'
type: array
required:
- items
type: object
PerformanceTuningAnalysis:
description: Performance tuning analysis configuration
properties:
isEnabled:
default: false
description: PerformanceTuningAnalysis flag to store enabled or disabled status
type: boolean
type: object
PostInstallationActions:
description: list of post installation actions
enum:
- CHANGE_MINIMUM_KEY_LENGTH_FOR_EC
- CHANGE_MINIMUM_KEY_LENGTH_FOR_DSA
- CHANGE_MINIMUM_KEY_LENGTH_FOR_DIFFIE_HELLMAN
- CHANGE_MINIMUM_KEY_LENGTH_FOR_RSA_SIGNED_JARS
- DISABLE_TLS
- USE_OS_CACERTS
- USE_SYSTEM_PROXIES
- SETUP_HTTP_PROXY
- SETUP_HTTPS_PROXY
- SETUP_FTP_PROXY
- SETUP_SOCKS_PROXY
- ADD_FILE_HANDLER
- LOGGING_LEVEL
type: string
UncorrelatedPackageApplicationUsageSummary:
description: 'Summary of an application where a given libary was detected. Contains the count of managed instances where the package was detected with this application.
'
properties:
applicationKey:
description: 'The internal identifier of a Java application.
'
type: string
applicationName:
description: 'The displayed name of the Java application.
'
type: string
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
managedInstanceCount:
description: 'The count of managed instances wherein the specified library was detected.
'
format: int32
type: integer
required:
- applicationKey
- applicationName
- managedInstanceCount
- lastDetectedDynamically
type: object
x-example: "{\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name 1\",\n \"managedInstanceCount\":2,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n}\n"
JavaServerUsage:
description: 'Java Server usage during a specified time period.
'
properties:
approximateDeployedApplicationCount:
description: 'The approximate count of deployed applications in the Java Server.
'
type: integer
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related fleet.
'
type: string
serverInstanceCount:
description: 'The count of server instances of the Java Server.
'
type: integer
serverKey:
description: 'The internal identifier of the Java Server.
'
type: string
serverName:
description: 'The name of the Java Server.
'
type: string
serverVersion:
description: 'The version of the Java Server.
'
type: string
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- serverKey
- fleetId
- serverName
type: object
x-example: "{\n \"serverKey\":\"<unique_Java_server_key>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"serverName\":\"Example Java Server name\",\n \"serverVersion\":\"1.0\",\n \"serverInstanceCount\":3,\n \"approximateDeployedApplicationCount\":10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-24T02:18:00.000Z\",\n \"timeLastSeen\":\"2022-01-25T02:18:00.000Z\"\n}\n"
DisableDrsDetails:
description: 'Details of the request to disable DRS file from active managed instance(s) in a Fleet.
When the targets aren''t specified, then all active managed instance(s) currently in the Fleet are selected.
'
properties:
manageDrsDetails:
$ref: '#/components/schemas/ManageDrsDetails'
TlsVersions:
description: List of TLS versions to be disabled.
enum:
- TLS_1_0
- TLS_1_1
type: string
PluginErrorAggregation:
description: Aggregation of PluginErrors
properties:
count:
description: Number of FleetErrors encountered for the specific reason.
type: integer
reason:
description: Enum that uniquely identifies the plugin error.
enum:
- REGISTRATION_POLICY
- LOG_RESOURCE_POLICY
- NO_FLEET
type: string
x-obmcs-top-level-enum: '#/definitions/PluginErrorReason'
required:
- reason
- count
type: object
JavaServerInstanceUsage:
description: 'Java Server instance usage during a specified time period.
'
properties:
approximateDeployedApplicationCount:
description: 'The approximate count of deployed applications in the Java Server instance.
'
type: integer
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related Fleet.
'
type: string
hostName:
description: 'The host name of the related managed instance.
'
type: string
jvmDistribution:
description: 'The distribution of the Java Runtime.
'
type: string
jvmKey:
description: 'The internal identifier of the related Java Runtime.
'
type: string
jvmSecurityStatus:
description: The security status of the Java Runtime.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
jvmVendor:
description: 'The vendor of the Java Runtime.
'
type: string
jvmVersion:
description: 'The version of the Java Runtime.
'
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
serverInstanceKey:
description: 'The internal identifier of the Java Server instance.
'
type: string
serverInstanceName:
description: 'The name of the Java Server instance.
'
type: string
serverInstancePort:
description: 'The port of the Java Server instance.
'
maximum: 65535
minimum: 1
type: integer
serverKey:
description: 'The internal identifier of the related Java Server.
'
type: string
serverName:
description: 'The name of the Java Server.
'
type: string
serverVersion:
description: 'The version of the Java Server.
'
type: string
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- serverInstanceKey
- fleetId
- serverKey
- serverInstanceName
- managedInstanceId
type: object
x-example: "{\n \"serverInstanceKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"serverInstanceName\":\"Example server instance name\",\n \"serverInstancePort\": 5080,\n \"serverKey\":\"<unique_id>\",\n \"serverName\":\"Example Java Server name\",\n \"serverVersion\":\"1.0\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.<unique_id>\"\n \"hostName\": \"Example managed instance host name\",\n \"jvmKey\":\"<unique_id>\",\n \"jvmVendor\":\"Oracle Corporation\",\n \"jvmDistribution\":\"Java(TM) SE Runtime Environment\",\n \"jvmVersion\":\"1.8.0_281\",\n \"jvmSecurityStatus\":\"UP_TO_DATE\",\n \"approximateDeployedApplicationCount\":7,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n}\n"
FleetAgentOsConfiguration:
description: 'Management Agent Configuration for list of include/exclude file system paths (specific to operating system).
'
properties:
excludePaths:
description: 'An array of file system paths (environment variables supported).
'
items:
type: string
type: array
uniqueItems: true
includePaths:
description: 'An array of file system paths (environment variables supported).
'
items:
type: string
type: array
uniqueItems: true
required:
- includePaths
- excludePaths
type: object
LibraryVulnerability:
description: A library vulnerability.
properties:
cvssScore:
description: The Common Vulnerability Scoring System (CVSS) score. If `cvssScore` is not available, it will be set to -1.
format: float
type: number
vulnerabilityKey:
description: The Vulnerability Key, could be CVE or GitHub Security Advisory or others e.g. GHSA-1234-abcd-5678 or CVE-2019-1234
type: string
required:
- vulnerabilityKey
- cvssScore
type: object
RequestPerformanceTuningAnalysesDetails:
description: 'Details of the request to start a JFR performance tuning analysis.
'
properties:
recordingDurationInMinutes:
default: 180
description: Duration of the JFR recording in minutes.
maximum: 1440
minimum: 1
type: integer
targets:
description: The attachment targets to start JFR.
items:
$ref: '#/components/schemas/JfrAttachmentTarget'
maxItems: 32768
type: array
x-default-description: If null, all managed instances in the fleet are selected.
waitingPeriodInMinutes:
description: 'Period to looking for JVMs. In addition to attach to running JVMs when given the command,
JVM started within the waiting period will also be attached for JFR. The value should be
larger than the agent polling interval setting for the fleet to ensure agent can get the
instructions. If not specified, the agent polling interval for the fleet is used.
'
format: int32
maximum: 1440
minimum: 10
type: integer
required:
- recordingDurationInMinutes
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n }, {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }],\n recordingDurationInMinutes: 180\n}\n"
PluginErrorCollection:
description: Collection of PluginErrors.
properties:
items:
description: A list of PluginErrorSummary.
items:
$ref: '#/components/schemas/PluginErrorSummary'
type: array
required:
- items
type: object
DrsFileSummary:
description: 'A Deployment Rule Set(DRS) is a JAR (Java ARchive) file used in Java applications to enforce security and manage compatibility
between different versions of Java applets and web start applications
(https://docs.oracle.com/javase/8/docs/technotes/guides/deploy/deployment_rules.html).
'
properties:
bucketName:
description: The Object Storage bucket name where the DRS file is located.
type: string
checksumType:
description: The checksum type for the DRS file in Object Storage.
enum:
- SHA256
type: string
checksumValue:
description: The checksum value for the DRS file in Object Storage.
maxLength: 256
type: string
drsFileKey:
description: The unique identifier of the DRS file in Object Storage.
maxLength: 36
type: string
drsFileName:
description: The name of the DRS file in Object Store.
maxLength: 1024
type: string
isDefault:
default: false
description: To check if the DRS file is the detfault ones.
type: boolean
namespace:
description: The namespace for Object Storage.
type: string
required:
- bucketName
- namespace
- drsFileKey
- drsFileName
- checksumType
- checksumValue
- isDefault
x-example: "{\n \"bucketName\": \"<unique_id>\",\n \"namespace\": \"<namesapace_value>\",\n \"drsFileName\": \"<file_name>\",\n \"drsFileKey\": \"<unique_key>\",\n \"checksumType\": \"SHA256\",\n \"checksumValue\": \"<sha_value>\",\n \"isDefault\": true\n}\n"
JmsPluginSummary:
description: Summary of the JmsPlugin.
properties:
agentId:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Management Agent (OMA), the Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) \ninstance where the JMS plugin is deployed.\n"
maxLength: 255
minLength: 1
type: string
agentType:
description: The agent type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
availabilityStatus:
description: The availability status.
enum:
- ACTIVE
- SILENT
- NOT_AVAILABLE
type: string
x-obmcs-top-level-enum: '#/definitions/JmsPluginAvailabilityStatus'
compartmentId:
description: 'The OMA/OCA/OCMA agent''s compartment [OCID](/Content/General/Concepts/identifiers.htm).
'
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
hostname:
description: 'The hostname of the agent.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this JmsPlugin.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The lifecycle state.
enum:
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/JmsPluginLifecycleState'
osArchitecture:
description: The architecture of the operating system of the plugin.
maximum: 255
minimum: 1
type: string
osDistribution:
description: The distribution of the operating system of the plugin.
maximum: 255
minimum: 1
type: string
osFamily:
description: The operating system family for the plugin.
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
pluginVersion:
description: The version of the plugin.
maximum: 90
minimum: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeRegistered:
description: 'The date and time the plugin was registered.
'
format: date-time
type: string
required:
- id
- agentId
- agentType
- lifecycleState
- availabilityStatus
- timeRegistered
TaskScheduleCollection:
description: Results of a task schedule search that contain task schedule records.
properties:
items:
description: A list of task schedules.
items:
$ref: '#/components/schemas/TaskScheduleSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n id: \"<task_schedule_OCID>\",\n fleetId: \"<fleet_OCID>\",\n name: \"Crypto event analysis\",\n lifecycleState: \"ACTIVE\",\n createdBy: \"John\",\n executionRecurrences: \"DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z\",\n taskDetails: {\n taskType: \"CRYPTO\",\n cryptoTaskRequest: {\n targets: [\n {\n managedInstanceId: \"<managed_instance_OCID>\"\n },\n {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }\n ],\n recordingDurationInMunites: \"30\",\n waitingPeriodInMinutes: \"10\"\n }\n },\n timeCreated: \"2023-08-04T11: 38: 15.123Z\",\n timeLastRun: \"2023-08-05T11: 38: 15.123Z\",\n timeNextRun: \"2024-08-06T11: 42: 15.123Z\",\n timeLastUpdated: \"2024-08-06T11: 45: 11.123Z\"\n },\n {\n id: \"<task_schedule_OCID>\",\n fleetId: \"<fleet_OCID>\",\n name: \"Crypto event analysis\",\n lifecycleState: \"INACTIVE\",\n createdBy: \"Sheryl\",\n executionRecurrences: \"DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z\",\n taskDetails: {\n taskType: \"CRYPTO\",\n cryptoTaskRequest: {\n targets: [\n {\n managedInstanceId: \"<managed_instance_OCID>\"\n },\n {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }\n ],\n recordingDurationInMunites: \"60\",\n waitingPeriodInMinutes: \"10\"\n }\n },\n timeCreated: \"2023-08-04T11: 38: 15.123Z\",\n timeLastRun: \"2023-08-05T11: 38: 15.123Z\",\n timeNextRun: \"2024-08-06T11: 42: 15.123Z\",\n timeLastUpdated: \"2024-08-06T11: 45: 11.123Z\"\n }\n ]\n}\n"
UncorrelatedPackageUsageSummary:
description: Summary of an uncorrelated package.
properties:
applicationCount:
description: The count of applications wherein the specified package was detected.
format: int32
type: integer
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
managedInstanceCount:
description: The count of managed instances wherein the specified package was detected.
format: int32
type: integer
packageName:
description: The name of the package.
type: string
required:
- packageName
- managedInstanceCount
- applicationCount
- lastDetectedDynamically
type: object
x-example: "{\n \"packageName\":\"com.example.packagename\",\n \"managedInstanceCount\":\"3\",\n \"applicationCount\":\"2\",\n \"lastDetectedDynamically\":\"2022-01-25T16:57:00.000Z\",\n}\n"
DeployedApplicationMigrationAnalysesTarget:
description: "The target describes the input data for deployed Java migration analyses.\nA target contains a managed instance, deployed application installation Key, sourceJdkVersion, targetJdkVersion, optional excludePackagePrefixes \nand optional includePackagePrefixes.\n"
properties:
deployedApplicationInstallationKey:
description: The unique key that identifies the deployed application's installation path that is to be used for the Java migration analyses.
maxLength: 255
minLength: 1
type: string
excludePackagePrefixes:
description: Excludes the packages that starts with the prefix from the migration analyses result. Either this or includePackagePrefixes can be specified.
items:
maxLength: 128
minLength: 1
type: string
maxItems: 64
type: array
includePackagePrefixes:
description: Includes the packages that starts with the prefix from the migration analyses result. Either this or excludePackagePrefixes can be specified.
items:
maxLength: 128
minLength: 1
type: string
maxItems: 64
type: array
managedInstanceId:
description: The OCID of the managed instance that hosts the application for which the Java migration analyses was performed.
maxLength: 255
minLength: 1
type: string
sourceJdkVersion:
description: The JDK version the application is currently running on.
maxLength: 255
minLength: 1
type: string
targetJdkVersion:
description: The JDK version against which the migration analyses was performed to identify effort required to move from source JDK.
maxLength: 255
minLength: 1
type: string
required:
- managedInstanceId
- deployedApplicationInstallationKey
- sourceJdkVersion
- targetJdkVersion
x-example: "{\n managedInstanceId: \"<managed_instance_OCID>\"\n deployedApplicationInstallationKey: \"<unique_deployed_application_installation_key>\"\n sourceJdkVersion: \"<source_jdk_version>\"\n targetJdkVersion: \"<target_jdk_version>\"\n excludePackagePrefixes: [\n \"lombok\",\n \"com.google\",\n \"org.apache.maven\"\n ]\n includePackagePrefixes: [\n \"jms\"\n ]\n}\n"
PerformanceTuningAnalysisResultSummary:
description: Summary of a performance tuning analysis result. The actual output of the analysis is stored in the Object Storage object.
properties:
applicationId:
description: The OCID of the application for which the report has been generated.
maxLength: 255
minLength: 1
type: string
applicationInstallationId:
description: The internal identifier of the application installation for which the report has been generated.
maxLength: 255
minLength: 1
type: string
applicationInstallationPath:
description: The installation path of the application for which the report has been generated.
maxLength: 255
minLength: 1
type: string
applicationName:
description: The name of the application for which the report has been generated.
maxLength: 255
minLength: 1
type: string
bucketName:
description: The Object Storage bucket name of this analysis result.
type: string
fleetId:
description: The fleet OCID.
maxLength: 255
minLength: 1
type: string
hostName:
description: The hostname of the managed instance.
maxLength: 255
minLength: 1
type: string
id:
description: The OCID to identify this analysis results.
maxLength: 255
minLength: 1
type: string
managedInstanceId:
description: The managed instance OCID.
maxLength: 255
minLength: 1
type: string
namespace:
description: The Object Storage namespace of this analysis result.
type: string
objectName:
description: The Object Storage object name of this analysis result.
type: string
result:
description: Result of the analysis based on whether warnings have been found or not.
enum:
- ACTION_RECOMMENDED
- NO_WARNINGS
type: string
x-obmcs-top-level-enum: '#/definitions/PerformanceTuningResultStatus'
timeCreated:
description: The time the result is compiled.
format: date-time
type: string
timeFinished:
description: The time the JFR recording has finished.
format: date-time
type: string
timeStarted:
description: The time the JFR recording has started.
format: date-time
type: string
warningCount:
description: Total number of warnings reported by the analysis.
type: integer
workRequestId:
description: The OCID of the work request to start the analysis.
maxLength: 255
minLength: 1
type: string
required:
- id
- fleetId
- applicationId
- applicationName
- applicationInstallationId
- applicationInstallationPath
- managedInstanceId
- hostName
- warningCount
- result
- namespace
- bucketName
- objectName
- timeCreated
- timeStarted
- timeFinished
x-example: "{\n id: \"<analysis_result_OCID>\",\n workRequestId: \"<work_request_OCID>\",\n fleetId: \"<fleet_OCID>\",\n applicationId: \"<application_OCID>\",\n applicationInstallationId: \"<application_installation_OCID>\",\n applicationInstallationPath: \"/path/to/application\",\n applicationName: \"application\",\n hostName: \"host\",\n warningCount: 3,\n namespace: \"jms\",\n bucketName: \"bucket\",\n objectName: \"managedInstance/2022-09-19/result.json\",\n timeCreated: \"2023-1-11T10:35:06.817Z\",\n timeStarted: \"2023-01-11T08:30:00.000Z\",\n timeFinished: \"2023-01-11T10:30:00.000Z\"\n}\n"
TaskDetails:
description: The minimum details of a task.
discriminator:
propertyName: taskType
properties:
taskType:
description: Type of task.
enum:
- CRYPTO
- JFR
- SCAN_LIBRARY
- SCAN_JAVA_SERVER
- JAVA_MIGRATION
- DEPLOYED_APPLICATION_MIGRATION
- PERFORMANCE_TUNING
- ADD_INSTALLATION_SITE
- REMOVE_INSTALLATION_SITE
type: string
required:
- taskType
type: object
UncorrelatedPackageManagedInstanceUsageSummary:
description: 'Summary of a managed instance where a given uncorrelated package was detected. Contains the count of application where the package was detected with this application.
'
properties:
applicationCount:
description: 'The count of applications wherein the specified library was detected.
'
format: int32
type: integer
hostname:
description: The hostname of the managed instance.
maxLength: 255
minLength: 1
type: string
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
required:
- managedInstanceId
- hostname
- applicationCount
- lastDetectedDynamically
type: object
x-example: "{\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name 2\",\n \"applicationCount\":3,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n}\n"
UpdateJmsPluginDetails:
description: Attributes to update a JmsPlugin.
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
type: object
TaskSchedule:
description: The properties of a task schedule.
properties:
createdBy:
description: Name of the task creator.
maxLength: 255
minLength: 1
type: string
executionRecurrences:
description: 'Recurrence specification for the task schedule execution (formatted according to [RFC-5545](https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/)). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be ''DTSTART=20240902T090000Z;
RRULE:FREQ=DAILY;COUNT=10''. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be ''DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z''.
'
format: x-obmcs-recurring-time
type: string
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: All possible status of task schedule.
enum:
- ACTIVE
- INACTIVE
type: string
name:
description: The name of the task schedule.
maxLength: 255
minLength: 1
type: string
taskDetails:
$ref: '#/components/schemas/TaskDetails'
timeCreated:
description: The date and time the task schedule was created (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeLastRun:
description: The date and time the task schedule ran last (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeLastUpdated:
description: The date and time the task schedule was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeNextRun:
description: The date and time the task schedule will run next (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
required:
- id
- fleetId
- name
- lifecycleState
- createdBy
- executionRecurrences
- taskDetails
- timeCreated
- timeLastUpdated
type: object
PatchDetail:
description: My Oracle Support(MoS) patch details for the Java release.
properties:
displayName:
description: Commonly used name for the MoS release.
type: string
patchUrl:
description: MoS URL to access the artifacts for the Java release.
maxLength: 512
type: string
required:
- displayName
- patchUrl
type: object
x-example: "{\n \"displayName\": \"Oracle JDK 8 Update 333 b33\",\n \"patchUrl\": \"https://support.oracle.com/epmos/faces/PatchResultsNDetails?patchId=33845254\"\n}\n"
Fleet:
description: 'A Fleet is the primary collection with which users interact when using Java Management Service.
'
properties:
approximateApplicationCount:
description: 'The approximate count of all unique applications in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateInstallationCount:
description: 'The approximate count of all unique Java installations in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateJavaServerCount:
description: 'The approximate count of all unique Java servers in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateJreCount:
description: 'The approximate count of all unique Java Runtimes in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateLibraryCount:
description: 'The approximate count of all unique libraries in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateLibraryVulnerabilityCount:
description: 'The approximate count of all unique library vulnerabilities in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
approximateManagedInstanceCount:
description: 'The approximate count of all unique managed instances in the Fleet in the past seven days.
This metric is provided on a best-effort manner, and isn''t taken into account when computing the resource ETag.
'
type: integer
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Fleet.
'
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: The Fleet's description.
maxLength: 255
minLength: 1
type: string
displayName:
description: The name of the Fleet.
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
type: string
inventoryLog:
$ref: '#/components/schemas/CustomLog'
isAdvancedFeaturesEnabled:
description: 'Whether or not advanced features are enabled in this Fleet.
Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` API instead.
'
type: boolean
isExportSettingEnabled:
description: 'Whether or not export setting is enabled in this Fleet.
'
type: boolean
lifecycleState:
description: The lifecycle state of the Fleet.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
operationLog:
$ref: '#/components/schemas/CustomLog'
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeCreated:
description: 'The creation date and time of the Fleet (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- id
- displayName
- description
- compartmentId
- lifecycleState
- timeCreated
- approximateJreCount
- approximateInstallationCount
- approximateApplicationCount
- approximateManagedInstanceCount
- approximateJavaServerCount
- approximateLibraryCount
- approximateLibraryVulnerabilityCount
x-example: "{\n \"id\":\"ocid1.jmsfleet.oc1.iad.amaaaaaafhbuohyalyygmhsvlwfycidr6dyeufryinp4ae56fgppdq4cxhfa\",\n \"displayName\":\"Created Fleet\",\n \"description\":\"Created Fleet\",\n \"compartmentId\":\"ocid1.compartment.oc1..aaaaaaaamzyawgkflgibjuu62ug6rhlfpz3bjscxh4k5aw7ft2r47zg2bziq\",\n \"approximateJreCount\":0,\n \"approximateInstallationCount\":0,\n \"approximateApplicationCount\":0,\n \"approximateManagedInstanceCount\":0,\n \"approximateJavaServerCount\":0,\n \"approximateLibraryCount\":500,\n \"approximateLibraryVulnerabilityCount\":40,\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false,\n \"isExportSettingEnabled\": false,\n \"timeCreated\":\"2021-01-26T15:07:58.786Z\",\n \"lifecycleState\":\"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{\n \"orcl-cloud\":{\n \"free-tier-retained\":\"false\"\n }\n }\n}\n"
InstallationSiteSummary:
description: 'Installation site of a Java Runtime.
An installation site is a Java Runtime installed at a specific path on a managed instance.
'
properties:
approximateApplicationCount:
description: The approximate count of applications running on this installation
type: integer
blocklist:
description: The list of operations that are blocklisted.
items:
$ref: '#/components/schemas/BlocklistEntry'
type: array
installationKey:
description: The unique identifier for the installation of Java Runtime at a specific path on a specific operating system.
type: string
jre:
$ref: '#/components/schemas/JavaRuntimeId'
lifecycleState:
description: The lifecycle state of the installation site.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
operatingSystem:
$ref: '#/components/schemas/OperatingSystem'
path:
description: The file system path of the installation.
type: string
securityStatus:
description: The security status of the Java Runtime.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
required:
- installationKey
- managedInstanceId
type: object
x-example: "{\n \"installationKey\": \"<unique_installation_id>\",\n \"managedInstanceId\": \"<managed_instance_OCID>\",\n \"jre\": {\n \"version\": \"11.0.13\",\n \"vendor\": \"Oracle Corporation\",\n \"distribution\": \"Java(TM) SE Runtime Environment\",\n \"jreKey\": \"<unique_jre_id>\"\n },\n \"path\": \"/usr/java/jdk-11.0.13\",\n \"operatingSystem\": {\n \"family\": \"LINUX\",\n \"name\": \"Linux\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"architecture\": \"amd64\"\n },\n \"approximateApplicationCount\": 0,\n \"timeLastSeen\": \"2022-01-24T02:18:00.000Z\",\n \"blocklist\": [],\n}\n"
ScanJavaServerUsageDetails:
description: The list of managed instances to scan.
properties:
managedInstanceIds:
description: The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of managed instances to scan.
items:
type: string
maxItems: 32768
type: array
type: object
x-example: "{\n \"items\":[\n \"<managed_instance_OCID_1>\",\n \"<managed_instance_OCID_2>\",\n \"<managed_instance_OCID_3>\",\n \"<managed_instance_OCID_4>\",\n \"<managed_instance_OCID_5>\",\n ]\n}\n"
RequestCryptoAnalysesDetails:
description: 'Details of the request to start a JFR crypto event analysis.
When the targets aren''t specified, then all managed instances currently in the fleet are selected.
'
properties:
recordingDurationInMinutes:
default: 180
description: Duration of the JFR recording in minutes.
maximum: 1440
minimum: 1
type: integer
targets:
description: The attachment targets to start JFR.
items:
$ref: '#/components/schemas/JfrAttachmentTarget'
maxItems: 32768
type: array
waitingPeriodInMinutes:
description: 'Period to looking for JVMs. In addition to attach to running JVMs when given the command,
JVM started within the waiting period will also be attached for JFR. The value should be
larger than the agent polling interval setting for the fleet to ensure agent can get the
instructions. If not specified, the agent polling interval for the fleet is used.
'
format: int32
maximum: 1440
minimum: 10
type: integer
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n }, {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }],\n recordingDurationInMinutes: 180\n}\n"
ManagedInstanceUsageCollection:
description: Results of a managed instance search. Contains ManagedInstanceUsage items.
properties:
items:
description: A list of managed instances.
items:
$ref: '#/components/schemas/ManagedInstanceUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"managedInstanceId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"managedInstanceType\":\"ORACLE_MANAGEMENT_AGENT\",\n \"hostId\":\"ocid1.instance.oc1.iad.<unique_id>\",\n \"operatingSystem\": {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\"\n },\n \"drsFileStatus\": \"NOT_CONFIGURED\"\n \"timeStart\":\"2021-01-19T17:42:25.000Z\",\n \"timeEnd\":\"2021-01-26T17:42:25.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:32:00.000Z\",\n \"timeLastSeen\":\"2021-01-26T17:42:00.000Z\"\n }\n ]\n}\n"
JavaRuntimeId:
description: The essential properties to identify a Java Runtime.
properties:
distribution:
description: The distribution of a Java Runtime is the name of the lineage of product to which it belongs, for example _Java(TM) SE Runtime Environment_.
type: string
jreKey:
description: The unique identifier for a Java Runtime.
type: string
vendor:
description: The vendor of the Java Runtime.
type: string
version:
description: The version of the Java Runtime.
type: string
required:
- version
- vendor
- distribution
type: object
x-example: "{\n \"version\": \"11.0.13\",\n \"vendor\": \"Oracle Corporation\",\n \"distribution\": \"Java(TM) SE Runtime Environment\"\n}\n"
FleetErrorSummary:
description: The summary of a fleet error.
properties:
compartmentId:
description: 'The compartment [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
'
maxLength: 255
minLength: 1
type: string
errors:
description: List of fleet error details.
items:
$ref: '#/components/schemas/FleetErrorDetails'
type: array
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
maxLength: 255
minLength: 1
type: string
fleetName:
description: The display name of the Fleet.
maximum: 255
minimum: 1
type: string
timeFirstSeen:
description: 'The timestamp of the first time an error was detected.
'
format: date-time
type: string
timeLastSeen:
description: 'The timestamp of the last time an error was detected.
'
format: date-time
type: string
required:
- fleetId
- fleetName
- compartmentId
- errors
- timeLastSeen
- timeFirstSeen
type: object
x-example: "{\n \"fleetId\": \"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"fleetName\": \"Test fleet\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"errors\": [\n {\"reason\": \"NO_MANAGED_INSTANCES\", \"details\": \"No managed instances in the fleet.\", \"timeLastSeen\": \"2024-10-1T23:59:00.000Z\"},\n {\"reason\": \"INVENTORY_LOG\", \"timeLastSeen\": \"2024-10-2T23:59:00.000Z\"}\n ],\n \"timeFirstSeen\": \"2024-10-1T23:59:00.000Z\",\n \"timeLastSeen\": \"2024-10-2T23:59:00.000Z\"\n}\n"
DeployedApplicationInstallationUsageSummary:
description: 'Summarize usage information about an application deployed on Java servers including installation information during a specified time period. The main difference between DeployedApplicationInstallationUsageSummary and DeployedApplicationUsage is the presence of the applicationSourcePath. DeployedApplicationUsage provides only an aggregated view to the deployed applications without installation information. DeployedApplicationUsage does not distinguish between applications with the identical deployment information deployed to different paths. DeployedApplicationInstallationUsageSummary contains installation information used to select target actions.
'
properties:
applicationInstallationKey:
description: 'The internal identifier of the deployed application installation.
'
maxLength: 255
minLength: 1
type: string
applicationKey:
description: 'The internal identifier of the deployed application.
ApplicationKey will be identical for deployed applications with different applicationSourcePaths.
'
maxLength: 255
minLength: 1
type: string
applicationName:
description: 'The name of the deployed application.
'
type: string
applicationSourcePath:
description: 'The full path to source WAR or EAR file for deployed application.
'
type: string
applicationType:
description: 'The type of the deployed application.
'
type: string
approximateJavaServerInstanceCount:
description: 'The approximate count of Java Server instances running the deployed application installations.
'
type: integer
approximateLibraryCount:
description: 'The approximate count of libraries in the deployed application.
'
type: integer
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related fleet.
'
maxLength: 255
minLength: 1
type: string
isClustered:
description: 'Whether or not the deployed application is clustered.
'
type: boolean
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- applicationInstallationKey
- applicationKey
- fleetId
- applicationName
type: object
x-example: "{\n \"applicationInstallationKey\":\"<unique_id>\",\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name\",\n \"applicationType\":\"EAR\",\n \"applicationSourcePath\": \"/full/path/to/application.ear\"\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 2,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n}\n"
AgentInstallerSummary:
description: 'Supported agent installer downloads.
'
properties:
agentInstallerDescription:
description: Description of the agent installer artifact. The description typically includes the OS, architecture, and agent installer type.
maxLength: 255
minLength: 1
type: string
agentInstallerId:
description: Unique identifier for the agent installer.
format: int64
type: integer
agentInstallerVersion:
description: Agent installer version.
maxLength: 30
minLength: 1
type: string
agentVersion:
description: Agent image version.
maxLength: 30
minLength: 1
type: string
approximateFileSizeInBytes:
description: Approximate compressed file size in bytes.
format: int64
type: integer
javaVersion:
description: Java version.
maxLength: 30
minLength: 1
type: string
osFamily:
description: The target operating system family for the agent installer.
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
packageType:
description: The package type (typically the file extension) of the agent software included in the installer.
enum:
- RPM
- ZIP
type: string
x-obmcs-top-level-enum: '#/definitions/PackageType'
platformArchitecture:
description: The target operating system architecture for the installer.
enum:
- X86_64
- X86
- AARCH64
type: string
x-obmcs-top-level-enum: '#/definitions/PlatformArchitectureType'
sha256:
description: SHA256 checksum of the agent installer.
type: string
required:
- agentInstallerId
- agentInstallerDescription
- approximateFileSizeInBytes
- sha256
- osFamily
- platformArchitecture
- packageType
- agentVersion
- javaVersion
- agentInstallerVersion
type: object
x-example: "{\n \"agentInstallerId\": 1001,\n \"agentInstallerDescription\": \"MacOs x64 ZIP installer\",\n \"approximateFileSizeInBytes\": 297444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"osFamily\": \"MACOS\",\n \"platformArchitecture\": \"X86_64\",\n \"packageType\": \"ZIP\",\n \"agentVersion\": \"20240216.3456\",\n \"javaVersion\": \"8u411\",\n \"agentInstallerVersion\": \"9.0.234\"\n}\n"
ManageDrsDetails:
description: 'Details of the request to manage DRS in active managed instance(s) in a Fleet.
When the targets aren''t specified, then all active managed instance(s) currently in the Fleet are selected.
'
properties:
targets:
description: The targets to manage DRS.
items:
$ref: '#/components/schemas/DrsTarget'
maxItems: 32768
type: array
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n }, {\n managedInstanceId: \"<managed_instance_OCID>\",\n }]\n}\n"
LibraryInventory:
description: Inventory of libraries in a fleet during a specified time period.
properties:
dynamicallyDetectedLibraryCount:
description: The count of libraries which are detected dynamically.
format: int32
type: integer
highSeverityLibraryCount:
description: The count of libraries with high severity vulnerabilities.
format: int32
type: integer
lowSeverityLibraryCount:
description: The count of libraries with low severity vulnerabilities.
format: int32
type: integer
mediumSeverityLibraryCount:
description: The count of libraries with medium severity vulnerabilities.
format: int32
type: integer
staticallyDetectedLibraryCount:
description: The count of libraries which are detected statically.
format: int32
type: integer
uncorrelatedPackageCount:
description: The count of packages which are detected but not correlated to any libraries.
format: int32
type: integer
required:
- staticallyDetectedLibraryCount
- dynamicallyDetectedLibraryCount
- uncorrelatedPackageCount
- highSeverityLibraryCount
- mediumSeverityLibraryCount
- lowSeverityLibraryCount
type: object
x-example: "{\n \"staticallyDetectedLibraryCount\":\"3\",\n \"dynamicallyDetectedLibraryCount\":\"2\",\n \"uncorrelatedPackageCount\":\"3\",\n \"highSeverityLibraryCount\":\"1\",\n \"mediumSeverityLibraryCount\":\"1\",\n \"lowSeverityLibraryCount\":\"0\",\n}\n"
FleetDiagnosisSummary:
description: Diagnosis of a resource needed by the fleet.
properties:
resourceDiagnosis:
description: The diagnosis message.
maxLength: 1024
type: string
resourceId:
description: The OCID of the external resouce needed by the fleet.
maxLength: 255
minLength: 1
type: string
resourceState:
description: 'The state of the resource. The resource state is ACTIVE when it works properly for the fleet.
In case it would cause an issue for the fleet function, the state is INACTIVE.
When JMS can''t locate the resource, the state is NOT_FOUND.
OTHER covers other cases, such as a temporarily network issue that prevents JMS from detecting the
resource. Check the resourceDiagnosis for details.
'
enum:
- ACTIVE
- INACTIVE
- NOT_FOUND
- OTHER
type: string
resourceType:
description: 'The type of the resource needed by the fleet.
This is the role of a resource in the fleet. Use the OCID to determine the actual OCI
resource type such as log group or log.
'
enum:
- INVENTORY_LOG
- OPERATION_LOG
- CRYPTO_SUMMARIZED_LOG
- ANALYSIS_OSS_BUCKET
type: string
required:
- resourceType
type: object
ExportSetting:
description: 'Export settings of a fleet.
'
properties:
exportDataFilters:
$ref: '#/components/schemas/ExportDataFilters'
exportDuration:
description: 'The duration of data to be exported for fleets.
'
enum:
- LAST_30_DAYS
- LAST_60_DAYS
- LAST_90_DAYS
type: string
x-obmcs-top-level-enum: '#/definitions/ExportDuration'
exportFrequency:
description: 'Schedule at which data will be exported.
'
enum:
- DAILY
- WEEKLY
- MONTHLY
type: string
x-obmcs-top-level-enum: '#/definitions/ExportFrequency'
exportResources:
description: 'Resource to export data associated from the fleets.
'
enum:
- MANAGED_INSTANCE
- MANAGED_INSTANCE_PLUS_JAVA_RUNTIME
- MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION
type: string
x-obmcs-top-level-enum: '#/definitions/ExportResources'
exportSettingKey:
description: 'The internal identifier of the export setting.
'
maxLength: 64
minLength: 1
type: string
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
type: string
isCrossRegionAcknowledged:
default: false
description: 'Acknowledgement for cross region target bucket configuration.
'
type: boolean
isEnabled:
default: false
description: ExportSetting flag to store enabled or disabled status.
type: boolean
targetBucketName:
description: 'The name of the bucket where data will be exported.
'
maxLength: 255
minLength: 1
type: string
targetBucketNamespace:
description: 'The namespace of the bucket where data will be exported.
'
maxLength: 1024
minLength: 1
type: string
targetBucketRegion:
description: 'The id of the region of the target bucket.
'
maxLength: 25
minLength: 1
type: string
timeCreated:
description: 'The creation date and time of the export setting (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeLastModified:
description: 'The update date and time of the export setting (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- isEnabled
type: object
x-example: "{\n \"exportSettingKey\": \"<unique_export_setting_key>\",\n \"fleetId\":\"ocid1.fleet.oc1..<unique_id>\",\n \"exportDuration\": \"LAST_30_DAYS\",\n \"exportResources\":\"MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION\",\n \"isCrossRegionAcknowledged\": false,\n \"targetBucketName\":\"\",\n \"targetBucketNamespace\":\"\",\n \"targetBucketRegion\":\"us-phoenix-1\",\n \"exportFrequency\": \"DAILY\",\n \"timeCreated\":\"2023-05-28T11:38:15.123Z\",\n \"timeLastModified\":\"2023-05-29T11:38:15.123Z\",\n \"exportDataFilters\": {\n \"javaVersions\": [\n \"1.8.0_381\",\n \"21.0.2\"\n ],\n \"javaMajorVersions\" : [\n \"11\",\n \"17\"\n ],\n \"javaVendors\": [\n \"Oracle Corporation\",\n \"OpenJDK\"\n ],\n \"applicationNameEqualTo\": [\n \"EchoClient\",\n \"SomeApp\"\n ],\n \"applicationNameContains\": [\n \"TestApp\",\n \"Echo\"\n ],\n \"securityStatuses\": [\n \"UPDATE_AVAILABLE\",\n \"UP_TO_DATE\"\n ]\n },\n \"isEnabled\": true\n}\n"
JavaMigrationAnalysisResult:
allOf:
- $ref: '#/components/schemas/JavaMigrationAnalysisResultSummary'
description: Result of the Java migration analysis. The analysis result is stored in an Object Storage bucket.
LibraryManagedInstanceUsageCollection:
description: 'Contains a list of LibraryManagedInstanceUsageSummaries.
'
properties:
items:
description: 'A list of LibraryManagedInstanceUsageSummaries.
'
items:
$ref: '#/components/schemas/LibraryManagedInstanceUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name\",\n \"applicationCount\":2,\n \"lastDetectedDynamically\":\"2022-02-21T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-22T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-24T02:18:00.000Z\",\n },\n {\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name 2\",\n \"applicationCount\":3,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-22T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-25T02:18:00.000Z\",\n }\n ]\n}\n"
PluginErrorSummary:
description: Entity that represents an error identified in a plugin.
properties:
agentType:
description: The agent type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
compartmentId:
description: 'The compartment [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
'
maxLength: 255
minLength: 1
type: string
errors:
description: List of plugin error details.
items:
$ref: '#/components/schemas/PluginErrorDetails'
type: array
hostName:
description: The HostName or Compute Instance name of the Managed Instance running the plugin.
maximum: 255
minimum: 1
type: string
managedInstanceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Instance running the plugin.
maxLength: 255
minLength: 1
type: string
timeFirstSeen:
description: 'The timestamp of the first time an error was detected.
'
format: date-time
type: string
timeLastSeen:
description: 'The timestamp of the last time an error was detected.
'
format: date-time
type: string
required:
- managedInstanceId
- compartmentId
- errors
- timeLastSeen
- timeFirstSeen
type: object
x-example: "{\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"agentType\": \"OMA\",\n \"hostName\": \"test-management-agent\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_id>\",\n \"errors\": [\n {\"reason\": \"NO_FLEET\", \"details\": \"No fleet was found for the plugin.\", \"timeLastSeen\": \"2024-10-1T23:59:00.000Z\"},\n {\"reason\": \"INVENTORY_LOG\", \"timeLastSeen\": \"2024-10-2T23:59:00.000Z\"}\n ],\n \"timeFirstSeen\": \"2024-10-1T23:59:00.000Z\",\n \"timeLastSeen\": \"2024-10-2T23:59:00.000Z\"\n}\n"
UpdateExportSettingDetails:
description: Attributes to update an export setting.
properties:
exportDataFilters:
$ref: '#/components/schemas/ExportDataFilters'
exportDuration:
description: 'The duration of data to be exported for fleets.
'
enum:
- LAST_30_DAYS
- LAST_60_DAYS
- LAST_90_DAYS
type: string
x-obmcs-top-level-enum: '#/definitions/ExportDuration'
exportFrequency:
description: 'Schedule at which data will be exported.
'
enum:
- DAILY
- WEEKLY
- MONTHLY
type: string
x-obmcs-top-level-enum: '#/definitions/ExportFrequency'
exportResources:
description: 'Resource to export data associated from the fleets.
'
enum:
- MANAGED_INSTANCE
- MANAGED_INSTANCE_PLUS_JAVA_RUNTIME
- MANAGED_INSTANCE_PLUS_JAVA_RUNTIME_PLUS_APPLICATION
type: string
x-obmcs-top-level-enum: '#/definitions/ExportResources'
isCrossRegionAcknowledged:
default: false
description: 'Acknowledgement for cross region target bucket configuration.
'
type: boolean
isEnabled:
default: false
description: ExportSetting flag to store enabled or disabled status.
type: boolean
targetBucketName:
description: 'The name of the bucket where data will be exported.
'
maxLength: 255
minLength: 1
type: string
targetBucketNamespace:
description: 'The namespace of the bucket where data will be exported.
'
maxLength: 1024
minLength: 1
type: string
targetBucketRegion:
description: 'The id of the region of the target bucket.
'
maxLength: 25
minLength: 1
type: string
required:
- isEnabled
type: object
BlocklistEntry:
description: An entry for blocklist to describe blocked operation and reason.
properties:
operation:
description: The operation type.
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
reason:
description: The reason why the operation is blocklisted.
type: string
required:
- operation
- reason
type: object
LibraryManagedInstanceUsageSummary:
description: 'Summary of a managed instance where a given library was detected statically and/or dynamically. Contains the count of applications where the library was detected.
'
properties:
applicationCount:
description: 'The count of applications where the specified library was detected.
'
format: int32
type: integer
firstSeenInClasspath:
description: 'The timestamp of the first time the specified library was detected in classpath.
'
format: date-time
type: string
hostname:
description: The hostname of the managed instance.
maxLength: 255
minLength: 1
type: string
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
lastSeenInClasspath:
description: 'The timestamp of the last time the specified library was detected in classpath.
'
format: date-time
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
required:
- managedInstanceId
- hostname
- applicationCount
- lastDetectedDynamically
- firstSeenInClasspath
- lastSeenInClasspath
type: object
x-example: "{\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name\",\n \"applicationCount\":2,\n \"lastDetectedDynamically\":\"2022-02-21T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-22T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-24T02:18:00.000Z\",\n}\n"
InstallationSite:
description: 'Installation site of a Java Runtime.
An installation site is a Java Runtime installed at a specific path on a managed instance.
'
properties:
approximateApplicationCount:
description: The approximate count of applications running on this installation
type: integer
blocklist:
description: The list of operations that are blocklisted.
items:
$ref: '#/components/schemas/BlocklistEntry'
maxItems: 256
type: array
hostname:
description: The hostname of the managed instance (if applicable).
maxLength: 255
minLength: 1
type: string
installationKey:
description: The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system.
type: string
jre:
$ref: '#/components/schemas/JavaRuntimeId'
lifecycleState:
description: The lifecycle state of the installation site.
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
managedInstanceType:
description: The type of the source of events.
enum:
- ORACLE_MANAGEMENT_AGENT
- ORACLE_CLOUD_AGENT
- ORACLE_CONTAINER_MANAGEMENT_AGENT
type: string
x-obmcs-top-level-enum: '#/definitions/ManagedInstanceType'
operatingSystem:
$ref: '#/components/schemas/OperatingSystem'
path:
description: The file system path of the installation.
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
required:
- installationKey
- managedInstanceId
- jre
- path
- operatingSystem
type: object
GenerateLoadPipelineScriptDetails:
description: Attributes to generate load pipeline script.
properties:
intervalMinutes:
default: 1440
description: 'The time internal in minutes between consecutive executions of scheduled pipeline job.
'
maximum: 40320
minimum: 15
type: integer
targetBucketName:
description: 'The name of the bucket where data will be exported.
'
maxLength: 255
minLength: 1
type: string
targetBucketNamespace:
description: 'The namespace of the bucket where data will be exported.
'
maxLength: 1024
minLength: 1
type: string
targetBucketRegion:
description: 'The id of the region of the target bucket.
'
maxLength: 25
minLength: 1
type: string
required:
- targetBucketName
- targetBucketNamespace
- targetBucketRegion
type: object
JavaFamilySummary:
description: 'A summary of the Java release family information.
A Java release family is typically a major version in the Java version identifier.
'
properties:
displayName:
description: The display name of the release family.
type: string
docUrl:
description: Link to access the documentation for the release.
format: uri
maxLength: 512
type: string
endOfSupportLifeDate:
description: 'The End of Support Life (EOSL) date of the Java release family (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
familyVersion:
description: The Java release family identifier.
type: string
isSupportedVersion:
description: 'Whether or not this Java release family is under active support.
Refer [Java Support Roadmap](https://www.oracle.com/java/technologies/java-se-support-roadmap.html) for more details.
'
type: boolean
latestReleaseVersion:
description: Latest Java release version in the family.
type: string
licenseTypes:
description: The license type(s) associated with the Java family.
items:
$ref: '#/components/schemas/LicenseType'
maxItems: 10
type: array
uniqueItems: true
releaseDate:
description: 'The date on which the Java release family was first made available (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
supportType:
description: This indicates the support category for the Java release family.
enum:
- LTS
- NON_LTS
type: string
x-obmcs-top-level-enum: '#/definitions/SupportType'
required:
- familyVersion
- displayName
- supportType
- endOfSupportLifeDate
- docUrl
- latestReleaseVersion
- isSupportedVersion
type: object
x-example: "{\n \"licenseTypes\": [\"NFTC\", \"OTN\"],\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2030-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"releaseDate\": \"2021-09-12T00:00:00.000Z\",\n \"latestReleaseVersion\": \"17.0.6\",\n \"isSupportedVersion\": true\n}\n"
DeployedApplicationUsage:
description: 'Deployed application usage during a specified time period.
'
properties:
applicationKey:
description: 'The internal identifier of the deployed application.
'
type: string
applicationName:
description: 'The name of the deployed application.
'
type: string
applicationType:
description: 'The type of the deployed application.
'
type: string
approximateJavaServerInstanceCount:
description: 'The approximate count of Java Server instances running the deployed application.
'
type: integer
approximateLibraryCount:
description: 'The approximate count of libraries in the deployed application.
'
type: integer
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related fleet.
'
type: string
isClustered:
description: 'Whether or not the deployed application is clustered.
'
type: boolean
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- applicationKey
- fleetId
- applicationName
type: object
x-example: "{\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name\",\n \"applicationType\":\"EAR\",\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 2,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n}\n"
FleetErrorDetails:
description: Details of a fleet error.
properties:
details:
description: Optional string containing additional details.
type: string
reason:
description: The fleet error reason.
enum:
- NO_MANAGED_INSTANCES
- INVENTORY_LOG
type: string
x-obmcs-top-level-enum: '#/definitions/FleetErrorReason'
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
required:
- reason
- timeLastSeen
type: object
PostInstallationActionSettings:
description: 'List of available post actions you can execute after the successful Java installation.
'
properties:
addLoggingHandler:
default: false
description: 'Sets FileHandler and ConsoleHandler as handlers in logging.properties file.
'
type: boolean
disabledTlsVersions:
default: []
description: 'The following post JRE installation actions are supported by the field:
- Disable TLS 1.0 , TLS 1.1
'
items:
$ref: '#/components/schemas/TlsVersions'
type: array
globalLoggingLevel:
description: 'Sets the logging level in logging.properties file.
'
enum:
- ALL
- SEVERE
- WARNING
- INFO
- CONFIG
- FINE
- FINER
- FINEST
- 'OFF'
type: string
x-obmcs-top-level-enum: '#/definitions/GlobalLoggingLevel'
minimumKeySizeSettings:
$ref: '#/components/schemas/MinimumKeySizeSettings'
proxies:
$ref: '#/components/schemas/Proxies'
shouldReplaceCertificatesOperatingSystem:
default: false
description: 'Restores JDK root certificates with the certificates that are available in the operating system.
The following action is supported by the field:
- Replace JDK root certificates with a list provided by the operating system.
'
type: boolean
type: object
DeployedApplicationUsageCollection:
description: 'Results of a deployed application usage search. Contains deployed application usage items.
'
properties:
items:
description: 'A list of deployed application usages.
'
items:
$ref: '#/components/schemas/DeployedApplicationUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name 1\",\n \"applicationType\":\"EAR\",\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 2,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n },\n {\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name 2\",\n \"applicationType\":\"WAR\",\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 4,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n }\n ]\n}\n"
JreUsage:
description: Java Runtime usage during a specified time period. A Java Runtime is identified by its vendor and version.
properties:
approximateApplicationCount:
description: The approximate count of the applications running on this Java Runtime.
type: integer
approximateInstallationCount:
description: The approximate count of installations that are installations of this Java Runtime.
type: integer
approximateManagedInstanceCount:
description: The approximate count of the managed instances that report this Java Runtime.
type: integer
approximatePendingWorkRequestCount:
description: The approximate count of work requests working on this Java Runtime.
type: integer
daysUnderSecurityBaseline:
description: The number of days since this release has been under the security baseline.
type: integer
distribution:
description: The distribution of a Java Runtime is the name of the lineage of product to which it belongs, for example _Java(TM) SE Runtime Environment_.
type: string
endOfSupportLifeDate:
description: The End of Support Life (EOSL) date of the Java Runtime (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related fleet.
type: string
id:
description: The internal identifier of the Java Runtime.
type: string
managedInstanceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance. This property value is present only for /listJreUsage.
type: string
operatingSystems:
description: The operating systems that have this Java Runtime installed.
items:
$ref: '#/components/schemas/OperatingSystem'
type: array
releaseDate:
description: The release date of the Java Runtime (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
securityStatus:
description: The security status of the Java Runtime.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
vendor:
description: The vendor of the Java Runtime.
type: string
version:
description: The version of the Java Runtime.
type: string
required:
- distribution
- vendor
- version
type: object
x-example: "{\n \"id\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.amaaaaaafhbuohyalyygmhsvlwfycidr6dyeufryinp4ae56fgppdq4cxhfa\",\n \"managedInstanceId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"securityStatus\":\"UP_TO_DATE\",\n \"releaseDate\":\"2021-01-19T00:00:00.000Z\",\n \"endOfSupportLifeDate:\"2030-12-31T23:59:00.000Z\",\n \"vendor\":\"Oracle Corporation\",\n \"distribution\":\"Java(TM) SE Runtime Environment\",\n \"version\":\"1.8.0_281\",\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n }, {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\",\n \"managedInstanceCount\": 2\n } ],\n \"timeStart\":\"2021-01-19T17:34:41.000Z\",\n \"timeEnd\":\"2021-01-26T17:34:41.000Z\",\n \"timeFirstSeen\":\"2021-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T22:57:00.000Z\"\n}\n"
DrsFileCollection:
description: List of DRS details.
properties:
items:
description: A list of DRS details.
items:
$ref: '#/components/schemas/DrsFileSummary'
type: array
required:
- items
type: object
JfrRecording:
description: JfrRecording configuration
properties:
isEnabled:
default: false
description: JfrRecording flag to store enabled or disabled status.
type: boolean
type: object
JavaRelease:
allOf:
- $ref: '#/components/schemas/JavaReleaseSummary'
- properties:
artifacts:
description: List of Java artifacts.
items:
$ref: '#/components/schemas/JavaArtifact'
maxItems: 50
minItems: 1
type: array
type: object
description: 'Metadata associated with a specific release of Java. Includes the artifact details.
'
x-example: "{\n \"releaseVersion\": \"11.0.14\",\n \"familyVersion\": \"11\",\n \"parentReleaseVersion\": null,\n \"securityStatus\": \"UP_TO_DATE\",\n \"releaseType\": \"CPU\",\n \"licenseType\": \"OTN\",\n \"mosPatches\": [],\n \"daysUnderSecurityBaseline\": 100,\n \"licenseDetails\": {\n \"displayName\": \"Oracle Technology Network\",\n \"licenseType\": \"OTN\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/javase-license1.html\"\n },\n \"releaseDate\": \"2021-01-19T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/11-0-14-relnotes.html\",\n \"familyDetails\": {\n \"familyVersion\": \"11\",\n \"displayName\": \"JDK 11\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2030-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/11\"\n },\n \"artifacts\": [\n {\n \"artifactId\": 1001,\n \"artifactDescription\": \"Linux x64 Debian Package\",\n \"approximateFileSizeInBytes\": 134222,\n \"sha256\": \"5d5a13db89571840cf9e3935a82a7f457c9d2ea7857d9e794f239e3f94285b45\",\n \"artifactContentType\": \"JDK\"\n \"artifactFileName\": \"jdk-11.0.14_linux-x64_bin.deb\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"deb\",\n \"packageTypeDetail\": \"Debian Package\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.deb\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.deb.sha256\"\n },\n {\n \"artifactId\": 1002,\n \"artifactDescription\": \"Linux x64 RPM Package\",\n \"approximateFileSizeInBytes\": 14033,\n \"sha256\": \"52c446709d01ff77504d5a4b13ce1ec16808329d576e690bb0f0f8ac4c4f6300\",\n \"artifactContentType\": \"JDK\"\n \"artifactFileName\": \"jdk-11.0.14_linux-x64_bin.rpm\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"rpm\",\n \"packageTypeDetail\": \"RPM Package\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.rpm\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.rpm.sha256\"\n },\n {\n \"artifactId\": 1003,\n \"artifactDescription\": \"Linux x64 Compressed Archive\",\n \"approximateFileSizeInBytes\": 15667,\n \"sha256\": \"5f42a2f7f94920befc166ba0e12cb628f9606c9f440126cc063ca23efef41a5c\",\n \"artifactType\": \"JDK\"\n \"artifactFileName\": \"jdk-11.0.14_linux-x64_bin.tar.gz\",\n \"osFamily\": \"linux\",\n \"architecture\": \"x64\",\n \"packageType\": \"tar.gz\",\n \"packageTypeDetail\": \"Compressed Archive\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.tar.gz\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_linux-x64_bin.tar.gz.sha256\"\n },\n {\n \"artifactId\": 1004,\n \"artifactDescription\": \"macOS x64 DMG Installer\",\n \"approximateFileSizeInBytes\": 15444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"artifactContentType\": \"JDK\"\n \"artifactFileName\": \"jdk-11.0.14_osx-x64_bin.dmg\",\n \"osFamily\": \"macos\",\n \"architecture\": \"x64\",\n \"packageType\": \"dmg\",\n \"packageTypeDetail\": \"DMG Installer\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_macos-x64_bin.dmg\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_macos-x64_bin.dmg.sha256\"\n },\n {\n \"artifactId\": 1005,\n \"artifactDescription\": \"macOS x64 Compressed Archive\",\n \"approximateFileSizeInBytes\": 15393,\n \"sha256\": \"2c43522e9ab7993d5186b1393c583ed794ec21e186adc5dfe3a5720ab780fe7b\",\n \"artifactContentType\": \"JDK\"\n \"artifactFileName\": \"jdk-11.0.14_osx-x64_bin.tar.gz\",\n \"osFamily\": \"macos\",\n \"architecture\": \"x64\",\n \"packageType\": \"tar.gz\",\n \"packageTypeDetail\": \"Compressed Archive\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_macos-x64_bin.tar.gz\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.14_macos-x64_bin.tar.gz.sha256\"\n }\n ]\n}\n"
CreateFleetDetails:
description: Attributes to create a Fleet.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment of the Fleet.
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
description:
description: The Fleet's description. If nothing is provided, the Fleet description will be null.
type: string
displayName:
description: The name of the Fleet. The displayName must be unique for Fleets in the same compartment.
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
inventoryLog:
$ref: '#/components/schemas/CustomLog'
isAdvancedFeaturesEnabled:
description: 'Whether or not advanced features are enabled in this Fleet.
Deprecated, use `/fleets/{fleetId}/advanceFeatureConfiguration` API instead.
'
type: boolean
operationLog:
$ref: '#/components/schemas/CustomLog'
required:
- compartmentId
- displayName
- inventoryLog
type: object
ApplicationInstallationUsageSummary:
description: 'Summarizes application installation usage information during a specified time period. The main difference between ApplicationUsage and ApplicationInstallationUsageSummary is the presence of installation information. ApplicationUsage provides only aggregated information for an application regardless of the installation paths. Therefore, two different applications with the same application name installed in two different paths will be aggregated to a single application. This aggregation makes it difficult to focus actions to single application installed on a known path.
An application installation is independent of the Java Runtime on which it''s running or the Managed Instance where it''s installed.
'
properties:
applicationInstallationKey:
description: 'An internal identifier for the application installation that is unique to a Fleet.
'
maxLength: 255
minLength: 1
type: string
applicationInvokedBy:
description: Comma separated list of user names that invoked application installations.
type: string
applicationKey:
description: 'An internal identifier for the application that is unique to a Fleet.
ApplicationKey will be identical for applications with different installation information.
'
maxLength: 255
minLength: 1
type: string
applicationType:
description: The type of the application, denoted by how the application was started.
type: string
approximateInstallationCount:
description: The approximate count of installations running this application.
type: integer
approximateJreCount:
description: The approximate count of Java Runtimes running this application.
type: integer
approximateLibraryCount:
description: The approximate count of libraries in this application.
type: integer
approximateManagedInstanceCount:
description: The approximate count of managed instances reporting this application.
type: integer
displayName:
description: The name of the application.
type: string
fullClassPath:
description: 'List of full paths where the application last searched for classes.
Contains full paths to all items from module-list and class path list.
'
items:
type: string
maxItems: 32768
minItems: 0
type: array
installationPath:
description: The full path on which the application installation was detected.
type: string
operatingSystems:
description: The operating systems running this application.
items:
$ref: '#/components/schemas/OperatingSystem'
maxItems: 255
minItems: 1
type: array
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- applicationInstallationKey
- applicationKey
- applicationType
- displayName
type: object
x-example: "{\n \"applicationInstallationKey\":\"81abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c4f8f3\",\n \"applicationKey\":\"79abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c44509\",\n \"displayName\":\"application display name\",\n \"applicationType\":\"VM start\",\n \"installationPath\": \"/some/path/application.jar\"\n \"fullClassPath\": [\n \"/some/path/application.jar\"\n ]\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n }, {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\",\n \"managedInstanceCount\": 2\n } ],\n \"approximateInstallationCount\": 1,\n \"approximateJreCount\": 2,\n \"approximateManagedInstanceCount\": 3,\n \"approximateLibraryCount\": 10,\n \"applicationInvokedBy\": \"root,opc\",\n \"timeStart\":\"2021-01-19T17:40:15.000Z\",\n \"timeEnd\":\"2021-01-26T17:40:15.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:36:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T15:46:00.000Z\"\n}\n"
ManagedInstanceUsage:
description: 'Managed instance usage during a specified time period.
An entity that emits usage events to Java Management Service (JMS) is represented as a managed instance.
A managed instance has a unique identity which is used by JMS to distinguish it from other managed instances.
'
properties:
agent:
$ref: '#/components/schemas/Agent'
applicationInvokedBy:
description: Comma separated list of user names that invoked applications within this managed instance.
type: string
approximateApplicationCount:
description: The approximate count of applications reported by this managed instance.
type: integer
approximateInstallationCount:
description: The approximate count of installations reported by this managed instance.
type: integer
approximateJreCount:
description: The approximate count of Java Runtimes reported by this managed instance.
type: integer
clusterDetails:
$ref: '#/components/schemas/ClusterDetails'
drsFileStatus:
description: DRS file status
enum:
- PRESENT
- ABSENT
- MISMATCH
- NOT_CONFIGURED
type: string
x-obmcs-top-level-enum: '#/definitions/DrsFileStatus'
fqdns:
description: Captured fully qualify domain names of the managed instance.
items:
type: string
maxItems: 1000
type: array
hostId:
description: 'The host [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
hostname:
description: The hostname of the managed instance (if applicable).
maxLength: 255
minLength: 1
type: string
hostnames:
description: Captured hostnames of the managed instance.
items:
type: string
maxItems: 1000
type: array
ipAddresses:
description: Captured IP addresses of the managed instance.
items:
type: string
maxItems: 1000
type: array
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
managedInstanceType:
description: The type of the source of events.
enum:
- ORACLE_MANAGEMENT_AGENT
- ORACLE_CLOUD_AGENT
- ORACLE_CONTAINER_MANAGEMENT_AGENT
type: string
x-obmcs-top-level-enum: '#/definitions/ManagedInstanceType'
operatingSystem:
$ref: '#/components/schemas/OperatingSystem'
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- managedInstanceId
- managedInstanceType
type: object
x-example: "{\n \"managedInstanceId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"managedInstanceType\":\"ORACLE_MANAGEMENT_AGENT\",\n \"hostId\":\"ocid1.instance.oc1.iad.<unique_id>\"\n \"ipAddresses: [\"122.32.44.12\", \"122.32.0.1\"],\n \"hostnames\": [\"hostname-example\"],\n \"fqdns\": [\"user-agent.app.jmscustomer.oraclevcn.com\"],\n \"operatingSystem\": {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\"\n },\n \"drsFileStatus\": \"NOT_CONFIGURED\"\n \"agent\": {\n \"displayName\": \"jms-agent\",\n \"type\": \"OMA\",\n \"javaVersion\": \"1.8\",\n \"javaSecurityStatus\": \"UP_TO_DATE\",\n \"plugins\":\n [\n {\n \"name\": \"Java Management Service\",\n \"version\": \"6.0.154\"\n }\n ]\n },\n \"applicationInvokedBy\": \"root,opc\",\n \"timeStart\":\"2021-01-19T17:42:25.000Z\",\n \"timeEnd\":\"2021-01-26T17:42:25.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:32:00.000Z\",\n \"timeLastSeen\":\"2021-01-26T17:42:00.000Z\"\n}\n"
PerformanceTuningAnalysisResultCollection:
description: List of Performance Tuning Analysis results.
properties:
items:
description: A list of Performance Tuning Analysis results.
items:
$ref: '#/components/schemas/PerformanceTuningAnalysisResultSummary'
type: array
required:
- items
type: object
Principal:
description: An authorized principal.
properties:
displayName:
description: The name of the principal.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the principal.
type: string
required:
- id
- displayName
type: object
ExportDataFilters:
description: 'Filters applied when exporting data
'
properties:
applicationNameContains:
description: 'List of application names to filter by partial match
'
items:
maxLength: 255
type: string
maxItems: 100
type: array
applicationNameEqualTo:
description: 'List of application names to filter by exact match
'
items:
maxLength: 255
type: string
maxItems: 100
type: array
javaMajorVersions:
description: 'List of Java major versions to filter by
'
items:
maxLength: 255
type: string
maxItems: 50
type: array
javaVendors:
description: 'List of Java vendors to filter by
'
items:
maxLength: 255
type: string
maxItems: 50
type: array
javaVersions:
description: 'List of Java versions to filter by
'
items:
maxLength: 255
type: string
maxItems: 100
type: array
securityStatuses:
description: The security statuses of the Java Runtime
items:
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
maxLength: 64
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
maxItems: 10
type: array
type: object
LibraryApplicationUsageSummary:
description: 'Summary of an application where a given library was detected statically and/or dynamically. Contains the count of managed instances where the library was detected with this application.
'
properties:
applicationKey:
description: 'The internal identifier of a Java application.
'
type: string
applicationName:
description: 'The displayed name of the Java application.
'
type: string
firstSeenInClasspath:
description: 'The timestamp of the first time the specified library was detected in classpath.
'
format: date-time
type: string
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
lastSeenInClasspath:
description: 'The timestamp of the last time the specified library was detected in classpath.
'
format: date-time
type: string
managedInstanceCount:
description: 'The count of managed instances wherein the specified library was detected.
'
format: int32
type: integer
required:
- applicationKey
- applicationName
- managedInstanceCount
- lastDetectedDynamically
- firstSeenInClasspath
- lastSeenInClasspath
type: object
x-example: "{\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name\",\n \"managedInstanceCount\":2,\n \"lastDetectedDynamically\":\"2022-02-21T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-22T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-24T02:18:00.000Z\",\n}\n"
ApplicationInstallationUsageSummaryCollection:
description: Results of an application installation search. Contains ApplicationInstallationUsageSummary items.
properties:
items:
description: A list of application installations.
items:
$ref: '#/components/schemas/ApplicationInstallationUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationInstallationKey\":\"81abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c4f8f3\",\n \"applicationKey\":\"79abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c44509\",\n \"displayName\":\"application display name\",\n \"applicationType\":\"VM start\",\n \"installationPath\": \"/some/path/application.jar\"\n \"fullClassPath\": [\n \"/some/path/application.jar\"\n ]\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n } ],\n \"approximateInstallationCount\": 1,\n \"approximateJreCount\": 2,\n \"approximateManagedInstanceCount\": 1,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2021-01-19T17:40:15.000Z\",\n \"timeEnd\":\"2021-01-26T17:40:15.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:36:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T15:46:00.000Z\"\n }\n ]\n}\n"
CreateDrsFileDetails:
description: Details of the request to create DRS file in a Fleet.
properties:
bucketName:
description: The Object Storage bucket name where the DRS file is located.
type: string
drsFileName:
description: The name of the DRS file in Object Store.
maxLength: 1024
type: string
namespace:
description: The namespace for Object Storage.
type: string
required:
- namespace
- bucketName
- drsFileName
UpdateDrsFileDetails:
description: Details of the request to update DRS file in a Fleet.
properties:
bucketName:
description: The Object Storage bucket name where the DRS file is located.
type: string
drsFileName:
description: The name of the DRS file in Object Store.
maxLength: 1024
type: string
namespace:
description: The namespace for Object Storage.
type: string
required:
- namespace
- bucketName
- drsFileName
CryptoEventAnalysis:
description: CryptoEventAnalysis configuration
properties:
isEnabled:
default: false
description: CryptoEventAnalysis flag to store enabled or disabled status.
type: boolean
summarizedEventsLog:
$ref: '#/components/schemas/SummarizedEventsLog'
type: object
AnnouncementSummary:
description: An summary of a announcement on Console Overview page
properties:
key:
description: Unique id of the announcement
format: int32
type: integer
summary:
description: Summary text of the announcement
type: string
timeReleased:
description: Date time on which the announcement was released
format: date-time
type: string
url:
description: URL to the announcement web page
type: string
required:
- key
- summary
- url
- timeReleased
type: object
x-example: "{\n \"key\": 1,\n \"summary\": \"Release of JMS 6.0.0\",\n \"url\": \"https://docs.oracle.com/en-us/iaas/releasenotes/changes/7d48d9d1\",\n \"timeReleased\": \"2022-12-08T10:00:00.000Z\"\n}\n"
CryptoAnalysisResultSummary:
description: Summary of a crypto analysis result. The actual output of the analysis is stored in the Object Storage object.
properties:
aggregationMode:
description: The result aggregation mode
enum:
- JFR
- MANAGED_INSTANCE
type: string
x-obmcs-top-level-enum: '#/definitions/CryptoAnalysisResultMode'
bucketName:
description: The Object Storage bucket name of this analysis result.
type: string
cryptoRoadmapVersion:
description: The Crypto Roadmap version used to perform the analysis.
type: string
findingCount:
description: Total number of findings with the analysis.
type: integer
fleetId:
description: The fleet OCID.
maxLength: 255
minLength: 1
type: string
hostName:
description: The hostname of the managed instance.
maxLength: 255
minLength: 1
type: string
id:
description: The OCID to identify this analysis results.
maxLength: 255
minLength: 1
type: string
managedInstanceId:
description: The managed instance OCID.
maxLength: 255
minLength: 1
type: string
namespace:
description: The Object Storage namespace of this analysis result.
type: string
nonCompliantFindingCount:
description: 'Total number of non-compliant findings with the analysis. A non-compliant finding means the
application won''t work properly with the changes introduced by the Crypto Roadmap version
used by the analysis.
'
type: integer
objectName:
description: The Object Storage object name of this analysis result.
type: string
summarizedEventCount:
description: Total number of summarized events. Summarized events are deduplicated events of interest.
type: integer
timeCreated:
description: The time the result is compiled.
format: date-time
type: string
timeFinished:
description: The time the JFR recording has finished.
format: date-time
type: string
timeFirstEvent:
description: Time of the first event in the analysis.
format: date-time
type: string
timeLastEvent:
description: Time of the last event in the analysis.
format: date-time
type: string
timeStarted:
description: The time the JFR recording has started.
format: date-time
type: string
totalEventCount:
description: Total number of events in the analysis.
type: integer
workRequestId:
description: The OCID of the work request to start the analysis.
maxLength: 255
minLength: 1
type: string
required:
- id
- aggregationMode
- fleetId
- cryptoRoadmapVersion
- totalEventCount
- summarizedEventCount
- findingCount
- nonCompliantFindingCount
- namespace
- bucketName
- objectName
x-example: "{\n id: \"<analysis_result_OCID>\",\n workRequestId: \"<work_request_OCID>\",\n aggregationMode: \"MANAGED_INSTANCE\",\n fleetId: \"<fleet_OCID>\",\n cryptoRoadmapVersion: \"2022-04-19\",\n totalEventCount: 24,\n summarizedEventCount: 18,\n findingCount: 2,\n nonCompliantFindingCount: 0,\n namespace: \"jms\",\n bucketName: \"fleetName\",\n objectName: \"managedInstance/2022-09-19/result.json\",\n timeStarted: \"2023-01-11T08:30:00.000Z\",\n timeFinished: \"2023-01-11T10:30:00.000Z\"\n}\n"
UpdateTaskScheduleDetails:
description: Attributes to update a task schedule.
properties:
executionRecurrences:
description: 'Recurrence specification for the task schedule execution (formatted according to [RFC-5545](https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/)). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be ''DTSTART=20240902T090000Z;
RRULE:FREQ=DAILY;COUNT=10''. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be ''DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z''.
'
format: x-obmcs-recurring-time
type: string
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
maxLength: 255
minLength: 1
type: string
taskDetails:
$ref: '#/components/schemas/TaskDetails'
required:
- fleetId
- taskDetails
- executionRecurrences
type: object
JavaReleaseSummary:
description: A summary of the Java release properties.
properties:
artifactContentTypes:
description: Artifact content types for the Java version.
items:
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
maxItems: 3
minItems: 1
type: array
uniqueItems: true
daysUnderSecurityBaseline:
description: The number of days since this release has been under the security baseline.
type: integer
familyDetails:
$ref: '#/components/schemas/JavaFamily'
familyVersion:
description: Java release family identifier.
type: string
licenseDetails:
$ref: '#/components/schemas/JavaLicense'
licenseType:
description: License type for the Java version.
enum:
- OTN
- NFTC
- RESTRICTED
type: string
x-obmcs-top-level-enum: '#/definitions/LicenseType'
mosPatches:
description: 'List of My Oracle Support(MoS) patches available for this release.
This information is only available for `BPR` release type.
'
items:
$ref: '#/components/schemas/PatchDetail'
maxItems: 25
minItems: 1
type: array
parentReleaseVersion:
description: Parent Java release version identifier. This is applicable for BPR releases.
type: string
releaseDate:
description: The release date of the Java version (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
releaseNotesUrl:
description: Release notes associated with the Java version.
format: uri
maxLength: 512
type: string
releaseType:
description: Release category of the Java version.
enum:
- CPU
- FEATURE
- BPR
- PATCH_RELEASE
type: string
x-obmcs-top-level-enum: '#/definitions/ReleaseType'
releaseVersion:
description: Java release version identifier.
type: string
securityStatus:
description: The security status of the Java version.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
required:
- releaseVersion
- familyVersion
- securityStatus
- releaseType
- licenseType
- releaseDate
- releaseNotesUrl
- artifactContentTypes
type: object
x-example: "{\n \"releaseVersion\": \"17.0.3\",\n \"familyVersion\": \"17\",\n \"securityStatus\": \"UP_TO_DATE\",\n \"releaseType\": \"CPU\",\n \"licenseType\": \"NFTC\",\n \"releaseDate\": \"2021-01-19T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-3-relnotes.html\",\n \"artifactContentTypes\": [\"JDK\"],\n \"mosPatches\": [],\n \"daysUnderSecurityBaseline\": 100,\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/no-fee-license.html\"\n },\n \"familyDetails\": {\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2029-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\"\n }\n}\n"
JavaServerInstanceUsageCollection:
description: 'Results of a Java Server instance usage search. Contains Java Server usage items.
'
properties:
items:
description: 'A list of Java Server instance usages.
'
items:
$ref: '#/components/schemas/JavaServerInstanceUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"serverInstanceKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"serverInstanceName\":\"Example server instance name 1\",\n \"serverKey\":\"<unique_id>\",\n \"serverName\":\"Example Java Server name\",\n \"serverInstancePort\": 5080,\n \"serverVersion\":\"1.0\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.<unique_id>\"\n \"hostName\": \"Example managed instance host name 1\",\n \"jvmKey\":\"<unique_id>\",\n \"jvmVendor\":\"Oracle Corporation\",\n \"jvmDistribution\":\"Java(TM) SE Runtime Environment\",\n \"jvmVersion\":\"1.8.0_281\",\n \"jvmSecurityStatus\":\"UP_TO_DATE\",\n \"approximateDeployedApplicationCount\":7,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n },\n {\n \"serverInstanceKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"serverInstanceName\":\"Example server instance name 2\",\n \"serverInstancePort\": null,\n \"serverKey\":\"<unique_id>\",\n \"serverName\":\"Example Java Server name\",\n \"serverVersion\":\"1.0\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.<unique_id>\"\n \"hostName\": \"Example managed instance host name 2\",\n \"jvmKey\":\"<unique_id>\",\n \"jvmVendor\":\"Oracle Corporation\",\n \"jvmDistribution\":\"Java(TM) SE Runtime Environment\",\n \"jvmVersion\":\"1.8.0_281\",\n \"jvmSecurityStatus\":\"UP_TO_DATE\",\n \"approximateDeployedApplicationCount\":7,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n }\n ]\n}\n"
WorkRequestLogEntry:
description: A log message from executing 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 (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
required:
- message
- timestamp
ContainerSummary:
description: 'Information about a container in the cluster.
'
properties:
applicationKey:
description: Unique key that identifies the application running in the container.
maxLength: 255
minLength: 1
type: string
applicationName:
description: The name of the application running in the container.
maxLength: 255
minLength: 1
type: string
containerKey:
description: Unique identifier for the container.
maxLength: 255
minLength: 1
type: string
displayName:
description: The name of the container.
maxLength: 255
minLength: 1
type: string
imageName:
description: The container image name.
maxLength: 255
minLength: 1
type: string
javaVersion:
description: The Java runtime used to run the application in the container.
maxLength: 30
minLength: 1
type: string
jreKey:
description: Unique key that identifies the Java runtime used to run the application in the container.
maxLength: 255
minLength: 1
type: string
jreSecurityStatus:
description: The security status of the Java runtime used to run the application in the container.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
managedInstanceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated managed instance of type OCMA.
type: string
namespace:
description: The namespace of the container.
maxLength: 255
minLength: 1
type: string
nodeName:
description: The name of the node associated with the pod running this container.
maxLength: 255
minLength: 1
type: string
podName:
description: The name of the pod running this container.
maxLength: 255
minLength: 1
type: string
timeStarted:
description: The start time of the container.
format: date-time
type: string
required:
- containerKey
- managedInstanceId
- displayName
- imageName
- namespace
- nodeName
- podName
type: object
x-example: "{\n \"containerKey\": \"UUID-of-the-container\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.unique_id\",\n \"displayName\": \"hello-world\",\n \"imageName\": \"alpine:latest\",\n \"namespace\": \"namespace1\",\n \"nodeName\": \"node1\",\n \"podName\": \"pod1\",\n \"applicationKey\": \"eed8db429153c3e555ac439aac11d4c4c51df1edaa50df1f68c80cadf2f867df\",\n \"applicationName\": \"com.oracle.HelloWorld\",\n \"jreKey\": \"1e543401165e2cc05d39bcaaa355bcb31f08c4786250837caa1d86968ff5dbff\",\n \"jreVersion\": \"17.0.12\",\n \"jreSecurityStatus\":\"UP_TO_DATE\",\n \"timeStarted\": \"2024-10-07T00:00:00.000Z\"\n}\n"
ClusterDetails:
description: The state of the cluster during a specified time period.
properties:
clusterType:
description: The type of the cluster.
enum:
- OKE
- OTHER
type: string
containerCount:
description: Number of containers as reported in the last cluster scan
type: integer
nodeCount:
description: Number of nodes as reported in the last cluster scan
type: integer
podCount:
description: Number of pods as reported in the last cluster scan
type: integer
type: object
LibraryUsageCollection:
description: 'Results of a library usage search. Contains library usage items.
'
properties:
items:
description: 'A list of library usages.
'
items:
$ref: '#/components/schemas/LibraryUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"libraryKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.amaaaaaafhbuohyalyygmhsvlwfycidr6dyeufryinp4ae56fgppdq4cxhfa\",\n \"libraryName\":\"Example library name 1\",\n \"libraryVersion\":\"1.0\",\n \"cveId\":\"CVE-2019-16163\",\n \"cvssScore\":3.0,\n \"highestVulnerabilityScore\":3.0\n \"vulnerabilities\": [\n {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":3.0\n }, {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":2.0\n }],\n \"confidenceLevel\":\"HIGH\",\n \"approximateApplicationCount\":10,\n \"approximateJavaServerInstanceCount\":2,\n \"approximateDeployedApplicationCount\":14,\n \"approximateManagedInstanceCount\":1,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\",\n \"timeLastCveRefreshed\":\"2022-01-26T10:00:00.000Z\"\n },\n {\n \"libraryKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.amaaaaaafhbuohyalyygmhsvlwfycidr6dyeufryinp4ae56fgppdq4cxhfa\",\n \"libraryName\":\"Example library name 2\",\n \"libraryVersion\":\"1.0\",\n \"cveId\":\"CVE-2019-16163\",\n \"cvssScore\":3.0,\n \"highestVulnerabilityScore\":3.0\n \"vulnerabilities\": [\n {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":3.0\n }, {\n \"vulnerabilityKey\":\"GHSA-1234-abcd-5678\", \n \"cvssScore\":2.0\n }],\n \"confidenceLevel\":\"HIGH\",\n \"approximateApplicationCount\":10,\n \"approximateJavaServerInstanceCount\":2,\n \"approximateDeployedApplicationCount\":14,\n \"approximateManagedInstanceCount\":1,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\",\n \"timeLastCveRefreshed\":\"2022-01-26T10:00:00.000Z\"\n }\n ]\n}\n"
EnableDrsDetails:
description: 'Details of the request to enable DRS in active managed instance(s) in a Fleet.
When the targets aren''t specified, then all active managed instance(s) currently in the Fleet are selected.
'
properties:
manageDrsDetails:
$ref: '#/components/schemas/ManageDrsDetails'
WorkRequest:
description: An asynchronous work request. See [Work Requests](/Content/General/Concepts/workrequestoverview.htm).
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources,
and those resources aren''t in the same compartment, it''s up to the service team to pick the primary
resource whose compartment should be used.
'
maxLength: 255
minLength: 1
type: string
completedTaskCount:
description: The number of tasks had been executed to a terminal state.
type: integer
createdBy:
$ref: '#/components/schemas/Principal'
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
type: string
operationType:
description: The asynchronous operation tracked by this work request.
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
percentComplete:
description: The percentage complete of the operation tracked by this work request.
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
- CANCELED
- CANCELING
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
timeAccepted:
description: 'The date and time the request was created (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeFinished:
description: 'The date and time the work request reached a terminal state, either _FAILED_ or _SUCCEEDED_ (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeLastUpdated:
description: 'The date and time the work request percentage was last updated. (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeStarted:
description: 'The date and time the work request transitioned from _ACCEPTED_ to _IN_PROGRESS_ (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
totalTaskCount:
description: The total number of tasks to be executed for this work request.
type: integer
required:
- compartmentId
- id
- operationType
- percentComplete
- resources
- status
- timeAccepted
PluginErrorDetails:
description: Details of a plugin error.
properties:
details:
description: Optional string containing additional details.
type: string
reason:
description: The plugin error reason.
enum:
- REGISTRATION_POLICY
- LOG_RESOURCE_POLICY
- NO_FLEET
type: string
x-obmcs-top-level-enum: '#/definitions/PluginErrorReason'
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
required:
- reason
- timeLastSeen
type: object
SummarizedEventsLog:
description: 'Summarized events log for advanced feature.
'
properties:
logGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the log group.
maxLength: 255
minLength: 1
type: string
logId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the log.
maxLength: 255
minLength: 1
type: string
required:
- logGroupId
- logId
type: object
x-example: "{\n \"logGroupId\": \"ocid..<unique_id_of_log_group>\",\n \"logId\": \"ocid..<unique_id_of_log>\"\n}\n"
LicenseType:
description: Type of license associated with the Java version.
enum:
- OTN
- NFTC
- RESTRICTED
type: string
FleetAdvancedFeatureConfiguration:
description: Metadata for the advanced features in the Fleet.
properties:
advancedUsageTracking:
$ref: '#/components/schemas/AdvancedUsageTracking'
analyticBucketName:
description: Bucket name required to store JFR and related data.
type: string
analyticNamespace:
description: Namespace for the Fleet advanced feature.
type: string
cryptoEventAnalysis:
$ref: '#/components/schemas/CryptoEventAnalysis'
javaMigrationAnalysis:
$ref: '#/components/schemas/JavaMigrationAnalysis'
jfrRecording:
$ref: '#/components/schemas/JfrRecording'
lcm:
$ref: '#/components/schemas/Lcm'
performanceTuningAnalysis:
$ref: '#/components/schemas/PerformanceTuningAnalysis'
timeLastModified:
description: 'The date and time of the last modification to the Fleet Agent Configuration (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
required:
- lcm
- cryptoEventAnalysis
- performanceTuningAnalysis
- advancedUsageTracking
- jfrRecording
- javaMigrationAnalysis
- analyticNamespace
- analyticBucketName
- timeLastModified
type: object
x-example: "{\n \"analyticNamespace\": \"\",\n \"analyticBucketName\": \"\",\n \"lcm\": {\n \"isEnabled\": true,\n \"postInstallationActions\": {\n \"disabledTlsVersions\": [\n \"TLS_1_0\",\n \"TLS_1_1\"\n ],\n \"shouldReplaceCertificatesOperatingSystem\": false,\n \"minimumKeySizeSettings\": {\n \"tls\": [\n {\n \"name\": \"DH\",\n \"keySize\": 2048\n }\n ],\n \"certpath\": [\n {\n \"name\": \"EC\",\n \"keySize\": 256\n },\n {\n \"name\": \"DSA\",\n \"keySize\": 2048\n }\n ],\n \"jar\": [\n {\n \"name\": \"RSA\",\n \"keySize\": 2048\n }\n ]\n }\n }\n },\n \"cryptoEventAnalysis\": {\n \"isEnabled\": true,\n \"summarizedEventsLog\": {\n \"logGroupId\": \"ocid..<unique_id_of_log_group>\",\n \"logId\": \"ocid..<unique_id_of_log>\"\n }\n },\n \"advancedUsageTracking\": {\n \"isEnabled\": true\n },\n \"jfrRecording\": {\n \"isEnabled\": true\n },\n \"performanceTuningAnalysis\": {\n \"isEnabled\": true\n },\n \"javaMigrationAnalysis\": {\n \"isEnabled\": true\n }\n}\n"
FleetCollection:
description: Results of a Fleet search. Contains FleetSummary items.
properties:
items:
description: A list of Fleets.
items:
$ref: '#/components/schemas/FleetSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"displayName\":\"Fleet display name\",\n \"description\":\"Fleet description\",\n \"compartmentId\":\"ocid1.compartment.oc1..<unique_id>\",\n \"approximateJreCount\":1,\n \"approximateInstallationCount\":3,\n \"approximateApplicationCount\":2,\n \"approximateManagedInstanceCount\":2,\n \"approximateJavaServerCount\":10,\n \"approximateLibraryCount\":500,\n \"approximateLibraryVulnerabilityCount\":40,\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false,\n \"isExportSettingEnabled\": false,\n \"timeCreated\":\"2021-01-26T15:58:25.748Z\",\n \"lifecycleState\":\"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{\n \"orcl-cloud\":{\n \"free-tier-retained\":\"false\"\n }\n }\n },\n {\n \"id\":\"ocid1.jmsfleet.oc1.iad.<other_unique_id>\",\n \"displayName\":\"Other fleet display name\",\n \"description\":\"Other fleet description\",\n \"compartmentId\":\"ocid1.compartment.oc1..<unique_id>\",\n \"approximateJreCount\":1,\n \"approximateInstallationCount\":3,\n \"approximateApplicationCount\":2,\n \"approximateManagedInstanceCount\":2,\n \"approximateJavaServerCount\":5,\n \"approximateLibraryCount\":500,\n \"approximateLibraryVulnerabilityCount\":40,\n \"inventoryLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"operationLog\":{\n \"logGroupId\":\"ocid..<unique_id_of_log_group>\",\n \"logId\":\"ocid..<unique_id_of_log>\"\n },\n \"isAdvancedFeaturesEnabled\": false,\n \"isExportSettingEnabled\": false,\n \"timeCreated\":\"2021-01-26T15:51:33.512Z\",\n \"timeCreated\":\"2021-01-26T15:58:25.748Z\",\n \"lifecycleState\":\"ACTIVE\",\n \"freeformTags\":{},\n \"definedTags\":{},\n \"systemTags\":{\n \"orcl-cloud\":{\n \"free-tier-retained\":\"false\"\n }\n }\n }\n ]\n}\n"
WorkRequestCollection:
description: Results of a work request search. Contains WorkRequest items
properties:
items:
description: A list of work requests.
items:
$ref: '#/components/schemas/WorkRequest'
type: array
required:
- items
type: object
AnnouncementCollection:
description: Results of list announcements call. Contains AnnouncementSummary items
properties:
items:
description: List of AnnouncementSummary items
items:
$ref: '#/components/schemas/AnnouncementSummary'
type: array
required:
- items
type: object
CryptoAnalysisResult:
allOf:
- $ref: '#/components/schemas/CryptoAnalysisResultSummary'
description: Metadata for the result of a crypto event analysis. The analysis result is stored in an Object Storage bucket.
RemoveFleetInstallationSitesDetails:
description: The list of Java installation sites to remove.
properties:
installationSites:
description: The list of installation sites to remove.
items:
$ref: '#/components/schemas/ExistingInstallationSiteId'
maxItems: 32768
type: array
required:
- installationSites
type: object
JmsPlugin:
description: 'Information about a JmsPlugin that has been registered.
'
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Management Agent (OMA), the Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA)
instance where the JMS plugin is deployed.
'
maxLength: 255
minLength: 1
type: string
agentType:
description: The agent type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
availabilityStatus:
description: The availability status.
enum:
- ACTIVE
- SILENT
- NOT_AVAILABLE
type: string
x-obmcs-top-level-enum: '#/definitions/JmsPluginAvailabilityStatus'
compartmentId:
description: 'The OMA/OCA/OCMA agent''s compartment [OCID](/Content/General/Concepts/identifiers.htm).
'
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
hostname:
description: 'The hostname of the agent.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this JmsPlugin.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The lifecycle state.
enum:
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETED
type: string
x-obmcs-top-level-enum: '#/definitions/JmsPluginLifecycleState'
osArchitecture:
description: The architecture of the operating system of the plugin.
maximum: 255
minimum: 1
type: string
osDistribution:
description: The distribution of the operating system of the plugin.
maximum: 255
minimum: 1
type: string
osFamily:
description: The operating system family for the plugin.
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
pluginVersion:
description: The version of the plugin.
maximum: 90
minimum: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeRegistered:
description: 'The date and time the plugin was registered.
'
format: date-time
type: string
required:
- id
- agentId
- agentType
- lifecycleState
- availabilityStatus
- timeRegistered
ContainerCollection:
description: 'Collection of the container summary.
'
properties:
items:
description: A list of the container summaries.
items:
$ref: '#/components/schemas/ContainerSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"containerKey\": \"UUID-of-the-container\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.unique_id\",\n \"displayName\": \"hello-world\",\n \"imageName\": \"alpine:latest\",\n \"namespace\": \"namespace1\",\n \"nodeName\": \"node1\",\n \"podName\": \"pod1\",\n \"applicationKey\": \"eed8db429153c3e555ac439aac11d4c4c51df1edaa50df1f68c80cadf2f867df\",\n \"applicationName\": \"com.oracle.HelloWorld\",\n \"jreKey\": \"1e543401165e2cc05d39bcaaa355bcb31f08c4786250837caa1d86968ff5dbff\",\n \"jreVersion\": \"17.0.12\",\n \"jreSecurityStatus\":\"UP_TO_DATE\",\n \"timeStarted\": \"2024-10-07T00:00:00.000Z\"\n },\n {\n \"containerKey\": \"UUID-of-the-container-2\",\n \"managedInstanceId\": \"ocid1.managementagent.oc1.iad.unique_id\",\n \"displayName\": \"hello-world\",\n \"imageName\": \"alpine:latest\",\n \"namespace\": \"namespace1\",\n \"nodeName\": \"node1\",\n \"podName\": \"pod2\",\n \"applicationKey\": \"eed8db429153c3e555ac439aac11d4c4c51df1edaa50df1f68c80cadf2f867df\",\n \"applicationName\": \"com.oracle.HelloWorld\",\n \"jreKey\": \"1e543401165e2cc05d39bcaaa355bcb31f08c4786250837caa1d86968ff5dbff\",\n \"jreVersion\": \"17.0.12\",\n \"jreSecurityStatus\":\"UP_TO_DATE\",\n \"timeStarted\": \"2024-10-07T00:00:00.000Z\"\n }\n ]\n}\n"
JmsPluginCollection:
description: Results of a JmsPlugin search. Contains JmsPluginSummary items.
properties:
items:
description: A list of JmsPlugins.
items:
$ref: '#/components/schemas/JmsPluginSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"id\":\"ocid1.jmsplugin.oc1.iad.<unique_id>\",\n \"agentId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"agentType\":\"OMA\",\n \"lifecycleState\":\"ACTIVE\",\n \"timeRegistered\":\"2024-01-31T02:18:00.000Z\",\n \"timeLastSeen\":\"2024-01-31T02:18:00.000Z\"\n },\n {\n \"id\":\"ocid1.jmsplugin.oc1.iad.<unique_id>\",\n \"agentId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"agentType\":\"OMA\",\n \"lifecycleState\":\"INACTIVE\",\n \"timeRegistered\":\"2024-01-31T02:18:00.000Z\",\n \"timeLastSeen\":\"2024-01-31T02:18:00.000Z\"\n },\n {\n \"id\":\"ocid1.jmsplugin.oc1.iad.<unique_id>\",\n \"agentId\":\"ocid1.instance.oc1.iad.<unique_id>\",\n \"agentType\":\"OCA\",\n \"lifecycleState\":\"INACTIVE\",\n \"timeRegistered\":\"2024-01-31T02:18:00.000Z\",\n \"timeLastSeen\":\"2024-01-31T02:18:00.000Z\"\n }\n ]\n}\n"
TaskScheduleSummary:
description: A summary of the task schedule properties.
properties:
createdBy:
description: The name of the task creator.
maxLength: 255
minLength: 1
type: string
executionRecurrences:
description: 'Recurrence specification for the task schedule execution (formatted according to [RFC-5545](https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/)). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be ''DTSTART=20240902T090000Z
RRULE:FREQ=DAILY;COUNT=10''. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be ''DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z''.
'
format: x-obmcs-recurring-time
type: string
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule.
maxLength: 255
minLength: 1
type: string
lifecycleState:
description: The current state of the task schedule.
type: string
x-obmcs-enumref: '#/definitions/TaskSchedule/lifecycleState'
name:
description: The name of the task schedule.
maxLength: 255
minLength: 1
type: string
taskDetails:
$ref: '#/components/schemas/TaskDetails'
timeCreated:
description: The date and time the task schedule was created (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeLastRun:
description: The date and time the task schedule ran last (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeLastUpdated:
description: The date and time the task schedule was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
timeNextRun:
description: The date and time the task schedule will run next (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
required:
- id
- fleetId
- name
- lifecycleState
- createdBy
- executionRecurrences
- taskDetails
- timeCreated
- timeLastUpdated
type: object
UpdateFleetAdvancedFeatureConfigurationDetails:
description: 'Details object containing advanced feature configurations to be updated.
Ensure that the namespace and bucket storage are created prior to turning on the JfrRecording or CryptoEventAnalysis feature.
'
properties:
advancedUsageTracking:
$ref: '#/components/schemas/AdvancedUsageTracking'
analyticBucketName:
description: Bucket name required to store JFR and related data.
type: string
analyticNamespace:
description: Namespace for the Fleet advanced feature.
type: string
cryptoEventAnalysis:
$ref: '#/components/schemas/CryptoEventAnalysis'
javaMigrationAnalysis:
$ref: '#/components/schemas/JavaMigrationAnalysis'
jfrRecording:
$ref: '#/components/schemas/JfrRecording'
lcm:
$ref: '#/components/schemas/Lcm'
performanceTuningAnalysis:
$ref: '#/components/schemas/PerformanceTuningAnalysis'
type: object
x-example: "{\n \"analyticNamespace\": \"\",\n \"analyticBucketName\": \"\",\n \"lcm\": {\n \"isEnabled\": true,\n \"postInstallationActions\": {\n \"disabledTlsVersions\": [\n \"TLS_1_0\",\n \"TLS_1_1\"\n ],\n \"shouldReplaceCertificatesOperatingSystem\": false,\n \"minimumKeySizeSettings\": {\n \"tls\": [\n {\n \"name\": \"DH\",\n \"keySize\": 2048\n }\n ],\n \"certpath\": [\n {\n \"name\": \"EC\",\n \"keySize\": 256\n },\n {\n \"name\": \"DSA\",\n \"keySize\": 2048\n }\n ],\n \"jar\": [\n {\n \"name\": \"RSA\",\n \"keySize\": 2048\n }\n ]\n }\n }\n },\n \"cryptoEventAnalysis\": {\n \"isEnabled\": true,\n \"summarizedEventsLog\": {\n \"logGroupId\": \"ocid..<unique_id_of_log_group>\",\n \"logId\": \"ocid..<unique_id_of_log>\"\n }\n },\n \"advancedUsageTracking\": {\n \"isEnabled\": true\n },\n \"jfrRecording\": {\n \"isEnabled\": true\n },\n \"performanceTuningAnalysis\": {\n \"isEnabled\": true\n },\n \"javaMigrationAnalysis\": {\n \"isEnabled\": true\n }\n }\n"
ExistingInstallationSiteId:
description: The essential properties to identity a Java installation site.
properties:
installationKey:
description: The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system.
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
required:
- managedInstanceId
- installationKey
type: object
WorkRequestResource:
description: A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
properties:
actionType:
description: 'The way in which this resource was affected by the operation that spawned the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- DELETED
- IN_PROGRESS
- RELATED
- UPDATED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/ActionType'
entityType:
description: The resource type affected by the work request.
type: string
entityUri:
description: The URI path that the user can perform a GET operation to access the resource metadata.
type: string
identifier:
description: An [OCID](/Content/General/Concepts/identifiers.htm) or other unique identifier of the resource affected by the work request.
type: string
required:
- actionType
- entityType
- identifier
AgentInstallerCollection:
description: 'Collection of the agent installer summary.
'
properties:
items:
description: A list of the agent installer summaries.
items:
$ref: '#/components/schemas/AgentInstallerSummary'
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"agentInstallerId\": 1001,\n \"agentInstallerDescription\": \"MacOs x64 ZIP installer\",\n \"approximateFileSizeInBytes\": 297444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"osFamily\": \"MACOS\",\n \"platformArchitecture\": \"X86_64\",\n \"packageType\": \"ZIP\",\n \"agentVersion\": \"20240216.3456\",\n \"javaVersion\": \"8u411\",\n \"agentInstallerVersion\": \"9.0.234\"\n },\n {\n \"agentInstallerId\": 1002,\n \"agentInstallerDescription\": \"Windows x86 ZIP installer\",\n \"approximateFileSizeInBytes\": 297444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"osFamily\": \"WINDOWS\",\n \"platformArchitecture\": \"X86\",\n \"packageType\": \"ZIP\",\n \"agentVersion\": \"20240216.3456\",\n \"javaVersion\": \"8u411\",\n \"agentInstallerVersion\": \"9.0.234\"\n },\n {\n \"agentInstallerId\": 1003,\n \"agentInstallerDescription\": \"Linux AArch64 ZIP installer\",\n \"approximateFileSizeInBytes\": 297444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"osFamily\": \"LINUX\",\n \"platformArchitecture\": \"AARCH64\",\n \"packageType\": \"ZIP\",\n \"agentVersion\": \"20240216.3456\",\n \"javaVersion\": \"8u411\",\n \"agentInstallerVersion\": \"9.0.234\"\n },\n {\n \"agentInstallerId\": 1004,\n \"agentInstallerDescription\": \"Linux x64 RPM installer\",\n \"approximateFileSizeInBytes\": 297444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"osFamily\": \"LINUX\",\n \"platformArchitecture\": \"X86_64\",\n \"packageType\": \"RPM\",\n \"agentVersion\": \"20240216.3456\",\n \"javaVersion\": \"8u411\",\n \"agentInstallerVersion\": \"9.0.234\"\n },\n ]\n}\n"
RequestJavaMigrationAnalysesDetails:
description: 'Details of the request to start a Java migration analysis. The analysis requires the managed instance OCID, application installation key,
source JDK version, and target JDK version of each selected application.
'
properties:
targets:
description: An array of migration analysis requests.
items:
$ref: '#/components/schemas/JavaMigrationAnalysisTarget'
maxItems: 1024
type: array
required:
- targets
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n applicationInstallationKey: \"<unique_application_installation_key>\"\n sourceJdkVersion: \"<source_jdk_version>\"\n targetJdkVersion: \"<target_jdk_version>\"\n excludePackagePrefixes: [\n \"lombok\",\n \"com.google\",\n \"org.apache.maven\"\n ]\n includePackagePrefixes: [\n \"jms\"\n ]\n }]\n}\n"
JavaMigrationAnalysis:
description: JavaMigrationAnalysis configuration
properties:
isEnabled:
default: false
description: JavaMigrationAnalysis flag to store enabled or disabled status.
type: boolean
type: object
UpdateFleetAgentConfigurationDetails:
description: Attributes to update a Fleet Agent Configuration.
properties:
agentPollingIntervalInMinutes:
default: 10
description: 'Agent polling interval in minutes
'
maximum: 720
minimum: 10
type: integer
isCapturingIpAddressAndFqdnEnabled:
default: false
description: 'Collect network addresses of managed instances in the fleet.
'
type: boolean
isCollectingManagedInstanceMetricsEnabled:
default: false
description: 'Collect JMS agent metrics on all managed instances in the fleet.
'
type: boolean
isCollectingUsernamesEnabled:
default: true
description: 'Collect username for application invocations for all managed instances in the fleet.
'
type: boolean
isLibrariesScanEnabled:
default: true
description: 'Enable libraries scan on all managed instances in the fleet.
'
type: boolean
javaUsageTrackerProcessingFrequencyInMinutes:
description: 'The frequency (in minutes) of Java Usage Tracker processing. (That is, how often should JMS process data from the Java Usage Tracker.)
'
maximum: 90
minimum: 5
type: integer
jreScanFrequencyInMinutes:
description: 'The frequency (in minutes) of JRE scanning. (That is, how often should JMS scan for JRE installations.)
'
maximum: 40320
minimum: 180
type: integer
linuxConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
macOsConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
windowsConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
workRequestValidityPeriodInDays:
default: 14
description: 'The validity period in days for work requests.
'
maximum: 30
minimum: 7
type: integer
type: object
x-example: "{\n \"jreScanFrequencyInMinutes\": 180,\n \"javaUsageTrackerProcessingFrequencyInMinutes\": 5,\n \"workRequestValidityPeriodInDays\": 7,\n \"agentPollingIntervalInMinutes\": 60,\n \"linuxConfiguration\": {\n \"includePaths\": [\"/var/www/opc\", \"/home/opc\"],\n \"excludePaths\": [\"/home/etc\"]\n },\n \"windowsConfiguration\": {\n \"includePaths\": [\"C://path\"],\n \"excludePaths\": [\"E://path\"]\n },\n \"macOsConfiguration\": {\n \"includePaths\": [\"/Library/Java\"],\n \"excludePaths\": [\"/home\"]\n }\n}\n"
ApplicationUsageCollection:
description: Results of an application search. Contains ApplicationUsage items.
properties:
items:
description: A list of applications.
items:
$ref: '#/components/schemas/ApplicationUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationId\":\"81abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c4f8f3\",\n \"displayName\":\"application display name\",\n \"applicationType\":\"VM start\",\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n }, {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\",\n \"managedInstanceCount\": 2\n } ],\n \"approximateInstallationCount\": 2,\n \"approximateJreCount\": 2,\n \"approximateManagedInstanceCount\": 3,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2021-01-19T17:40:15.000Z\",\n \"timeEnd\":\"2021-01-26T17:40:15.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:36:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T15:46:00.000Z\"\n }\n ]\n}\n"
Lcm:
description: Enable lifecycle management and set post action configurations.
properties:
isEnabled:
default: false
description: Lifecycle management flag to store enabled or disabled status.
type: boolean
postInstallationActions:
$ref: '#/components/schemas/PostInstallationActionSettings'
type: object
JavaMigrationAnalysisTarget:
description: 'The target describes the input data for Java migration analysis.
A target contains a managed instance, application Installation Key, sourceJdkVersion, targetJdkVersion, optional excludePackagePrefixes and optional includePackagePrefixes.
'
properties:
applicationInstallationKey:
description: The unique key that identifies the application's installation path that is to be used for the Java migration analysis.
maxLength: 255
minLength: 1
type: string
excludePackagePrefixes:
description: Excludes the packages that starts with the prefix from the migration analysis result. Either this or includePackagePrefixes can be specified.
items:
maxLength: 128
minLength: 1
type: string
maxItems: 64
type: array
includePackagePrefixes:
description: includes the packages that starts with the prefix from the migration analysis result. Either this or excludePackagePrefixes can be specified.
items:
maxLength: 128
minLength: 1
type: string
maxItems: 64
type: array
managedInstanceId:
description: The OCID of the managed instance that hosts the application for which the Java migration analysis was performed.
maxLength: 255
minLength: 1
type: string
sourceJdkVersion:
description: The JDK version the application is currently running on.
maxLength: 255
minLength: 1
type: string
targetJdkVersion:
description: The JDK version against which the migration analysis was performed to identify effort required to move from source JDK.
maxLength: 255
minLength: 1
type: string
required:
- managedInstanceId
- applicationInstallationKey
- sourceJdkVersion
- targetJdkVersion
x-example: "{\n managedInstanceId: \"<managed_instance_OCID>\"\n applicationInstallationKey: \"<unique_application_installation_key>\"\n sourceJdkVersion: \"<source_jdk_version>\"\n targetJdkVersion: \"<target_jdk_version>\"\n excludePackagePrefixes: [\n \"lombok\",\n \"com.google\",\n \"org.apache.maven\"\n ]\n includePackagePrefixes: [\n \"jms\"\n ]\n}\n"
CreateBlocklistDetails:
description: The blocklist record details.
properties:
operation:
description: The operation type
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
type: string
x-obmcs-top-level-enum: '#/definitions/OperationType'
reason:
description: The reason why the operation is blocklisted
type: string
target:
$ref: '#/components/schemas/BlocklistTarget'
required:
- target
- operation
type: object
WorkRequestLogEntryCollection:
description: Results of a work request log entry search. Contains WorkRequestLogEntry items
properties:
items:
description: A list of work request log entries.
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
MinimumKeySizeSettings:
description: test
properties:
certpath:
default: []
description: 'Updates the minimum key size for the specified encryption algorithm.
The JDK property jdk.certpath.disabledAlgorithms will be updated with the following supported actions:
- Changing minimum key length for RSA signed jars
- Changing minimum key length for EC
- Changing minimum key length for DSA
'
items:
$ref: '#/components/schemas/KeySizeAlgorithm'
type: array
uniqueItems: true
jar:
default: []
description: 'Updates the minimum key size for the specified encryption algorithm.
The JDK property jdk.jar.disabledAlgorithms will be updated with the following supported actions:
- Changing minimum key length for RSA signed jars
- Changing minimum key length for EC
- Changing minimum key length for DSA
'
items:
$ref: '#/components/schemas/KeySizeAlgorithm'
type: array
uniqueItems: true
tls:
default: []
description: 'Updates the minimum key size for the specified encryption algorithm.
The JDK property jdk.tls.disabledAlgorithms will be updated with the following supported actions:
- Changing minimum key length for Diffie-Hellman
'
items:
$ref: '#/components/schemas/KeySizeAlgorithm'
type: array
uniqueItems: true
type: object
WorkRequestError:
description: An error encountered while executing an operation that is tracked by a work request.
properties:
code:
description: 'A machine-usable code for the error that occurred. Error codes are listed at [API Errors](/Content/API/References/apierrors.htm).
'
type: string
message:
description: A human readable description of the issue encountered.
type: string
timestamp:
description: The date and time the error occured (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
format: date-time
type: string
required:
- code
- message
- timestamp
BlocklistCollection:
description: Results of a blocklist search that contain Blocklist records.
properties:
items:
description: The blocklist
items:
$ref: '#/components/schemas/Blocklist'
type: array
required:
- items
type: object
BlocklistTarget:
description: A resource to blocklist for certain operation.
properties:
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
type: string
installationKey:
description: The unique identifier for the installation of Java Runtime at a specific path on a specific operating system.
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
required:
- fleetId
type: object
ApplicationUsage:
description: 'Application usage during a specified time period.
An application is a Java application that can be executed by a Java Runtime installation.
An application is independent of the Java Runtime or its installation.
'
properties:
applicationId:
description: 'An internal identifier for the application that is unique to a fleet.
'
type: string
applicationType:
description: The type of the application denoted by how the application was started.
type: string
approximateInstallationCount:
description: The approximate count of installations running this application.
type: integer
approximateJreCount:
description: The approximate count of Java Runtimes running this application.
type: integer
approximateLibraryCount:
description: 'The approximate count of libraries in this application.
'
type: integer
approximateManagedInstanceCount:
description: The approximate count of managed instances reporting this application.
type: integer
displayName:
description: The name of the application.
type: string
operatingSystems:
description: The operating systems running this application.
items:
$ref: '#/components/schemas/OperatingSystem'
type: array
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- applicationId
- applicationType
- displayName
type: object
x-example: "{\n \"applicationId\":\"81abcdef1234567891e9454ae748d16a6a9cf6fd3fb5ae4612d1beee69c4f8f3\",\n \"displayName\":\"application display name\",\n \"applicationType\":\"VM start\",\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n }, {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\",\n \"managedInstanceCount\": 2\n } ],\n \"approximateInstallationCount\": 2,\n \"approximateJreCount\": 2,\n \"approximateManagedInstanceCount\": 3,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2021-01-19T17:40:15.000Z\",\n \"timeEnd\":\"2021-01-26T17:40:15.000Z\",\n \"timeFirstSeen\":\"2021-01-25T14:36:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T15:46:00.000Z\"\n}\n"
JavaServerUsageCollection:
description: 'Results of a Java Server usage search. Contains Java Server usage items.
'
properties:
items:
description: 'A list of Java Server usages.
'
items:
$ref: '#/components/schemas/JavaServerUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\": [\n {\n \"serverKey\":\"<unique_Java_server_key_1>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id_1>\",\n \"serverName\":\"Example Java Server name 1\",\n \"serverVersion\":\"1.0\",\n \"serverInstanceCount\":3,\n \"approximateDeployedApplicationCount\":10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-24T02:18:00.000Z\",\n \"timeLastSeen\":\"2022-01-25T02:18:00.000Z\"\n },\n {\n \"serverKey\":\"<unique_Java_server_key_2>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id_2>\",\n \"serverName\":\"Example Java Server name 2\",\n \"serverVersion\":\"1.1\",\n \"serverInstanceCount\":2,\n \"approximateDeployedApplicationCount\":10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-20T02:18:00.000Z\",\n \"timeLastSeen\":\"2022-01-22T02:18:00.000Z\"\n },\n ]\n}\n"
InstallationSiteCollection:
description: Results of an installation site search. Contains installation sites.
properties:
items:
description: A list of Java installation sites.
items:
$ref: '#/components/schemas/InstallationSiteSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"installationKey\": \"<unique_installation_id>\",\n \"managedInstanceId\": \"<managed_instance_OCID>\",\n \"jre\": {\n \"version\": \"11.0.13\",\n \"vendor\": \"Oracle Corporation\",\n \"distribution\": \"Java(TM) SE Runtime Environment\",\n \"jreKey\": \"<unique_jre_key>\"\n },\n \"path\": \"/usr/java/jdk-11.0.13\",\n \"operatingSystem\": {\n \"family\": \"LINUX\",\n \"name\": \"Linux\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"architecture\": \"amd64\"\n },\n \"approximateApplicationCount\": 0,\n \"timeLastSeen\": \"2022-01-24T02:18:00.000Z\",\n \"blocklist\": [],\n \"lifecycleState\": \"ACTIVE\"\n }\n ]\n}\n"
FleetDiagnosisCollection:
description: List of the fleet resource diagnosis.
properties:
items:
description: A list of the fleet resource diagnosis.
items:
$ref: '#/components/schemas/FleetDiagnosisSummary'
type: array
required:
- items
type: object
FleetErrorAggregationSummary:
description: High level view of fleet error aggregations.
properties:
fleetErrorAggregations:
description: List of fleet error aggregations.
items:
$ref: '#/components/schemas/FleetErrorAggregation'
type: array
healthyFleetCount:
description: Count of fleets with no problems.
type: integer
required:
- healthyFleetCount
- fleetErrorAggregations
type: object
x-example: "{\n \"healthyFleetCount\": 38,\n \"fleetErrorAggregations\": [\n {\"reason\": \"NO_FLEET\", \"count\": 8},\n {\"reason\": \"INVENTORY_LOG\", \"count\": 3}\n ]\n}\n"
JreUsageCollection:
description: Results of a Java Runtime search. Contains JreUsage items
properties:
items:
description: A list of Java Runtimes.
items:
$ref: '#/components/schemas/JreUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"id\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.amaaaaaafhbuohyalyygmhsvlwfycidr6dyeufryinp4ae56fgppdq4cxhfa\",\n \"managedInstanceId\":\"ocid1.managementagent.oc1.iad.<unique_id>\",\n \"securityStatus\":\"UP_TO_DATE\",\n \"releaseDate\":\"2021-01-19T00:00:00.000Z\",\n \"endOfSupportLifeDate:\"2030-12-31T23:59:00.000Z\",\n \"vendor\":\"Oracle Corporation\",\n \"distribution\":\"Java(TM) SE Runtime Environment\",\n \"version\":\"1.8.0_281\",\n \"operatingSystems\": [ {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"4.14.35-1902.302.2.el7uek.x86_64\",\n \"managedInstanceCount\": 1\n }, {\n \"family\": \"Windows\",\n \"name\": \"Windows Server 2012 R2\",\n \"architecture\": \"amd64\",\n \"version\": \"6.3\",\n \"managedInstanceCount\": 2\n } ],\n \"timeStart\":\"2021-01-19T17:34:41.000Z\",\n \"timeEnd\":\"2021-01-26T17:34:41.000Z\",\n \"timeFirstSeen\":\"2021-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T22:57:00.000Z\"\n }\n ]\n}\n"
FleetErrorCollection:
description: Results of a Fleet Error search.
properties:
items:
description: A list of FleetErrorSummary.
items:
$ref: '#/components/schemas/FleetErrorSummary'
type: array
required:
- items
type: object
CustomLog:
description: 'Custom Log for inventory or operation log.
'
properties:
logGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the log group.
maxLength: 255
minLength: 1
type: string
logId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the log.
maxLength: 255
minLength: 1
type: string
required:
- logGroupId
- logId
type: object
x-example: "{\n \"logGroupId\": \"ocid..<unique_id_of_log_group>\",\n \"logId\": \"ocid..<unique_id_of_log>\"\n}\n"
UncorrelatedPackageUsageCollection:
description: Collection of uncorrelated package summaries.
properties:
items:
description: A list of uncorrelated package summaries.
items:
$ref: '#/components/schemas/UncorrelatedPackageUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"packageName\":\"com.example.packagename1\",\n \"managedInstanceCount\":\"3\",\n \"applicationCount\":\"2\",\n \"lastDetectedDynamically\":\"2022-01-25T16:57:00.000Z\",\n },\n {\n \"packageName\":\"com.example.packagename2\",\n \"managedInstanceCount\":\"2\",\n \"applicationCount\":\"1\",\n \"lastDetectedDynamically\":\"2022-02-25T16:57:00.000Z\",\n }\n ]\n}\n"
UncorrelatedPackageManagedInstanceUsageCollection:
description: Collection of UncorrelatedPackageManagedInstanceUsageSummaries.
properties:
items:
description: A list of UncorrelatedPackageManagedInstanceUsageSummaries.
items:
$ref: '#/components/schemas/UncorrelatedPackageManagedInstanceUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name\",\n \"applicationCount\":2,\n \"lastDetectedDynamically\":\"2022-02-21T00:00:00.000Z\",\n },\n {\n \"managedInstanceId\":\"<unique_managed_instance_id>\",\n \"hostname\":\"Example host name 2\",\n \"applicationCount\":3,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n }\n ]\n}\n"
PluginErrorAggregationSummary:
description: High level view of plugin error aggregations.
properties:
healthyPluginCount:
description: Count of plugins with no problems.
type: integer
pluginErrorAggregations:
description: List of plugin aggregation errors.
items:
$ref: '#/components/schemas/PluginErrorAggregation'
type: array
required:
- healthyPluginCount
- pluginErrorAggregations
type: object
x-example: "{\n \"healthyPluginCount\": 76,\n \"pluginErrorAggregations\": [\n {\"reason\": \"REGISTRATION_POLICY\", \"count\": 6},\n {\"reason\": \"LOG_RESOURCE_POLICY\", \"count\": 3},\n {\"reason\": \"NO_FLEET\", \"count\": 5},\n ]\n}\n"
JavaReleaseCollection:
description: Collection of Java releases information.
properties:
items:
description: A list of the Java release information.
items:
$ref: '#/components/schemas/JavaReleaseSummary'
maxItems: 100
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"releaseVersion\": \"17.0.3\",\n \"familyVersion\": \"17\",\n \"securityStatus\": \"UP_TO_DATE\",\n \"releaseType\": \"CPU\",\n \"licenseType\": \"NFTC\",\n \"releaseDate\": \"2022-01-19T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-0-3-relnotes.html\",\n \"daysUnderSecurityBaseline\": 165\n \"mosPatches\": []\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/no-fee-license.html\"\n },\n \"familyDetails\": {\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2029-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\"\n }\n },\n {\n \"releaseVersion\": \"17.0.3.0.1\",\n \"familyVersion\": \"17\",\n \"securityStatus\": \"UP_TO_DATE\",\n \"releaseType\": \"BPR\",\n \"licenseType\": \"RESTRICTED\",\n \"releaseDate\": \"2021-01-26T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-relnote-issues.html\",\n \"daysUnderSecurityBaseline\": 165\n \"mosPatches\": []\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/no-fee-license.html\"\n },\n \"familyDetails\": {\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2029-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\"\n }\n },\n {\n \"releaseVersion\": \"17\",\n \"familyVersion\": \"17\",\n \"securityStatus\": \"UPDATE_REQUIRED\",\n \"releaseType\": \"FEATURE\",\n \"licenseType\": \"NFTC\",\n \"releaseDate\": \"2021-09-14T00:00:00.000Z\",\n \"releaseNotesUrl\": \"https://www.oracle.com/java/technologies/javase/17-relnote-issues.html\",\n \"daysUnderSecurityBaseline\": 255\n \"mosPatches\": []\n \"licenseDetails\": {\n \"displayName\": \"Oracle No-Fee Terms and Conditions\",\n \"licenseType\": \"NFTC\",\n \"licenseUrl\": \"https://www.oracle.com/downloads/licenses/no-fee-license.html\"\n },\n \"familyDetails\": {\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2029-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\"\n }\n }\n ]\n}\n"
RequestJfrRecordingsDetails:
description: 'Details of the request to start JFR recordings.
When the targets aren''t specified, then all managed instances currently in the Fleet are selected.
'
properties:
jfcProfileName:
description: 'The profile used for JFR events selection. If the name isn''t recognized, the settings from jfcV1 or jfcV2
will be used depending on the JVM version.
Both jfcV2 and jfcV1 should be provided to ensure JFR collection on different JVM versions.
'
maxLength: 128
type: string
jfcV1:
description: The BASE64 encoded string of JFR settings XML with schema used by JDK 8.
maxLength: 65535
type: string
jfcV2:
description: 'The BASE64 encoded string of JFR settings XML with [schema used by JDK 9 and after](https://raw.githubusercontent.com/openjdk/jdk/master/src/jdk.jfr/share/classes/jdk/jfr/internal/jfc/jfc.xsd).
'
maxLength: 65535
type: string
recordingDurationInMinutes:
default: 180
description: Duration of the JFR recording in minutes.
maximum: 1440
minimum: 1
type: integer
recordingSizeInMb:
default: 4096
description: The maximum size limit for the JFR file collected.
maximum: 4096
minimum: 1
type: integer
targets:
description: The attachment targets to start JFR.
items:
$ref: '#/components/schemas/JfrAttachmentTarget'
maxItems: 32768
type: array
waitingPeriodInMinutes:
description: 'Period to looking for JVMs. In addition to attach to running JVMs when given the command,
JVM started within the waiting period will also be attached for JFR. The value should be
larger than the agent polling interval setting for the fleet to ensure agent can get the
instructions. If not specified, the agent polling interval for the fleet is used.
'
format: int32
maximum: 1440
minimum: 10
type: integer
required:
- jfcProfileName
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n }, {\n managedInstanceId: \"<managed_instance_OCID>\",\n applicationKey: \"<unique_application_key>\"\n }],\n jfcProfileName: \"default.jfc\",\n recordingDurationInMinutes: 180,\n recordingSizeInMb: 2048\n}\n"
WorkItemSummary:
description: Work item to complete a work request.
properties:
details:
$ref: '#/components/schemas/WorkItemDetails'
id:
description: The unique ID of ths work item.
type: string
installationSite:
$ref: '#/components/schemas/InstallationSite'
retryCount:
description: Number of times this work item is retried.
type: integer
status:
description: The status of the work item.
enum:
- ACCEPTED
- IN_PROGRESS
- CANCELING
- CANCELED
- SUCCEEDED
- NEEDS_ATTENTION
- RETRYING
- SKIPPED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkItemStatus'
timeLastUpdated:
description: 'The date and time the work item was last updated. (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
workRequestId:
description: The OCID of the work request created this work item.
type: string
required:
- id
- workRequestId
- installationSite
- status
- retryCount
- details
type: object
ExportStatus:
description: Attributes of fleet's export status.
properties:
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
maxLength: 255
minLength: 1
type: string
latestRunStatus:
description: 'The status of the latest export run.
'
enum:
- SCHEDULED
- PENDING
- IN_PROGRESS
- FAILED
- RETRYING
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/ExportRunStatus'
timeLastRun:
description: The date and time of the last export run.
format: date-time
type: string
timeNextRun:
description: The date and time of the next export run.
format: date-time
type: string
required:
- fleetId
- timeLastRun
- latestRunStatus
- timeNextRun
type: object
x-example: "{\n \"fleetId\": \"ocid1.fleet.oc1..<unique_id>\",\n \"timeLastRun\": \"2023-05-28T01:00:00.000Z\"\n \"timeNextRun\": \"2023-05-29T01:00:00.000Z\"\n \"latestRunStatus\": \"SUCCEEDED\"\n}\n"
FleetAgentConfiguration:
description: 'Management Agent Configuration for a Fleet. Includes JRE scanning frequency and a list of include/exclude file system paths.
'
properties:
agentPollingIntervalInMinutes:
default: 10
description: 'Agent polling interval in minutes
'
maximum: 720
minimum: 10
type: integer
isCapturingIpAddressAndFqdnEnabled:
default: false
description: 'Collect network addresses of managed instances in the fleet.
'
type: boolean
isCollectingManagedInstanceMetricsEnabled:
default: false
description: 'Collect JMS agent metrics on all managed instances in the fleet.
'
type: boolean
isCollectingUsernamesEnabled:
default: true
description: 'Collect username for application invocations for all managed instances in the fleet.
'
type: boolean
isLibrariesScanEnabled:
default: true
description: 'Enable libraries scan on all managed instances in the fleet.
'
type: boolean
javaUsageTrackerProcessingFrequencyInMinutes:
description: 'The frequency (in minutes) of Java Usage Tracker processing. (That is, how often should JMS process data from the Java Usage Tracker.)
'
maximum: 90
minimum: 5
type: integer
jreScanFrequencyInMinutes:
description: 'The frequency (in minutes) of JRE scanning. (That is, how often should JMS scan for JRE installations.)
'
maximum: 40320
minimum: 180
type: integer
linuxConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
macOsConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
timeLastModified:
description: 'The date and time of the last modification to the Fleet Agent Configuration (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
windowsConfiguration:
$ref: '#/components/schemas/FleetAgentOsConfiguration'
workRequestValidityPeriodInDays:
default: 14
description: 'The validity period in days for work requests.
'
maximum: 30
minimum: 7
type: integer
required:
- jreScanFrequencyInMinutes
- javaUsageTrackerProcessingFrequencyInMinutes
- linuxConfiguration
- windowsConfiguration
- macOsConfiguration
- timeLastModified
x-example: "{\n \"jreScanFrequencyInMinutes\": 180,\n \"javaUsageTrackerProcessingFrequencyInMinutes\": 5,\n \"workRequestValidityPeriodInDays\": 7,\n \"agentPollingIntervalInMinutes\": 60,\n isCapturingIpAddressAndFqdnEnabled: true,\n \"linuxConfiguration\": {\n \"includePaths\": [\"/var/www/opc\", \"/home/opc\"],\n \"excludePaths\": [\"/home/etc\"]\n },\n \"windowsConfiguration\": {\n \"includePaths\": [\"C://path\"],\n \"excludePaths\": [\"E://path\"]\n },\n \"macOsConfiguration\": {\n \"includePaths\": [\"/Library/Java\"],\n \"excludePaths\": [\"/home\"]\n },\n \"timeLastModified\": \"2021-03-26T10:00:05.123Z\"\n}\n"
JavaMigrationAnalysisResultSummary:
description: Summary of a Java migration analysis result. The output of the analysis is stored in the Object Storage object.
properties:
applicationExecutionType:
description: Execution type of the application for an application type, such as WAR and EAR, that is deployed or installed.
enum:
- INSTALLED
- DEPLOYED
type: string
x-obmcs-top-level-enum: '#/definitions/ApplicationExecutionType'
applicationKey:
description: The unique key that identifies the application.
maxLength: 255
minLength: 1
type: string
applicationName:
description: The name of the application for which the Java migration analysis was performed.
maxLength: 255
minLength: 1
type: string
applicationPath:
description: The installation path of the application for which the Java migration analysis was performed.
maxLength: 8196
minLength: 1
type: string
bucketName:
description: The name of the object storage bucket that contains the results of the migration analysis.
type: string
fleetId:
description: The fleet OCID.
maxLength: 255
minLength: 1
type: string
hostName:
description: The hostname of the managed instance that hosts the application for which the Java migration analysis was performed.
maxLength: 255
minLength: 1
type: string
id:
description: The OCID of the migration analysis report.
maxLength: 255
minLength: 1
type: string
managedInstanceId:
description: The managed instance OCID.
maxLength: 255
minLength: 1
type: string
metadata:
description: Additional info reserved for future use.
type: string
namespace:
description: The object storage namespace that contains the results of the migration analysis.
type: string
objectList:
description: The names of the object storage objects that contain the results of the migration analysis.
items:
type: string
maxItems: 32768
type: array
objectStorageUploadDirPath:
description: The directory path of the object storage bucket that contains the results of the migration analysis.
type: string
sourceJdkVersion:
description: The source JDK version of the application that's currently running.
maxLength: 255
minLength: 1
type: string
targetJdkVersion:
description: The target JDK version of the application to be migrated.
maxLength: 255
minLength: 1
type: string
timeCreated:
description: The time the result is compiled.
format: date-time
type: string
workRequestId:
description: The OCID of the work request of this analysis.
maxLength: 255
minLength: 1
type: string
required:
- id
- fleetId
- applicationName
- applicationPath
- applicationExecutionType
- sourceJdkVersion
- targetJdkVersion
- namespace
- bucketName
- objectStorageUploadDirPath
- objectList
- metadata
x-example: "{\n id: \"<analysis_result_OCID>\",\n workRequestId: \"<work_request_OCID>\",\n fleetId: \"<fleet_OCID>\",\n applicationKey: \"<application_key>\",\n applicationName: \"<application_name>\",\n applicationPath: \"<application_path>\",\n applicationExecutionType: \"<application_execution_type>\",\n sourceJdkVersion: \"11\",\n targetJdkVersion: \"17\",\n namespace: \"<namespace>\",\n bucketName: \"<bucketName>\",\n objectStorageUploadDirPath: \"<objectStorageUploadDirPath>\",\n objectList: [\n \"diagnostic-by-class.json\",\n \"diagnostic-by-api.json\"\n ]\n}\n"
LibraryApplicationUsageCollection:
description: 'Contains a list of LibraryApplicationUsageSummaries.
'
properties:
items:
description: 'A list of LibraryApplicationUsageSummaries.
'
items:
$ref: '#/components/schemas/LibraryApplicationUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name 1\",\n \"managedInstanceCount\":2,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-20T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-24T02:18:00.000Z\",\n },\n {\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name 2\",\n \"managedInstanceCount\":3,\n \"lastDetectedDynamically\":\"2022-02-22T00:00:00.000Z\",\n \"firstSeenInClasspath\":\"2022-02-21T23:59:00.000Z\",\n \"lastSeenInClasspath\":\"2022-01-25T02:18:00.000Z\",\n }\n ]\n}\n"
InstallationUsageCollection:
description: Results of an installation search. Contains InstallationUsage items.
properties:
items:
description: A list of installations.
items:
$ref: '#/components/schemas/InstallationUsage'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"jreVendor\":\"Oracle Corporation\",\n \"jreDistribution\":\"Java(TM) SE Runtime Environment\",\n \"jreVersion\":\"1.8.0_281\",\n \"securityStatus\":\"UP_TO_DATE\",\n \"path\":\"/usr/java/jdk1.8.0_281-amd64/jre\",\n \"os\":\"Linux 5.4.17-2036.102.0.2.el7uek.x86_64\",\n \"architecture\":\"amd64\",\n \"timeStart\":\"2021-01-19T17:37:55.000Z\",\n \"timeEnd\":\"2021-01-26T17:37:55.000Z\",\n \"timeFirstSeen\":\"2021-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T22:57:00.000Z\"\n }\n ]\n}\n"
UncorrelatedPackageApplicationUsageCollection:
description: Collection of UncorrelatedPackageApplicationUsageSummaries.
properties:
items:
description: A list of UncorrelatedPackageApplicationUsageSummaries.
items:
$ref: '#/components/schemas/UncorrelatedPackageApplicationUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name 1\",\n \"managedInstanceCount\":2,\n \"lastDetectedDynamically\":\"2022-02-23T00:00:00.000Z\",\n },\n {\n \"applicationKey\":\"<unique_Java_application_key>\",\n \"applicationName\":\"Example Java application name 2\",\n \"managedInstanceCount\":3,\n \"lastDetectedDynamically\":\"2022-02-22T00:00:00.000Z\",\n }\n ]\n}\n"
FleetErrorAggregationCollection:
description: Collection of FleetErrorAggregationSummary.
properties:
items:
description: A list of FleetErrorAggregationSummary.
items:
$ref: '#/components/schemas/FleetErrorAggregationSummary'
type: array
required:
- items
type: object
CreateJmsPluginDetails:
description: The details for creating a JmsPlugin.
properties:
agentId:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the Management Agent (OMA), the Oracle Cloud Agent (OCA), \nor the Oracle Container Management Agent (OCMA) instance where the JMS plugin is deployed.\n"
maxLength: 255
minLength: 1
type: string
agentType:
description: The agent type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
compartmentId:
description: The OMA/OCA/OCMA agent's compartment [OCID](/Content/General/Concepts/identifiers.htm).
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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
required:
- agentId
- compartmentId
type: object
DeployedApplicationInstallationUsageSummaryCollection:
description: 'Results of a deployed application installation usage search. Contains deployed application installation usage items.
'
properties:
items:
description: 'A list of deployed application installation usages.
'
items:
$ref: '#/components/schemas/DeployedApplicationInstallationUsageSummary'
type: array
required:
- items
type: object
x-example: "{\n \"items\":[\n {\n \"applicationInstallationKey\":\"<unique_id>\",\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name 1\",\n \"applicationType\":\"EAR\",\n \"applicationSourcePath\": \"/full/path/to/application.ear\"\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 2,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n },\n {\n \"applicationInstallationKey\":\"<unique_id>\",\n \"applicationKey\":\"<unique_id>\",\n \"fleetId\":\"ocid1.jmsfleet.oc1.iad.<unique_id>\",\n \"applicationName\":\"Example deployed application name 2\",\n \"applicationType\":\"WAR\",\n \"applicationSourcePath\": \"/full/path/to/application.war\"\n \"isClustered\": true,\n \"approximateJavaServerInstanceCount\": 4,\n \"approximateLibraryCount\": 10,\n \"timeStart\":\"2022-02-21T00:00:00.000Z\",\n \"timeEnd\":\"2022-02-22T23:59:00.000Z\",\n \"timeFirstSeen\":\"2022-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2022-01-27T10:00:00.000Z\"\n }\n ]\n}\n"
InstallationUsage:
description: 'Installation usage during a specified time period.
An installation is a collection of deployed instances of a specific Java Runtime that share the same install path.
'
properties:
approximateApplicationCount:
description: The approximate count of applications running on this installation
type: integer
approximateManagedInstanceCount:
description: The approximate count of managed instances reporting this installation
type: integer
architecture:
description: The architecture of the operating system for the installation. Deprecated, use `operatingSystem` instead.
type: string
installationKey:
description: The unique identifier for the installation of a Java Runtime at a specific path on a specific operating system.
maxLength: 255
type: string
jreDistribution:
description: The distribution of the Java Runtime that is deployed with the installation.
type: string
jreVendor:
description: The vendor of the Java Runtime that is deployed with the installation.
type: string
jreVersion:
description: The version of the Java Runtime that is deployed with the installation.
type: string
operatingSystem:
$ref: '#/components/schemas/OperatingSystem'
os:
description: The Operating System for the installation. Deprecated, use `operatingSystem` instead.
type: string
path:
description: The file system path of the Java installation.
type: string
securityStatus:
description: The security status of the Java Runtime.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
required:
- architecture
- jreDistribution
- jreVendor
- jreVersion
- os
- path
type: object
x-example: "{\n \"installationKey\":\"<nique_installation_id>\",\n \"jreVendor\":\"Oracle Corporation\",\n \"jreDistribution\":\"Java(TM) SE Runtime Environment\",\n \"jreVersion\":\"1.8.0_281\",\n \"securityStatus\":\"UP_TO_DATE\",\n \"path\":\"/usr/java/jdk1.8.0_281-amd64/jre\",\n \"os\":\"Linux 5.4.17-2036.102.0.2.el7uek.x86_64\",\n \"architecture\":\"amd64\",\n \"operatingSystem\": {\n \"family\": \"Linux\",\n \"name\": \"Linux\",\n \"architecture\": \"amd64\",\n \"version\": \"5.4.17-2036.102.0.2.el7uek.x86_64\"\n },\n \"timeStart\":\"2021-01-19T17:37:55.000Z\",\n \"timeEnd\":\"2021-01-26T17:37:55.000Z\",\n \"timeFirstSeen\":\"2021-01-25T16:57:00.000Z\",\n \"timeLastSeen\":\"2021-01-25T22:57:00.000Z\"\n}\n"
GenerateAgentDeployScriptDetails:
description: Attributes to generate agent deploy script for a Fleet.
properties:
installKeyId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the install key for which to generate the script.
maxLength: 255
type: string
isUserNameEnabled:
description: Enable/disable user name collection on agent.
type: boolean
osFamily:
description: The operating system type for the script. Currently only 'LINUX' and 'WINDOWS' are supported.
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
required:
- installKeyId
- osFamily
- isUserNameEnabled
type: object
x-example: "{\n \"installKeyId\":\"ocid1.managementagentinstallkey.oc1.iad.<unique_id>\",\n \"osFamily\":\"LINUX\",\n \"isUserNameEnabled\":true\n}\n"
JavaMigrationAnalysisResultCollection:
description: List of Java migration analysis results.
properties:
items:
description: A list of Java migration analysis results.
items:
$ref: '#/components/schemas/JavaMigrationAnalysisResultSummary'
type: array
required:
- items
type: object
NewInstallationSite:
description: The properties of a new Java installation site.
properties:
artifactContentType:
description: Artifact content type for the Java version.
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
forceInstall:
default: false
description: Forces the installation request even if a more recent release is already present in the host.
type: boolean
headlessMode:
default: false
description: Flag to install headless or headful Java installation. Only valid for Oracle Linux in OCI.
type: boolean
installationPath:
description: Custom path to install new Java installation site.
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
releaseVersion:
description: The release version of the Java Runtime.
type: string
required:
- managedInstanceId
- releaseVersion
type: object
ChangeFleetCompartmentDetails:
description: Attributes to change the compartment of a Fleet.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the Fleet should be moved.
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
PluginErrorAggregationCollection:
description: Collection of PluginErrorAggregation.
properties:
items:
description: A list of PluginErrorAggregationSummary.
items:
$ref: '#/components/schemas/PluginErrorAggregationSummary'
type: array
required:
- items
type: object
RequestDeployedApplicationMigrationAnalysesDetails:
description: 'Details of the request to start a Java migration analyses. The analyses requires the managed instance OCID, deployed application key,
source JDK version, and target JDK version of each selected application.
'
properties:
targets:
description: An array of migration analyses requests.
items:
$ref: '#/components/schemas/DeployedApplicationMigrationAnalysesTarget'
maxItems: 1024
type: array
required:
- targets
x-example: "{\n targets: [{\n managedInstanceId: \"<managed_instance_OCID>\"\n deployedApplicationInstallationKey: \"<unique_deployed_application_installation_key>\"\n sourceJdkVersion: \"<source_jdk_version>\"\n targetJdkVersion: \"<target_jdk_version>\"\n excludePackagePrefixes: [\n \"lombok\",\n \"com.google\",\n \"org.apache.maven\"\n ]\n includePackagePrefixes: [\n \"jms\"\n ]\n }]\n}\n"
WorkRequestErrorCollection:
description: Results of a work request error search. Contains WorkRequestError items
properties:
items:
description: A list of work request errors.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
Agent:
description: 'Information about the agent.
'
properties:
displayName:
description: The name of the agent.
maximum: 255
minimum: 1
type: string
javaSecurityStatus:
description: The security status of the Java Runtime.
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
type: string
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
javaVersion:
description: The java version.
maximum: 90
minimum: 1
type: string
plugins:
description: 'A list of plugins installed on this agent.
'
items:
$ref: '#/components/schemas/Plugin'
type: array
type:
description: The agent type.
enum:
- OMA
- OCA
- OCMA
type: string
x-obmcs-top-level-enum: '#/definitions/AgentType'
required:
- displayName
- type
- javaVersion
- javaSecurityStatus
- plugins
type: object
Plugin:
description: 'Information about the plugin.
'
properties:
name:
description: The name of the plugin.
maximum: 255
minimum: 1
type: string
version:
description: The version of the plugin.
maximum: 90
minimum: 1
type: string
required:
- name
- version
type: object
DrsTarget:
description: 'The target to manage DRS distribution. A target is a managed instance.
'
properties:
managedInstanceId:
description: OCID of the managed instance to manage DRS distribution.
maxLength: 255
minLength: 1
type: string
required:
- managedInstanceId
JavaFamilyCollection:
description: 'Collection of the Java release family summary.
A Java release family is typically a major version in the Java version identifier.
'
properties:
items:
description: A list of the Java Release family summary.
items:
$ref: '#/components/schemas/JavaFamilySummary'
maxItems: 20
minItems: 1
type: array
required:
- items
type: object
x-example: "{\n items: [\n {\n \"licenseTypes\": [\"NFTC\", \"OTN\"],\n \"familyVersion\": \"17\",\n \"displayName\": \"JDK 17\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2030-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/en/java/javase/17\",\n \"latestReleaseVersion\": \"17.0.6\",\n \"isSupportedVersion\": true\n },\n {\n \"licenseTypes\": [\"OTN\"],\n \"familyVersion\": \"8\",\n \"displayName\": \"JDK 8\",\n \"supportType\": \"LTS\",\n \"endOfSupportLifeDate\": \"2030-12-31T23:59:00.000Z\",\n \"docUrl\": \"https://docs.oracle.com/javase/8\",\n \"latestReleaseVersion\": \"1.8.0_371\",\n \"isSupportedVersion\": true\n }\n ]\n}\n"
WorkItemDetails:
description: The minimum details of a work item.
discriminator:
propertyName: kind
properties:
kind:
description: The kind of work item details.
enum:
- BASIC
- APPLICATION
- LCM
- DEPLOYED_APPLICATION
type: string
workItemType:
description: The work item type.
enum:
- LCM
- JFR_CAPTURE
- JFR_UPLOAD
- CRYPTO_ANALYSIS
- CRYPTO_ANALYSIS_MERGE
- ADVANCED_USAGE_TRACKING
- ADV_USAGE_SERVER_METADATA
- ADV_USAGE_SERVER_LIBRARIES
- ADV_USAGE_JAVA_LIBRARIES
- ADV_USAGE_JAVA_LIBRARIES_DYNAMIC
- PERFORMANCE_TUNING
- JMIGRATE_ANALYSIS
- JMIGRATE_CREATE_REPORT
- DRS
type: string
x-obmcs-top-level-enum: '#/definitions/WorkItemType'
required:
- kind
type: object
JavaArtifact:
description: Information about a binary artifact of Java.
properties:
approximateFileSizeInBytes:
description: Approximate compressed file size in bytes.
format: int64
type: integer
architecture:
description: The target Operating System architecture for the artifact.
type: string
artifactContentType:
description: Product content type of this artifact.
enum:
- JDK
- JRE
- SERVER_JRE
type: string
x-obmcs-top-level-enum: '#/definitions/ArtifactContentType'
artifactDescription:
description: Description of the binary artifact. Typically includes the OS, architecture, and installer type.
type: string
artifactFileName:
description: The file name of the artifact.
type: string
artifactId:
description: Unique identifier for the artifact.
format: int64
type: integer
downloadUrl:
description: 'The endpoint that returns a short-lived artifact download URL in the response payload.
This download url can then be used for downloading the artifact.
See this [API](https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/DownloadUrl/GenerateArtifactDownloadUrl) for more details.
'
type: string
osFamily:
description: The target Operating System family for the artifact.
type: string
packageType:
description: The package type(typically the file extension) of the artifact.
type: string
packageTypeDetail:
description: Additional information about the package type.
type: string
scriptChecksumUrl:
description: 'The URL for retrieving the checksum for the artifact.
Depending on the context, this can point to the checksum of the archive or latest update release version artifact.
'
type: string
scriptDownloadUrl:
description: 'The endpoint for downloading this artifact from command line, automatically in scripts and dockerfiles.
Depending on the context, this can point to the archive or latest update release version artifact in the specified family.
'
type: string
sha256:
description: SHA256 checksum of the artifact.
format: hash
type: string
required:
- artifactId
- artifactDescription
- artifactContentType
- approximateFileSizeInBytes
- sha256
- osFamily
- architecture
- packageType
- downloadUrl
- scriptDownloadUrl
- scriptChecksumUrl
type: object
x-example: "{\n \"artifactId\": 1001,\n \"artifactDescription\": \"macOS x64 DMG Installer\",\n \"approximateFileSizeInBytes\": 15444,\n \"sha256\": \"db82736369765fd1ba92361ca3d7b30d683f078be44f35b879456b014d599271\",\n \"artifactContentType\": \"JDK\",\n \"artifactFileName\": \"jdk-11.0.15_osx-x64_bin.dmg\",\n \"osFamily\": \"macos\",\n \"architecture\": \"x64\",\n \"packageType\": \"dmg\",\n \"packageTypeDetail\": \"DMG Installer\",\n \"downloadUrl\": \"https://javamanagementservice-download.us-ashburn-1.oci.oraclecloud.com/20230601/actions/generateArtifactDownloadUrl\",\n \"scriptDownloadUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.15_osx-x64_bin.dmg\",\n \"scriptChecksumUrl\": \"https://java.oraclecloud.com/java/11/archive/jdk-11.0.15_osx-x64_bin.dmg.sha256\"\n}\n"
ResourceInventory:
description: Inventory of JMS resources in a compartment during a specified time period.
properties:
activeFleetCount:
description: The number of _active_ fleets.
format: int32
type: integer
applicationCount:
description: The number of applications.
format: int32
type: integer
installationCount:
description: The number of Java installations.
format: int32
type: integer
jreCount:
description: The number of Java Runtimes.
format: int32
type: integer
managedInstanceCount:
description: The number of managed instances.
format: int32
type: integer
required:
- activeFleetCount
- managedInstanceCount
- jreCount
- installationCount
- applicationCount
type: object
AdvancedUsageTracking:
description: AdvancedUsageTracking configuration
properties:
isEnabled:
default: false
description: AdvancedUsageTracking flag to store enabled or disabled status.
type: boolean
type: object
OperatingSystem:
description: 'Operating System of the platform on which the Java Runtime was reported.
'
properties:
architecture:
description: The architecture of the operating system as provided by the Java system property os.arch.
maximum: 255
minimum: 1
type: string
containerCount:
description: Number of containers running the operating system.
type: integer
distribution:
description: The name of the Operating System distribution, such as Oracle Linux 9, Windows 10, or macOS X.
maximum: 255
minimum: 1
type: string
family:
description: The operating system type, such as Windows, Linux or macOS
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
managedInstanceCount:
description: Number of instances running the operating system.
type: integer
name:
description: The name of the operating system as provided by the Java system property os.name.
maximum: 255
minimum: 1
type: string
version:
description: The version of the operating system as provided by the Java system property os.version.
maximum: 255
minimum: 1
type: string
required:
- family
- name
- version
- architecture
type: object
CreateTaskScheduleDetails:
description: Attributes to create a task schedule.
properties:
executionRecurrences:
description: 'Recurrence specification for the task schedule execution (formatted according to [RFC-5545](https://icalendar.org/RFC-Specifications/iCalendar-RFC-5545/)). To run daily for 10 occurrences starts on September 2, 2024 09:00 UTC, it should be ''DTSTART=20240902T090000Z;
RRULE:FREQ=DAILY;COUNT=10''. To run every 3 hours from 9:00 AM to 5:00 PM on August 5, 2024 UTC, it should be ''DTSTART=20240805T090000Z;RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=20240805T170000Z''.
'
format: x-obmcs-recurring-time
type: string
fleetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
maxLength: 255
minLength: 1
type: string
taskDetails:
$ref: '#/components/schemas/TaskDetails'
required:
- fleetId
- taskDetails
- executionRecurrences
type: object
ScanLibraryUsageDetails:
description: 'The list of managed instances to scan.
'
properties:
dynamicScanDurationInMinutes:
default: 10
description: 'The duration of the dynamic scan in minutes.
'
maximum: 1440
minimum: 10
type: integer
isDynamicScan:
default: false
description: 'Indicates whether the scan is dynamic or static.
'
type: boolean
managedInstanceIds:
description: 'The list of [OCIDs](/Content/General/Concepts/identifiers.htm) of managed instances to scan.
'
items:
type: string
maxItems: 32768
type: array
type: object
x-example: "{\n \"managedInstanceIds\": [\n \"<managed_instance_OCID_1>\",\n \"<managed_instance_OCID_2>\",\n \"<managed_instance_OCID_3>\",\n \"<managed_instance_OCID_4>\",\n \"<managed_instance_OCID_5>\"\n ],\n \"isDynamicScan\": true,\n \"dynamicScanDurationInMinutes\": 10\n}\n"
Proxies:
description: 'List of proxy properties to be configured in net.properties file.
'
properties:
ftpProxyHost:
description: 'Ftp host to be set in net.properties file.
'
type: string
ftpProxyPort:
default: 21
description: 'Ftp port number to be set in net.properties file.
'
maximum: 65535
minimum: 1
type: integer
httpProxyHost:
description: 'Http host to be set in net.properties file.
'
type: string
httpProxyPort:
default: 80
description: 'Http port number to be set in net.properties file.
'
maximum: 65535
minimum: 1
type: integer
httpsProxyHost:
description: 'Https host to be set in net.properties file.
'
type: string
httpsProxyPort:
default: 443
description: 'Https port number to be set in net.properties file.
'
maximum: 65535
minimum: 1
type: integer
socksProxyHost:
description: 'Socks host to be set in net.properties file.
'
type: string
socksProxyPort:
default: 1080
description: 'Socks port number to be set in net.properties file.
'
maximum: 65535
minimum: 1
type: integer
useSystemProxies:
default: false
description: 'Sets "java.net.useSystemProxies=true" in net.properties when they exist.
'
type: boolean
type: object
parameters:
FleetErrorSortByQueryParam:
description: 'The field to sort FleetError. Only one sort order may be provided.
Default order is **descending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/FleetErrorSortBy'
schema:
type: string
enum:
- TIME_FIRST_SEEN
- TIME_LAST_SEEN
default: TIME_LAST_SEEN
JmsPluginLifecycleStateQueryParam:
description: Filter JmsPlugin with its lifecycle state.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/JmsPluginLifecycleState'
schema:
type: string
enum:
- ACTIVE
- INACTIVE
- NEEDS_ATTENTION
- DELETED
SummarizeApplicationUsageFieldsQueryParam:
description: 'Additional fields to include into the returned model on top of the required ones.
This parameter can also include ''approximateJreCount'', ''approximateInstallationCount'' and ''approximateManagedInstanceCount''.
For example ''approximateJreCount,approximateInstallationCount''.
'
in: query
name: fields
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- approximateJreCount
- approximateInstallationCount
- approximateManagedInstanceCount
type: string
x-obmcs-top-level-enum: '#/definitions/SummarizeApplicationUsageFields'
default: []
OsFamilyQueryParam:
description: The operating system type.
in: query
name: osFamily
required: false
x-default-description: By default the osFamily filter need not be provided. If it is not provided, results are irrespective of operating system type.
style: form
explode: true
schema:
type: array
items:
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/OsFamily'
maxItems: 10
TaskScheduleNameQueryParam:
description: The task name.
in: query
name: name
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
PackageIdentifierPathParam:
description: The unique identifier of a Java package.
in: path
name: packageName
required: true
schema:
type: string
maxLength: 255
minLength: 1
ApplicationNameQueryParam:
description: The name of the application.
in: query
name: applicationName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 1024
minLength: 1
LibrarySortByQueryParam:
description: 'The field to sort libraries. Only one sort order may be provided.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/LibrarySortBy'
schema:
type: string
enum:
- applicationCount
- javaServerInstanceCount
- cvssScore
- deployedApplicationCount
- libraryName
- libraryVersion
- managedInstanceCount
- timeFirstSeen
- timeLastSeen
- highestVulnerabilityScore
- confidenceLevel
default: timeLastSeen
JavaReleaseSortByQueryParam:
description: 'If no value is specified _releaseDate_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaReleaseSortBy'
schema:
type: string
enum:
- releaseDate
- releaseVersion
- familyVersion
- licenseType
default: releaseDate
ApplicationIdentifierQueryParam:
description: The Fleet-unique identifier of the application.
in: query
name: applicationId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
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
TimeErrorFirstSeenLessThanOrEqualToQueryParam:
description: If specified, only errors with a first seen time earlier than this parameter will be included in the search (formatted according to RFC3339).
in: query
name: timeFirstSeenLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
JmsPluginAgentTypeQueryParam:
description: Filter JmsPlugin with agent type.
in: query
name: agentType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/AgentType'
schema:
type: string
enum:
- OMA
- OCA
- OCMA
ManagedInstanceSortByQueryParam:
description: 'The field to sort managed instance views. Only one sort order may be provided.
Default order for _timeFirstSeen_, _timeLastSeen_, approximateJreCount_, _approximateInstallationCount_
and _approximateApplicationCount_ is **descending**.
Default order for _osName_ is **ascending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/ManagedInstanceSortBy'
schema:
type: string
enum:
- timeFirstSeen
- timeLastSeen
- approximateJreCount
- approximateInstallationCount
- approximateApplicationCount
- osName
default: timeLastSeen
UncorrelatedPackageApplicationSortByQueryParam:
description: 'The field to sort detection events. Only one sort order may be provided.
If no value is specified _dynamicallyLastDetected_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/UncorrelatedPackageApplicationSortBy'
schema:
type: string
enum:
- applicationName
- managedInstanceCount
- lastDetectedDynamically
default: dynamicallyLastDetected
FleetFilterQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
in: query
name: fleetId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JavaServerInstanceNameQueryParam:
description: 'The Java Server instance name.
'
in: query
name: serverInstanceName
x-default-description: 'null'
schema:
type: string
maxLength: 256
minLength: 1
AgentInstallerPlatformArchitectureQueryParam:
description: The platform architecture for the agent installer.
in: query
name: platformArchitecture
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/PlatformArchitectureType'
schema:
type: string
enum:
- X86_64
- X86
- AARCH64
ManagedInstanceTypeQueryParam:
description: The type of the managed instance.
in: query
name: managedInstanceType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ManagedInstanceType'
schema:
type: string
enum:
- ORACLE_MANAGEMENT_AGENT
- ORACLE_CLOUD_AGENT
- ORACLE_CONTAINER_MANAGEMENT_AGENT
ApplicationInstallationSortByQueryParam:
description: 'The field to sort application installation views. Only one sort order may be provided.
Default order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_
and _approximateManagedInstanceCount_ is **descending**.
Default order for _displayName_, _installationPath_ and _osName_ is **ascending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/ApplicationInstallationSortBy'
schema:
type: string
enum:
- timeFirstSeen
- timeLastSeen
- displayName
- installationPath
- osName
- approximateJreCount
- approximateInstallationCount
- approximateManagedInstanceCount
- approximateLibraryCount
default: timeLastSeen
CryptoAnalysisResultSortByQueryParam:
description: 'The field to sort crypto event analysis results. Only one sort order can be provided.
Default order for _timeCreated_, and _jreVersion_ is **descending**.
Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.
If no value is specified _timeCreated_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/CryptoAnalysisResultSortBy'
schema:
type: string
enum:
- timeCreated
- managedInstanceId
- workRequestId
default: timeCreated
SummarizeJreUsageFieldsQueryParam:
description: 'Additional fields to include into the returned model on top of the required ones.
This parameter can also include ''approximateApplicationCount'', ''approximateInstallationCount'' and ''approximateManagedInstanceCount''.
For example ''approximateApplicationCount,approximateManagedInstanceCount''.
'
in: query
name: fields
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- approximateInstallationCount
- approximateApplicationCount
- approximateManagedInstanceCount
type: string
x-obmcs-top-level-enum: '#/definitions/SummarizeJreUsageFields'
default: []
OperationStatusQueryParam:
description: The status of the work request.
in: query
name: status
style: form
explode: true
schema:
type: array
items:
enum:
- ACCEPTED
- CANCELED
- CANCELING
- FAILED
- IN_PROGRESS
- SUCCEEDED
type: string
x-obmcs-top-level-enum: '#/definitions/OperationStatus'
default: []
FleetIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet.
in: path
name: fleetId
required: true
schema:
type: string
maxLength: 255
minLength: 1
NonCompliantFindingCountGreaterThanQueryParam:
description: Non Compliant Finding Count of CryptoAnalysis Report.
in: query
name: nonCompliantFindingCountGreaterThan
required: false
x-default-description: 'null'
schema:
type: integer
TaskScheduleSortByQueryParam:
description: "The field used to sort task schedule records. Only one sort order may be provided.\nDefault order for _timeCreated_ is **ascending**.\nIf no value is specified, _timeCreated_ is default. \n"
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/TaskScheduleSortBy'
schema:
type: string
enum:
- name
- lifecycleState
- timeCreated
- timeNextRun
- timeLastRun
default: timeCreated
DeployedAppInstallationIdentifierQueryParam:
description: 'The deployed application installation key.
'
in: query
name: applicationInstallationKey
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
DeployedApplicationNameContainsQueryParam:
description: 'Filter the list with deployed application name contains the given value.
'
in: query
name: applicationNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
JavaFamilyVersionQueryParam:
description: The version identifier for the Java family.
in: query
name: familyVersion
required: false
x-default-description: 'null'
schema:
type: string
LifecycleStateQueryParam:
description: The state of the lifecycle.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LifecycleState'
schema:
type: string
enum:
- ACTIVE
- CREATING
- DELETED
- DELETING
- FAILED
- NEEDS_ATTENTION
- UPDATING
AnnouncementSortByQueryParam:
description: 'The field to sort AnnouncementSummary by. Only one sort order may be provided.
If no value is specified _timeReleased_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/AnnouncementSortBy'
schema:
type: string
enum:
- timeReleased
- summary
default: timeReleased
AgentIdentifierQueryParam:
description: "The ManagementAgent (OMA), Oracle Cloud Agent (OCA), or the Oracle Container Management Agent (OCMA) [OCID](/Content/General/Concepts/identifiers.htm) \nthat identifies the Agent.\n"
in: query
name: agentId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ApplicationSortByQueryParam:
description: 'The field to sort application views. Only one sort order may be provided.
Default order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_
and _approximateManagedInstanceCount_ is **descending**.
Default order for _displayName_ and _osName_ is **ascending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/ApplicationSortBy'
schema:
type: string
enum:
- timeFirstSeen
- timeLastSeen
- displayName
- approximateJreCount
- approximateInstallationCount
- approximateManagedInstanceCount
- approximateLibraryCount
- osName
default: timeLastSeen
DeployedApplicationSourcePathContainsQueryParam:
description: Filter the list with application source path contains the given value.
in: query
name: applicationSourcePathContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
DrsFileSortByQueryParam:
description: 'The field that sorts the DRS details results. Only one sort order can be provided.
The default order for _drsFileKey_ is **descending**.
If no value is specified, then _drsFileKey_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/DrsFileSortBy'
schema:
type: string
enum:
- bucketName
- namespace
- drsFileKey
- drsFileName
- checksumType
- isDefault
default: drsFileKey
TimeLastSeenLessThanOrEqualToQueryParam:
description: If present, only plugins with a last seen time before this parameter are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeLastSeenLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
DisplayNameContainsQueryParam:
description: 'Filter the list with displayName contains the given value.
'
in: query
name: displayNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
AgentInstallerOsFamilyQueryParam:
description: The OS family for the agent installer.
in: query
name: osFamily
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OsFamily'
schema:
type: string
enum:
- LINUX
- WINDOWS
- MACOS
- UNKNOWN
NonCompliantFindingCountQueryParam:
description: Non Compliant Finding Count of CryptoAnalysis Report.
in: query
name: nonCompliantFindingCount
required: false
x-default-description: 'null'
schema:
type: integer
RelatedApplicationIdentifierQueryParam:
description: The Fleet-unique identifier of the related application.
in: query
name: applicationId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
PackageIdentifierQueryParam:
description: The unique identifier of a Java package.
in: query
name: packageName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OperationTypeQueryParam:
description: The operation type of the work request.
in: query
name: operationType
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OperationType'
schema:
type: string
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
SupportedVersionQueryParam:
description: Filter the Java Release Family versions by support status.
in: query
name: isSupportedVersion
required: false
x-default-description: If this parameter is not specified, all versions are included.
schema:
type: boolean
TimeErrorLastSeenGreaterThanOrEqualToQueryParam:
description: If specified, only errors with a last seen time later than this parameter will be included in the search (formatted according to RFC3339).
in: query
name: timeLastSeenGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
RelatedManagedInstanceIdentifierQueryParam:
description: The Fleet-unique identifier of the related managed instance.
in: query
name: managedInstanceId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
in: path
name: workRequestId
required: true
schema:
type: string
maxLength: 255
minLength: 1
TaskScheduleIdentifierQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule.
in: query
name: id
required: false
schema:
type: string
maxLength: 255
minLength: 1
ApplicationInstallationPathContainsQueryParam:
description: Filter the list with the application installation path that contains the given value.
in: query
name: appInstallationPathContains
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
ApplicationNameContainsQueryParam:
description: 'Filter the list with application name contains the given value.
'
in: query
name: applicationNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
FleetIdQueryParam:
description: The ID of the Fleet.
in: query
name: fleetId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JmsPluginSortByQueryParam:
description: 'The field to sort JmsPlugin. Only one sort order may be provided.
Default order is **descending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
required: false
x-obmcs-top-level-enum: '#/definitions/JmsPluginSortBy'
schema:
type: string
enum:
- id
- timeLastSeen
- timeRegistered
- hostname
- agentId
- agentType
- lifecycleState
- availabilityStatus
- fleetId
- compartmentId
- osFamily
- osArchitecture
- osDistribution
- pluginVersion
default: timeLastSeen
PluginErrorSortByQueryParam:
description: 'The field to sort PluginError. Only one sort order may be provided.
Default order is **descending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/PluginErrorSortBy'
schema:
type: string
enum:
- TIME_FIRST_SEEN
- TIME_LAST_SEEN
default: TIME_LAST_SEEN
JreSortByQueryParam:
description: 'The field to sort JRE usages. Only one sort order may be provided.
Default order for _timeFirstSeen_, _timeLastSeen_, and _version_ is **descending**.
Default order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_,
_approximateApplicationCount_ and _approximateManagedInstanceCount_ is **descending**.
Default order for _distribution_, _vendor_, and _osName_ is **ascending**.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JreSortBy'
schema:
type: string
enum:
- distribution
- timeFirstSeen
- timeLastSeen
- vendor
- version
- approximateInstallationCount
- approximateApplicationCount
- approximateManagedInstanceCount
- osName
- securityStatus
default: timeLastSeen
DistributionQueryParam:
description: The distribution of the Java Runtime.
in: query
name: jreDistribution
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JavaFamilySortByQueryParam:
description: 'If no value is specified _familyVersion_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaFamilySortBy'
schema:
type: string
enum:
- familyVersion
- endOfSupportLifeDate
- supportType
default: familyVersion
CvssScoreGreaterThanQueryParam:
description: Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.
in: query
name: cvssScoreGreaterThan
required: false
x-default-description: 'null'
schema:
type: number
format: float
LibraryIdentifierQueryParam:
description: 'The library key.
'
in: query
name: libraryKey
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
JavaMigrationAnalysisResultIdPathParam:
description: The OCID of the analysis result.
in: path
name: javaMigrationAnalysisResultId
required: true
schema:
type: string
maxLength: 255
minLength: 1
JavaServerNameQueryParam:
description: 'The server name.
'
in: query
name: serverName
x-default-description: 'null'
schema:
type: string
maxLength: 256
minLength: 1
TaskScheduleIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule.
in: path
name: taskScheduleId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PerformanceTuningAnalysisResultIdPathParam:
description: The OCID of the performance tuning analysis result.
in: path
name: performanceTuningAnalysisResultId
required: true
schema:
type: string
maxLength: 255
minLength: 36
DisplayNameQueryParam:
description: The display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OperationQueryParam:
description: The operation type.
in: query
name: operation
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/OperationType'
schema:
type: string
enum:
- CREATE_FLEET
- DELETE_FLEET
- MOVE_FLEET
- UPDATE_FLEET
- UPDATE_FLEET_AGENT_CONFIGURATION
- DELETE_JAVA_INSTALLATION
- CREATE_JAVA_INSTALLATION
- COLLECT_JFR
- REQUEST_CRYPTO_EVENT_ANALYSIS
- REQUEST_PERFORMANCE_TUNING_ANALYSIS
- REQUEST_JAVA_MIGRATION_ANALYSIS
- DELETE_JMS_REPORT
- SCAN_JAVA_SERVER_USAGE
- SCAN_LIBRARY_USAGE
- SCAN_LIBRARY_DYNAMIC_USAGE
- EXPORT_DATA_CSV
- CREATE_DRS_FILE
- UPDATE_DRS_FILE
- DELETE_DRS_FILE
- ENABLE_DRS
- DISABLE_DRS
JavaFamilyDisplayNameQueryParam:
description: The display name for the Java family.
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
ManagedInstanceIdentifierQueryParam:
description: The Fleet-unique identifier of the managed instance.
in: query
name: managedInstanceId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
CryptoAnalysisResultIdPathParam:
description: The OCID of the analysis result.
in: path
name: cryptoAnalysisResultId
required: true
schema:
type: string
maxLength: 255
minLength: 1
SummarizeInstallationUsageFieldsQueryParam:
description: 'Additional fields to include into the returned model on top of the required ones.
This parameter can also include ''approximateApplicationCount'' and ''approximateManagedInstanceCount''.
For example ''approximateApplicationCount,approximateManagedInstanceCount''.
'
in: query
name: fields
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- approximateApplicationCount
- approximateManagedInstanceCount
type: string
x-obmcs-top-level-enum: '#/definitions/SummarizeInstallationUsageFields'
default: []
ContainerSortByQueryParam:
description: 'The field to sort the containers. Only one sort order can be provided.
Default order for _displayName_, _namespace_, _podName_, _applicationName_, or _jreVersion_ is **ascending**.
Default order for _timeStarted_ is **descending**.
If no value is specified _timeStarted_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/ContainerSortBy'
schema:
type: string
enum:
- displayName
- namespace
- podName
- applicationName
- jreVersion
- jreSecurityStatus
- timeStarted
default: timeStarted
SummarizeManagedInstanceUsageFieldsQueryParam:
description: 'Additional fields to include into the returned model on top of the required ones.
This parameter can also include ''approximateJreCount'', ''approximateInstallationCount'' and ''approximateApplicationCount''.
For example ''approximateJreCount,approximateInstallationCount''.
'
in: query
name: fields
required: false
style: form
explode: true
schema:
type: array
items:
enum:
- approximateJreCount
- approximateInstallationCount
- approximateApplicationCount
type: string
x-obmcs-top-level-enum: '#/definitions/SummarizeManagedInstanceUsageFields'
default: []
IdQueryParam:
description: The ID.
in: query
name: id
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JavaFamilyIdentifierPathParam:
description: Unique Java family version identifier.
in: path
name: familyVersion
required: true
schema:
type: string
UncorrelatedPackageManagedInstanceSortByQueryParam:
description: 'The field to sort detection events. Only one sort order may be provided.
If no value is specified _dynamicallyLastDetected_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/UncorrelatedPackageManagedInstanceSortBy'
schema:
type: string
enum:
- hostname
- applicationCount
- lastDetectedDynamically
default: dynamicallyLastDetected
InstallationPathQueryParam:
description: The file system path of the Java Runtime installation.
in: query
name: installationPath
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
PaginationTokenQueryParam:
description: The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
in: query
name: page
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
JreDistributionQueryParam:
description: The distribution of the related Java Runtime.
in: query
name: jreDistribution
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
JavaServerInstanceIdentifierQueryParameter:
description: 'The Java Server instance key.
'
in: query
name: serverInstanceKey
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
AgentInstallerIdPathParam:
description: Unique agent installer identifier.
in: path
name: agentInstallerId
required: true
schema:
type: integer
format: int64
JavaMigrationAnalysisResultSortByQueryParam:
description: 'The field that sorts the Java migration analysis results. Only one sort order can be provided.
The default order for _timeCreated_, _managedInstanceId_ and _workRequestId_ is **descending**.
If no value is specified, then _timeCreated_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaMigrationAnalysisResultSortBy'
schema:
type: string
enum:
- timeCreated
- managedInstanceId
- workRequestId
default: timeCreated
FindingCountQueryParam:
description: FindingCount of CryptoAnalysis Report.
in: query
name: findingCount
required: false
x-default-description: 'null'
schema:
type: integer
JreVersionQueryParam:
description: The version of the related Java Runtime.
in: query
name: jreVersion
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
FleetSortByQueryParam:
description: 'The field to sort Fleets. Only one sort order may be provided.
Default order for _timeCreated_, _approximateJreCount_, _approximateInstallationCount_,
_approximateApplicationCount_ and _approximateManagedInstanceCount_ is **descending**.
Default order for _displayName_ is **ascending**.
If no value is specified _timeCreated_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/SortBy'
schema:
type: string
enum:
- displayName
- timeCreated
default: timeCreated
SecurityStatusQueryParam:
description: The security status of the Java Runtime.
in: query
name: jreSecurityStatus
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/JreSecurityStatus'
schema:
type: string
enum:
- EARLY_ACCESS
- UNKNOWN
- UP_TO_DATE
- UPDATE_REQUIRED
- UPGRADE_REQUIRED
InstallationSiteSortByQueryParam:
description: 'The field to sort installation sites. Only one sort order may be provided.
Default order for _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_ is **descending**.
Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.
If no value is specified _managedInstanceId_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/InstallationSiteSortBy'
schema:
type: string
enum:
- managedInstanceId
- jreDistribution
- jreVendor
- jreVersion
- path
- approximateApplicationCount
- osName
- securityStatus
default: managedInstanceId
DrsFileKeyPathParam:
description: The unique identifier of the DRS File in Object Storage.
in: path
name: drsFileKey
required: true
schema:
type: string
maxLength: 255
minLength: 1
PathQueryParam:
description: The file system path of the installation.
in: query
name: installationPath
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 4096
minLength: 1
TimeErrorFirstSeenGreaterThanOrEqualToQueryParam:
description: If specified, only errors with a first seen time later than this parameter will be included in the search (formatted according to RFC3339).
in: query
name: timeFirstSeenGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
HostnameQueryParam:
description: The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance.
in: query
name: hostName
schema:
type: string
default: hostName
maxLength: 255
minLength: 1
JreIdentifierQueryParam:
description: The Fleet-unique identifier of the related Java Runtime.
in: query
name: jreId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
JavaServerInstanceNameContainsQueryParam:
description: 'Filter the list with the Java Server instance name contains the given value.
'
in: query
name: serverInstanceNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 256
minLength: 1
JavaServerVersionQueryParam:
description: 'The server version.
'
in: query
name: serverVersion
x-default-description: 'null'
schema:
type: string
maxLength: 256
minLength: 1
BlocklistSortByQueryParam:
description: 'The field used to sort blocklist records. Only one sort order may be provided.
Default order for _operation_ is **ascending**.
If no value is specified, _operation_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/BlocklistSortBy'
schema:
type: string
enum:
- operation
default: operation
LibraryApplicationSortByQueryParam:
description: 'The field to sort library application usage summaries. Only one sort order may be provided.
If no value is specified _lastSeenInClasspath_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/LibraryApplicationSortBy'
schema:
type: string
enum:
- applicationName
- managedInstanceCount
- lastDetectedDynamically
- firstSeenInClasspath
- lastSeenInClasspath
default: lastSeenInClasspath
WorkRequestIdQueryParam:
description: The ID of an asynchronous work request.
in: query
name: id
x-default-description: 'null'
schema:
type: string
JavaReleaseIdentifierPathParam:
description: Unique Java release version identifier
in: path
name: releaseVersion
required: true
schema:
type: string
SortOrderQueryParam:
description: The sort order, either 'asc' or 'desc'.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: ASC
LibraryManagedInstanceSortByQueryParam:
description: 'The field to sort library application usage summaries. Only one sort order may be provided.
If no value is specified _lastSeenInClasspath_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/LibraryManagedInstanceSortBy'
schema:
type: string
enum:
- hostname
- applicationCount
- lastDetectedDynamically
- firstSeenInClasspath
- lastSeenInClasspath
default: lastSeenInClasspath
ApplicationTypeQueryParam:
description: The type of the application.
in: query
name: applicationType
required: false
x-default-description: 'null'
schema:
type: string
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
TimeErrorLastSeenLessThanOrEqualToQueryParam:
description: If specified, only errors with a last seen time earlier than this parameter will be included in the search (formatted according to RFC3339).
in: query
name: timeLastSeenLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
JavaServerIdentifierQueryParameter:
description: 'The server key.
'
in: query
name: serverKey
x-default-description: 'null'
schema:
type: string
maxLength: 64
minLength: 1
CvssScoreLessThanQueryParam:
description: Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis.
in: query
name: cvssScoreLessThan
required: false
x-default-description: 'null'
schema:
type: number
format: float
CompartmentIdInSubtreeQueryParam:
description: 'Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.
'
in: query
name: compartmentIdInSubtree
required: false
schema:
type: boolean
default: false
VendorQueryParam:
description: The vendor of the Java Runtime.
in: query
name: jreVendor
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
TimeEndQueryParam:
description: The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeEnd
required: false
x-default-description: current time
schema:
type: string
format: date-time
JreVendorQueryParam:
description: The vendor of the related Java Runtime.
in: query
name: jreVendor
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
HostIdentifierQueryParam:
description: The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance.
in: query
name: hostId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
CompartmentIdQueryParam:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
'
in: query
name: compartmentId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
AgentInstallerSortByQueryParam:
description: 'The field to sort the agent installer. Only one sort order can be provided.
Default order for _agentInstallerId_, _osFamily_, _platformArchitecture_ is **ascending**.
If no value is specified _agentInstallerId_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/AgentInstallerSortBy'
schema:
type: string
enum:
- agentInstallerId
- osFamily
- platformArchitecture
default: agentInstallerId
LibraryNameContainsQueryParam:
description: 'Filter the list with library name contains the given value.
'
in: query
name: libraryNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
TaskScheduleNameContainsQueryParam:
description: 'Filter the list with task schedule name contains the given value.
'
in: query
name: taskScheduleNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
FindingCountGreaterThanQueryParam:
description: FindingCount of CryptoAnalysis Report.
in: query
name: findingCountGreaterThan
required: false
x-default-description: 'null'
schema:
type: integer
PerformanceTuningAnalysisResultSortByQueryParam:
description: 'The field to sort performance tuning analysis results. Only one sort order may be provided.
Default order for _timeCreated_, and _jreVersion_ is **descending**.
Default order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.
If no value is specified _timeCreated_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/PerformanceTuningAnalysisResultSortBy'
schema:
type: string
enum:
- timeCreated
- managedInstanceId
- workRequestId
- warningCount
default: timeCreated
DeployedApplicationSortByQueryParam:
description: 'The field to sort the deployed applications. Only one sort order can be provided.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/DeployedApplicationSortBy'
schema:
type: string
enum:
- applicationName
- applicationType
- isClustered
- javaServerInstanceCount
- approximateJavaServerInstanceCount
- approximateLibraryCount
- timeFirstSeen
- timeLastSeen
default: timeLastSeen
JavaServerInstanceSortByQueryParam:
description: 'The field to sort the Java Server instances. Only one sort order can be provided.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaServerInstanceSortBy'
schema:
type: string
enum:
- serverInstanceName
- managedInstanceName
- approximateDeployedApplicationCount
- timeFirstSeen
- timeLastSeen
default: timeLastSeen
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
LibraryIdentifierPathParam:
description: The unique identifier of a Java library.
in: path
name: libraryKey
required: true
schema:
type: string
maxLength: 64
minLength: 1
JavaReleaseVersionQueryParam:
description: Unique Java release version identifier
in: query
name: releaseVersion
required: false
x-default-description: 'null'
schema:
type: string
TimeStartedGreaterThanOrEqualToQueryParam:
description: If specified, only containers with a start time later than or equal to this parameter will be included in the response (formatted according to RFC3339).
in: query
name: timeStartedGreaterThanOrEqualTo
required: false
x-default-description: current time minus seven days
schema:
type: string
format: date-time
BlocklistIdentifierPathParam:
description: The unique identifier of the blocklist record.
in: path
name: blocklistKey
required: true
schema:
type: string
maxLength: 64
minLength: 1
InstallationSortByQueryParam:
description: 'The field to sort installation views. Only one sort order may be provided.
Default order for _timeFirstSeen_, _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_
and _approximateManagedInstanceCount_ is **descending**.
Default order for _jreDistribution_ and _jreVendor_ is **ascending**. If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/InstallationSortBy'
schema:
type: string
enum:
- jreDistribution
- jreVendor
- jreVersion
- path
- timeFirstSeen
- timeLastSeen
- approximateApplicationCount
- approximateManagedInstanceCount
- osName
- securityStatus
default: timeLastSeen
TimeStartedLessThanOrEqualToQueryParam:
description: If specified, only containers with a start time earlier than or equal to this parameter will be included in the response (formatted according to RFC3339).
in: query
name: timeStartedLessThanOrEqualTo
required: false
x-default-description: current time
schema:
type: string
format: date-time
TimeStartQueryParam:
description: The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeStart
required: false
x-default-description: currentTime minus seven days
schema:
type: string
format: date-time
CryptoAnalysisResultAggregationModeQueryParam:
description: The aggregation mode of the crypto event analysis result.
in: query
name: aggregationMode
required: false
x-obmcs-top-level-enum: '#/definitions/CryptoAnalysisResultMode'
schema:
type: string
enum:
- JFR
- MANAGED_INSTANCE
default: managedInstance
PackageSortByQueryParam:
description: 'The field to sort Java packages. Only one sort order may be provided.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/PackageSortBy'
schema:
type: string
enum:
- packageName
- managedInstanceCount
- applicationCount
- lastDetectedDynamically
default: timeLastSeen
JavaServerSortByQueryParam:
description: 'The field to sort a Java Server. Only one sort order can be provided.
If no value is specified _timeLastSeen_ is default.
'
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/JavaServerSortBy'
schema:
type: string
enum:
- serverName
- serverVersion
- serverInstanceCount
- approximateDeployedApplicationCount
- timeFirstSeen
- timeLastSeen
default: timeLastSeen
TimeRegisteredLessThanOrEqualToQueryParam:
description: If present, only plugins with a registration time before this parameter are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
in: query
name: timeRegisteredLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
JmsPluginAvailabilityStatusQueryParam:
description: Filter JmsPlugin with its availability status.
in: query
name: availabilityStatus
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/JmsPluginAvailabilityStatus'
schema:
type: string
enum:
- ACTIVE
- SILENT
- NOT_AVAILABLE
JmsPluginIdentifierPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin.
in: path
name: jmsPluginId
required: true
schema:
type: string
maxLength: 255
minLength: 1
JmsPluginIdentifierQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin.
in: query
name: id
required: false
schema:
type: string
maxLength: 255
minLength: 1
PathContainsQueryParam:
description: 'Filter the list with path contains the given value.
'
in: query
name: pathContains
x-default-description: 'null'
schema:
type: string
maxLength: 1024
minLength: 1
LibraryNameQueryParam:
description: 'The library name.
'
in: query
name: libraryName
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
JavaLicenseTypeQueryParam:
description: Java license type.
in: query
name: licenseType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LicenseType'
schema:
type: string
enum:
- OTN
- NFTC
- RESTRICTED
HostnameContainsQueryParam:
description: 'Filter the list with hostname contains the given value.
'
in: query
name: hostnameContains
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DeployedApplicationNameQueryParam:
description: 'The deployed application name.
'
in: query
name: applicationName
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
ApplicationInstallationIdentifierQueryParam:
description: The Fleet-unique identifier of the application installation.
in: query
name: applicationInstallationKey
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
DeployedApplicationInstallationSortByQueryParam:
description: "The field to sort the deployed application installations. Only one sort order can be provided.\nIf no value is specified _timeLastSeen_ is default.\n \n"
in: query
name: sortBy
x-obmcs-top-level-enum: '#/definitions/DeployedApplicationInstallationSortBy'
schema:
type: string
enum:
- applicationName
- applicationType
- applicationSourcePath
- isClustered
- javaServerInstanceCount
- approximateJavaServerInstanceCount
- approximateLibraryCount
- timeFirstSeen
- timeLastSeen
default: timeLastSeen
DeployedApplicationIdentifierQueryParam:
description: 'The deployed application key.
'
in: query
name: applicationKey
x-default-description: 'null'
schema:
type: string
maxLength: 250
minLength: 1
JavaReleaseTypeQueryParam:
description: Java release type.
in: query
name: releaseType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ReleaseType'
schema:
type: string
enum:
- CPU
- FEATURE
- BPR
- PATCH_RELEASE
JavaServerNameContainsQueryParam:
description: 'Filter the list with server name contains the given value.
'
in: query
name: serverNameContains
x-default-description: 'null'
schema:
type: string
maxLength: 256
minLength: 1
SummaryContainsQueryParam:
description: 'Filter the list with summary contains the given value.
'
in: query
name: summaryContains
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
VersionQueryParam:
description: The version of the Java Runtime.
in: query
name: jreVersion
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
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, provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
x-anchors:
x-headers:
content-length:
description: The content size of the body in bytes.
format: int64
type: integer
content-type:
description: The content type of the body.
type: string
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
type: string
location:
description: URL to redirect to on returning a 3XX status code.
type: string
opc-next-page:
description: 'For list pagination, when this header appears in the response, additional pages of results remain.
Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
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, 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 the 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.
format: float
type: number
x-properties:
agentPollingIntervalInMinutes:
default: 10
description: 'Agent polling interval in minutes
'
maximum: 720
minimum: 10
type: integer
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer, and boolean types are supported.
'
type: object
description: 'Key-value pair representing predefined 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"}}`. (See [Understanding Free-form Tags](/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm)).
'
type: object
fleetId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet.
'
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"}`. (See [Managing Tags and Tag Namespaces](/Content/Tagging/Concepts/understandingfreeformtags.htm).)
'
type: object
hostname:
description: The hostname of the managed instance.
maxLength: 255
minLength: 1
type: string
isCapturingIpAddressAndFqdnEnabled:
default: false
description: 'Collect network addresses of managed instances in the fleet.
'
type: boolean
isCollectingManagedInstanceMetricsEnabled:
default: false
description: 'Collect JMS agent metrics on all managed instances in the fleet.
'
type: boolean
isCollectingUsernamesEnabled:
default: true
description: 'Collect username for application invocations for all managed instances in the fleet.
'
type: boolean
isCrossRegionAcknowledged:
default: false
description: 'Acknowledgement for cross region target bucket configuration.
'
type: boolean
isEnabled:
default: false
description: ExportSetting flag to store enabled or disabled status.
type: boolean
isLibrariesScanEnabled:
default: true
description: 'Enable libraries scan on all managed instances in the fleet.
'
type: boolean
javaUsageTrackerProcessingFrequencyInMinutes:
description: 'The frequency (in minutes) of Java Usage Tracker processing. (That is, how often should JMS process data from the Java Usage Tracker.)
'
maximum: 90
minimum: 5
type: integer
jfrWaitingPeriodInMinutes:
description: 'Period to looking for JVMs. In addition to attach to running JVMs when given the command,
JVM started within the waiting period will also be attached for JFR. The value should be
larger than the agent polling interval setting for the fleet to ensure agent can get the
instructions. If not specified, the agent polling interval for the fleet is used.
'
format: int32
maximum: 1440
minimum: 10
type: integer
jreScanFrequencyInMinutes:
description: 'The frequency (in minutes) of JRE scanning. (That is, how often should JMS scan for JRE installations.)
'
maximum: 40320
minimum: 180
type: integer
lastDetectedDynamically:
description: 'The date and time a library or Java package was _last_ detected in a dynamic library scan.
'
format: date-time
type: string
managedInstanceId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the related managed instance.
'
type: string
osPaths:
description: 'An array of file system paths (environment variables supported).
'
items:
type: string
type: array
uniqueItems: true
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"free-tier-retained": "true"}`
'
type: object
description: 'System tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
System tags can be viewed by users, but can only be created by the system.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
'
type: object
targetBucketName:
description: 'The name of the bucket where data will be exported.
'
maxLength: 255
minLength: 1
type: string
targetBucketNamespace:
description: 'The namespace of the bucket where data will be exported.
'
maxLength: 1024
minLength: 1
type: string
targetBucketRegion:
description: 'The id of the region of the target bucket.
'
maxLength: 25
minLength: 1
type: string
timeEnd:
description: Upper bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeEndParam:
description: 'The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
Defaults to current time.
JMS provides a view of the data that is _per day_.
The query uses only the date element of the parameter.
'
format: date-time
type: string
timeFirstSeen:
description: 'The date and time the resource was _first_ reported to JMS.
This is potentially _before_ the specified time period provided by the filters.
For example, a resource can be first reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeLastModified:
description: 'The date and time of the last modification to the Fleet Agent Configuration (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
'
format: date-time
type: string
timeLastSeen:
description: 'The date and time the resource was _last_ reported to JMS.
This is potentially _after_ the specified time period provided by the filters.
For example, a resource can be last reported to JMS before the start of a specified time period,
if it is also reported during the time period.
'
format: date-time
type: string
timeStart:
description: Lower bound of the specified time period filter. JMS provides a view of the data that is _per day_. The query uses only the date element of the parameter.
format: date-time
type: string
timeStartParam:
description: 'The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).
Defaults to current time minus seven days.
JMS provides a view of the data that is _per day_.
The query uses only the date element of the parameter.
'
format: date-time
type: string
workRequestValidityPeriodInDays:
default: 14
description: 'The validity period in days for work requests.
'
maximum: 30
minimum: 7
type: integer
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.aj