{ "opencollection": "1.0.0", "info": { "name": "Fleets Java Management Service API", "version": "20210610" }, "items": [ { "info": { "name": "javaManagementService", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of the supported agent installer information.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/agentInstallers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "platformArchitecture", "value": "", "type": "query", "description": "The platform architecture for the agent installer." }, { "name": "osFamily", "value": "", "type": "query", "description": "The OS family for the agent installer." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the agent installer. Only one sort order can be provided.\nDefault order for _agentInstallerId_, _osFamily_, _platformArchitecture_ is **ascending**.\nIf no value is specified _agentInstallerId_ is default.\n" } ] }, "docs": "Returns a list of the agent installer information.\n" }, { "info": { "name": "Generate Agent Installer Configuration for Fleet", "type": "http" }, "http": { "method": "POST", "url": "/20210610/agentInstallers/actions/generateAgentInstallerConfiguration", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates the agent installer configuration using the information provided.\n" }, { "info": { "name": "Download the Agent Installer", "type": "http" }, "http": { "method": "GET", "url": "/20210610/agentInstallers/:agentInstallerId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "agentInstallerId", "value": "", "type": "path", "description": "Unique agent installer identifier." } ] }, "docs": "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.\n" }, { "info": { "name": "Retrieve JMS announcements", "type": "http" }, "http": { "method": "GET", "url": "/20210610/announcements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "summaryContains", "value": "", "type": "query", "description": "Filter the list with summary contains the given value.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort AnnouncementSummary by. Only one sort order may be provided.\nIf no value is specified _timeReleased_ is default.\n" } ] }, "docs": "Return a list of AnnouncementSummary items" }, { "info": { "name": "Returns a summary of FleetErrors.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleetErrorAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." } ] }, "docs": "Returns a high level summary of FleetErrors." }, { "info": { "name": "Returns a list of FleetErrors.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleetErrors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "timeFirstSeenLessThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a first seen time earlier than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeFirstSeenGreaterThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a first seen time later than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeLastSeenLessThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a last seen time earlier than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeLastSeenGreaterThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a last seen time later than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort FleetError. Only one sort order may be provided.\nDefault order is **descending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "Returns a list of fleet errors that describe all detected errors." }, { "info": { "name": "Retrieve a list of all Fleets in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "id", "value": "", "type": "query", "description": "The ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The state of the lifecycle." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort Fleets. Only one sort order may be provided.\nDefault order for _timeCreated_, _approximateJreCount_, _approximateInstallationCount_,\n_approximateApplicationCount_ and _approximateManagedInstanceCount_ is **descending**.\nDefault order for _displayName_ is **ascending**.\nIf no value is specified _timeCreated_ is default.\n" }, { "name": "displayNameContains", "value": "", "type": "query", "description": "Filter the list with displayName contains the given value.\n" } ] }, "docs": "Returns a list of all the Fleets contained by a compartment. The query parameter `compartmentId`\nis required unless the query parameter `id` is specified.\n" }, { "info": { "name": "Create a new Fleet.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Fleet using the information provided.\n\n`inventoryLog` is now a required parameter for CreateFleet API.\nUpdate existing applications using this API\nbefore July 15, 2022 to ensure the applications continue to work.\nSee the [Service Change Notice](https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#JMS) for more details.\nMigrate existing fleets using the `UpdateFleet` API to set the `inventoryLog` parameter.\n" }, { "info": { "name": "Retrieve a Fleet.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Retrieve a Fleet with the specified identifier." }, { "info": { "name": "Update a Fleet.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/fleets/:fleetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Fleet specified by an identifier." }, { "info": { "name": "Delete a Fleet.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Deletes the Fleet specified by an identifier." }, { "info": { "name": "Add Java installation sites in a fleet.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/addInstallationSites", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Java installation sites in a Fleet." }, { "info": { "name": "Move a Fleet into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move a specified Fleet into the compartment identified in the POST form. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Request to disable DRS.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/disableDrs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to disable the DRS in the selected target in the Fleet.\n" }, { "info": { "name": "Request to enable DRS.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/enableDrs", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to enable the DRS in the selected target in the Fleet.\n" }, { "info": { "name": "Generate Agent Deploy Script for Fleet", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/generateAgentDeployScript", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates Agent Deploy Script for Fleet using the information provided.\n" }, { "info": { "name": "Generate Load Pipeline Script", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/generateLoadPipelineScript", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates Load Pipeline Script\n" }, { "info": { "name": "Remove Java installation sites in a fleet.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/removeInstallationSites", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Java installation sites in a Fleet." }, { "info": { "name": "Request to start crypto analyses on selected target.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/requestCryptoAnalyses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n" }, { "info": { "name": "Request to start the Java migration analyses for selected deployed applications.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/requestDeployedApplicationMigrationAnalyses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to perform a deployed Java migration analyses. The results of the deployed Java migration analyses will be uploaded to the\nObject Storage bucket that you designate when you enable the Java Migration Analyses feature.\n" }, { "info": { "name": "Request to start the Java migration analysis for selected applications.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/requestJavaMigrationAnalyses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to perform a Java migration analysis. The results of the Java migration analysis will be uploaded to the\nObject Storage bucket that you designate when you enable the Java Migration Analysis feature.\n" }, { "info": { "name": "Request to collect JFR recordings.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/requestJfrRecordings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n" }, { "info": { "name": "Request to start performance tuning analyses on selected target.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/requestPerformanceTuningAnalyses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to perform performance tuning analyses. The result of performance tuning analysis will be uploaded to the\nobject storage bucket that you designated when you enabled the recording feature.\n" }, { "info": { "name": "Scan Java Server usage in a fleet.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/scanJavaServerUsage", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scan Java Server usage in a fleet." }, { "info": { "name": "Scan library usage in a fleet.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/actions/scanLibraryUsage", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Scan library usage in a fleet." }, { "info": { "name": "Summarize application installation usage in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeApplicationInstallationUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "applicationInstallationKey", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application installation." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "Filter the list with displayName contains the given value.\n" }, { "name": "applicationType", "value": "", "type": "query", "description": "The type of the application." }, { "name": "appInstallationPathContains", "value": "", "type": "query", "description": "Filter the list with the application installation path that contains the given value." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the related Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the related Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "installationPath", "value": "", "type": "query", "description": "The file system path of the Java Runtime installation." }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort application installation views. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_\nand _approximateManagedInstanceCount_ is **descending**.\nDefault order for _displayName_, _installationPath_ and _osName_ is **ascending**.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "List application usage in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeApplicationUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name." }, { "name": "applicationType", "value": "", "type": "query", "description": "The type of the application." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the related Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the related Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "installationPath", "value": "", "type": "query", "description": "The file system path of the Java Runtime installation." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "fields", "value": "", "type": "query", "description": "Additional fields to include into the returned model on top of the required ones.\nThis parameter can also include 'approximateJreCount', 'approximateInstallationCount' and 'approximateManagedInstanceCount'.\nFor example 'approximateJreCount,approximateInstallationCount'.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort application views. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, _approximateJreCount_, _approximateInstallationCount_\nand _approximateManagedInstanceCount_ is **descending**.\nDefault order for _displayName_ and _osName_ is **ascending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "displayNameContains", "value": "", "type": "query", "description": "Filter the list with displayName contains the given value.\n" }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" } ] }, "docs": "List application usage in a Fleet filtered by query parameters." }, { "info": { "name": "Summarize deployed application installation usage in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeDeployedApplicationInstallationUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "serverKey", "value": "", "type": "query", "description": "The server key.\n" }, { "name": "serverInstanceKey", "value": "", "type": "query", "description": "The Java Server instance key.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationInstallationKey", "value": "", "type": "query", "description": "The deployed application installation key.\n" }, { "name": "applicationKey", "value": "", "type": "query", "description": "The deployed application key.\n" }, { "name": "applicationNameContains", "value": "", "type": "query", "description": "Filter the list with deployed application name contains the given value.\n" }, { "name": "applicationName", "value": "", "type": "query", "description": "The deployed application name.\n" }, { "name": "applicationSourcePathContains", "value": "", "type": "query", "description": "Filter the list with application source path contains the given value." }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "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.\n" }, { "info": { "name": "List of deployed applications in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeDeployedApplicationUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "serverKey", "value": "", "type": "query", "description": "The server key.\n" }, { "name": "serverInstanceKey", "value": "", "type": "query", "description": "The Java Server instance key.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" }, { "name": "applicationKey", "value": "", "type": "query", "description": "The deployed application key.\n" }, { "name": "applicationNameContains", "value": "", "type": "query", "description": "Filter the list with deployed application name contains the given value.\n" }, { "name": "applicationName", "value": "", "type": "query", "description": "The deployed application name.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the deployed applications. Only one sort order can be provided.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "List of deployed applications in a Fleet filtered by query parameters.\n" }, { "info": { "name": "List Java installation usage in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeInstallationUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the related Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the related Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "installationPath", "value": "", "type": "query", "description": "The file system path of the installation." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "fields", "value": "", "type": "query", "description": "Additional fields to include into the returned model on top of the required ones.\nThis parameter can also include 'approximateApplicationCount' and 'approximateManagedInstanceCount'.\nFor example 'approximateApplicationCount,approximateManagedInstanceCount'.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort installation views. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_\nand _approximateManagedInstanceCount_ is **descending**.\nDefault order for _jreDistribution_ and _jreVendor_ is **ascending**. If no value is specified _timeLastSeen_ is default.\n" }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "pathContains", "value": "", "type": "query", "description": "Filter the list with path contains the given value.\n" }, { "name": "jreSecurityStatus", "value": "", "type": "query", "description": "The security status of the Java Runtime." } ] }, "docs": "List Java installation usage in a Fleet filtered by query parameters." }, { "info": { "name": "List of Java Server instances in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeJavaServerInstanceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "serverKey", "value": "", "type": "query", "description": "The server key.\n" }, { "name": "serverInstanceKey", "value": "", "type": "query", "description": "The Java Server instance key.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationKey", "value": "", "type": "query", "description": "The deployed application key.\n" }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" }, { "name": "serverInstanceNameContains", "value": "", "type": "query", "description": "Filter the list with the Java Server instance name contains the given value.\n" }, { "name": "serverInstanceName", "value": "", "type": "query", "description": "The Java Server instance name.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the Java Server instances. Only one sort order can be provided.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "List Java Server instances in a fleet filtered by query parameters.\n" }, { "info": { "name": "List of Java Servers in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeJavaServerUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "serverKey", "value": "", "type": "query", "description": "The server key.\n" }, { "name": "serverNameContains", "value": "", "type": "query", "description": "Filter the list with server name contains the given value.\n" }, { "name": "serverName", "value": "", "type": "query", "description": "The server name.\n" }, { "name": "serverVersion", "value": "", "type": "query", "description": "The server version.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort a Java Server. Only one sort order can be provided.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "List of Java servers in a Fleet filtered by query parameters.\n" }, { "info": { "name": "List Java Runtime usage in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeJreUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "jreId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related Java Runtime." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the Java Runtime." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "fields", "value": "", "type": "query", "description": "Additional fields to include into the returned model on top of the required ones.\nThis parameter can also include 'approximateApplicationCount', 'approximateInstallationCount' and 'approximateManagedInstanceCount'.\nFor example 'approximateApplicationCount,approximateManagedInstanceCount'.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort JRE usages. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, and _version_ is **descending**.\nDefault order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_,\n_approximateApplicationCount_ and _approximateManagedInstanceCount_ is **descending**.\nDefault order for _distribution_, _vendor_, and _osName_ is **ascending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "jreSecurityStatus", "value": "", "type": "query", "description": "The security status of the Java Runtime." } ] }, "docs": "List Java Runtime usage in a specified Fleet filtered by query parameters." }, { "info": { "name": "List libraries in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeLibraryUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "serverInstanceKey", "value": "", "type": "query", "description": "The Java Server instance key.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationKey", "value": "", "type": "query", "description": "The deployed application key.\n" }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" }, { "name": "libraryNameContains", "value": "", "type": "query", "description": "Filter the list with library name contains the given value.\n" }, { "name": "libraryName", "value": "", "type": "query", "description": "The library name.\n" }, { "name": "cvssScoreGreaterThan", "value": "", "type": "query", "description": "Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis." }, { "name": "cvssScoreLessThan", "value": "", "type": "query", "description": "Total Common Vulnerability Scoring System (CVSS) Score reported by the analysis." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort libraries. Only one sort order may be provided.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "List libraries in a fleet filtered by query parameters.\n" }, { "info": { "name": "List managed instance usage in a Fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/actions/summarizeManagedInstanceUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "managedInstanceType", "value": "", "type": "query", "description": "The type of the managed instance." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the related Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the related Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "installationPath", "value": "", "type": "query", "description": "The file system path of the Java Runtime installation." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related application." }, { "name": "fields", "value": "", "type": "query", "description": "Additional fields to include into the returned model on top of the required ones.\nThis parameter can also include 'approximateJreCount', 'approximateInstallationCount' and 'approximateApplicationCount'.\nFor example 'approximateJreCount,approximateInstallationCount'.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort managed instance views. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, approximateJreCount_, _approximateInstallationCount_\nand _approximateApplicationCount_ is **descending**.\nDefault order for _osName_ is **ascending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "hostnameContains", "value": "", "type": "query", "description": "Filter the list with hostname contains the given value.\n" }, { "name": "libraryKey", "value": "", "type": "query", "description": "The library key.\n" } ] }, "docs": "List managed instance usage in a Fleet filtered by query parameters." }, { "info": { "name": "Get fleet advanced feature config.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/advancedFeatureConfiguration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Returns Fleet level advanced feature configuration.\n" }, { "info": { "name": "Update fleet advanced feature config.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/fleets/:fleetId/advancedFeatureConfiguration", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update advanced feature configurations for the Fleet.\nEnsure that the namespace and bucket storage are created prior to turning on the JfrRecording or CryptoEventAnalysis feature.\n" }, { "info": { "name": "Retrieve a Fleet Agent Configuration.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/agentConfiguration", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Retrieve a Fleet Agent Configuration for the specified Fleet." }, { "info": { "name": "Update a Fleet Agent Configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/fleets/:fleetId/agentConfiguration", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Fleet Agent Configuration for the specified Fleet." }, { "info": { "name": "Retrieve the blocklist of the fleet.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/blocklists", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "operation", "value": "", "type": "query", "description": "The operation type." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort blocklist records. Only one sort order may be provided.\nDefault order for _operation_ is **ascending**.\nIf no value is specified, _operation_ is default.\n" } ] }, "docs": "Returns a list of blocklist entities contained by a fleet.\n" }, { "info": { "name": "Add a new blocklist record.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/blocklists", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new record to the fleet blocklist.\n" }, { "info": { "name": "Delete a blocklist record.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId/blocklists/:blocklistKey", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "blocklistKey", "value": "", "type": "path", "description": "The unique identifier of the blocklist record." } ] }, "docs": "Deletes the blocklist record specified by an identifier." }, { "info": { "name": "List containers in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/containers", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name." }, { "name": "applicationName", "value": "", "type": "query", "description": "The name of the application." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "jreSecurityStatus", "value": "", "type": "query", "description": "The security status of the Java Runtime." }, { "name": "timeStartedGreaterThanOrEqualTo", "value": "", "type": "query", "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)." }, { "name": "timeStartedLessThanOrEqualTo", "value": "", "type": "query", "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)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort the containers. Only one sort order can be provided.\nDefault order for _displayName_, _namespace_, _podName_, _applicationName_, or _jreVersion_ is **ascending**.\nDefault order for _timeStarted_ is **descending**.\nIf no value is specified _timeStarted_ is default.\n" } ] }, "docs": "List containers in a fleet filtered by query parameters." }, { "info": { "name": "List Crypto Event Analysis results.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/cryptoAnalysisResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "aggregationMode", "value": "", "type": "query", "description": "The aggregation mode of the crypto event analysis result." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "hostName", "value": "", "type": "query", "description": "The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "nonCompliantFindingCount", "value": "", "type": "query", "description": "Non Compliant Finding Count of CryptoAnalysis Report." }, { "name": "nonCompliantFindingCountGreaterThan", "value": "", "type": "query", "description": "Non Compliant Finding Count of CryptoAnalysis Report." }, { "name": "findingCount", "value": "", "type": "query", "description": "FindingCount of CryptoAnalysis Report." }, { "name": "findingCountGreaterThan", "value": "", "type": "query", "description": "FindingCount of CryptoAnalysis Report." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort crypto event analysis results. Only one sort order can be provided.\nDefault order for _timeCreated_, and _jreVersion_ is **descending**.\nDefault order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.\nIf no value is specified _timeCreated_ is default.\n" } ] }, "docs": "Lists the results of a Crypto event analysis." }, { "info": { "name": "Retrieve metadata of a Crypto Event Analysis result.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/cryptoAnalysisResults/:cryptoAnalysisResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "cryptoAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the analysis result." } ] }, "docs": "Retrieve the metadata for the result of a Crypto event analysis." }, { "info": { "name": "Delete metadata of a Crypto Event Analysis result.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId/cryptoAnalysisResults/:cryptoAnalysisResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "cryptoAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the analysis result." } ] }, "docs": "Deletes the metadata for the result of a Crypto event analysis. The actual report shall remain in the object storage." }, { "info": { "name": "List diagnoses on resources needed by the fleet.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/diagnoses", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." } ] }, "docs": "List potential diagnoses that would put a fleet into FAILED or NEEDS_ATTENTION lifecycle state.\n" }, { "info": { "name": "List the DRS details.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/drsFiles", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field that sorts the DRS details results. Only one sort order can be provided.\nThe default order for _drsFileKey_ is **descending**.\nIf no value is specified, then _drsFileKey_ is default.\n" } ] }, "docs": "List the details about the created DRS files in the Fleet." }, { "info": { "name": "Request to create DRS file in Object Store.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/fleets/:fleetId/drsFiles", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to perform validation of the DRS file and create the file to the Object Storage.\n" }, { "info": { "name": "Get the DRS detail.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/drsFiles/:drsFileKey", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "drsFileKey", "value": "", "type": "path", "description": "The unique identifier of the DRS File in Object Storage." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." } ] }, "docs": "Get the detail about the created DRS file in the Fleet." }, { "info": { "name": "Request to update DRS to object store.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/fleets/:fleetId/drsFiles/:drsFileKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "drsFileKey", "value": "", "type": "path", "description": "The unique identifier of the DRS File in Object Storage." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request to perform validation of the DRS file and update the existing file in the Object Storage.\n" }, { "info": { "name": "Delete DRS file from object store.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId/drsFiles/:drsFileKey", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "drsFileKey", "value": "", "type": "path", "description": "The unique identifier of the DRS File in Object Storage." } ] }, "docs": "Request to delete the DRS file from the Object Storage.\n" }, { "info": { "name": "Retrieves export setting", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/exportSetting", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Returns export setting for the specified fleet." }, { "info": { "name": "Updates existing Export setting.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/fleets/:fleetId/exportSetting", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates existing export setting for the specified fleet." }, { "info": { "name": "Retrieves last export status", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/exportStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." } ] }, "docs": "Returns last export status for the specified fleet." }, { "info": { "name": "List Java installations in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/installationSites", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "jreVendor", "value": "", "type": "query", "description": "The vendor of the related Java Runtime." }, { "name": "jreDistribution", "value": "", "type": "query", "description": "The distribution of the related Java Runtime." }, { "name": "jreVersion", "value": "", "type": "query", "description": "The version of the related Java Runtime." }, { "name": "installationPath", "value": "", "type": "query", "description": "The file system path of the installation." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort installation sites. Only one sort order may be provided.\nDefault order for _timeLastSeen_, and _jreVersion_, _approximateApplicationCount_ is **descending**.\nDefault order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.\nIf no value is specified _managedInstanceId_ is default.\n" }, { "name": "osFamily", "value": "", "type": "query", "description": "The operating system type." }, { "name": "jreSecurityStatus", "value": "", "type": "query", "description": "The security status of the Java Runtime." }, { "name": "pathContains", "value": "", "type": "query", "description": "Filter the list with path contains the given value.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." } ] }, "docs": "List Java installation sites in a Fleet filtered by query parameters." }, { "info": { "name": "Lists the Java migration analysis results.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/javaMigrationAnalysisResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "hostName", "value": "", "type": "query", "description": "The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "applicationName", "value": "", "type": "query", "description": "The name of the application." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field that sorts the Java migration analysis results. Only one sort order can be provided.\nThe default order for _timeCreated_, _managedInstanceId_ and _workRequestId_ is **descending**.\nIf no value is specified, then _timeCreated_ is default.\n" } ] }, "docs": "Lists the results of a Java migration analysis." }, { "info": { "name": "Retrieve Java Migration Analysis result.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/javaMigrationAnalysisResults/:javaMigrationAnalysisResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "javaMigrationAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the analysis result." } ] }, "docs": "Retrieve Java Migration Analysis result." }, { "info": { "name": "Delete Java Migration Analysis result.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId/javaMigrationAnalysisResults/:javaMigrationAnalysisResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "javaMigrationAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the analysis result." } ] }, "docs": "Delete the Java migration analysis result. The actual report will remain in the Object Storage bucket." }, { "info": { "name": "List applications where a library has been detected.\n", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/libraries/:libraryKey/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "libraryKey", "value": "", "type": "path", "description": "The unique identifier of a Java library." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationName", "value": "", "type": "query", "description": "The name of the application." }, { "name": "applicationNameContains", "value": "", "type": "query", "description": "Filter the list with application name contains the given value.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort library application usage summaries. Only one sort order may be provided.\nIf no value is specified _lastSeenInClasspath_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "List applications where a library has been detected filtered by query parameters.\n" }, { "info": { "name": "List managed instances where a library has been detected.\n", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/libraries/:libraryKey/managedInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "libraryKey", "value": "", "type": "path", "description": "The unique identifier of a Java library." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "hostName", "value": "", "type": "query", "description": "The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "hostnameContains", "value": "", "type": "query", "description": "Filter the list with hostname contains the given value.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort library application usage summaries. Only one sort order may be provided.\nIf no value is specified _lastSeenInClasspath_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "List managed instances where a library has been detected, filtered by query parameters.\n" }, { "info": { "name": "List Performance Tuning Analysis results.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/performanceTuningAnalysisResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related application." }, { "name": "applicationName", "value": "", "type": "query", "description": "The name of the application." }, { "name": "hostName", "value": "", "type": "query", "description": "The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort performance tuning analysis results. Only one sort order may be provided.\nDefault order for _timeCreated_, and _jreVersion_ is **descending**.\nDefault order for _managedInstanceId_, _jreDistribution_, _jreVendor_ and _osName_ is **ascending**.\nIf no value is specified _timeCreated_ is default.\n" } ] }, "docs": "List Performance Tuning Analysis results." }, { "info": { "name": "Retrieve metadata of a Performance Tuning Analysis result.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/performanceTuningAnalysisResults/:performanceTuningAnalysisResultId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "performanceTuningAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the performance tuning analysis result." } ] }, "docs": "Retrieve metadata of the Performance Tuning Analysis result." }, { "info": { "name": "Delete metadata of a Performance Tuning Analysis result.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/fleets/:fleetId/performanceTuningAnalysisResults/:performanceTuningAnalysisResultId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "performanceTuningAnalysisResultId", "value": "", "type": "path", "description": "The OCID of the performance tuning analysis result." } ] }, "docs": "Deletes only the metadata of the Performance Tuning Analysis result, but the file remains in the object storage." }, { "info": { "name": "Retrieves libraries inventory in a fleet, filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/summarizeLibraryInventory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." } ] }, "docs": "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.\n" }, { "info": { "name": "List uncorrelated package summaries in a fleet, filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/uncorrelatedPackages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "packageName", "value": "", "type": "query", "description": "The unique identifier of a Java package." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort Java packages. Only one sort order may be provided.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "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.\n" }, { "info": { "name": "List applications where an uncorrelated package has been detected.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/uncorrelatedPackages/:packageName/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "packageName", "value": "", "type": "path", "description": "The unique identifier of a Java package." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort detection events. Only one sort order may be provided.\nIf no value is specified _dynamicallyLastDetected_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "List applications where an uncorrelated package has been detected, filtered by query parameters.\n" }, { "info": { "name": "List uncorrelated Java package detection events for a Java application in a fleet filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/fleets/:fleetId/uncorrelatedPackages/:packageName/managedInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the Fleet." }, { "name": "packageName", "value": "", "type": "path", "description": "The unique identifier of a Java package." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort detection events. Only one sort order may be provided.\nIf no value is specified _dynamicallyLastDetected_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "List managed instances where an uncorrelated package has been detected, filtered by query parameters.\n" }, { "info": { "name": "Retrieve a list of the Java release family information.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/javaFamilies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "familyVersion", "value": "", "type": "query", "description": "The version identifier for the Java family." }, { "name": "displayName", "value": "", "type": "query", "description": "The display name for the Java family." }, { "name": "isSupportedVersion", "value": "", "type": "query", "description": "Filter the Java Release Family versions by support status." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "If no value is specified _familyVersion_ is default.\n" } ] }, "docs": "Returns a list of the Java release family information.\nA Java release family is typically a major version in the Java version identifier.\n" }, { "info": { "name": "Retrieve metadata associated with a specific Java release family.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/javaFamilies/:familyVersion", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "familyVersion", "value": "", "type": "path", "description": "Unique Java family version identifier." } ] }, "docs": "Returns metadata associated with a specific Java release family.\n" }, { "info": { "name": "Retrieve a list of Java releases.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/javaReleases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "releaseVersion", "value": "", "type": "query", "description": "Unique Java release version identifier" }, { "name": "familyVersion", "value": "", "type": "query", "description": "The version identifier for the Java family." }, { "name": "releaseType", "value": "", "type": "query", "description": "Java release type." }, { "name": "jreSecurityStatus", "value": "", "type": "query", "description": "The security status of the Java Runtime." }, { "name": "licenseType", "value": "", "type": "query", "description": "Java license type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "If no value is specified _releaseDate_ is default.\n" } ] }, "docs": "Returns a list of Java releases.\n" }, { "info": { "name": "Retrieve complete details of a specific Java release including artifact information.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/javaReleases/:releaseVersion", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "releaseVersion", "value": "", "type": "path", "description": "Unique Java release version identifier" } ] }, "docs": "Returns detail of a Java release." }, { "info": { "name": "Returns a list of JmsPlugins.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/jmsPlugins", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin." }, { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "agentId", "value": "", "type": "query", "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" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter JmsPlugin with its lifecycle state." }, { "name": "availabilityStatus", "value": "", "type": "query", "description": "Filter JmsPlugin with its availability status." }, { "name": "agentType", "value": "", "type": "query", "description": "Filter JmsPlugin with agent type." }, { "name": "timeRegisteredLessThanOrEqualTo", "value": "", "type": "query", "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))." }, { "name": "timeLastSeenLessThanOrEqualTo", "value": "", "type": "query", "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))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort JmsPlugin. Only one sort order may be provided.\nDefault order is **descending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "hostnameContains", "value": "", "type": "query", "description": "Filter the list with hostname contains the given value.\n" } ] }, "docs": "Lists the JmsPlugins." }, { "info": { "name": "Creates a JmsPlugin.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/jmsPlugins", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Registers an agent's JmsPlugin, optionally attaching to an existing fleet of the tenancy.\nJmsPlugins registered fleet-less are created with lifecycle state INACTIVE.\nFor the operation to be authorized, the agent must exist, and the authorized user requires JMS_PLUGIN_CREATE permission for the agent's compartment.\n" }, { "info": { "name": "Returns the JmsPlugin.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/jmsPlugins/:jmsPluginId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jmsPluginId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin." } ] }, "docs": "Returns the JmsPlugin." }, { "info": { "name": "Update a JmsPlugin.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/jmsPlugins/:jmsPluginId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "jmsPluginId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Fleet of a JmsPlugin." }, { "info": { "name": "Deletes a JmsPlugin.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/jmsPlugins/:jmsPluginId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "jmsPluginId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the JmsPlugin." } ] }, "docs": "Deletes a JmsPlugin. The JmsPlugin may be visible for some time with state DELETED.\nDeleted plugins will not be able to communicate with the JMS service.\n" }, { "info": { "name": "List Java Runtime usage in a specified host filtered by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/listJreUsage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "hostId", "value": "", "type": "query", "description": "The host [OCID](/Content/General/Concepts/identifiers.htm) of the managed instance." }, { "name": "applicationId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the application." }, { "name": "applicationName", "value": "", "type": "query", "description": "The name of the application." }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort JRE usages. Only one sort order may be provided.\nDefault order for _timeFirstSeen_, _timeLastSeen_, and _version_ is **descending**.\nDefault order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_,\n_approximateApplicationCount_ and _approximateManagedInstanceCount_ is **descending**.\nDefault order for _distribution_, _vendor_, and _osName_ is **ascending**.\nIf no value is specified _timeLastSeen_ is default.\n" } ] }, "docs": "List Java Runtime usage in a specified host filtered by query parameters." }, { "info": { "name": "Returns a summary of PluginErrors.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/pluginErrorAnalytics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." } ] }, "docs": "Returns a high level summary of PluginErrors." }, { "info": { "name": "Returns a list of PluginErrors.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/pluginErrors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "timeFirstSeenLessThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a first seen time earlier than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeFirstSeenGreaterThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a first seen time later than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeLastSeenLessThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a last seen time earlier than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "timeLastSeenGreaterThanOrEqualTo", "value": "", "type": "query", "description": "If specified, only errors with a last seen time later than this parameter will be included in the search (formatted according to RFC3339)." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort PluginError. Only one sort order may be provided.\nDefault order is **descending**.\nIf no value is specified _timeLastSeen_ is default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." } ] }, "docs": "Returns a list of plugin errors that describe all detected errors." }, { "info": { "name": "Retrieve the inventory of JMS resources in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/summarizeResourceInventory", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "Flag to determine whether the info should be gathered only in the compartment or in the compartment and its subcompartments.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end of the time period during which resources are searched (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339))." } ] }, "docs": "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.\n" }, { "info": { "name": "List the task schedule results.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/taskSchedules", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the related managed instance." }, { "name": "name", "value": "", "type": "query", "description": "The task name." }, { "name": "taskScheduleNameContains", "value": "", "type": "query", "description": "Filter the list with task schedule name contains the given value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "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" } ] }, "docs": "Returns a list of task schedules.\n" }, { "info": { "name": "Create a task schedule.", "type": "http" }, "http": { "method": "POST", "url": "/20210610/taskSchedules", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a task schedule using the information provided." }, { "info": { "name": "Retrieve a task schedule.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/taskSchedules/:taskScheduleId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "taskScheduleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule." } ] }, "docs": "Returns a task schedule.\n" }, { "info": { "name": "Update a task schedule.", "type": "http" }, "http": { "method": "PUT", "url": "/20210610/taskSchedules/:taskScheduleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "taskScheduleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the task schedule for the given task type.\n" }, { "info": { "name": "Delete a task schedule record.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/taskSchedules/:taskScheduleId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "fleetId", "value": "", "type": "query", "description": "The ID of the Fleet." }, { "name": "taskScheduleId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) to identify this task schedule." } ] }, "docs": "Deletes the task schedule record specified by an identifier." }, { "info": { "name": "List Work Requests.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, { "name": "id", "value": "", "type": "query", "description": "The ID of an asynchronous work request." }, { "name": "fleetId", "value": "", "type": "query", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the fleet." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "managedInstanceId", "value": "", "type": "query", "description": "The Fleet-unique identifier of the managed instance." }, { "name": "operationType", "value": "", "type": "query", "description": "The operation type of the work request." }, { "name": "status", "value": "", "type": "query", "description": "The status of the work request." } ] }, "docs": "List the work requests in a compartment. The query parameter `compartmentId` is required unless the query parameter `id` or `fleetId` is specified.\n" }, { "info": { "name": "Retrieve Work Request description.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Retrieve the details of a work request with the specified ID." }, { "info": { "name": "Cancel a work request.", "type": "http" }, "http": { "method": "DELETE", "url": "/20210610/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Deletes the work request specified by an identifier." }, { "info": { "name": "List work request errors.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Retrieve a (paginated) list of errors for a specified work request.\n" }, { "info": { "name": "List work request logs.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Retrieve a paginated list of logs for a specified work request.\n" }, { "info": { "name": "List work items of a work request.", "type": "http" }, "http": { "method": "GET", "url": "/20210610/workRequests/:workRequestId/workItems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Retrieve a paginated list of work items for a specified work request.\n" } ] } ], "bundled": true }