openapi: 3.2.0 info: description: 'Use the Ops Insights API to perform data extraction operations to obtain database resource utilization, performance statistics, and reference information. For more information, see [About Oracle Cloud Infrastructure Ops Insights](https://docs.cloud.oracle.com/en-us/iaas/operations-insights/doc/operations-insights.html). ' title: Ops Insights Operations Insights API version: '20200630' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/c007dae182854959d1b6f5270c5f3450a2aae7a5d0353dc74113571364355d4b.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Ops Insights API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/c007dae182854959d1b6f5270c5f3450a2aae7a5d0353dc74113571364355d4b.yaml what: the harvested document for Ops Insights API servers: - url: http://127.0.0.1/20200630 - url: https://127.0.0.1/20200630 tags: - name: operationsInsights paths: /awrHubObjects/awrHubSources/{awrHubSourceId}/o: get: description: 'Gets a list of Awr Hub objects. Awr Hub id needs to specified. ' operationId: ListAwrHubObjects parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/PrefixQueryParam' - $ref: '#/components/parameters/StartWithQueryParam' - $ref: '#/components/parameters/EndBeforeQueryParam' - $ref: '#/components/parameters/DelimiterQueryParam' - $ref: '#/components/parameters/StartAfterQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/ObjectFieldsQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of Awr Hub object summaries, the object name to begin the next page of results. headers: opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ListObjects' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Awr Hub objects. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubObjects' /awrHubObjects/awrHubSources/{awrHubSourceId}/o/{objectName}: delete: description: Deletes an Awr Hub object. operationId: DeleteAwrHubObject parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/ObjectNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The Awr Hub object was deleted successfully. headers: is-delete-marker: description: This is `true` if the deleted object is a delete marker, otherwise `false` schema: type: boolean last-modified: description: The Awr Hub object modification time. schema: type: string format: date-time opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string version-id: description: VersionId of the requested Awr Hub object. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Awr Hub object. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubObjects' get: description: Gets the Awr Hub object metadata and body. operationId: GetAwrHubObject parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/ObjectNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Awr Hub object metadata and bytes. headers: archival-state: description: Archival state of an Awr Hub object. This field is set only for Awr Hub objects in Archive tier. schema: type: string enum: - ARCHIVED - RESTORING - RESTORED cache-control: description: Cache-Control header. schema: type: string content-disposition: description: Content-Disposition header. schema: type: string content-encoding: description: Content-Encoding header. schema: type: string content-language: description: Content-Language header. schema: type: string content-length: description: The Awr Hub object size in bytes. schema: type: integer format: int64 content-md5: description: Content-MD5 header. schema: type: string content-range: description: Content-Range header. schema: type: string content-type: description: Content-Type header. schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string expires: description: The date and time after which the Awr Hub object is no longer cached by a browser, proxy, or other caching entity. schema: type: string format: date-time last-modified: description: The Awr Hub object modification time. schema: type: string format: date-time opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-meta-*: description: The user-defined metadata for the Awr Hub object. x-obmcs-header-collection: true x-obmcs-prefix: opc-meta- schema: type: string opc-multipart-md5: schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string storage-tier: description: The storage tier that the Awr Hub object is stored in. schema: type: string enum: - STANDARD - INFREQUENTACCESS - ARCHIVE time-of-archival: description: Time that the Awr Hub object is returned to the archived state. schema: type: string format: date-time version-id: description: VersionId of the requested Awr Hub object. schema: type: string content: application/octet-stream: schema: format: binary type: string 206: description: The Awr Hub object metadata and partial bytes. headers: archival-state: description: Archival state of an Awr Hub object. This field is set only for Awr Hub objects in Archive tier. schema: type: string enum: - ARCHIVED - RESTORING - RESTORED cache-control: description: Cache-Control header. schema: type: string content-disposition: description: Content-Disposition header. schema: type: string content-encoding: description: Content-Encoding header. schema: type: string content-language: description: Content-Language header. schema: type: string content-length: description: The Awr Hub object size in bytes. schema: type: integer format: int64 content-md5: description: Content-MD5 header. schema: type: string content-range: description: Content-Range header. schema: type: string content-type: description: Content-Type header. schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string expires: description: The date and time after which the Awr Hub object is no longer cached by a browser, proxy, or other caching entity. schema: type: string format: date-time last-modified: description: The Awr Hub object modification time. schema: type: string format: date-time opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-meta-*: description: The user-defined metadata for the Awr Hub object. x-obmcs-header-collection: true x-obmcs-prefix: opc-meta- schema: type: string opc-multipart-md5: schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string storage-tier: description: The storage tier that the Awr Hub object is stored in. schema: type: string enum: - STANDARD - INFREQUENTACCESS - ARCHIVE time-of-archival: description: Time that the Awr Hub object is returned to the archived state. schema: type: string format: date-time version-id: description: VersionId of the requested Awr Hub object. schema: type: string content: application/octet-stream: schema: format: binary type: string 304: description: Not Modified headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the Awr Hub object metadata and body. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubObjects' head: description: 'Gets the Awr Hub object''s user-defined metadata and entity tag (ETag). ' operationId: HeadAwrHubObject parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/ObjectNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Awr Hub object metadata and bytes. headers: archival-state: description: Archival state of an Awr Hub object. This field is set only for Awr Hub objects in Archive tier. schema: type: string enum: - ARCHIVED - RESTORING - RESTORED cache-control: description: Cache-Control header. schema: type: string content-disposition: description: Content-Disposition header. schema: type: string content-encoding: description: Content-Encoding header. schema: type: string content-language: description: Content-Language header. schema: type: string content-length: description: The Awr Hub object size in bytes. schema: type: integer format: int64 content-md5: description: Content-MD5 header. schema: type: string content-type: description: Content-Type header. schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string last-modified: description: The Awr Hub object modification time. schema: type: string format: date-time opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-meta-*: description: The user-defined metadata for the Awr Hub object. x-obmcs-header-collection: true x-obmcs-prefix: opc-meta- schema: type: string opc-multipart-md5: schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string storage-tier: description: The storage tier that the Awr Hub object is stored in. schema: type: string enum: - STANDARD - INFREQUENTACCESS - ARCHIVE time-of-archival: description: Time that the Awr Hub object is returned to the archived state. schema: type: string format: date-time version-id: description: VersionId of the requested Awr Hub object. schema: type: string 304: description: Not Modified headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: HEAD Object tags: - operationsInsights x-related-resource: '#/definitions/AwrHubObjects' put: description: 'Creates a new object or overwrites an existing object with the same name to the Awr Hub. ' operationId: PutAwrHubObject parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/ObjectNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The AwrHub object was created successfully. headers: last-modified: description: The Awr Hub object modification time. schema: type: string format: date-time opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. schema: type: string opc-content-md5: description: Content-MD5 header. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string version-id: description: VersionId of the requested Awr Hub object. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Upload an Awr hub Object tags: - operationsInsights x-obmcs-signing-strategy: exclude_body x-related-resource: '#/definitions/AwrHubObjects' requestBody: content: application/json: schema: format: binary type: string description: The object to be uploaded to the Awr Hub. required: true /awrHubSources: get: description: Gets a list of Awr Hub source objects. operationId: ListAwrHubSources parameters: - $ref: '#/components/parameters/AwrHubIdQueryParamRequired' - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/AwrHubSourceIdQueryParam' - $ref: '#/components/parameters/AwrHubSourceTypeQueryParam' - $ref: '#/components/parameters/AwrHubSourceNameQueryParam' - $ref: '#/components/parameters/AwrHubSourceStatusQueryParam' - $ref: '#/components/parameters/AwrHubSourceLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AwrHubSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: List of Awr Hub sources and the name of the object to start next page of results. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHubSourceSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Awr Hub source objects. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' post: description: 'Register Awr Hub source ' operationId: CreateAwrHubSource parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The Awr hub source is being registered. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHubSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Register Awr Hub source tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAwrHubSourceDetails' description: Payload containing details to register the source database required: true /awrHubSources/{awrHubSourceId}: delete: description: Deletes an Awr Hub source object. operationId: DeleteAwrHubSource parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Awr Hub source resource will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Awr Hub source object. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' get: description: Gets the Awr Hub source object. operationId: GetAwrHubSource parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Awr Hub source object for a given source id and Awr Hub id headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHubSource' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the Awr Hub source object. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' put: description: Update Awr Hub Source object. operationId: UpdateAwrHubSource parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Awr Hub source will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update Awr Hub Source object. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAwrHubSourceDetails' description: The configuration to be updated. required: true /awrHubSources/{awrHubSourceId}/actions/changeCompartment: post: description: Moves an AwrHubSource resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeAwrHubSourceCompartment parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The AwrHubSource resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubSources' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAwrHubSourceCompartmentDetails' description: The information to be updated. required: true /awrHubSources/{awrHubSourceId}/actions/disable: post: description: Disables a Awr Hub source database in Operations Insights. This will stop the Awr data flow for the given Awr Hub source. operationId: DisableAwrHubSource parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Awr Hub source database will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables a Awr Hub source database in Operations Insights. tags: - operationsInsights x-obmcs-terraform: actionType: DISABLE identifier: AWRHUBSOURCE x-related-resource: '#/definitions/AwrHubSources' /awrHubSources/{awrHubSourceId}/actions/enable: post: description: Enables a Awr Hub source database in Operations Insights. This will resume the Awr data flow for the given Awr Hub source if it was stopped earlier. operationId: EnableAwrHubSource parameters: - $ref: '#/components/parameters/AwrHubSourceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Awr Hub source database will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables a Awr Hub source database in Operations Insights. tags: - operationsInsights x-obmcs-terraform: actionType: ENABLE identifier: AWRHUBSOURCE x-related-resource: '#/definitions/AwrHubSources' /awrHubs: get: description: 'Gets a list of AWR hubs. Either compartmentId or id must be specified. All these resources are expected to be in root compartment. ' operationId: ListAwrHubs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AwrHubIdQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseIdQueryParamRequired' - $ref: '#/components/parameters/AwrHubLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AwrHubSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AwrHub objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHubSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of AWR hubs. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' post: description: 'Create a AWR hub resource for the tenant in Operations Insights. This resource will be created in root compartment. ' operationId: CreateAwrHub parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The AWR hub is being created. Example: `message: The hub is being created for the provided configuration.` ' headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHub' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Awr hub resource tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAwrHubDetails' description: Details using which an AWR hub resource will be created in Operations Insights. required: true /awrHubs/{awrHubId}: delete: description: Deletes an AWR hub. operationId: DeleteAwrHub parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The AWR hub resource will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an AWR hub. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' get: description: Gets details of an AWR hub. operationId: GetAwrHub parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the AWR Hub for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrHub' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an AWR hub. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' put: description: Updates the configuration of a hub . operationId: UpdateAwrHub parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights hub configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the configuration of a hub . tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAwrHubDetails' description: The configuration to be updated. required: true /awrHubs/{awrHubId}/awrDatabaseCpuUsages: get: description: 'Summarizes the AWR CPU resource limits and metrics for the specified database in AWR. Based on the time range provided as part of query param, the metrics points will be returned in the response as below. - if time range is <=7 days then the metrics points will be for every MINUTES - if time range is <=2 hours then the metrics points will be for every 10 SECONDS - if time range is >7 days then the metrics points will be for every HOUR. ' operationId: SummarizeAwrDatabaseCpuUsages parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/SessionTypeQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbCpuSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of AWR CPU resource limit and metric samples was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseCpuUsageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes AWR CPU usage data. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseCpuUsages?\n awrSourceDatabaseIdentifier=123456&beginSnapshotIdentifierGreaterThanOrEqualTo=5&endSnapshotIdentifierLessThanOrEqualTo=10\n<authorization and other headers>\n{\n \"name\": \"AWRDB_ASH_CPU_USAGE_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"numCpuCores\": 11,\n \"databaseCpuCount\": 8,\n \"hostCpuCount\": 8,\n \"items\": [\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\":.66\n },\n {\n \"timestamp\": \"2020-12-04T14:02:00Z\", \"avgValue\":.68\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseMetrics: get: description: 'Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric. ' operationId: SummarizeAwrDatabaseMetrics parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNamesQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbNameSampledTimeSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of the AWR metric samples was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseMetricCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes metric samples for the specified database. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseMetrics?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=average active sessions&name=logons per sec\n<authorization and other headers>\n{\n \"name\": \"AWRDB_METRICS_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": .66, \"minValue\": 0.5, \"maxValue\": 0.8, \"name\":\"Average Active Sessions\"\n },\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": .6, \"minValue\": 0.4, \"maxValue\": 0.9, \"name\":\"Average Active Sessions\"\n },\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": 90, \"minValue\": 40, \"maxValue\": 150, \"name\":\"Logons Per Sec\"\n },\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": 80, \"minValue\": 30, \"maxValue\": 120, \"name\":\"Logons Per Sec\"\n }\n\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseParameterChanges: get: description: 'Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter. Note that this API only returns information on change history details for one database parameter. To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint: /awrHubs/{awrHubId}/awrDbParameters?awrSourceDatabaseIdentifier={awrSourceDbId} ' operationId: SummarizeAwrDatabaseParameterChanges parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNameQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbParamChangeSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of AWR database parameter change history for the given database parameter was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseParameterChangeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarize the AWR database parameter change history. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseParameterChanges?\n awrSourceDatabaseIdentifier=123456&beginSnapshotIdentifierGreaterThanOrEqualTo=5&endSnapshotIdentifierLessThanOrEqualTo=10&name=_datapump_inherit_svcname\n<authorization and other headers>\n\n{\n \"name\": \"AWRDB_DB_PARAMETER_CHANGE\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"prevValue\": \"v1\", \"value\": \"v2\", \"snapshotId\": 5, \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\"\n },\n {\n \"prevValue\": \"v2\", \"value\": \"v3\", \"snapshotId\": 6, \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\"\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseParameters: get: description: 'Summarizes the database parameter history for the specified database in AWR. This includes the list of database parameters, with information on whether the parameter values were modified within the query time range. Note that each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include: Queryparam (valueChanged ="Y") - Each parameter whose value was changed during the time range, "isChanged : true" in response for the DB params. Queryparam (valueChanged ="N") - Each parameter whose value was unchanged during the time range, "isChanged : false" in response for the DB params. Queryparam (valueChanged ="Y" and valueModified = "SYSTEM_MOD") - Each parameter whose value was changed at the system level during the time range, "isChanged : true" & "valueModified : SYSTEM_MOD" in response for the DB params. Queryparam (valueChanged ="N" and valueDefault = "FALSE") - Each parameter whose value was unchanged during the time range, however, the value is not the default value, "isChanged : true" & "isDefault : false" in response for the DB params. Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint: /awrHubs/{awrHubId}/awrDbParameterChanges?awrSourceDatabaseIdentifier={awrSourceDbId} ' operationId: SummarizeAwrDatabaseParameters parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNamesOptionalQueryParam' - $ref: '#/components/parameters/EntityNameContainsFilterOptionalQueryParam' - $ref: '#/components/parameters/AwrDbParameterValueOptionalQueryParam' - $ref: '#/components/parameters/AwrDbParameterDefaultOptionalQueryParam' - $ref: '#/components/parameters/AwrDbParameterModifiedOptionalQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbParamChangeSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of AWR database parameters was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseParameterCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarize AWR datbase parameter history information. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseParameters?\n awrSourceDatabaseIdentifier=123456&beginSnapshotIdentifierGreaterThanOrEqualTo=5&endSnapshotIdentifierLessThanOrEqualTo=10&name=_datapump_inherit_svcname\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_PARAMETER_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"_datapump_inherit_svcname\", \"beginValue\": \"v1\", \"endValue\": \"v2\", \"isChanged\": true\n },\n {\n \"name\":\"parameter2\", \"beginValue\": \"v1\", \"endValue\": null, \"isChanged\": false\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseReport: get: description: 'Gets the AWR report for the specified database. ' operationId: GetAwrDatabaseReport parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrDbReportTypeQueryParam' - $ref: '#/components/parameters/ReportFormatQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The AWR report was retrieved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the AWR database report. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseReport?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_REPORT\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"content\": \"...\",\n \"format\":\"HTML\"\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseSnapshotRanges: get: description: 'Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified AWRHub. ' operationId: SummarizeAwrDatabaseSnapshotRanges parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/EntityNameOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/AwrDbSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of AWR snapshot ranges was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseSnapshotRangeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes AWR snapshot ranges. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseSnapshotRanges?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SNAPSHOT_RANGE_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"awrSourceDatabaseIdentifier\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [1],\n \"timeDbStartup\": \"2020-10-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-10-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-11-04T19:00:29Z\",\n \"firstSnapshotIdentifier\": 2,\n \"latestSnapshotIdentifier\": 5,\n \"snapshotCount\": 4,\n \"snapshotIntervalInMin\": 60,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"awrSourceDatabaseIdentifier\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [1],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotIdentifier\": 48,\n \"latestSnapshotIdentifier\": 248,\n \"snapshotCount\": 201,\n \"snapshotIntervalInMin\": 60,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"awrSourceDatabaseIdentifier\": 1586624638,\n \"dbName\":\"db2\",\n \"instanceList\": [1],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotIdentifier\": 4,\n \"latestSnapshotIdentifier\": 8,\n \"snapshotCount\": 5,\n \"snapshotIntervalInMin\": 60,\n \"dbVersion\": \"18.0.0.0.0\"\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseSnapshots: get: description: 'Lists AWR snapshots for the specified database in the AWR. ' operationId: ListAwrDatabaseSnapshots parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/AwrDbSnapSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of AWR snapshots was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseSnapshotCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the AWR snapshots for specified database. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseSnapshots?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SNAPSHOT_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"awrSourceDatabaseIdentifier\": 1586624637,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"snapshotId\": 216,\n \"errorCount\": 0,\n \"timeBegin\": \"2020-12-03T18:00:41Z\",\n \"timeEnd\": \"2020-12-03T19:00:50Z\"\n },\n {\n \"awrSourceDatabaseIdentifier\": 1586624637,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"snapshotId\": 217,\n \"errorCount\": 0,\n \"timeBegin\": \"2020-12-03T19:00:53Z\",\n \"timeEnd\": \"2020-12-03T20:00:55Z\"\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseSqlReport: get: description: 'Gets the SQL health check report for one SQL of the specified database. ' operationId: GetAwrDatabaseSqlReport parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/SqlIdQueryParam' - $ref: '#/components/parameters/ReportFormatQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The AWR report for the SQL statement was retrieved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseSqlReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the SQL health check report for the SQL statement specified by the SQL ID. The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/awrHubs/{awrHubId}/awrDatabaseReport). tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/AwrDatabaseSqlReport?\n awrSourceDatabaseIdentifier=123456&beginSnapshotIdentifierGreaterThanOrEqualTo=5&endSnapshotIdentifierLessThanOrEqualTo=10\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_SQL_REPORT\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"content\": \"...\",\n \"format\":\"HTML\"\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseSysstats: get: description: 'Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic. ' operationId: SummarizeAwrDatabaseSysstats parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNamesQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbNameSampledBeginTimeSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of the AWR SYSSTAT sample data was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseSysstatCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes AWR Sysstat sample data for specified database. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseSysstats?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=user calls\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SYSSTAT_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\", \"avgValue\": .66, \"currentValue\": 0.5\n },\n {\n \"name\":\"user logouts cumulative\", \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\", \"avgValue\": .6, \"currentValue\": 0.4\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseTopWaitEvents: get: description: 'Summarizes the AWR top wait events. ' operationId: SummarizeAwrDatabaseTopWaitEvents parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/SessionTypeQueryParam' - $ref: '#/components/parameters/AwrDbTopNQueryParam' - $ref: '#/components/parameters/AwrDbTopEventSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of AWR top wait events was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseTopWaitEventCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes AWR top N wait events. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseTopWaitEvents?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\n<authorization and other headers>\n{\n \"name\": \"AWRDB_TOP_EVENT_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"avgWaitTimePerSec\": .66, \"waitsPerSec\": 0.5\n },\n {\n \"name\":\"event 2\", \"avgWaitTimePerSec\": .6, \"waitsPerSec\": 0.4\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseWaitEventBuckets: get: description: 'Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR. ' operationId: SummarizeAwrDatabaseWaitEventBuckets parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNameQueryParam' - $ref: '#/components/parameters/AwrNumBucketOptionalQueryParam' - $ref: '#/components/parameters/AwrMinValueOptionalQueryParam' - $ref: '#/components/parameters/AwrMaxValueOptionalQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbCategoryPercSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of AWR wait event data in value buckets was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseWaitEventBucketCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarize AWR event data into value buckets and frequencies for specified database. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseWaitEventBuckets\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\n<authorization and other headers>\n{\n \"name\": \"AWRDB_EVENT_HISTOGRAM_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"categroy\":\" < 2um\", \"percentage\": 0.2\n },\n {\n \"categroy\":\" < 3um\", \"percentage\": 0.\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabaseWaitEvents: get: description: 'Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event. ' operationId: SummarizeAwrDatabaseWaitEvents parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/EntityNamesOptionalQueryParam' - $ref: '#/components/parameters/SessionTypeQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/AwrDbNameSampledBeginTimeSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The summary of the AWR wait event sample data was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseWaitEventCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes AWR wait event sample data. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabaseWaitEvents?\n awrSourceDatabaseIdentifier=123456&timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\n<authorization and other headers>\n{\n \"name\": \"AWRDB_EVENT_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"snapshotId\": 5, \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\", \"avgWaitTimePerSec\": .66, \"waitsPerSec\": 0.5\n },\n {\n \"name\":\"user logouts cumulative\", \"snapshotId\": 6, \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\", \"avgWaitTimePerSec\": .6, \"waitsPerSec\": 0.4\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrDatabases: get: description: 'Gets the list of databases and their snapshot summary details available in the AWRHub. ' operationId: ListAwrDatabases parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/EntityNameOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/AwrDbSortByQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of databases and their snapshot summary details was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrDatabaseCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of AWR database information. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrDatabases\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [{\n \"awrSourceDatabaseIdentifier\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [1],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:00Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotIdentifier\": 48,\n \"latestSnapshotIdentifier\": 248,\n \"snapshotCount\": 201,\n \"snapshotIntervalInMin\": 60,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"awrSourceDatabaseIdentifier\": 1586624638,\n \"dbName\":\"db2\",\n \"instanceList\": [1],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotIdentifier\": 4,\n \"latestSnapshotIdentifier\": 8,\n \"snapshotCount\": 5,\n \"snapshotIntervalInMin\": 60,\n \"dbVersion\": \"18.0.0.0.0\"\n }\n ]\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrReport: get: description: 'Gets the AWR report for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not be greater than 7 days. Either beginSnapshotIdentifierGreaterThanOrEqualTo & endSnapshotIdentifierLessThanOrEqualTo params Or timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are required. ' operationId: GetAwrReport parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParamRequired' - $ref: '#/components/parameters/AwrReportFormatOptionalQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndSnapshotIdentifierOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The AWR report was retrieved successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the AWR report for the specified source database in the AWR hub. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrSourceDatabases/<awrSourceDatabaseIdentifier>/awrReport?\ntimeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\nHost: operationsinsights-dev.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"content\": \"...\",\n \"format\":\"HTML\"\n}\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrSnapshots: get: description: 'Lists AWR snapshots for the specified source database in the AWR hub. The difference between the timeGreaterThanOrEqualTo and timeLessThanOrEqualTo should not exceed an elapsed range of 1 day. The timeGreaterThanOrEqualTo & timeLessThanOrEqualTo params are optional. If these params are not provided, by default last 1 day snapshots will be returned. ' operationId: ListAwrSnapshots parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/AwrSourceDatabaseIdentifierQueryParamRequired' - $ref: '#/components/parameters/AwrSnapshotBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/AwrSnapshotEndTimeOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AwrSnapshotSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of AWR snapshots was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AwrSnapshotCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists AWR snapshots for the specified source database in the AWR hub. tags: - operationsInsights x-example: "GET /20200630/awrHubs/<awrHubId>/awrSourceDatabases/<awrSourceDatabaseIdentifier>/awrSnapshots?\ntimeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\nHost: operationsinsights-dev.us-phoenix-1.oci.oraclecloud.com\n <authorization and other headers>\n {\n \"items\": [{\n \"awrSourceDatabaseId\": \"234123\",\n \"snapshotId\": 123,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"timeSnapshotBegin\": \"2020-12-03T18:00:41Z\",\n \"timeSnapshotEnd\": \"2020-12-03T19:00:50Z\",\n \"errorCount\": 0\n },\n {\n \"awrSourceDatabaseId\": \"234124\",\n \"snapshotId\": 124,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"timeSnapshotBegin\": \"2020-12-03T19:00:41Z\",\n \"timeSnapshotEnd\": \"2020-12-03T20:00:50Z\",\n \"errorCount\": 0\n }]\n }\n" x-related-resource: '#/definitions/AwrHubs' /awrHubs/{awrHubId}/awrSourcesSummary: get: description: 'Gets a list of summary of AWR Sources. ' operationId: SummarizeAwrSourcesSummaries parameters: - $ref: '#/components/parameters/AwrHubIdPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/AwrSourceNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AwrSourcesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned the list of AWR Sources for given AWR hub. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeAwrSourcesSummariesCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of summary of AWR Sources. tags: - operationsInsights x-related-resource: '#/definitions/AwrHubs' /chargebackPlanReport: get: description: Gets a list of Ops Insights chargeback plan reports for a resource. operationId: ListChargebackPlanReports parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ChargebackPlanReportSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of chargeback plan reports successfully retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlanReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Ops Insights chargeback plan reports for a resource. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' post: description: Creates a chargeback plan report for a resource in Ops Insights operationId: CreateChargebackPlanReport parameters: - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Chargeback plan report will be created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlanReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a chargeback plan report for a resource in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateChargebackPlanReportDetails' description: Details for the chargeback plan report to be created in Ops Insights. required: true /chargebackPlanReport/{chargebackPlanReportId}: delete: description: Deletes a chargeback plan report if it's not assigned to any resource. operationId: DeleteChargebackPlanReport parameters: - $ref: '#/components/parameters/ChargebackPlanReportIdPathParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The chargeback plan report will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a chargeback plan report tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' get: description: Gets the details of the specified chargeback plan plan report operationId: GetChargebackPlanReport parameters: - $ref: '#/components/parameters/ChargebackPlanReportIdPathParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the chargeback plan report for a given resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlanReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of the specified chargeback plan report for a resource tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' put: description: Updates one or more attributes of the specified chargeback plan report. operationId: UpdateChargebackPlanReport parameters: - $ref: '#/components/parameters/ChargebackPlanReportIdPathParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Ops Insights chargeback plan report details will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates one or more attributes of the specified chargeback plan report. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateChargebackPlanReportDetails' description: The details used to update a chargeback plan report. required: true /chargebackPlanReport/{chargebackPlanReportId}/content: get: description: Generates the chargeback report in csv format for a specified time interval operationId: GetChargebackPlanReportContent parameters: - $ref: '#/components/parameters/ChargebackPlanReportIdPathParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/ResourceTypeQueryParam' - $ref: '#/components/parameters/RelativeTimeIntervalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Generates the chargeback plan report for a given resource in specified time interval headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Generates the chargeback report in csv format for a given resource tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' /chargebackPlans: get: description: Gets a list of Ops Insights chargeback plans. operationId: ListChargebackPlans parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ChargebackPlanIdQueryParamOptional' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ChargebackPlanSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of chargeback plans successfully retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlanCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Ops Insights chargeback plans. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' post: description: 'Create a chargeback plan resource for the resource in Ops Insights. ' operationId: CreateChargebackPlan parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The chargeback plan is being created. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Ops Insights chargeback plan resource tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateChargebackPlanDetails' description: Details to create a new chargeback plan resource. required: true /chargebackPlans/{chargebackplanId}: delete: description: Deletes a chargeback plan if it's not assigned to any resource. operationId: DeleteChargebackPlan parameters: - $ref: '#/components/parameters/ChargebackPlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The chargeback plan will be deleted in Ops Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a chargeback plan. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' get: description: Gets the details of the specified chargeback plan. operationId: GetChargebackPlan parameters: - $ref: '#/components/parameters/ChargebackPlanIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the chargeback plan for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ChargebackPlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of the specified chargeback plan tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' put: description: Updates one or more attributes of the specified chargeback plan. operationId: UpdateChargebackPlan parameters: - $ref: '#/components/parameters/ChargebackPlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Ops Insights chargeback plan details will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates one or more attributes of the specified chargeback plan. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateChargebackPlanDetails' description: The details used to update a chargeback plan. required: true /chargebackPlans/{chargebackplanId}/actions/changeCompartment: post: description: Moves a Chargeback Plan insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeChargebackPlanCompartment parameters: - $ref: '#/components/parameters/ChargebackPlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Chargeback Plan resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/ChargebackPlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeChargebackPlanCompartmentDetails' description: The information to be updated. required: true /databaseInsights: get: description: 'Gets a list of database insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insights in that compartment and in all sub-compartments will be returned. ' operationId: ListDatabaseInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ListDatabaseInsightsEnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ResourceStatusQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightSummaryFieldsQueryParam' - $ref: '#/components/parameters/DatabaseInsightCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DatabaseInsightCollectionSortByQueryParam' - $ref: '#/components/parameters/ExadataInsightIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DatabaseInsightSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DatabaseInsightsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of database insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' post: description: 'Create a Database Insight resource for a database in Operations Insights. The database will be enabled in Operations Insights. Database metric collection and analysis will be started. ' operationId: CreateDatabaseInsight parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The database insight resource is being created. The database will be enabled in Operations Insights. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a Database Insight resource for a database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDatabaseInsightDetails' description: Details for the database for which a Database Insight resource will be created in Operations Insights. required: true /databaseInsights/actions/ingestAddmReports: post: description: 'This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. ' operationId: IngestAddmReports parameters: - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted SQL text to Operations Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: "For optimistic concurrency control. See `if-match`. \n" schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestAddmReportsResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the addm reports payload and persists it in Operation Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestAddmReportsDetails' description: Collection of addm reports for a particular database. required: true /databaseInsights/actions/ingestDatabaseConfiguration: post: description: This is a generic ingest endpoint for all database configuration metrics. operationId: IngestDatabaseConfiguration parameters: - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted the database metrics to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestDatabaseConfigurationResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the database configuration metrics payload and persists it in the Ops Insights Service. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestDatabaseConfigurationDetails' description: Payload for one or more database configuration metrics for a particular database. required: true /databaseInsights/actions/ingestMySqlSqlStatsMetric: post: description: 'The MySql SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified. ' operationId: IngestMySqlSqlStats parameters: - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted MySql SQL stats metrics to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestMySqlSqlStatsResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the MySql SQL Stats metrics payload and persists it in Ops Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestMySqlSqlStatsDetails' description: Collection of MySql SQL stats objects for a particular database. required: true /databaseInsights/actions/ingestMySqlSqlText: post: description: 'The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. Disclaimer: SQL text being uploaded explicitly via APIs is already masked. All sensitive literals contained in the sqlFullText column are masked prior to ingestion. ' operationId: IngestMySqlSqlText parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted MySql SQL text to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestMySqlSqlTextResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the sql text metrics payload and persists it in Operation Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestMySqlSqlTextDetails' description: Collection of SQL text objects for a particular database. required: true /databaseInsights/actions/ingestSqlBucket: post: description: 'The sqlbucket endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified. ' operationId: IngestSqlBucket parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted SQL bucket metrics to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestSqlBucketResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the bucket metrics payload and persists it in Ops Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestSqlBucketDetails' description: Collection of SQL bucket objects for a particular database. required: true /databaseInsights/actions/ingestSqlPlanLines: post: description: 'The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. ' operationId: IngestSqlPlanLines parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted SQL plan lines to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestSqlPlanLinesResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the sql plan lines payload and persists it in Operation Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestSqlPlanLinesDetails' description: Collection of SQL plan line objects for a particular database. required: true /databaseInsights/actions/ingestSqlStatsMetric: post: description: 'The SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified. ' operationId: IngestSqlStats parameters: - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted SQL stats metrics to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestSqlStatsResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the SQL Stats metrics payload and persists it in Ops Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestSqlStatsDetails' description: Collection of SQL stats objects for a particular database. required: true /databaseInsights/actions/ingestSqlText: post: description: 'The SqlText endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified. Disclaimer: SQL text being uploaded explicitly via APIs is not masked. Any sensitive literals contained in the sqlFullText column should be masked prior to ingestion. ' operationId: IngestSqlText parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted SQL text to Ops Insights service. Example: `message: Payload successfully uploaded.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestSqlTextResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the sql text metrics payload and persists it in Operation Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestSqlTextDetails' description: Collection of SQL text objects for a particular database. required: true /databaseInsights/actions/testMacsManagedCloudDatabaseInsightConnectionDetails: post: description: Test the connection details of a Cloud MACS-managed database. operationId: TestMacsManagedCloudDatabaseInsightConnection parameters: - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The connection details of a Cloud MACS managed database insight will be tested. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Test the connection details of a Cloud MACS-managed database. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/TestMacsManagedCloudDatabaseInsightConnectionDetails' description: The database connection information for the Cloud MACS-managed database. required: true /databaseInsights/addmDbFindingCategories: get: description: 'Gets list of ADDM finding categories. ' operationId: ListAddmDbFindingCategories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbFindingCategoryQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Returns a list of ADDM finding categories headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbFindingCategoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets list of ADDM finding categories tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbFindings: get: description: 'Summarizes ADDM findings for the specified databases. ' operationId: SummarizeAddmDbFindings parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/AddmDbFindingsCategoryNameOptionalQueryParameter' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbFindingSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: ADDM findings summary data headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbFindingAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes ADDM findings for the specified databases tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbFindingsTimeSeries: get: description: 'Get the ADDM findings time series for the specified databases for a given time period. ' operationId: ListAddmDbFindingsTimeSeries parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/AddmDbFindingsCategoryNameOptionalQueryParameter' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbFindingsTimeSeriesSortByQueryParameter' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Succesfully returned the ADDM findings time series for a database. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbFindingsTimeSeriesCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the ADDM findings time series for the specified databases. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbParameterCategories: get: description: 'Gets list of ADDM database parameter categories for the specified databases. ' operationId: ListAddmDbParameterCategories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbParameterCategoryQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Returns a list of ADDM database parameter categories headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbParameterCategoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets list of ADDM database parameter categories tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbParameterChanges: get: description: 'Summarizes the AWR database parameter change history for the specified parameter. There will be one element for each time that parameter changed during the specified time period. This API is limited to only one parameter per request. ' operationId: SummarizeAddmDbParameterChanges parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/NameRequiredQueryParam' - $ref: '#/components/parameters/ValueContainsOptionalQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbParameterChangeSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: List of AWR database parameter changes headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbParameterChangeAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes the AWR database parameter change history tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbParameters: get: description: 'Summarizes database parameter history information for the specified databases. Return a list of parameters with information on whether the parameter values were changed or not within the specified time period. The response does not include the individual parameter changes within the time period. ' operationId: SummarizeAddmDbParameters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ParameterCategoryNameOptionalQueryParam' - $ref: '#/components/parameters/NameOrValueContainsOptionalQueryParam' - $ref: '#/components/parameters/IsChangedOptionalQueryParam' - $ref: '#/components/parameters/IsDefaultOptionalQueryParam' - $ref: '#/components/parameters/HasRecommendationsOptionalQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbParameterSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: List of AWR database parameters headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbParameterAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes database parameter history information tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbRecommendationCategories: get: description: 'Gets list of ADDM recommendation categories for the specified databases. ' operationId: ListAddmDbRecommendationCategories parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbRecommendationCategoryQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Returns a list of ADDM recommendation categories headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbRecommendationCategoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets list of ADDM recommendation categories tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbRecommendations: get: description: 'Summarizes ADDM recommendations for the specified databases. ' operationId: SummarizeAddmDbRecommendations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/AddmDbRecommendationCategoryNameOptionalQueryParameter' - $ref: '#/components/parameters/AddmDbFindingIdentifierOptionalQueryParam' - $ref: '#/components/parameters/SqlIdOptionalQueryParam' - $ref: '#/components/parameters/OwnerOrNameContainsOptionalQueryParam' - $ref: '#/components/parameters/NameContainsOptionalQueryParam' - $ref: '#/components/parameters/NameOptionalQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbRecommendationSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: ADDM recommendations summary data headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbRecommendationAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes ADDM recommendations for the specified databases tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbRecommendationsTimeSeries: get: description: 'Gets time series data for ADDM recommendations for the specified databases. ' operationId: ListAddmDbRecommendationsTimeSeries parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/InstanceNumberOptionalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/AddmDbRecommendationCategoryNameOptionalQueryParameter' - $ref: '#/components/parameters/SqlIdOptionalQueryParam' - $ref: '#/components/parameters/OwnerOrNameContainsOptionalQueryParam' - $ref: '#/components/parameters/NameContainsOptionalQueryParam' - $ref: '#/components/parameters/NameOptionalQueryParam' - $ref: '#/components/parameters/PaginationLargeLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AddmDbRecommendationTimeSeriesSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: ADDM recommendations time series data headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbRecommendationsTimeSeriesCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets time series data for ADDM recommendations for the specified databases tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbSchemaObjects: get: description: 'Summarizes Schema objects for the specified databases for the specified objectIdentifiers ' operationId: SummarizeAddmDbSchemaObjects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ObjectIdsRequiredQueryParamRequired' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Schema object summary data headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbSchemaObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes Schema objects for the specified databases for the specified objectIdentifiers tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbSqlStatements: get: description: 'Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers ' operationId: SummarizeAddmDbSqlStatements parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/AddmSqlIdentifiersQueryParamRequired' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: SQL Statements summary data headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbSqlStatementCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/addmDbs: get: description: 'Gets a list of ADDM database information ' operationId: ListAddmDbs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderDescQueryParam' - $ref: '#/components/parameters/AddmDbSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: List of databases with their ADDM information. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddmDbCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of ADDM database information tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/databaseConfigurations: get: description: 'Gets a list of database insight configurations based on the query parameters specified. Either compartmentId or databaseInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of database insight configurations in that compartment and in all sub-compartments will be returned. ' operationId: ListDatabaseConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ListDatabaseInsightsEnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseConfigurationCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DatabaseConfigurationCollectionSortByQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: A page of DatabaseConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DatabaseConfigurationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of database insights configuration. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceCapacityTrend: get: description: 'Returns response with time series data (endTimestamp, capacity, baseCapacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeDatabaseInsightResourceCapacityTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/UtilizationLevelQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CapacityTrendSortByQueryParam' - $ref: '#/components/parameters/TablespaceNameQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: 'Successfully returned aggregated base and maximum capacity for a specified time period. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceCapacityTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get base and maximum capacity for a resource type. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceForecastTrend: get: description: 'Get Forecast predictions for CPU and Storage resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeDatabaseInsightResourceForecastTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/ForecastModelQueryParam' - $ref: '#/components/parameters/UtilizationLevelQueryParam' - $ref: '#/components/parameters/ConfidenceQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/TablespaceNameQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned historical data and forecast predictions. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceForecastTrendAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Forecast predictions for host resources. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceStatistics: get: description: 'Lists the Resource statistics (usage,capacity, usage change percent, utilization percent, base capacity, isAutoScalingEnabled) for each database filtered by utilization level in a compartment and in all sub-compartments if specified. ' operationId: SummarizeDatabaseInsightResourceStatistics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/InsightByQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ResourceStatisticsSortByQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned current resource statistics and database details. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceStatisticsAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the Resource statistics for each database tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceUsageSummary: get: description: 'A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeDatabaseInsightResourceUsage parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' responses: 200: description: Successfully returned aggregated usage,capacity and usage change percent for the current time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceUsageAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get aggregated usage, capacity and usage change percentage summed across databases for the current time period. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceUsageTrend: get: description: 'Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeDatabaseInsightResourceUsageTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TrendSortByQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' responses: 200: description: Successfully returned aggregated usage and capacity for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceUsageTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets aggregate usage and capacity for a resource type. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/resourceUtilizationInsight: get: description: 'Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeDatabaseInsightResourceUtilizationInsight parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/IsDatabaseInstanceLevelMetrics' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned current and projected resource utilization insights headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightResourceUtilizationInsightAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets current and projected utilization insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlInsights: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance insights for SQLs taking greater than X% database time for a given time period across the given databases or database \ntypes in a compartment and in all sub-compartments if specified.\n" operationId: SummarizeSqlInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/DbTimePercentGreaterThanQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: Successfully returned SQL insights for one or more databases. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlInsightAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get performance Insights for SQLs across databases. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlPlanInsights: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period.\nEither databaseId or id must be specified.\n" operationId: SummarizeSqlPlanInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned execution plan insights for a SQL. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlPlanInsightAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get performance insights on execution plans for a SQL. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlPlans: get: description: 'Query SQL Warehouse to list the plan xml for a given SQL execution plan. This returns a SqlPlanCollection object, but is currently limited to a single plan. Either databaseId or id must be specified. ' operationId: ListSqlPlans parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/PlanHashMultiQueryParamRequired' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned plan xml for a SQL execution plan. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlPlanCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the plan xml for a SQL execution plan tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlResponseTimeDistributions: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to summarize the response time distribution of query executions for a given SQL for a given time period. Either databaseId or id must be specified.\n" operationId: SummarizeSqlResponseTimeDistributions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned response time distribution of query executions for a SQL. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlResponseTimeDistributionAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Summarize response time distribution of query executions for a SQL tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlSearches: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nSearch SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified.\nAnd get the SQL Text and the details of the databases executing the SQL for a given time period.\n" operationId: ListSqlSearches parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Successfully returned SQL Text and the details of the databases executing the SQL. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlSearchCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Search SQL by SQL Identifier across databases. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlStatistics: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given\ntime period across the given databases or database types in a compartment and in all sub-compartments if specified.\n" operationId: SummarizeSqlStatistics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseTypesQueryParam' - $ref: '#/components/parameters/DatabaseIdsQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/DbTimePercentGreaterThanQueryParam' - $ref: '#/components/parameters/SqlIdentifiersQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/StatisticsSortByQueryParam' - $ref: '#/components/parameters/StatisticsCategoryQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: Successfully returned SQL statistics for one of more databases. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlStatisticAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get performance statistics for SQLs across databases. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlStatisticsTimeSeries: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a\ngiven time period in a compartment and in all sub-compartments if specified.\n" operationId: SummarizeSqlStatisticsTimeSeries parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/TimeSeriesDatabaseIdsQueryParam' - $ref: '#/components/parameters/TimeSeriesDatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/HostNamesQueryParam' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: Successfully returned SQL statistics time series by one or more databases. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlStatisticsTimeSeriesAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get performance statistics time series for a SQL across one or more databases tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlStatisticsTimeSeriesByPlan: get: description: "This API was deprecated May 2024 and is no longer functional as of May 31st, 2025. \nQuery SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period.\nEither databaseId or id must be specified.\n" operationId: SummarizeSqlStatisticsTimeSeriesByPlan parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/SqlIdentifierQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned performance statistics time series for a SQL by execution plans. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlStatisticsTimeSeriesByPlanAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get performance statistics time series for a SQL by execution plans tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/sqlTexts: get: description: 'Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified. ' operationId: ListSqlTexts parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/SqlTextDatabaseIdsQueryParam' - $ref: '#/components/parameters/SqlTextDatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/SqlIdentifiersQueryParamRequired' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' responses: 200: description: Successfully returned SQL Text for a SQL. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlTextCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get SQL Text for a SQL tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/tablespaceUsageTrend: get: description: 'Returns response with usage time series data (endTimestamp, usage, capacity) with breakdown by tablespaceName for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Either databaseId or id must be specified. ' operationId: SummarizeDatabaseInsightTablespaceUsageTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/DatabaseIdQueryParam' - $ref: '#/components/parameters/DatabaseInsightIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned usage tablespace metrics for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeDatabaseInsightTablespaceUsageTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets tablespace usage metrics for a database. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/{databaseInsightId}: delete: description: Deletes a database insight. The database insight will be deleted and cannot be enabled again. operationId: DeleteDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This database insight will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a database insight. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' get: description: Gets details of a database insight. operationId: GetDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the DatabaseInsight with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of a database insight. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' put: description: Updates configuration of a database insight. operationId: UpdateDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The DatabaseInsight will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of a database insight. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDatabaseInsightDetails' description: The configuration to be updated. required: true /databaseInsights/{databaseInsightId}/actions/changeAutonomousDatabaseInsightAdvancedFeatures: post: description: Update connection detail for advanced features of Autonomous Database in Operations Insights. operationId: ChangeAutonomousDatabaseInsightAdvancedFeatures parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The DatabaseInsight will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update advanced features for Autonomous Database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAutonomousDatabaseInsightAdvancedFeaturesDetails' description: Details for the advanced features of Autonomous Database in Operations Insights. required: true /databaseInsights/{databaseInsightId}/actions/changeCompartment: post: description: Moves a DatabaseInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeDatabaseInsightCompartment parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The DatabaseInsight resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDatabaseInsightCompartmentDetails' description: The information to be updated. required: true /databaseInsights/{databaseInsightId}/actions/changeExternalMysqlDatabaseInsightConnectionDetails: post: deprecated: true description: 'MySQL support within the OCI Ops Insights service has been deprecated as of January 29, 2026. Change the connection details of an External MySQL database insight. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeExternalMysqlDatabaseInsightConnection parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The connection details of an External MySQL database insight will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the connection details of a External Mysql database insight. tags: - operationsInsights x-example: "UPDATE /20200630/databaseInsights/<databaseInsightId>/actions/changeExternalMysqlDatabaseInsightConnectionDetails\n<authorization and other headers>\n{\n \"ChangeExternalMysqlDatabaseInsightConnectionDetails\": {\n \"databaseConnectorId\" : \"databaseConnectorOcid\"\n }\n}\n" x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExternalMysqlDatabaseInsightConnectionDetails' description: The information to be updated. required: true /databaseInsights/{databaseInsightId}/actions/changeMacsManagedCloudDatabaseInsightConnectionDetails: post: description: Change the connection details of a Cloud MACS-managed database insight. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeMacsManagedCloudDatabaseInsightConnection parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The connection details of a Cloud MACS managed database insight will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the connection details of a Cloud MACS-managed database insight. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMacsManagedCloudDatabaseInsightConnectionDetails' description: The information to be updated. required: true /databaseInsights/{databaseInsightId}/actions/changePeComanagedDatabaseInsightDetails: post: description: Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource. operationId: ChangePeComanagedDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The connection details or private endpoint of co managed database insight will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Change the connection details or private endpoint of co managed database insight. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePeComanagedDatabaseInsightDetails' description: The information to be updated. required: true /databaseInsights/{databaseInsightId}/actions/disable: post: description: Disables a database in Operations Insights. Database metric collection and analysis will be stopped. operationId: DisableDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The DatabaseInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables a database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/{databaseInsightId}/actions/disableAutonomousDatabaseInsightAdvancedFeatures: post: description: Disable advanced features for an Autonomous Database in Operations Insights. The connection detail and advanced features will be removed. operationId: DisableAutonomousDatabaseInsightAdvancedFeatures parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Advance feature for DatabaseInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disable advanced features for an Autonomous Database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' /databaseInsights/{databaseInsightId}/actions/enable: post: description: Enables a database in Operations Insights. Database metric collection and analysis will be started. operationId: EnableDatabaseInsight parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The DatabaseInsight will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables a database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableDatabaseInsightDetails' description: Details for the database to be enabled in Operations Insights. required: true /databaseInsights/{databaseInsightId}/actions/enableAutonomousDatabaseInsightAdvancedFeatures: post: description: Enables advanced features for an Autonomous Database in Operations Insights. A direct connection will be available for further collection. operationId: EnableAutonomousDatabaseInsightAdvancedFeatures parameters: - $ref: '#/components/parameters/DatabaseInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The direct connection detail will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables advanced features for an Autonomous Database in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/DatabaseInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableAutonomousDatabaseInsightAdvancedFeaturesDetails' description: Connection Details for the Autonomous Database in Operations Insights. required: true /enterpriseManagerBridges: get: description: 'Gets a list of Ops Insights Enterprise Manager bridges. Either compartmentId or id must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of bridges in that compartment and in all sub-compartments will be returned. ' operationId: ListEnterpriseManagerBridges parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/EnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/EnterpriseManagerBridgeSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of EnterpriseManagerBridgeSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EnterpriseManagerBridgeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Ops Insights Enterprise Manager bridges. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' post: description: 'Create a Enterprise Manager bridge in Operations Insights. ' operationId: CreateEnterpriseManagerBridge parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The Enterprise Manager bridge resource is being created. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EnterpriseManagerBridge' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a Enterprise Manager bridge in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEnterpriseManagerBridgeDetails' description: Details for the Enterprise Manager bridge to be created in Operations Insights. required: true /enterpriseManagerBridges/{enterpriseManagerBridgeId}: delete: description: Deletes an Operations Insights Enterprise Manager bridge. If any database insight is still referencing this bridge, the operation will fail. operationId: DeleteEnterpriseManagerBridge parameters: - $ref: '#/components/parameters/EnterpriseManagerBridgeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Enterprise Manager bridge will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Operations Insights Enterprise Manager bridge. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' get: description: Gets details of an Operations Insights Enterprise Manager bridge. operationId: GetEnterpriseManagerBridge parameters: - $ref: '#/components/parameters/EnterpriseManagerBridgeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the EnterpriseManagerBridge for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EnterpriseManagerBridge' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an Operations Insights Enterprise Manager bridge. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' put: description: Updates configuration of an Operations Insights Enterprise Manager bridge. operationId: UpdateEnterpriseManagerBridge parameters: - $ref: '#/components/parameters/EnterpriseManagerBridgeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Enterprise Manager bridge configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of an Operations Insights Enterprise Manager bridge. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEnterpriseManagerBridgeDetails' description: The configuration to be updated. required: true /enterpriseManagerBridges/{enterpriseManagerBridgeId}/actions/changeCompartment: post: description: Moves a EnterpriseManagerBridge resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeEnterpriseManagerBridgeCompartment parameters: - $ref: '#/components/parameters/EnterpriseManagerBridgeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The EnterpriseManagerBridge resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeEnterpriseManagerBridgeCompartmentDetails' description: The information to be updated. required: true /enterpriseManagerBridges/{enterpriseManagerBridgeId}/importableEnterpriseManagerEntities: get: description: 'Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before. ' operationId: ListImportableEnterpriseManagerEntities parameters: - $ref: '#/components/parameters/EnterpriseManagerBridgeIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/EnterpriseManagerEntityTypesQueryParam' - $ref: '#/components/parameters/EnterpriseManagerIdentifierQueryParam' - $ref: '#/components/parameters/EnterpriseManagerParentEntityIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ImportableEnterpriseManagerEntity objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportableEnterpriseManagerEntityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before. tags: - operationsInsights x-related-resource: '#/definitions/EnterpriseManagerBridges' /exadataInsights: get: description: 'Gets a list of Exadata insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of Exadata insights in that compartment and in all sub-compartments will be returned. ' operationId: ListExadataInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ListExadataInsightsEnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/ListExadataInsightExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ResourceStatusQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataInsightCollectionSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ExadataInsightSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExadataInsightSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Exadata insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' post: description: 'Create an Exadata insight resource for an Exadata system in Operations Insights. The Exadata system will be enabled in Operations Insights. Exadata-related metric collection and analysis will be started. ' operationId: CreateExadataInsight parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The Exadata insight resource is being created. The Exadata system will be enabled in Operations Insights. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Exadata insight resource for an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExadataInsightDetails' description: Details for the Exadata system for which an Exadata insight resource will be created in Operations Insights. required: true /exadataInsights/exadataConfigurations: get: description: Gets a list of exadata insight configurations. Either compartmentId or exadataInsightsId query parameter must be specified. operationId: ListExadataConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/ExadataConfigurationCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataConfigurationCollectionSortByQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ExadataConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExadataConfigurationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of exadata insights configuration. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/exadataMembers: get: description: Lists the software and hardware inventory of the Exadata System. operationId: SummarizeExadataMembers parameters: - $ref: '#/components/parameters/ExadataInsightIdQueryParamRequired' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataMemberCollectionSortByQueryParam' - $ref: '#/components/parameters/ExadataMemberCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Returns exadata members for an exadata system. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExadataMemberCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets software and hardware inventory for an exadata insight resource. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceCapacityTrend: get: description: 'Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system for a resource metric. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId, cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName is returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid values for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field. ' operationId: SummarizeExadataInsightResourceCapacityTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdQueryParamRequired' - $ref: '#/components/parameters/ExadataDatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataHostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataStorageServerNameQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ExadataCapacityTrendPaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataResourceCapacityTrendCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Successfully returned capacity for a specified time period. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceCapacityTrendCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets capacity for an exadata system. Either compartmentId or exadataInsightsId query parameter must be specified. tags: - operationsInsights x-example: "Sample 1: ResourceType as DISKGROUP and resourceMetric as STORAGE\n {\n \"exadataResourceMetric\" : \"STORAGE\",\n \"exadataResourceType\" : \"DISKGROUP\",\n \"usageUnit\": \"GB\",\n \"timeIntervalStart\" : \"2019-08-28T20:00:00.000Z\",\n \"timeIntervalEnd\" : \"2019-09-03T20:00:00.000Z\",\n \"itemDurationInMs\" : \"86400000\",\n \"items\": [\n {\n \"id\": \"NOT_APPLICABLE\",\n \"name\" : \"ASM_DBM01-c,DATAC1\",\n \"capacityData\" : [\n {\n \"endTimestamp:\": \"2019-08-28T20:00:00.000Z\",\n \"capacity\": \"895214.35\"\n },\n {\n \"endTimestamp:\": \"2019-08-29T20:00:00.000Z\",\n \"capacity\": \"895740.23\"\n },\n {\n \"endTimestamp:\": \"2019-08-30T20:00:00.000Z\",\n \"capacity\": \"895740.24\"\n },\n {\n \"endTimestamp:\": \"2019-08-31T20:00:00.000Z\",\n \"capacity\": \"895740.14\"\n }\n ]\n }\n ]\n }\n\nSample 2: ResourceType as DATABASE and resourceMetric as CPU\n {\n \"exadataResourceMetric\" : \"CPU\",\n \"exadataResourceType\" : \"DATABASE\",\n \"usageUnit\": \"GB\",\n \"timeIntervalStart\" : \"2019-08-28T20:00:00.000Z\",\n \"timeIntervalEnd\" : \"2019-09-03T20:00:00.000Z\",\n \"itemDurationInMs\" : \"86400000\",\n \"items\": [\n {\n \"id\": \"ocid1.databaseinsight.oc1.phx.aaaaaaaayriffv3yyzu5zevagn4kwvvzlo7ftnya67cqiafjmkedc5igqhda\",\n \"name\" : \"HRPROD\",\n \"capacityData\" : [\n {\n \"endTimestamp:\": \"2019-08-28T20:00:00.000Z\",\n \"totalHostCapacity\": \"985214.00\",\n \"capacity\": \"895214.35\"\n },\n {\n \"endTimestamp:\": \"2019-08-29T20:00:00.000Z\",\n \"totalHostCapacity\": \"985214.00\",\n \"capacity\": \"895740.23\"\n },\n {\n \"endTimestamp:\": \"2019-08-30T20:00:00.000Z\",\n \"totalHostCapacity\": \"985214.00\",\n \"capacity\": \"895740.24\"\n },\n {\n \"endTimestamp:\": \"2019-08-31T20:00:00.000Z\",\n \"totalHostCapacity\": \"985214.00\",\n \"capacity\": \"895740.14\"\n }\n ]\n }\n ]\n }\n" x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceCapacityTrendAggregated: get: description: 'Returns response with time series data (endTimestamp, capacity) for the time period specified for an exadata system or fleet aggregation for a resource metric. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. ' operationId: SummarizeExadataInsightResourceCapacityTrendAggregated parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataInsightCapacityTrendSortByQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Successfully returned aggregated capacity for a specified time period. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceCapacityTrendAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets capacity for an exadata system. Either compartmentId or exadataInsightsId query parameter must be specified. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceForecastTrend: get: description: 'Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts or storage servers. Additionally resources can be filtered using databaseInsightId, hostInsightId or storageServerName query parameters. Top five resources are returned if total exceeds the limit specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Database name is returned in name field. DatabaseInsightId , cdbName and hostName query parameter applies to ResourceType DATABASE. Valid values for ResourceType HOST are CPU and MEMORY. HostName s returned in name field. HostInsightId and hostName query parameter applies to ResourceType HOST. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. Storage server name is returned in name field for resourceMetric IOPS and THROUGHPUT and asmName is returned in name field for resourceMetric STORAGE. StorageServerName query parameter applies to ResourceType STORAGE_SERVER. Valid value for ResourceType DISKGROUP is STORAGE. Comma delimited (asmName,diskgroupName) is returned in name field. ' operationId: SummarizeExadataInsightResourceForecastTrend parameters: - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdQueryParamRequired' - $ref: '#/components/parameters/ExadataDatabaseInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataHostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataStorageServerNameQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastStartDayQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastDaysQueryParam' - $ref: '#/components/parameters/ForecastModelQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/ExadataForecastTrendPaginationLimitQueryParam' - $ref: '#/components/parameters/ConfidenceQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataResourceForecastTrendCollectionSortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned historical usage data and forecast predictions. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceForecastTrendCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get historical usage and forecast predictions for an exadata system with breakdown by databases, hosts,storage servers or diskgroup. tags: - operationsInsights x-example: "Sample \n {\n \"exadataInsightId\": \"oc1.exadatainsight.oc1.phx.abyhqljs7kyor2s4jhmkr2gdncj3bg2e52tsqcssadqrslbccdyngcfjexgq\",\n \"exadataResourceMetric\" : \"STORAGE\",\n \"exadataResourceType\" : \"DISKGROUP\",\n \"usageUnit\": \"GB\",\n \"timeIntervalStart\" : \"2020-02-02T19:00:00.000Z\",\n \"timeIntervalEnd\" : \"2016-02-07T19:00:00.000Z\",\n \"items\" : [\n {\n \"id\": \"NOT_APPLICABLE\",\n \"name\": \"ASM_DBM01,DATAC1\",\n \"daysToReachCapacity\" : 170,\n \"pattern\": \"WEEKLY_SEASONS\",\n \"selectedForecastAlgorithm\": \"NaiveForecaster\",\n \"historicalData\": [\n {\n \"endTimestamp:\": \"2020-02-02T19:00:00.000Z\",\n \"usage\": 26.53\n },\n {\n \"endTimestamp:\": \"2020-02-03T19:00:00.000Z\",\n \"usage\": 14.06\n },\n {\n \"endTimestamp:\": \"2020-02-04T19:00:00.000Z\",\n \"usage\": 26.17\n }\n ],\n \"projectedData\": [\n {\n \"endTimestamp:\": \"2020-03-02T19:00:00.000Z\",\n \"usage\": 23.52,\n \"lowValue\": 1.92,\n \"highValue\": 45.12\n },\n {\n \"endTimestamp:\": \"2020-03-03T19:00:00.000Z\",\n \"usage\": 23.51,\n \"lowValue\": 1.91,\n \"highValue\": 45.11\n },\n {\n \"endTimestamp:\": \"2020-03-04T19:00:00.000Z\",\n \"usage\": 23.51,\n \"lowValue\": 1.91,\n \"highValue\": 45.10\n }\n ]\n }\n ]\n }\n" x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceForecastTrendAggregated: get: description: 'Get aggregated historical usage and forecast predictions for resources. Either compartmentId or exadataInsightsId query parameter must be specified. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. ' operationId: SummarizeExadataInsightResourceForecastTrendAggregated parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastStartDayQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastDaysQueryParam' - $ref: '#/components/parameters/ForecastModelQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/ConfidenceQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned aggregated historical usage data and forecast predictions. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceForecastTrendAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get aggregated historical usage and forecast predictions for exadata systems. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceStatistics: get: description: 'Lists the Resource statistics (usage, capacity, usage change percent, utilization percent) for each resource based on resourceMetric filtered by utilization level. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS, THROUGHPUT. Valid value for ResourceType DISKGROUP is STORAGE. ' operationId: SummarizeExadataInsightResourceStatistics parameters: - $ref: '#/components/parameters/ExadataInsightIdQueryParamRequired' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataResourceStatisticsSortByQueryParam' - $ref: '#/components/parameters/ExadataStatisticsPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned current resource statistics and details. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceStatisticsAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the Resource statistics for each resource/member of the Exadata System (database, hosts, storage server or diskgroup). tags: - operationsInsights x-example: "Sample 1: ResourceType as DATABASE and resourceMetric as MEMORY\n {\n \"exadataResourceMetric\" : \"MEMORY\",\n \"exadataInsightId\": \"ocid1.opsiexadatainsight.oc1.phx.49686\",\n \"exadataDisplayName\": \"DBM01\",\n \"timeIntervalStart\" : \"2020-03-06T00:00:00.000Z\",\n \"timeIntervalEnd\" : \"2020-05-06T00:00:00.000Z\",\n \"usageUnit\": \"GB\",\n \"items\": [\n {\n \"exadataResourceType\" : \"DATABASE\",\n \"resourceDetails\" :\n {\n \"id\": \"ocid1.databaseinsight.oc1.phx.aaaaaaaayriffv3yyzu5zevagn4kwvvzlo7ftnya67cqiafjmkedc5igqhda\",\n \"databaseId\": \"NOT_APPLICABLE\",\n \"databaseName\": \"HR-PROD\",\n \"databaseDisplayName\": \"HRPROD\",\n \"databaseType\": \"EXTERNAL-PDB\",\n \"databaseVersion\": \"18.0.0\",\n \"cdbName\" : \"HRPROD-CDB\",\n \"instances\" : [{\"hostName\": \"host1\", \"instanceName\" : \"instance1\"}]\n },\n \"currentStatistics\": {\n \"usage\": 0.99,\n \"capacity\": 4,\n \"utilizationPercent\": 20.48,\n \"instanceMetrics\" : [\n {\n \"instanceName\" : \"instance1\",\n \"hostName\" : \"host1\",\n \"usage\" : 2.3,\n \"capacity\" : 8.0,\n \"utilizationPercent\": 20.48,\n \"usageChangePercent\": 3.5\n },\n {\n \"instanceName\" : \"instance2\",\n \"hostName\" : \"host2\",\n \"usage\" : 2.3,\n \"capacity\" : 8.0,\n \"utilizationPercent\": 20.48,\n \"usageChangePercent\": 3.5\n }\n ],\n \"usageChangePercent\": 0\n }\n }\n ]\n }\n\nSample 2: ResourceType as HOST and resourceMetric as CPU\n {\n \"exadataResourceMetric\" : \"CPU\",\n \"exadataInsightId\": \"ocid1.opsiexadatainsight.oc1.phx.49686\",\n \"exadataDisplayName\": \"DBM01\",\n \"timeIntervalStart\" : \"2020-03-06T00:00:00.000Z\",\n \"timeIntervalEnd\" : \"2020-05-06T00:00:00.000Z\",\n \"usageUnit\": \"CORES\",\n \"items\": [\n {\n \"exadataResourceType\" : \"HOST\",\n \"resourceDetails\" :\n {\n \"id\" : \"ocid1.hostinsight.oc1.phx.12345\",\n \"hostName\": \"hostName1\",\n \"hostDisplayName\": \"hostName1\",\n \"platformType\": \"LINUX\",\n \"agentIdentifier\": \"agent1\"\n },\n \"currentStatistics\": {\n \"usage\": 0.99,\n \"capacity\": 4,\n \"utilizationPercent\": 20.48,\n \"instanceMetrics\" : [],\n \"usageChangePercent\": 0\n }\n }\n ]\n }\n\nSample 3: ResourceType as STORAGE_SERVER and resourceMetric as STORAGE\n\n {\n \"exadataResourceMetric\" : \"STORAGE\",\n \"exadataInsightId\": \"ocid1.opsiexadatainsight.oc1.phx.49686\",\n \"exadataDisplayName\": \"DBM01\",\n \"timeIntervalStart\" : \"2020-03-06T00:00:00.000Z\",\n \"timeIntervalEnd\" : \"2020-05-06T00:00:00.000Z\",\n \"usageUnit\": \"CORES\",\n \"items\": [\n {\n \"exadataResourceType\" : \"STORAGE_SERVER\",\n \"resourceDetails\" :\n {\n \"storageServerName\" : \"DBM08cel03\",\n \"storageServerDisplayName\" : \"DBM08cel03\"\n },\n \"currentStatistics\": {\n \"usage\": 0.99,\n \"capacity\": 4,\n \"utilizationPercent\": 20.48,\n \"instanceMetrics\" : [],\n \"usageChangePercent\": 0\n }\n }\n ]\n }\nSample 4: ResourceType as DISKGROUP and resourceMetric as STORAGE\n\n {\n \"exadataResourceMetric\" : \"STORAGE\",\n \"exadataInsightId\": \"ocid1.opsiexadatainsight.oc1.phx.49686\",\n \"exadataDisplayName\": \"DBM01\",\n \"timeIntervalStart\" : \"2020-03-06T00:00:00.000Z\",\n \"timeIntervalEnd\" : \"2020-05-06T00:00:00.000Z\",\n \"usageUnit\": \"GB\",\n \"items\": [\n {\n \"exadataResourceType\" : \"DISKGROUP\",\n \"resourceDetails\" :\n {\n \"diskgroupName\" : \"DATAC1\",\n \"asmName\" : \"ASM_DBM01-c\"\n },\n \"currentStatistics\": {\n \"usage\": 0.99,\n \"capacity\": 4,\n \"utilizationPercent\": 20.48,\n \"instanceMetrics\" : [],\n \"usageChangePercent\": 0\n }\n },\n {\n \"exadataResourceType\" : \"STORAGE_SERVER\",\n \"resourceDetails\" :\n {\n \"diskgroupName\" : \"RECO\",\n \"asmName\" : \"ASM_DBM01-c\"\n },\n \"currentStatistics\": {\n \"usage\": 0.79,\n \"capacity\": 4,\n \"utilizationPercent\": 21.48,\n \"instanceMetrics\" : [],\n \"usageChangePercent\": 0\n }\n }\n ]\n }\n" x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceUsageSummary: get: description: 'A cumulative distribution function is used to rank the usage data points per resource within the specified time period. For each resource, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. ' operationId: SummarizeExadataInsightResourceUsage parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ExadataResourceUsageSummarySortByQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ExadataResourceUsageSummaryPaginationLimitQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned usage,capacity and usage change percent for the current time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceUsageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get usage, capacity and usage change percentage for exadata systems for the current time period. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceUsageSummaryAggregated: get: description: 'A cumulative distribution function is used to rank the usage data points per database within the specified time period. For each database, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. ' operationId: SummarizeExadataInsightResourceUsageAggregated parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned aggregated usage,capacity and usage change percent for the current time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceUsageAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get aggregated usage, capacity and usage change percentage summed across exadata systems for the current time period. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/resourceUtilizationInsight: get: description: Gets current utilization, projected utilization and days to reach projectedUtilization for an exadata system over specified time period. Valid values for ResourceType DATABASE are CPU,MEMORY,IO and STORAGE. Valid values for ResourceType HOST are CPU and MEMORY. Valid values for ResourceType STORAGE_SERVER are STORAGE, IOPS and THROUGHPUT. operationId: SummarizeExadataInsightResourceUtilizationInsight parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/ExadataResourceTypeQueryParam' - $ref: '#/components/parameters/ExadataResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataTypesQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastStartDayQueryParam' - $ref: '#/components/parameters/ExadataInsightForecastDaysQueryParam' - $ref: '#/components/parameters/CdbNamesQueryParam' - $ref: '#/components/parameters/ExadataHostNamesQueryParam' - $ref: '#/components/parameters/ExadataUtilizationInsightPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned current and projected resource utilization insights headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/SummarizeExadataInsightResourceUtilizationInsightAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets current utilization and projected insights for an exadata system. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/{exadataInsightId}: delete: description: Deletes an Exadata insight. The Exadata insight will be deleted and cannot be enabled again. operationId: DeleteExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This Exadata insight will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Exadata insight. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' get: description: Gets details of an Exadata insight. operationId: GetExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the ExadataInsight with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExadataInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an Exadata insight. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' put: description: Updates configuration of an Exadata insight. operationId: UpdateExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The ExadataInsight will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of an Exadata insight. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExadataInsightDetails' description: The configuration to be updated. required: true /exadataInsights/{exadataInsightId}/actions/addMembers: post: description: Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started. operationId: AddExadataInsightMembers parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The members of the Exadata system will be added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddExadataInsightMembersDetails' description: Details for the members (e.g. databases and hosts) of an Exadata system to be added in Operations Insights. required: true /exadataInsights/{exadataInsightId}/actions/changeCompartment: post: description: Moves an Exadata insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeExadataInsightCompartment parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Exadata insight resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeExadataInsightCompartmentDetails' description: The information to be updated. required: true /exadataInsights/{exadataInsightId}/actions/disable: post: description: Disables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be stopped. operationId: DisableExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The ExadataInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/{exadataInsightId}/actions/disablePlan: post: description: Disables a chargeback plan on an Exadata system in Operations Insights. Metering-related metric collection and analysis will be stopped. operationId: DisablePlanExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Chargeback plan on ExadataInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables a chargeback plan on an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' /exadataInsights/{exadataInsightId}/actions/enable: post: description: Enables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started. operationId: EnableExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The ExadataInsight will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableExadataInsightDetails' description: Details for the Exadata system to be enabled in Operations Insights. required: true /exadataInsights/{exadataInsightId}/actions/enablePlan: post: description: Enables a chargeback plan on an Exadata system in Operations Insights. Metering-related metric collection and analysis will be started. operationId: EnablePlanExadataInsight parameters: - $ref: '#/components/parameters/ExadataInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Chargeback plan on ExadataInsight will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables a chargeback plan on an Exadata system in Operations Insights. tags: - operationsInsights x-related-resource: '#/definitions/ExadataInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnablePlanExadataInsightDetails' description: Details for the Exadata system to be enabled in Operations Insights. required: true /hostInsights: get: description: 'Gets a list of host insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insights in that compartment and in all sub-compartments will be returned. ' operationId: ListHostInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ResourceStatusQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostInsightCollectionSortByQueryParam' - $ref: '#/components/parameters/ListHostInsightsEnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/ExadataInsightIdQueryParam' - $ref: '#/components/parameters/KubeClusterInsightIdQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of HostInsightSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/HostInsightSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of host insights. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' post: description: 'Create a Host Insight resource for a host in Ops Insights. The host will be enabled in Ops Insights. Host metric collection and analysis will be started. ' operationId: CreateHostInsight parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The host insight resource is being created. The host will be enabled in Ops Insights. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a Host Insight resource for a host in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHostInsightDetails' description: Details for the host for which a Host Insight resource will be created in Ops Insights. required: true /hostInsights/actions/ingestHostConfiguration: post: description: This is a generic ingest endpoint for all the host configuration metrics operationId: IngestHostConfiguration parameters: - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted the host configuration metrics to the Ops Insights service. Example: `message: Payload successfully uploaded to the Operation Insights ingest pipeline.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestHostConfigurationResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the host configuration metrics payload and persists it in the Ops Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestHostConfigurationDetails' description: Payload for one or more host configuration metrics for a particular host. required: true /hostInsights/actions/ingestHostMetrics: post: description: This is a generic ingest endpoint for all the host performance metrics operationId: IngestHostMetrics parameters: - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'Successfully posted the host performance metrics to the Ops Insights service. Example: `message: Payload successfully uploaded to the Operation Insights ingest pipeline.` ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IngestHostMetricsResponseDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Accepts the host performance metrics payload and persists it in the Ops Insights ingest pipeline. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/IngestHostMetricsDetails' description: Payload for one or more host performance metrics for a particular host. required: true /hostInsights/diskStatistics: get: description: 'Returns response with disk(s) statistics for a host. ' operationId: SummarizeHostInsightDiskStatistics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned unallocated space per disk for a host. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightsDiskStatisticsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets disk(s) statistics for a host. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/hostConfigurations: get: description: 'Gets a list of host insight configurations based on the query parameters specified. Either compartmentId or hostInsightId query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of host insight configurations in that compartment and in all sub-compartments will be returned. ' operationId: ListHostConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ListHostInsightsEnterpriseManagerBridgeIdQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostConfigurationCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostConfigurationCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: A page of HostConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/HostConfigurationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of host insights configuration. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/hostRecommendation: get: description: 'Returns response with some recommendations if apply for a host. ' operationId: SummarizeHostInsightHostRecommendation parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned recommendations for a host. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightHostRecommendationAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets recommendations for a host. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/hostedEntities: get: description: 'Get a list of hosted entities details. ' operationId: ListHostedEntities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/ExadataInsightIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedEntityCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' responses: 200: description: 'Successfully returned a list of hosted entities. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostedEntityCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of hosted entities details based on the query parameters specified. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/ioUsageTrend: get: description: 'Returns response with usage time series data with breakdown by IO interface for the time period specified. ' operationId: SummarizeHostInsightIoUsageTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully returned usage IO metrics for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightIoUsageTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets IO usage metrics for a host. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceCapacityTrend: get: description: 'Returns response with time series data (endTimestamp, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeHostInsightResourceCapacityTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/UtilizationLevelQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostCapacityTrendSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned aggregated capacity for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceCapacityTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets capacity for a resource type. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceForecastTrend: get: description: 'Get Forecast predictions for CPU or memory resources since a time in the past. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeHostInsightResourceForecastTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/StatisticQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/ForecastModelQueryParam' - $ref: '#/components/parameters/UtilizationLevelQueryParam' - $ref: '#/components/parameters/ConfidenceQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' - $ref: '#/components/parameters/ProcessHashQueryParam' responses: 200: description: Successfully returned historical data and forecast predictions. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceForecastTrendAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Forecast predictions for host resources. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceStatistics: get: description: 'Lists the resource statistics (usage, capacity, usage change percent, utilization percent, load) for each host filtered by utilization level in a compartment and in all sub-compartments if specified. ' operationId: SummarizeHostInsightResourceStatistics parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/InsightByQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostResourceStatisticsSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned current resource statistics and host details. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceStatisticsAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists the resource statistics for each host. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceUsageSummary: get: description: 'A cumulative distribution function is used to rank the usage data points per host within the specified time period. For each host, the minimum data point with a ranking > the percentile value is included in the summation. Linear regression functions are used to calculate the usage change percentage. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeHostInsightResourceUsage parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PercentileQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: Successfully returned aggregated usage,capacity and usage change percent for the current time period. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceUsageAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: 'Get aggregated CPU, or memory usage, capacity and usage change percentage summed across hosts for the current time period. ' tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceUsageTrend: get: description: 'Returns response with time series data (endTimestamp, usage, capacity) for the time period specified. The maximum time range for analysis is 2 years, hence this is intentionally not paginated. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeHostInsightResourceUsageTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TrendSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' responses: 200: description: Successfully returned aggregated usage and capacity for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceUsageTrendAggregationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets aggregate usage and capacity for a resource type. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/resourceUtilizationInsight: get: description: 'Gets resources with current utilization (high and low) and projected utilization (high and low) for a resource type over specified time period. If compartmentIdInSubtree is specified, aggregates resources in a compartment and in all sub-compartments. ' operationId: SummarizeHostInsightResourceUtilizationInsight parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PlatformTypesQueryParam' - $ref: '#/components/parameters/HostInsightIdsQueryParam' - $ref: '#/components/parameters/ExadataInsightIdsQueryParam' - $ref: '#/components/parameters/ForecastDaysQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam' - $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam' - $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ExadataInsightVMClusterNameQueryParam' - $ref: '#/components/parameters/HighUtilizationThresholdQueryParam' - $ref: '#/components/parameters/LowUtilizationThresholdQueryParam' responses: 200: description: Successfully returned current and projected resource utilization insights headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightResourceUtilizationInsightAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets current and projected utilization insights. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/topProcessesUsage: get: description: 'Returns response with aggregated data (timestamp, usageData) for top processes on a specific date. Data is aggregated for the time specified and processes are sorted descendent by the process metric specified (CPU, MEMORY, VIRTUAL_MEMORY). hostInsightId, processMetric must be specified. ' operationId: SummarizeHostInsightTopProcessesUsage parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/HostProcessResourceMetricQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/TimestampQueryParam' responses: 200: description: Successfully returned usage top processes metrics for a specified date. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightsTopProcessesUsageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets top processes usage metrics for a host on a specific date. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/topProcessesUsageTrend: get: description: 'Returns response with aggregated time series data (timeIntervalstart, timeIntervalEnd, commandArgs, usageData) for top processes. Data is aggregated for the time period specified and proceses are sorted descendent by the proces metric specified (CPU, MEMORY, VIRTUAL_MEMORY). HostInsight Id and Process metric must be specified ' operationId: SummarizeHostInsightTopProcessesUsageTrend parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/HostInsightIdQueryParamRequired' - $ref: '#/components/parameters/HostProcessResourceMetricQueryParam' - $ref: '#/components/parameters/AnalysisTimeIntervalQueryParam' - $ref: '#/components/parameters/TimeIntervalStartQueryParam' - $ref: '#/components/parameters/TimeIntervalEndQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/HostTypesQueryParam' - $ref: '#/components/parameters/HostIdQueryParam' - $ref: '#/components/parameters/ProcessHashQueryParam' responses: 200: description: Successfully returned usage top processes metrics for a specified time period. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeHostInsightsTopProcessesUsageTrendCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets top processes usage metrics for a host. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/{hostInsightId}: delete: description: Deletes a host insight. The host insight will be deleted and cannot be enabled again. operationId: DeleteHostInsight parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This host insight will be deleted in Ops Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a host insight. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' get: description: Gets details of a host insight. operationId: GetHostInsight parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the HostInsight with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/HostInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of a host insight. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' put: description: Updates configuration of a host insight. operationId: UpdateHostInsight parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The HostInsight will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of a host insight. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHostInsightDetails' description: The configuration to be updated. required: true /hostInsights/{hostInsightId}/actions/changeCompartment: post: description: Moves a HostInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeHostInsightCompartment parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The HostInsight resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHostInsightCompartmentDetails' description: The information to be updated. required: true /hostInsights/{hostInsightId}/actions/disable: post: description: Disables a host in Ops Insights. Host metric collection and analysis will be stopped. operationId: DisableHostInsight parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The HostInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables a host in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /hostInsights/{hostInsightId}/actions/enable: post: description: Enables a host in Ops Insights. Host metric collection and analysis will be started. operationId: EnableHostInsight parameters: - $ref: '#/components/parameters/HostInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The HostInsight will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables a host in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableHostInsightDetails' description: Details for the host to be enabled in Ops Insights. required: true /importableAgentEntities: get: description: "Gets a list of agent entities available to add a new hostInsight. An agent entity is \"available\"\nand will be shown if all the following conditions are true:\n 1. The agent OCID is not already being used for an existing hostInsight.\n 2. The agent availabilityStatus = 'ACTIVE'\n 3. The agent lifecycleState = 'ACTIVE'\n" operationId: ListImportableAgentEntities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/HostedEntityCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Successfully returned list of agent entities. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportableAgentEntitySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of agent entities available to add a new hostInsight tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /importableComputeEntities: get: description: "Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is \"available\"\nand will be shown if all the following conditions are true:\n 1. Compute is running OCA\n 2. OCI Management Agent is not enabled or If OCI Management Agent is enabled\n 2.1 The agent OCID is not already being used for an existing hostInsight.\n 2.2 The agent availabilityStatus = 'ACTIVE'\n 2.3 The agent lifecycleState = 'ACTIVE'\n" operationId: ListImportableComputeEntities parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ImportableComputeEntityCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Successfully returned list of compute intances running oracle cloud agent entities. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportableComputeEntitySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of compute instances running OCA available to add a new hostInsight tags: - operationsInsights x-related-resource: '#/definitions/HostInsights' /kubeClusterInsights: get: description: 'Gets a list of Kubernetes cluster insights based on the query parameters specified. Either compartmentId or id query parameter must be specified. When both compartmentId and compartmentIdInSubtree are specified, a list of Kubernetes cluster insights in that compartment and in all sub-compartments will be returned. ' operationId: ListKubeClusterInsights parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ListKubeClusterInsightIdsQueryParam' - $ref: '#/components/parameters/ResourceStatusQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/KubeClusterInsightCollectionSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of KubeClusterInsightSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/KubeClusterInsightSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Kubernetes cluster insights. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' post: description: 'Create a Kubernetes cluster insight resource for a Kubernetes Cluster in Ops Insights. The Kubernetes cluster will be enabled in Ops Insights. Kubernetes cluster-related metric collection and analysis will be started. ' operationId: CreateKubeClusterInsight parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The Kubernetes cluster insight resource is being created. The Kubernetes cluster will be enabled in Ops Insights. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KubeClusterInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Kubernetes cluster insight resource for a Kubernetes Cluster in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateKubeClusterInsightDetails' description: Details for the Kubernetes cluster for which a Kubernetes cluster insight resource will be created in Ops Insights. required: true /kubeClusterInsights/{kubeClusterInsightId}: delete: description: Deletes a Kubernetes cluster insight. The Kubernetes cluster insight will be deleted and cannot be enabled again. operationId: DeleteKubeClusterInsight parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This Kubernetes cluster insight will be deleted in Ops Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a Kubernetes cluster insight. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' get: description: Gets details of a Kubernetes cluster insight. operationId: GetKubeClusterInsight parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the KubeClusterInsight with the given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/KubeClusterInsight' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of a Kubernetes cluster insight. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' put: description: Updates configuration of a Kubernetes cluster insight. operationId: UpdateKubeClusterInsight parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The KubeClusterInsights will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates configuration of a Kubernetes cluster insight. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKubeClusterInsightDetails' description: The configuration to be updated. required: true /kubeClusterInsights/{kubeClusterInsightId}/actions/changeCompartment: post: description: Moves a Kubernetes cluster insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeKubeClusterInsightCompartment parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The KubeClusterInsight resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeKubeClusterInsightCompartmentDetails' description: The information to be updated. required: true /kubeClusterInsights/{kubeClusterInsightId}/actions/disable: post: description: Disables a Kubernetes cluster in Ops Insights. Kubernetes cluster-related metric collection and analysis will be stopped. operationId: DisableKubeClusterInsight parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The KubeClusterInsight will be disabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Disables a Kubernetes cluster in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' /kubeClusterInsights/{kubeClusterInsightId}/actions/enable: post: description: Enables a Kubernetes cluster in Ops Insights. Kubernetes cluster-related metric collection and analysis will be started. operationId: EnableKubeClusterInsight parameters: - $ref: '#/components/parameters/KubeClusterInsightIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The KubeClusterInsight will be enabled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Enables a Kubernetes cluster in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/KubeClusterInsights' requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableKubeClusterInsightDetails' description: Details for the Kubernetes cluster to be enabled in Ops Insights. required: true /newsReports: get: description: 'Gets a list of news reports based on the query parameters specified. Either compartmentId or id query parameter must be specified. ' operationId: ListNewsReports parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/NewsReportIdQueryParam' - $ref: '#/components/parameters/ResourceStatusQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NewsReportCollectionSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of OpsiNewsReportSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/NewsReportCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of news reports. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' post: description: 'Create a news report in Ops Insights. The report will be enabled in Ops Insights. Insights will be emailed as per selected frequency. ' operationId: CreateNewsReport parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The news report is being created. The news report will be enabled in Ops Insights. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NewsReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a news report in Ops Insights. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNewsReportDetails' description: Details for the news report that will be created in Ops Insights. required: true /newsReports/{newsReportId}: delete: description: Deletes a news report. The news report will be deleted and cannot be enabled again. operationId: DeleteNewsReport parameters: - $ref: '#/components/parameters/NewsReportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This news report will be deleted in Ops Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a news report. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' get: description: Gets details of a news report. operationId: GetNewsReport parameters: - $ref: '#/components/parameters/NewsReportIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the news report with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NewsReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of a news report. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' put: description: Updates the configuration of a news report. operationId: UpdateNewsReport parameters: - $ref: '#/components/parameters/NewsReportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The news report will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the configuration of a news report. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNewsReportDetails' description: The configuration to be updated. required: true /newsReports/{newsReportId}/actions/changeCompartment: post: description: Moves a news report resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeNewsReportCompartment parameters: - $ref: '#/components/parameters/NewsReportIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The news report resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/NewsReports' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNewsReportCompartmentDetails' description: The information to be updated. required: true /operationsInsightsPrivateEndpoints: get: description: Gets a list of Operation Insights private endpoints. operationId: ListOperationsInsightsPrivateEndpoints parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdQueryParam' - $ref: '#/components/parameters/IsUsedForRacDbsQueryParam' - $ref: '#/components/parameters/VcnIdQueryParam' - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PrivateEndpointSortByQueryParam' - $ref: '#/components/parameters/CompartmentIdInSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of private endpoints successfully retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsPrivateEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Operation Insights private endpoints. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' post: description: 'Create a private endpoint resource for the tenant in Ops Insights. This resource will be created in customer compartment. ' operationId: CreateOperationsInsightsPrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The private endpoint is being created. headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsPrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Operation Insights private endpoint resource tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationsInsightsPrivateEndpointDetails' description: Details to create a new private endpoint. required: true /operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}: delete: description: Deletes a private endpoint. operationId: DeleteOperationsInsightsPrivateEndpoint parameters: - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The private endpoint will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a private endpoint. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' get: description: Gets the details of the specified private endpoint. operationId: GetOperationsInsightsPrivateEndpoint parameters: - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the private endpoint for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsPrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of the specified private endpoint. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' put: description: Updates one or more attributes of the specified private endpoint. operationId: UpdateOperationsInsightsPrivateEndpoint parameters: - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights private endpoint details will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates one or more attributes of the specified private endpoint. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOperationsInsightsPrivateEndpointDetails' description: The details used to update a private endpoint. required: true /operationsInsightsPrivateEndpoints/{operationsInsightsPrivateEndpointId}/actions/changeCompartment: post: description: Moves a private endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeOperationsInsightsPrivateEndpointCompartment parameters: - $ref: '#/components/parameters/OperationsInsightsPrivateEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The privte endpoint resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a private endpoint into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsPrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOperationsInsightsPrivateEndpointCompartmentDetails' description: The details used to change the compartment of a private endpoint required: true /operationsInsightsWarehouseUsers: get: description: 'Gets a list of Operations Insights Warehouse users. Either compartmentId or id must be specified. All these resources are expected to be in root compartment. ' operationId: ListOperationsInsightsWarehouseUsers parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseUserIdQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseIdQueryParamRequired' - $ref: '#/components/parameters/OperationsInsightsWarehouseUserLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseUserSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Operations Insights Warehouse User objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouseUserSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Operations Insights Warehouse Users. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouseUsers' post: description: 'Create a Operations Insights Warehouse user resource for the tenant in Operations Insights. This resource will be created in root compartment. ' operationId: CreateOperationsInsightsWarehouseUser parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The Operations Insights Warehouse user is being created. Example: `message: The Operations Insights Warehouse user is being created for the provided configuration.` ' headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouseUser' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: This is the endpoint for creating an Operations Insights Warehouse user tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouseUsers' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationsInsightsWarehouseUserDetails' description: Parameter using which an Operations Insights Warehouse user resource will be created. required: true /operationsInsightsWarehouseUsers/{operationsInsightsWarehouseUserId}: delete: description: Deletes an Operations Insights Warehouse User. operationId: DeleteOperationsInsightsWarehouseUser parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseUserIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Warehouse user will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Operations Insights Warehouse User. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouseUsers' get: description: Gets details of an Operations Insights Warehouse User. operationId: GetOperationsInsightsWarehouseUser parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseUserIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Operations Insights Warehouse User for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouseUser' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an Operations Insights Warehouse User. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouseUsers' put: description: Updates the configuration of an Operations Insights Warehouse User. operationId: UpdateOperationsInsightsWarehouseUser parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseUserIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Warehouse User configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the configuration of an Operations Insights Warehouse User. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouseUsers' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOperationsInsightsWarehouseUserDetails' description: The configuration to be updated. required: true /operationsInsightsWarehouses: get: description: 'Gets a list of Ops Insights warehouses. Either compartmentId or id must be specified. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. ' operationId: ListOperationsInsightsWarehouses parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseIdQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OperationsInsightsWarehouseSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of Ops Insights Warehouse objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouseSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of Ops Insights warehouses. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' post: description: 'Create a Ops Insights Warehouse resource for the tenant in Ops Insights. New ADW will be provisioned for this tenant. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. If the ''opsi-warehouse-type'' header is passed to the API, a warehouse resource without ADW or Schema provisioning is created. ' operationId: CreateOperationsInsightsWarehouse parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'The Ops Insights Warehouse is being created. Example: `message: The Ops Insights Warehouse is being created for the provided configuration.` ' headers: content-location: description: URI of the resource schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: URI of the resource schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouse' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an Ops Insights Warehouse tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOperationsInsightsWarehouseDetails' description: Details using which an Ops Insights Warehouse resource will be created in Ops Insights. required: true /operationsInsightsWarehouses/{operationsInsightsWarehouseId}: delete: description: 'Deletes an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. User must delete AWR Hub resource for this warehouse before calling this operation. User must delete the warehouse users before calling this operation. ' operationId: DeleteOperationsInsightsWarehouse parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Warehouse will be deleted in Operations Insights. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an Operations Insights Warehouse. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' get: description: 'Gets details of an Ops Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. ' operationId: GetOperationsInsightsWarehouse parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Ops Insights Warehouse for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OperationsInsightsWarehouse' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an Ops Insights Warehouse. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' put: description: 'Updates the configuration of an Ops Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. ' operationId: UpdateOperationsInsightsWarehouse parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The Operations Insights Warehouse configuration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates the configuration of an Ops Insights Warehouse. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOperationsInsightsWarehouseDetails' description: The configuration to be updated. required: true /operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/changeCompartment: post: description: Moves a Operations Insights Warehouse resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeOperationsInsightsWarehouseCompartment parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The Operations Insights Warehouse resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOperationsInsightsWarehouseCompartmentDetails' description: The information to be updated. required: true /operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/downloadWarehouseWallet: post: description: Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed. operationId: DownloadOperationsInsightsWarehouseWallet parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: The connection details for the Operations Insights Warehouse database is being retrieved. headers: content-length: description: Size of the file. schema: type: integer format: int64 etag: description: For optimistic concurrency control. See `if-match`. schema: type: string last-modified: description: The date and time the wallet was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. schema: type: string format: date-time opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Download the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' requestBody: content: application/json: schema: $ref: '#/components/schemas/DownloadOperationsInsightsWarehouseWalletDetails' description: The information to be updated. required: true /operationsInsightsWarehouses/{operationsInsightsWarehouseId}/actions/rotateWarehouseWallet: post: description: Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed. operationId: RotateOperationsInsightsWarehouseWallet parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Accepted the request. The ADW wallet for Operations Insights Warehouse will be rotated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Rotate the ADW wallet for Operations Insights Warehouse using which the Hub data is exposed. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' /operationsInsightsWarehouses/{operationsInsightsWarehouseId}/resourceUsageSummary: get: description: 'Gets the details of resources used by an Operations Insights Warehouse. There is only expected to be 1 warehouse per tenant. The warehouse is expected to be in the root compartment. ' operationId: SummarizeOperationsInsightsWarehouseResourceUsage parameters: - $ref: '#/components/parameters/OperationsInsightsWarehouseIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the details of resources used by the Operations Insights Warehouse for a given ID headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SummarizeOperationsInsightsWarehouseResourceUsageAggregation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the details of resources used by an Operations Insights Warehouse. tags: - operationsInsights x-related-resource: '#/definitions/OperationsInsightsWarehouses' /opsiConfigurations: get: description: 'Gets a list of OPSI configuration resources based on the query parameters specified. ' operationId: ListOpsiConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/OpsiConfigurationDisplayNameQueryParam' - $ref: '#/components/parameters/OpsiConfigurationLifecycleStateQueryParam' - $ref: '#/components/parameters/OpsiConfigurationTypesQueryParam' - $ref: '#/components/parameters/OpsiConfigurationCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OpsiConfigurationCollectionSortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of OpsiConfigurationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpsiConfigurationsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of OPSI configuration resources. tags: - operationsInsights x-related-resource: '#/definitions/OpsiConfigurations' post: description: 'Create an OPSI configuration resource. ' operationId: CreateOpsiConfiguration parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpsiConfigurationFieldsQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemCustomizationStatusesQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemApplicableContextsQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemSummaryFieldsQueryParam' responses: 201: description: The OPSI configuration resource is being created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpsiConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an OPSI configuration resource. tags: - operationsInsights x-related-resource: '#/definitions/OpsiConfigurations' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOpsiConfigurationDetails' description: Information about OPSI configuration resource to be created. required: true /opsiConfigurations/configurationItems: get: description: 'Gets the applicable configuration items based on the query parameters specified. Configuration items for an opsiConfigType with respect to a compartmentId can be fetched. Values specified in configItemField param will determine what fields for each configuration items have to be returned. ' operationId: SummarizeConfigurationItems parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/ConfigurationItemsCollectionOpsiConfigurationTypeQueryParam' - $ref: '#/components/parameters/ConfigurationItemsCollectionPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ConfigurationItemApplicableContextsQueryParam' - $ref: '#/components/parameters/ConfigurationItemSummaryFieldsQueryParam' - $ref: '#/components/parameters/ConfigurationItemNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of applicable ConfigurationItemSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConfigurationItemsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the applicable configuration items. tags: - operationsInsights x-example: 'GET /20200630/opsiConfigurations/configurationItems?compartmentId=ocid1.compartment.oc1..example0123456789 &opsiConfigType=UX_CONFIGURATION&configItemsApplicableContext=HOST_CAPACITY_PLANNING &configItemField=name&configItemField=value&configItemField=valueSourceConfig&configItemField=metadata&configItemField=applicableContexts ' x-related-resource: '#/definitions/OpsiConfigurations' /opsiConfigurations/{opsiConfigurationId}: delete: description: Deletes an OPSI configuration resource. operationId: DeleteOpsiConfiguration parameters: - $ref: '#/components/parameters/OpsiConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. This OPSI configuration resource will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes an OPSI configuration resource. tags: - operationsInsights x-related-resource: '#/definitions/OpsiConfigurations' get: description: 'Gets details of an OPSI configuration resource. Values specified in configItemField and configItemCustomStatus query params will be considered, only if configItems field is requested as part of opsiConfigField query param. Values specified in configItemCustomStatus will determine whether only customized configuration items or only non-customized configuration items or both have to be returned. ' operationId: GetOpsiConfiguration parameters: - $ref: '#/components/parameters/OpsiConfigurationIdPathParam' - $ref: '#/components/parameters/OpsiConfigurationFieldsQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemCustomizationStatusesQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemApplicableContextsQueryParam' - $ref: '#/components/parameters/OpsiConfigurationConfigurationItemSummaryFieldsQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the OPSI configuration resource with the given ID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpsiConfiguration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an OPSI configuration resource. tags: - operationsInsights x-example: 'GET /20200630/opsiConfigurations/ocid1.opsiconfiguration.oc1.phx.exampleabcdefghijklmnopqrstuvwxyz?configItemsApplicableContext=HOST_CAPACITY_PLANNING &opsiConfigField=configItems&configItemType=customizedItems&configItemField=name&configItemField=value ' x-related-resource: '#/definitions/OpsiConfigurations' put: description: Updates an OPSI configuration resource with the given ID. operationId: UpdateOpsiConfiguration parameters: - $ref: '#/components/parameters/OpsiConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OpsiConfiguration resource will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates an OPSI configuration resource with the given ID. tags: - operationsInsights x-related-resource: '#/definitions/OpsiConfigurations' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOpsiConfigurationDetails' description: The OPSI configuration resource details to be updated. required: true /opsiConfigurations/{opsiConfigurationId}/actions/changeCompartment: post: description: Moves an OpsiConfiguration resource from one compartment to another. operationId: ChangeOpsiConfigurationCompartment parameters: - $ref: '#/components/parameters/OpsiConfigurationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 202: description: Accepted the request. The OpsiConfiguration resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - operationsInsights x-related-resource: '#/definitions/OpsiConfigurations' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOpsiConfigurationCompartmentDetails' description: The information to be updated. required: true /opsiDataObjects: get: description: 'Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified. ' operationId: ListOpsiDataObjects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/OpsiDataObjectTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DataObjectPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/OpsiDataObjectCollectionSortByQueryParam' - $ref: '#/components/parameters/DataObjectGroupNameQueryParam' - $ref: '#/components/parameters/DataObjectNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of OpsiDataObjectSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpsiDataObjectsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of OPSI data objects. tags: - operationsInsights x-related-resource: '#/definitions/OpsiDataObjects' /opsiDataObjects/actions/queryData: post: description: 'Queries an OPSI data object with the inputs provided and sends the result set back. Either analysisTimeInterval or timeIntervalStart and timeIntervalEnd parameters need to be passed as well. ' operationId: QueryOpsiDataObjectData parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/DataObjectQueryDataPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of rows from the result set of executed query. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/QueryDataObjectResultSetRowsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Queries data from an OPSI data object. tags: - operationsInsights x-example: "POST /20200630/opsiDataObjects/actions/queryData?compartmentId=ocid1.compartment.oc1.samplecompartmentid\n{\n \"dataObjectIdentifier\": \"6d467c4b-a42b-45c6-95ca-dd94556271ad\",\n \"dataObjects\": [\n {\n \"dataObjectDetailsTarget\": \"INDIVIDUAL_OPSIDATAOBJECT\",\n \"dataObjectIdentifier\": \"6d467c4b-a42b-45c6-95ca-dd94556271ad\",\n \"queryParams\": [{\n \"name\": \"filterByOpsiIds\",\n \"value\": [\"ocid1.opsidatabaseinsight.oc1.phx.12345\", \"ocid1.opsidatabaseinsight.oc1.phx.789910\"]\n }]\n }\n ],\n \"query\": {\n \"queryType\": \"TEMPLATIZED_QUERY\",\n \"selectList\": [\n \"sql_text\",\n \"optimizer_mode\",\n \"avg(disk_reads)\"\n ],\n \"whereConditionsList\": [\n \"optimizer_mode='mode1'\"\n ],\n \"groupByList\": [\n \"sql_text\",\n \"optimizer_mode\"\n ],\n \"havingConditionsList\": [\n \"avg(disk_reads)>20\"\n ],\n \"orderByList\": [\n \"sql_text ASC\"\n ],\n \"timeFilters\": {\n \"timePeriod\": \"P28M\"\n }\n }\n}\nPOST /20200630/opsiDataObjects/actions/queryData?compartmentId=ocid1.compartment.oc1.samplecompartmentid\n{\n \"query\": {\n \"queryType\": \"STANDARD_QUERY\",\n \"statement\": \"SELECT SQL_TEXT, OPTIMIZER_MODE, AVG(DISK_READS) FROM SQL_STATS_DO WHERE OPTIMIZER_MODE='mode1' OR OPTIMIZER_MODE=:optimizerMode GROUP BY SQL_TEXT, OPTIMIZER_MODE\"\n \"timeFilters\": {\n \"timePeriod\": \"P28M\"\n },\n \"bindParams\": [{\n \"name: \"optimizerMode\",\n \"value\": \"mode2\",\n \"dataType\": \"STRING\"\n }],\n \"queryExecutionTimeoutInSeconds\": 15\n }\n}\n" x-related-resource: '#/definitions/OpsiDataObjects' requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryOpsiDataObjectDataDetails' description: The information to be used for querying an OPSI data object. required: true /opsiDataObjects/{opsiDataObjectIdentifier}: get: description: Gets details of an OPSI data object. operationId: GetOpsiDataObject parameters: - $ref: '#/components/parameters/CompartmentIdQueryParamRequired' - $ref: '#/components/parameters/OpsiDataObjectIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the OPSI data object with the given identifier. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OpsiDataObject' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets details of an OPSI data object. tags: - operationsInsights x-related-resource: '#/definitions/OpsiDataObjects' /workRequests: get: description: 'Lists the work requests in a compartment. Either compartmentId or id must be specified. Only one of id, resourceId or relatedResourceId can be specified optionally. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParamOptional' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RelatedResourceIdentifierQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List work requests tags: - operationsInsights x-related-resource: '#/definitions/WorkRequests' /workRequests/{workRequestId}: get: description: Gets the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: number format: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets work request status tags: - operationsInsights x-related-resource: '#/definitions/WorkRequests' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request errors tags: - operationsInsights x-related-resource: '#/definitions/WorkRequests' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request logs tags: - operationsInsights x-related-resource: '#/definitions/WorkRequests' /{warehouseType}/{warehouseId}/actions/queryData: post: description: 'Queries Warehouse data objects (e.g: views, tables) with the inputs provided and sends the result set back. Any data to which an OperationsInsightsWarehouseUser with a permission to the corresponding Warehouse can be queried. ' operationId: QueryWarehouseDataObjectData parameters: - $ref: '#/components/parameters/WarehouseTypePathParam' - $ref: '#/components/parameters/WarehouseIdPathParam' - $ref: '#/components/parameters/DataObjectQueryDataPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of rows from the result set of executed query. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/QueryDataObjectResultSetRowsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: 'Queries data from Warehouse data objects (e.g: views, tables). ' tags: - operationsInsights x-example: "POST /20200630/awrHubs/{awrHubId}/actions/queryData\n{\n \"query\": {\n \"queryType\": \"STANDARD_QUERY\",\n \"statement\": \"SELECT DBID, TOTAL_WAITS FROM SYS.DBA_HIST_SYSTEM_EVENT WHERE SNAP_ID IN(SELECT SNAP_ID FROM SYS.DBA_HIST_SNAPSHOT WHERE BEGIN_INTERVAL_TIME>SYSDATE-1)\",\n \"queryExecutionTimeoutInSeconds\": 15\n }\n}\n" x-related-resource: '#/definitions/OpsiWarehouseDataObjects' requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryWarehouseDataObjectDataDetails' description: The information to be used for querying a Warehouse. required: true /{warehouseType}/{warehouseId}/dataObjects: get: description: 'Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified. ' operationId: ListWarehouseDataObjects parameters: - $ref: '#/components/parameters/WarehouseTypePathParam' - $ref: '#/components/parameters/WarehouseIdPathParam' - $ref: '#/components/parameters/DataObjectTypeQueryParam' - $ref: '#/components/parameters/DataObjectNameQueryParam' - $ref: '#/components/parameters/DataObjectOwnerQueryParam' - $ref: '#/components/parameters/DataObjectPaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WarehouseDataObjectCollectionSortByQueryParam' - $ref: '#/components/parameters/WarehouseDataObjectSummaryFieldsQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of WarehouseDataObjectSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WarehouseDataObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: 'Gets a list of Warehouse data objects (e.g: views, tables). ' tags: - operationsInsights x-related-resource: '#/definitions/OpsiWarehouseDataObjects' components: parameters: EnterpriseManagerEntityTypesQueryParam: description: 'Filter by one or more Enterprise Manager entity types. Currently, the supported types are "oracle_pdb", "oracle_database", "host", "oracle_dbmachine", "oracle_exa_cloud_service", and "oracle_oci_exadata_cloud_service". If this parameter is not specified, targets of all supported entity types are returned by default. ' in: query name: enterpriseManagerEntityType required: false style: form explode: true schema: type: array items: type: string default: [] WarehouseIdPathParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Warehouse. ' in: path name: warehouseId required: true schema: type: string OpsiConfigurationDisplayNameQueryParam: description: Filter to return based on resources that match the entire display name. in: query name: displayName x-default-description: 'null' schema: type: string IsUsedForRacDbsQueryParam: description: The option to filter OPSI private endpoints that can used for RAC. Should be used along with vcnId query parameter. in: query name: isUsedForRacDbs schema: type: boolean default: false AwrReportFormatOptionalQueryParam: description: The format of the AWR report. Default report format is HTML. in: query name: reportFormat required: false x-obmcs-top-level-enum: '#/definitions/AwrReportFormatType' schema: type: string enum: - HTML - TEXT default: HTML IfMatchHeader: description: 'Used for optimistic concurrency control. In the update or delete call for a resource, set the `if-match` parameter to the value of the etag from a previous get, create, or update response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string PlanHashMultiQueryParamRequired: description: 'Unique plan hash for a SQL Plan of a particular SQL Statement. Example: `9820154385` ' in: query name: planHash required: true style: form explode: true schema: type: array items: format: int64 maxLength: 40 minLength: 1 type: integer maxItems: 1 minItems: 1 ExadataInsightIdQueryParam: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource. ' in: query name: exadataInsightId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 NewsReportIdPathParam: description: Unique news report identifier. in: path name: newsReportId required: true schema: type: string ExadataMemberCollectionSortByQueryParam: description: The order in which exadata member records are listed in: query name: sortBy required: false schema: type: string enum: - name - displayName - entityType default: name FilterByFreeformTagExistsQueryParam: description: 'A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND". ' in: query name: freeformTagExists required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 106 type: string ConfigurationItemSummaryFieldsQueryParam: description: 'Specifies the fields to return in a config item summary. ' in: query name: configItemField style: form explode: true schema: type: array items: enum: - name - value - defaultValue - valueSourceConfig - metadata - applicableContexts type: string default: [] CdbNamesQueryParam: description: 'Filter by one or more cdb name. ' in: query name: cdbName required: false style: form explode: true schema: type: array items: type: string default: [] maxItems: 1 OperationsInsightsPrivateEndpointLifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsPrivateEndpointLifecycleState' default: [] StartWithQueryParam: description: Object names returned by Awr Hub list objects query must be greater or equal to this parameter. in: query name: start required: false x-default-description: 'null' schema: type: string AddmDbFindingsTimeSeriesSortByQueryParameter: description: 'Field name for sorting the ADDM finding time series summary data ' in: query name: sortBy required: false schema: type: string enum: - timestamp default: timestamp LifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' default: - ACTIVE AddmDbFindingIdentifierOptionalQueryParam: description: Unique finding ID in: query name: findingIdentifier required: false x-default-description: 'null' schema: type: string AwrDbParameterDefaultOptionalQueryParam: description: The optional query parameter to filter the database parameters that had the default value in the last snapshot. in: query name: valueDefault required: false x-default-description: 'null' schema: type: string enum: - 'TRUE' - 'FALSE' HostInsightIdQueryParamRequired: description: 'Required [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource. ' in: query name: id required: true schema: type: string maxLength: 255 minLength: 1 SqlIdentifiersQueryParam: description: 'One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7` ' in: query name: sqlIdentifier required: false style: form explode: true schema: type: array items: maxLength: 13 type: string default: [] TimeIntervalEndQueryParam: description: 'Analysis end time in UTC in ISO 8601 format(exclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). timeIntervalStart and timeIntervalEnd are used together. If timeIntervalEnd is not specified, current time is used as timeIntervalEnd. ' in: query name: timeIntervalEnd required: false x-default-description: Current time would be the end time in UTC (yyyy-MM-ddThh:mm:ssZ) by default schema: type: string format: date-time SqlTextDatabaseIdsQueryParam: description: 'Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the assosicated DBaaS entity. ' in: query name: databaseId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 1 minItems: 1 HostTypesQueryParam: description: 'Filter by one or more host types. Possible values are CLOUD-HOST, EXTERNAL-HOST, COMANAGED-VM-HOST, COMANAGED-BM-HOST, COMANAGED-EXACS-HOST, COMANAGED-EXACC-HOST ' in: query name: hostType required: false style: form explode: true schema: type: array items: type: string default: [] AwrDbSortByQueryParam: description: The option to sort the AWR summary data. in: query name: sortBy required: false schema: type: string enum: - END_INTERVAL_TIME - NAME default: END_INTERVAL_TIME AddmDbFindingsCategoryNameOptionalQueryParameter: description: 'Optional value filter to match the finding category exactly. ' in: query name: categoryName required: false x-default-description: 'null' schema: type: string ExadataInsightForecastDaysQueryParam: description: 'Number of days used for utilization forecast analysis. ' in: query name: forecastDays schema: type: integer default: 30 maximum: 365 minimum: 0 AwrHubSourceLifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: default: [] enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceLifecycleState' EntityNamesOptionalQueryParam: description: The optional multiple value query parameter to filter the entity name. in: query name: name required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string ExadataResourceCapacityTrendCollectionSortByQueryParam: description: The order in which resource capacity trend records are listed in: query name: sortBy required: false schema: type: string enum: - id - name default: name AwrSnapshotEndTimeOptionalQueryParam: description: 'The optional less than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z ' in: query name: timeLessThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time OperationsInsightsWarehouseIdQueryParamRequired: description: Unique Operations Insights Warehouse identifier in: query name: operationsInsightsWarehouseId required: true x-default-description: 'null' schema: type: string OperationsInsightsWarehouseUserIdPathParam: description: Unique Operations Insights Warehouse User identifier in: path name: operationsInsightsWarehouseUserId required: true schema: type: string DatabaseIdsQueryParam: description: 'Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity. ' in: query name: databaseId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 OpsiConfigurationConfigurationItemCustomizationStatusesQueryParam: description: 'Specifies whether only customized configuration items or only non-customized configuration items or both have to be returned. By default only customized configuration items are returned. ' in: query name: configItemCustomStatus style: form explode: true schema: type: array items: enum: - customized - nonCustomized type: string default: - customized ExadataForecastTrendPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 5 maximum: 10 minimum: 1 ConfigurationItemApplicableContextsQueryParam: description: 'Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. ' in: query name: configItemsApplicableContext style: form explode: true schema: type: array items: type: string default: [] AwrHubIdQueryParamRequired: description: Unique Awr Hub identifier in: query name: awrHubId required: true x-default-description: 'null' schema: type: string HostInsightCollectionSortByQueryParam: description: 'Host insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. ' in: query name: sortBy required: false x-default-description: Since the fields to return from listHostInsights are configurable, by default no sorting will be applied. schema: type: string enum: - hostName - hostType AwrHubSourceTypeQueryParam: description: 'Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. ' in: query name: sourceType required: false x-default-description: 'null' style: form explode: true schema: type: array items: default: [] enum: - ADW_S - ATP_S - ADW_D - ATP_D - EXTERNAL_PDB - EXTERNAL_NONCDB - COMANAGED_VM_CDB - COMANAGED_VM_PDB - COMANAGED_VM_NONCDB - COMANAGED_BM_CDB - COMANAGED_BM_PDB - COMANAGED_BM_NONCDB - COMANAGED_EXACS_CDB - COMANAGED_EXACS_PDB - COMANAGED_EXACS_NONCDB - LH_S - APEX_S - AJD_S - AVD_S - LH_D - APEX_D - AJD_D - AVD_D - UNDEFINED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceType' DatabaseConfigurationCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 TimeIntervalStartQueryParam: description: 'Analysis start time in UTC in ISO 8601 format(inclusive). Example 2019-10-30T00:00:00Z (yyyy-MM-ddThh:mm:ssZ). The minimum allowed value is 2 years prior to the current day. timeIntervalStart and timeIntervalEnd parameters are used together. If analysisTimeInterval is specified, this parameter is ignored. ' in: query name: timeIntervalStart required: false x-default-description: Start time for analysis in UTC (yyyy-MM-ddThh:mm:ssZ) schema: type: string format: date-time AwrHubIdPathParam: description: Unique Awr Hub identifier in: path name: awrHubId required: true schema: type: string ParameterCategoryNameOptionalQueryParam: description: 'Optional value filter to match the parameter category exactly. Note the list of possible category names can be retrieved from the following endpoint: /databases/{databaseId}/addmDbParameterCategories. ' in: query name: categoryName required: false x-default-description: 'null' schema: type: string AwrDbNameSampledBeginTimeSortByQueryParam: description: The option to sort the data within a time period. in: query name: sortBy required: false schema: type: string enum: - TIME_BEGIN - NAME default: TIME_BEGIN DelimiterQueryParam: description: 'When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the Awr Hub list objects key of the response body. Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only ''/'' is a supported delimiter character at this time. ' in: query name: delimiter required: false x-default-description: 'null' schema: type: string WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted AwrDbTopEventSortByQueryParam: description: The option to sort the AWR top event summary data. in: query name: sortBy required: false schema: type: string enum: - WAITS_PERSEC - AVG_WAIT_TIME_PERSEC default: WAITS_PERSEC CompartmentIdInSubtreeQueryParam: description: 'A flag to search all resources within a given compartment and all sub-compartments. ' in: query name: compartmentIdInSubtree required: false schema: type: boolean default: false ResourceTypeQueryParam: description: 'Filter by resource type. Supported values are EXADATA_INSIGHT , HOST_INSIGHT, DATABASE_INSIGHT. ' in: query name: resourceType required: true schema: type: string items: enum: - EXADATA_INSIGHT - DATABASE_INSIGHT - HOST_INSIGHT type: string ExadataStorageServerNameQueryParam: description: 'Optional storage server name on an exadata system. ' in: query name: storageServerName required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 AwrSourceNameQueryParam: description: 'Name for an Awr source database ' in: query name: name required: false x-default-description: 'null' schema: type: string OperationsInsightsWarehouseUserIdQueryParam: description: Unique Operations Insights Warehouse User identifier in: query name: id x-default-description: 'null' schema: type: string OwnerOrNameContainsOptionalQueryParam: description: 'Optional filter to return only resources whose owner or name contains the substring given. The match is not case sensitive. Only considered when categoryName is SCHEMA_OBJECT. ' in: query name: ownerOrNameContains required: false x-default-description: 'null' schema: type: string AddmDbRecommendationCategoryQueryParam: description: Field name for sorting the recommendation categories in: query name: sortBy required: false schema: type: string enum: - name default: name OpsiDataObjectCollectionSortByQueryParam: description: 'OPSI data object list sort options. ' in: query name: sortBy required: false x-default-description: Since the fields to return from listOpsiDataObjects are configurable, by default no sorting will be applied. schema: type: string enum: - displayName - dataObjectType - name StatisticsSortByQueryParam: description: 'The field to use when sorting SQL statistics. Example: databaseTimeInSec ' in: query name: sortBy required: false schema: type: string enum: - databaseTimeInSec - executionsPerHour - executionsCount - cpuTimeInSec - ioTimeInSec - inefficientWaitTimeInSec - responseTimeInSec - planCount - variability - averageActiveSessions - databaseTimePct - inefficiencyInPct - changeInCpuTimeInPct - changeInIoTimeInPct - changeInInefficientWaitTimeInPct - changeInResponseTimeInPct - changeInAverageActiveSessionsInPct - changeInExecutionsPerHourInPct - changeInInefficiencyInPct default: databaseTimeInSec DatabaseInsightIdsQueryParam: description: 'Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 ExadataInsightIdsQueryParam: description: 'Optional list of exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: exadataInsightId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 1 minItems: 1 ListExadataInsightsEnterpriseManagerBridgeIdQueryParam: description: Unique Enterprise Manager bridge identifier in: query name: enterpriseManagerBridgeId x-default-description: 'null' schema: type: string ExadataConfigurationCollectionSortByQueryParam: description: 'Exadata configuration list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. ' in: query name: sortBy required: false schema: type: string enum: - exadataName - exadataDisplayName - exadataType default: exadataName ChargebackPlanReportIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan report in: path name: chargebackPlanReportId required: true schema: type: string maxLength: 255 minLength: 1 IsDatabaseInstanceLevelMetrics: description: 'Flag to indicate if database instance level metrics should be returned. The flag is ignored when a host name filter is not applied. When a hostname filter is applied this flag will determine whether to return metrics for the instances located on the specified host or for the whole database which contains an instance on this host. ' in: query name: isDatabaseInstanceLevelMetrics required: false schema: type: boolean default: false ResourceIdQueryParam: description: Unique Ops insight identifier in: query name: id required: true schema: type: string maxLength: 255 KubeClusterInsightIdPathParam: description: Unique Kubernetes cluster insight identifier in: path name: kubeClusterInsightId required: true schema: type: string StartAfterQueryParam: description: Awr Hub Object name after which remaining objects are listed in: query name: startAfter required: false x-default-description: 'null' schema: type: string AddmDbParameterCategoryQueryParam: description: Field name for sorting the database parameter categories in: query name: sortBy required: false schema: type: string enum: - name default: name HostConfigurationCollectionSortByQueryParam: description: 'Host configuration list sort options. ' in: query name: sortBy required: false schema: type: string enum: - hostName - platformType default: hostName IsDefaultOptionalQueryParam: description: 'Optional filter to return only parameters whose end value was set to the default value (TRUE) or was specified in the parameter file (FALSE). Valid values include: TRUE, FALSE ' in: query name: isDefault required: false schema: type: string enum: - 'TRUE' - 'FALSE' default: 'FALSE' HostNamesQueryParam: description: 'Filter by one or more hostname. ' in: query name: hostName required: false style: form explode: true schema: type: array items: type: string default: [] maxItems: 15 OperationsInsightsWarehouseIdQueryParam: description: Unique Ops Insights Warehouse identifier in: query name: id x-default-description: 'null' schema: type: string HostCapacityTrendSortByQueryParam: description: 'Sorts using end timestamp or capacity ' in: query name: sortBy required: false schema: type: string enum: - endTimestamp - capacity default: endTimestamp ExadataCapacityTrendPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 5 maximum: 10 minimum: 1 ForecastModelQueryParam: description: "Choose algorithm model for the forecasting.\nPossible values:\n - LINEAR: Uses linear regression algorithm for forecasting.\n - ML_AUTO: Automatically detects best algorithm to use for forecasting.\n - ML_NO_AUTO: Automatically detects seasonality of the data for forecasting using linear or seasonal algorithm.\n" in: query name: forecastModel required: false schema: type: string enum: - LINEAR - ML_AUTO - ML_NO_AUTO default: ML_NO_AUTO ListDatabaseInsightsEnterpriseManagerBridgeIdQueryParam: description: Unique Enterprise Manager bridge identifier in: query name: enterpriseManagerBridgeId x-default-description: 'null' schema: type: string DbTimePercentGreaterThanQueryParam: description: 'Filter sqls by percentage of db time. ' in: query name: databaseTimePctGreaterThan required: false schema: type: number format: double default: 1 maximum: 100 minimum: 1 ReportFormatQueryParam: description: The format of the AWR report. in: query name: reportFormat required: false schema: type: string enum: - HTML - TEXT default: HTML AddmDbRecommendationCategoryNameOptionalQueryParameter: description: 'Optional value filter to match the finding category exactly. ' in: query name: categoryName required: false x-default-description: 'null' schema: type: string OpsiConfigurationIdPathParam: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource. ' in: path name: opsiConfigurationId required: true schema: type: string StatisticsCategoryQueryParam: description: 'Filter sqls by one or more performance categories. ' in: query name: category style: form explode: true schema: type: array items: enum: - DEGRADING - VARIANT - INEFFICIENT - CHANGING_PLANS - IMPROVING - DEGRADING_VARIANT - DEGRADING_INEFFICIENT - DEGRADING_CHANGING_PLANS - DEGRADING_INCREASING_IO - DEGRADING_INCREASING_CPU - DEGRADING_INCREASING_INEFFICIENT_WAIT - DEGRADING_CHANGING_PLANS_AND_INCREASING_IO - DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU - DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT - VARIANT_INEFFICIENT - VARIANT_CHANGING_PLANS - VARIANT_INCREASING_IO - VARIANT_INCREASING_CPU - VARIANT_INCREASING_INEFFICIENT_WAIT - VARIANT_CHANGING_PLANS_AND_INCREASING_IO - VARIANT_CHANGING_PLANS_AND_INCREASING_CPU - VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT - INEFFICIENT_CHANGING_PLANS - INEFFICIENT_INCREASING_INEFFICIENT_WAIT - INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT type: string default: [] AddmDbFindingCategoryQueryParam: description: Field name for sorting the finding categories in: query name: sortBy required: false schema: type: string enum: - name default: name EntityNameOptionalQueryParam: description: The optional single value query parameter to filter the entity name. in: query name: name required: false x-default-description: 'null' schema: type: string SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). ' in: query name: sortOrder required: false x-default-description: This will default to `ASC` for string fields and `DESC` for numeric fields x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC DatabaseConfigurationCollectionSortByQueryParam: description: 'Database configuration list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. ' in: query name: sortBy required: false schema: type: string enum: - databaseName - databaseDisplayName - databaseType default: databaseName OpsiConfigurationConfigurationItemSummaryFieldsQueryParam: description: Specifies the fields to return in a config item summary. in: query name: configItemField style: form explode: true schema: type: array items: enum: - name - value - defaultValue - metadata - applicableContexts type: string default: [] AddmDbRecommendationTimeSeriesSortByQueryParam: description: Field name for sorting the ADDM recommendation time series summary data in: query name: sortBy required: false schema: type: string enum: - timestamp default: timestamp PlatformTypesQueryParam: description: 'Filter by one or more platform types. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. ' in: query name: platformType required: false style: form explode: true schema: type: array items: enum: - LINUX - SOLARIS - SUNOS - ZLINUX - WINDOWS - AIX - HP_UX - UNKNOWN type: string default: [] ExadataResourceTypeQueryParam: description: 'Filter by resource. Supported values are HOST , STORAGE_SERVER and DATABASE ' in: query name: resourceType required: true schema: type: string items: enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP type: string HostProcessResourceMetricQueryParam: description: 'Host top processes resource metric sort options. Supported values are CPU, MEMORY, VIIRTUAL_MEMORY. ' in: query name: resourceMetric required: true schema: type: string items: enum: - CPU - MEMORY - VIRTUAL_MEMORY type: string NameContainsOptionalQueryParam: description: 'Optional filter to return only resources whose name contains the substring given. The match is not case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. ' in: query name: nameContains required: false x-default-description: 'null' schema: type: string AnalysisTimeIntervalQueryParam: description: 'Specify time period in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). ' in: query name: analysisTimeInterval required: false schema: type: string default: P30D InsightByQueryParam: description: 'Return data of a specific insight Possible values are High Utilization, Low Utilization, Any ,High Utilization Forecast, Low Utilization Forecast ' in: query name: insightBy schema: type: string items: enum: - HIGH_UTILIZATION - LOW_UTILIZATION - ANY - HIGH_UTILIZATION_FORECAST - LOW_UTILIZATION_FORECAST type: string default: - ANY InstanceNumberOptionalQueryParam: description: The optional single value query parameter to filter by database instance number. in: query name: instanceNumber required: false x-default-description: 'null' schema: type: string AwrDbReportTypeQueryParam: description: The query parameter to filter the AWR report types. in: query name: reportType required: false schema: type: string enum: - AWR - ASH default: AWR DatabaseTypesQueryParam: description: 'Filter by one or more database type. Possible values are ADW-S, ATP-S, ADW-D, ATP-D, EXTERNAL-PDB, EXTERNAL-NONCDB. ' in: query name: databaseType required: false style: form explode: true schema: type: array items: enum: - ADW-S - ATP-S - ADW-D - ATP-D - EXTERNAL-PDB - EXTERNAL-NONCDB - COMANAGED-VM-CDB - COMANAGED-VM-PDB - COMANAGED-VM-NONCDB - COMANAGED-BM-CDB - COMANAGED-BM-PDB - COMANAGED-BM-NONCDB - COMANAGED-EXACS-CDB - COMANAGED-EXACS-PDB - COMANAGED-EXACS-NONCDB - COMANAGED-EXACC-CDB - COMANAGED-EXACC-PDB - COMANAGED-EXACC-NONCDB - MDS-MYSQL - EXTERNAL-MYSQL - LH-D - APEX-D - AJD-D - AVD-D - LH-S - APEX-S - AJD-S - AVD-S - LH-EXACC - APEX-EXACC - AJD-EXACC - AVD-EXACC type: string default: [] AwrMaxValueOptionalQueryParam: description: The maximum value of the histogram. in: query name: maxValue required: false x-default-description: 'null' schema: type: number format: double EnterpriseManagerIdentifierQueryParam: description: 'Used in combination with enterpriseManagerParentEntityIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity. ' in: query name: enterpriseManagerIdentifier required: false x-default-description: 'null' schema: type: string NewsReportCollectionSortByQueryParam: description: 'News report list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. ' in: query name: sortBy required: false x-default-description: Since the fields to return from listNewsReports are configurable, by default no sorting will be applied. schema: type: string enum: - name - newsFrequency ResourceIdentifierQueryParam: description: The ID of the resource affected by the work request. in: query name: resourceId x-default-description: 'null' schema: type: string AwrDbCategoryPercSortByQueryParam: description: The option to sort distribution data. in: query name: sortBy required: false schema: type: string enum: - CATEGORY - PERCENTAGE default: CATEGORY WorkRequestStatusQueryParam: description: A filter to return only resources their lifecycleState matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED DatabaseInsightIdPathParam: description: Unique database insight identifier in: path name: databaseInsightId required: true schema: type: string OpsiConfigurationLifecycleStateQueryParam: description: Filter to return based on Lifecycle state of OPSI configuration. in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationLifecycleState' default: - ACTIVE WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string HostInsightIdPathParam: description: Unique host insight identifier in: path name: hostInsightId required: true schema: type: string WarehouseDataObjectCollectionSortByQueryParam: description: Sort options for Warehouse data objects list. in: query name: sortBy required: false x-default-description: By default no sorting will be applied. schema: type: string enum: - dataObjectType - name - owner SqlTextDatabaseInsightIdsQueryParam: description: 'Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 1 minItems: 1 HasRecommendationsOptionalQueryParam: description: 'Optional filter to return only parameters which have recommendations in the specified time period. Valid values include: TRUE, FALSE ' in: query name: hasRecommendations required: false schema: type: string enum: - 'TRUE' - 'FALSE' default: 'FALSE' IsChangedOptionalQueryParam: description: 'Optional filter to return only parameters whose value changed in the specified time period. Valid values include: TRUE, FALSE ' in: query name: isChanged required: false schema: type: string enum: - 'TRUE' - 'FALSE' default: 'FALSE' ExadataResourceMetricQueryParam: description: 'Filter by resource metric. Supported values are CPU , STORAGE, MEMORY, IO, IOPS, THROUGHPUT ' in: query name: resourceMetric required: true schema: type: string items: enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT type: string PrefixQueryParam: description: The string to use for matching against the start of object names in a Awr Hub list objects query. in: query name: prefix required: false x-default-description: 'null' schema: type: string ConfidenceQueryParam: description: 'This parameter is used to change data''s confidence level, this data is ingested by the forecast algorithm. Confidence is the probability of an interval to contain the expected population parameter. Manipulation of this value will lead to different results. If not set, default confidence value is 95%. ' in: query name: confidence schema: type: integer default: 95 maximum: 100 minimum: 1 AwrHubSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated HighUtilizationThresholdQueryParam: description: Percent value in which a resource metric is considered highly utilized. in: query name: highUtilizationThreshold schema: type: integer default: 75 maximum: 100 minimum: 1 RelativeTimeIntervalQueryParam: description: 'Specify relative time period with respect to current time. If relativeTimeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P1M (previous month), P1Q (previous quarter) and P1Y (previous year). ' in: query name: relativeTimeInterval required: false schema: type: string default: [] maxLength: 5 TablespaceNameQueryParam: description: 'Tablespace name for a database ' in: query name: tablespaceName required: false x-default-description: 'null' schema: type: string AddmDbParameterSortByQueryParam: description: Field name for sorting the database parameter data in: query name: sortBy required: false schema: type: string enum: - isChanged - name default: isChanged EnterpriseManagerBridgeIdQueryParam: description: Unique Enterprise Manager bridge identifier in: query name: id x-default-description: 'null' schema: type: string WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: id x-default-description: 'null' schema: type: string ChargebackPlanSortByQueryParam: description: 'The field to sort chargeback plans. ' in: query name: sortBy schema: type: string enum: - timeCreated - id - lifecycleState default: timeCreated TrendSortByQueryParam: description: 'Sorts using end timestamp, usage or capacity ' in: query name: sortBy required: false schema: type: string enum: - endTimestamp - usage - capacity default: endTimestamp AwrDbParameterValueOptionalQueryParam: description: The optional query parameter to filter database parameters whose values were changed. in: query name: valueChanged schema: type: string enum: - Y - N default: Y ExadataResourceStatisticsSortByQueryParam: description: 'The order in which resource statistics records are listed ' in: query name: sortBy required: false schema: type: string enum: - utilizationPercent - usage - usageChangePercent default: utilizationPercent AwrHubIdQueryParam: description: Unique Awr Hub identifier in: query name: id x-default-description: 'null' schema: type: string SqlIdentifiersQueryParamRequired: description: 'One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7` ' in: query name: sqlIdentifier required: true style: form explode: true schema: type: array items: maxLength: 13 type: string maxItems: 1 minItems: 1 ChargebackPlanReportSortByQueryParam: description: 'The field to sort chargeback plan reports. ' in: query name: sortBy schema: type: string enum: - timeCreated - id default: timeCreated AddmDbSortByQueryParam: description: Field name for sorting ADDM database data in: query name: sortBy required: false schema: type: string enum: - databaseName - numberOfFindings default: numberOfFindings ExadataMemberCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 500 maximum: 1000 minimum: 1 SqlIdOptionalQueryParam: description: 'Optional filter to return only resources whose sql id matches the value given. Only considered when categoryName is SQL_TUNING. ' in: query name: sqlIdentifier required: false x-default-description: 'null' schema: type: string DataObjectOwnerQueryParam: description: A filter to return only data objects that match the entire data object owner name. By default, no filtering will be applied on data object owner name. in: query name: owner x-default-description: 'null' schema: type: string AwrHubSourceNameQueryParam: description: Awr Hub source database name in: query name: name required: false x-default-description: 'null' schema: type: string ExadataUtilizationInsightPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 5 maximum: 25 minimum: 1 DatabaseInsightCollectionSortByQueryParam: description: 'Database insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. ' in: query name: sortBy required: false x-default-description: Since the fields to return from listDatabases are configurable, by default no sorting will be applied. schema: type: string enum: - databaseName - databaseDisplayName - databaseType WarehouseTypePathParam: description: Type of the Warehouse. in: path name: warehouseType required: true schema: type: string enum: - awrHubs LowUtilizationThresholdQueryParam: description: Percent value in which a resource metric is considered low utilized. in: query name: lowUtilizationThreshold schema: type: integer default: 25 maximum: 99 minimum: 0 OpsiConfigurationCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 PrivateEndpointSortByQueryParam: description: 'The field to sort private endpoints. ' in: query name: sortBy schema: type: string enum: - timeCreated - id - displayName default: timeCreated EnterpriseManagerBridgeSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated OpsiConfigurationCollectionSortByQueryParam: description: 'OPSI configurations list sort options. ' in: query name: sortBy required: false x-default-description: By default no sorting will be applied. schema: type: string enum: - displayName AwrDbTopNQueryParam: description: The optional query parameter to filter the number of top categories to be returned. in: query name: topN schema: type: integer default: 10 maximum: 20 minimum: 1 WarehouseDataObjectSummaryFieldsQueryParam: description: 'Specifies the optional fields to return in a WarehouseDataObjectSummary. Unless requested, these fields are not returned by default. ' in: query name: summaryField style: form explode: true schema: type: array items: enum: - details type: string default: [] DataObjectGroupNameQueryParam: description: A filter to return only data objects that belongs to the group of the given group name. By default, no filtering will be applied on group name. in: query name: groupName x-default-description: 'null' schema: type: string AwrDbParameterModifiedOptionalQueryParam: description: The optional query parameter to filter the database parameters that had a modified value in the last snapshot. in: query name: valueModified required: false x-default-description: 'null' schema: type: string enum: - MODIFIED - SYSTEM_MOD - 'FALSE' FilterByFreeformTagEqualsQueryParam: description: 'A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND". ' in: query name: freeformTagEquals required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 357 type: string AwrDbSnapSortByQueryParam: description: The option to sort the AWR snapshot summary data. in: query name: sortBy required: false schema: type: string enum: - TIME_BEGIN - SNAPSHOT_ID default: TIME_BEGIN RelatedResourceIdentifierQueryParam: description: The ID of the related resource for the resource affected by the work request, e.g. the related Exadata Insight OCID of the Database Insight work request in: query name: relatedResourceId x-default-description: 'null' schema: type: string ExadataInsightForecastStartDayQueryParam: description: 'Number of days used for utilization forecast analysis. ' in: query name: forecastStartDay schema: type: integer default: 0 maximum: 365 minimum: 0 AwrSnapshotSortByQueryParam: description: The option to sort the AWR snapshot summary data. Default sort is by timeBegin. in: query name: sortBy required: false schema: type: string enum: - timeBegin - snapshotId default: timeBegin ImportableComputeEntityCollectionSortByQueryParam: description: 'Compute entity list sort options. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - computeId - computeDisplayName - platformType - hostName OpsiConfigurationConfigurationItemApplicableContextsQueryParam: description: 'Returns the configuration items filtered by applicable contexts sent in this param. By default configuration items of all applicable contexts are returned. ' in: query name: configItemsApplicableContext style: form explode: true schema: type: array items: type: string default: [] ConfigurationItemNameQueryParam: description: A filter to return only configuration items that match the entire name. in: query name: name x-default-description: 'null' schema: type: string ExadataDatabaseInsightIdsQueryParam: description: 'Optional list of database insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: databaseInsightId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 ObjectNamePathParam: description: Unique Awr Hub Object identifier in: path name: objectName required: true schema: type: string ExadataTypesQueryParam: description: 'Filter by one or more Exadata types. Possible value are DBMACHINE, EXACS, and EXACC. ' in: query name: exadataType required: false style: form explode: true schema: type: array items: type: string enum: - DBMACHINE - EXACS - EXACC default: [] ChargebackPlanIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan. in: path name: chargebackplanId required: true schema: type: string maxLength: 255 minLength: 1 ExadataInsightCollectionSortByQueryParam: description: 'Exadata insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - exadataName default: timeCreated ExadataInsightVMClusterNameQueryParam: description: 'Optional list of Exadata Insight VM cluster name. ' in: query name: vmclusterName required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 1 minItems: 1 AwrHubSourceStatusQueryParam: description: Resource Status in: query name: status style: form explode: true schema: type: array items: enum: - ACCEPTING - NOT_ACCEPTING - NOT_REGISTERED - TERMINATED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceStatus' default: [] EnterpriseManagerParentEntityIdentifierQueryParam: description: 'Used in combination with enterpriseManagerIdentifier to return the members of a particular Enterprise Manager parent entity. Both enterpriseManagerIdentifier and enterpriseManagerParentEntityIdentifier must be specified to identify a particular Enterprise Manager parent entity. ' in: query name: enterpriseManagerParentEntityIdentifier required: false x-default-description: 'null' schema: type: string KubeClusterInsightIdQueryParam: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of K8s cluster insight resource. ' in: query name: kubeClusterInsightId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParamRequired: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 AwrNumBucketOptionalQueryParam: description: The number of buckets within the histogram. in: query name: numBucket required: false schema: type: integer default: 10 maximum: 50 minimum: 5 KubeClusterInsightCollectionSortByQueryParam: description: 'Kubernetes cluster insight list sort options. If `fields` parameter is selected, the `sortBy` parameter must be one of the fields specified. Default order for timeCreated is descending. Default order for exadataName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - name default: timeCreated OperationsInsightsPrivateEndpointIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Operation Insights private endpoint. in: path name: operationsInsightsPrivateEndpointId required: true schema: type: string maxLength: 255 minLength: 1 AwrHubSourceIdPathParam: description: Unique Awr Hub Source identifier in: path name: awrHubSourceId required: true schema: type: string CapacityTrendSortByQueryParam: description: 'Sorts using end timestamp , capacity or baseCapacity ' in: query name: sortBy required: false schema: type: string enum: - endTimestamp - capacity - baseCapacity default: endTimestamp DatabaseInsightIdQueryParam: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. ' in: query name: id required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 UtilizationLevelQueryParam: description: "Filter by utilization level by the following buckets:\n - HIGH_UTILIZATION: DBs with utilization greater or equal than 75.\n - LOW_UTILIZATION: DBs with utilization lower than 25.\n - MEDIUM_HIGH_UTILIZATION: DBs with utilization greater or equal than 50 but lower than 75.\n - MEDIUM_LOW_UTILIZATION: DBs with utilization greater or equal than 25 but lower than 50.\n" in: query name: utilizationLevel required: false x-default-description: 'null' schema: type: string enum: - HIGH_UTILIZATION - LOW_UTILIZATION - MEDIUM_HIGH_UTILIZATION - MEDIUM_LOW_UTILIZATION ExadataHostInsightIdsQueryParam: description: 'Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: hostInsightId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 OpsiConfigurationFieldsQueryParam: description: 'Optional fields to return as part of OpsiConfiguration object. Unless requested, these fields will not be returned by default. ' in: query name: opsiConfigField style: form explode: true schema: type: array items: enum: - configItems type: string default: [] OpsiDataObjectTypeQueryParam: description: OPSI data object types. in: query name: dataObjectType style: form explode: true schema: type: array items: enum: - DATABASE_INSIGHTS_DATA_OBJECT - HOST_INSIGHTS_DATA_OBJECT - EXADATA_INSIGHTS_DATA_OBJECT type: string x-obmcs-top-level-enum: '#/definitions/OpsiDataObjectType' default: [] HostedEntityCollectionSortByQueryParam: description: 'Hosted entity list sort options. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - entityName - entityType ExadataInsightIdQueryParamRequired: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of exadata insight resource. ' in: query name: exadataInsightId required: true x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PercentileQueryParam: description: 'Percentile values of daily usage to be used for computing the aggregate resource usage. ' in: query name: percentile required: false schema: type: integer default: 90 maximum: 99 minimum: 1 OperationsInsightsWarehouseIdPathParam: description: Unique Ops Insights Warehouse identifier in: path name: operationsInsightsWarehouseId required: true schema: type: string OperationsInsightsWarehouseSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated AwrSnapshotBeginSnapshotIdentifierOptionalQueryParam: description: 'The optional greater than or equal to filter on the snapshot ID. ' in: query name: beginSnapshotIdentifierGreaterThanOrEqualTo required: false x-default-description: 'null' schema: type: integer OperationsInsightsWarehouseLifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseLifecycleState' default: [] HostInsightIdsQueryParam: description: 'Optional list of host insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 SqlIdentifierQueryParamRequired: description: 'Unique SQL_ID for a SQL Statement. Example: `6rgjh9bjmy2s7` ' in: query name: sqlIdentifier required: true schema: type: string maxLength: 13 ListHostInsightsEnterpriseManagerBridgeIdQueryParam: description: Unique Enterprise Manager bridge identifier in: query name: enterpriseManagerBridgeId x-default-description: 'null' schema: type: string CompartmentIdQueryParamOptional: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ObjectFieldsQueryParam: description: "By default all the fields are returned. Use this parameter to fetch specific fields 'size', 'etag', 'md5',\n'timeCreated', 'timeModified', 'storageTier' and 'archivalState' fields. List the names of those fields \nin a comma-separated, case-insensitive list as the value of this parameter. \nFor example: 'name,etag,timeCreated,md5,timeModified,storageTier,archivalState'.\n" in: query name: fields required: false x-default-description: 'null' schema: type: string enum: - name - size - etag - timeCreated - md5 - archivalState - timeModified - storageTier ResourceStatisticsSortByQueryParam: description: 'The order in which resource statistics records are listed ' in: query name: sortBy required: false schema: type: string enum: - utilizationPercent - usage - usageChangePercent - databaseName - databaseType default: utilizationPercent NameRequiredQueryParam: description: 'Required filter to return only changes for the specified parameter. The match is case sensitive. ' in: query name: name required: true schema: type: string ListExadataInsightExadataInsightIdsQueryParam: description: 'Optional list of Exadata insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 OpsiDataObjectIdentifierPathParam: description: Unique OPSI data object identifier. in: path name: opsiDataObjectIdentifier required: true schema: type: string maxLength: 255 minLength: 1 OpsiConfigurationTypesQueryParam: description: Filter to return based on configuration type of OPSI configuration. in: query name: opsiConfigType style: form explode: true schema: type: array items: enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' default: [] AwrMinValueOptionalQueryParam: description: The minimum value of the histogram. in: query name: minValue required: false schema: type: number format: double default: 0 HostConfigurationCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 AwrSnapshotEndSnapshotIdentifierOptionalQueryParam: description: 'The optional less than or equal to query parameter to filter the snapshot Identifier. ' in: query name: endSnapshotIdentifierLessThanOrEqualTo required: false x-default-description: 'null' schema: type: integer ListKubeClusterInsightIdsQueryParam: description: 'Optional list of Kubernetes cluster insight resource [OCIDs](/iaas/Content/General/Concepts/identifiers.htm). ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 50 minItems: 1 AwrDbParamChangeSortByQueryParam: description: The option to sort the AWR database parameter change history data. in: query name: sortBy required: false schema: type: string enum: - IS_CHANGED - NAME default: IS_CHANGED NameOrValueContainsOptionalQueryParam: description: 'Optional filter to return only resources whose name or value contains the substring given. The match is not case sensitive. ' in: query name: nameOrValueContains required: false x-default-description: 'null' schema: type: string StatisticQueryParam: description: Choose the type of statistic metric data to be used for forecasting. in: query name: statistic required: false schema: type: string enum: - AVG - MAX default: AVG HostIdQueryParam: description: 'Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host (Compute Id) ' in: query name: hostId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ExadataInsightIdPathParam: description: Unique Exadata insight identifier in: path name: exadataInsightId required: true schema: type: string DataObjectQueryDataPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 DatabaseIdQueryParam: description: 'Optional [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity. ' in: query name: databaseId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 AddmDbRecommendationSortByQueryParam: description: Field name for sorting the recommendation data in: query name: sortBy required: false schema: type: string enum: - maxBenefitPercent - maxBenefitAvgActiveSessions - frequencyCount default: maxBenefitPercent ExadataStatisticsPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 NameOptionalQueryParam: description: 'Optional filter to return only resources whose name exactly matches the substring given. The match is case sensitive. Only considered when categoryName is DATABASE_CONFIGURATION. ' in: query name: name required: false x-default-description: 'null' schema: type: string AwrSnapshotBeginTimeOptionalQueryParam: description: 'The optional greater than or equal to query parameter to filter the timestamp. The timestamp format to be followed is: YYYY-MM-DDTHH:MM:SSZ, example 2020-12-03T19:00:53Z ' in: query name: timeGreaterThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time AwrDbNameSampledTimeSortByQueryParam: description: The option to sort the AWR time series summary data. in: query name: sortBy required: false schema: type: string enum: - TIMESTAMP - NAME default: TIMESTAMP NewsReportIdQueryParam: description: Unique Ops Insights news report identifier in: query name: newsReportId x-default-description: 'null' schema: type: string DataObjectNameQueryParam: description: A filter to return only data objects that match the entire data object name. By default, no filtering will be applied on data object name. in: query name: name x-default-description: 'null' schema: type: string OpcRetryTokenHeaderParam: description: 'A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 ValueContainsOptionalQueryParam: description: 'Optional filter to return only resources whose value contains the substring given. The match is not case sensitive. ' in: query name: valueContains required: false x-default-description: 'null' schema: type: string HostResourceStatisticsSortByQueryParam: description: 'The order in which resource statistics records are listed. ' in: query name: sortBy required: false schema: type: string enum: - utilizationPercent - usage - usageChangePercent - hostName - platformType default: utilizationPercent FilterByDefinedTagExistsQueryParam: description: 'A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". ' in: query name: definedTagExists required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 207 type: string AwrSourcesSortByQueryParam: description: 'The order in which Awr sources summary records are listed ' in: query name: sortBy required: false schema: type: string enum: - snapshotsUploaded - name default: snapshotsUploaded AwrHubLifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubLifecycleState' default: [] ConfigurationItemsCollectionOpsiConfigurationTypeQueryParam: description: Filter to return configuration items based on configuration type of OPSI configuration. in: query name: opsiConfigType x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' schema: type: string enum: - UX_CONFIGURATION TimestampQueryParam: description: "Timestamp at which to gather the top processes. \nThis will be top processes over the hour or over the day pending the time range passed into the query.\n" in: query name: timestamp required: true x-default-description: Specific date for analysis in UTC (yyyy-MM-ddThh:mm:ssZ). schema: type: string format: date-time EntityNameContainsFilterOptionalQueryParam: description: The optional contains query parameter to filter the entity name by any part of the name. in: query name: nameContains required: false x-default-description: 'null' schema: type: string HostResourceMetricQueryParam: description: 'Filter by host resource metric. ' in: query name: resourceMetric required: true schema: type: string items: enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER type: string OperationsInsightsPrivateEndpointIdQueryParam: description: Unique Operations Insights PrivateEndpoint identifier in: query name: opsiPrivateEndpointId x-default-description: 'null' schema: type: string EntityNameQueryParam: description: The required single value query parameter to filter the entity name. in: query name: name required: true schema: type: string RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string ExadataInsightCapacityTrendSortByQueryParam: description: 'Sorts using end timestamp or capacity. ' in: query name: sortBy required: false schema: type: string enum: - endTimestamp - capacity default: endTimestamp EntityNamesQueryParam: description: The required multiple value query parameter to filter the entity name. in: query name: name required: true style: form explode: true schema: type: array items: type: string SessionTypeQueryParam: description: The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND. in: query name: sessionType required: false schema: type: string enum: - FOREGROUND - BACKGROUND - ALL default: FOREGROUND ExadataHostNamesQueryParam: description: 'Filter by hostname. ' in: query name: hostName required: false style: form explode: true schema: type: array items: type: string default: [] maxItems: 1 AwrDbCpuSortByQueryParam: description: The option to sort the AWR CPU usage summary data. in: query name: sortBy required: false schema: type: string enum: - TIME_SAMPLED - AVG_VALUE default: TIME_SAMPLED ConfigurationItemsCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 1000 minimum: 1 ProcessHashQueryParam: description: 'Unique identifier for a process. ' in: query name: processHash required: false x-default-description: 'null' schema: type: string VcnIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN. in: query name: vcnId required: false schema: type: string maxLength: 255 minLength: 1 ResourceMetricQueryParam: description: 'Filter by resource metric. Supported values are CPU , STORAGE, MEMORY and IO. ' in: query name: resourceMetric required: true schema: type: string items: enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA type: string SortOrderDescQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). ' in: query name: sortOrder required: false x-default-description: The option to sort information in ascending ('ASC') or descending ('DESC') order. Descending order is the default order. x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC default: DESC EnterpriseManagerBridgeIdPathParam: description: Unique Enterprise Manager bridge identifier in: path name: enterpriseManagerBridgeId required: true schema: type: string ExadataConfigurationCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 100 minimum: 1 DataObjectTypeQueryParam: description: A filter to return only data objects that match the data object type. By default, no filtering will be applied on data object type. in: query name: dataObjectType style: form explode: true schema: type: array items: enum: - VIEW - TABLE type: string x-obmcs-top-level-enum: '#/definitions/DataObjectType' default: [] ResourceStatusQueryParam: description: Resource Status in: query name: status style: form explode: true schema: type: array items: enum: - DISABLED - ENABLED - TERMINATED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' default: - ENABLED SqlIdQueryParam: description: 'The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/awrHubs/{awrHubId}/awrDbReport). ' in: query name: sqlId required: true schema: type: string DatabaseInsightCollectionPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 5000 minimum: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name. in: query name: displayName x-default-description: 'null' schema: type: string PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page required: false x-default-description: 'null' schema: type: string minLength: 1 TimeSeriesDatabaseIdsQueryParam: description: 'Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the associated DBaaS entity. ' in: query name: databaseId required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 20 minItems: 1 ExadataResourceForecastTrendCollectionSortByQueryParam: description: The order in which resource Forecast trend records are listed in: query name: sortBy required: false schema: type: string enum: - id - name - daysToReachCapacity default: name PaginationLargeLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 1000 maximum: 100000 minimum: 1 AddmSqlIdentifiersQueryParamRequired: description: 'One or more unique SQL_IDs for a SQL Statement. Example: `6rgjh9bjmy2s7` ' in: query name: sqlIdentifier required: true style: form explode: true schema: type: array items: maxLength: 13 type: string ChargebackPlanIdQueryParamOptional: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Ops Insights chargeback plan. in: query name: chargebackplanId required: false x-default-description: 'null' schema: type: string maxLength: 255 AddmDbParameterChangeSortByQueryParam: description: Field name for sorting the database parameter change data in: query name: sortBy required: false schema: type: string enum: - isChanged - beginSnapId default: beginSnapId TimeSeriesDatabaseInsightIdsQueryParam: description: 'Optional list of database [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. ' in: query name: id required: false style: form explode: true schema: type: array items: maxLength: 255 minLength: 1 type: string default: [] maxItems: 20 minItems: 1 OperationsInsightsWarehouseUserLifecycleStateQueryParam: description: Lifecycle states in: query name: lifecycleState style: form explode: true schema: type: array items: enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseUserLifecycleState' default: [] AwrSourceDatabaseIdentifierQueryParam: description: 'The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases ' in: query name: awrSourceDatabaseIdentifier required: true x-default-description: 'null' schema: type: string EndBeforeQueryParam: description: Object names returned by Awr Hub list objects query must be strictly less than this parameter. in: query name: end required: false x-default-description: 'null' schema: type: string ExadataResourceUsageSummaryPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 5 maximum: 10 minimum: 1 AwrHubSourceIdQueryParam: description: Awr Hub source identifier in: query name: awrHubSourceId required: false schema: type: string FilterByDefinedTagEqualsQueryParam: description: 'A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". ' in: query name: definedTagEquals required: false x-default-description: 'null' style: form explode: true schema: type: array items: maxLength: 458 type: string ExadataResourceUsageSummarySortByQueryParam: description: 'The order in which resource usage summary records are listed ' in: query name: sortBy required: false schema: type: string enum: - utilizationPercent - usage - capacity - usageChangePercent default: utilizationPercent ObjectIdsRequiredQueryParamRequired: description: 'One or more unique Object id (from RDBMS) ' in: query name: objectIdentifier required: true style: form explode: true schema: type: array items: type: integer DataObjectPaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit schema: type: integer default: 50 maximum: 100 minimum: 1 AddmDbFindingSortByQueryParam: description: Field name for sorting the ADDM finding summary data in: query name: sortBy required: false schema: type: string enum: - impactOverallPercent - impactMaxPercent - impactAvgActiveSessions - frequencyCount default: impactOverallPercent DatabaseInsightSummaryFieldsQueryParam: description: 'Specifies the fields to return in a database summary response. By default all fields are returned if omitted. ' in: query name: fields style: form explode: true schema: type: array items: enum: - compartmentId - databaseName - databaseDisplayName - databaseType - databaseVersion - databaseHostNames - freeformTags - definedTags type: string default: [] AwrSourceDatabaseIdentifierQueryParamRequired: description: AWR source database identifier. in: query name: awrSourceDatabaseIdentifier required: true x-default-description: 'null' schema: type: string ForecastDaysQueryParam: description: 'Number of days used for utilization forecast analysis. ' in: query name: forecastDays schema: type: integer default: 30 maximum: 365 minimum: 30 OperationsInsightsWarehouseUserSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated schemas: IngestMySqlSqlStatsDetails: description: 'Collection of MySql SQL Stats Metric Entries ' properties: items: description: List of MySql SQL Stats Metric Entries. items: $ref: '#/components/schemas/MySqlSqlStats' type: array type: object ChargebackPlanCollection: description: A collection of Ops Insights chargeback plan objects. properties: items: description: A list of ChargebackPlanSummary objects. items: $ref: '#/components/schemas/ChargebackPlanSummary' type: array required: - items type: object AwrDatabaseSummary: description: The AWR summary for a database. properties: awrSourceDatabaseIdentifier: description: 'The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases ' type: string dbName: description: The name of the database. type: string dbVersion: description: The version of the database. type: string firstSnapshotIdentifier: description: 'The ID of the earliest snapshot. The snapshot identifier is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabaseSnapshots ' type: integer instanceList: description: The database instance numbers. items: type: integer type: array latestSnapshotIdentifier: description: 'The ID of the latest snapshot. The snapshot identifier is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabaseSnapshots ' type: integer snapshotCount: description: The total number of snapshots. format: int64 type: integer snapshotIntervalInMin: description: The interval time between snapshots (in minutes). type: integer snapshotTimezone: description: The time zone of the snapshot. sample - snapshotTimezone=+0 00:00:00 type: string timeDbStartup: description: The timestamp of the database startup. format: date-time type: string timeFirstSnapshotBegin: description: The start time of the earliest snapshot. format: date-time type: string timeLatestSnapshotEnd: description: The end time of the latest snapshot. format: date-time type: string required: - awrSourceDatabaseIdentifier - dbName type: object CreateOperationsInsightsWarehouseDetails: description: The information about a Operations Insights Warehouse resource to be created. Input compartmentId MUST be the root compartment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuAllocated: description: 'Number of CPUs allocated to OPSI Warehouse ADW. ' format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of Ops Insights Warehouse that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object storageAllocatedInGBs: description: 'Storage allocated to OPSI Warehouse ADW. ' format: double type: number required: - compartmentId - displayName - cpuAllocated type: object AddmDbFindingsTimeSeriesSummary: description: ADDM findings time series data properties: analysisAvgActiveSessions: description: DB avg active sessions for the snapshot format: double type: number analysisDbTimeInSecs: description: DB time in seconds for the snapshot format: double type: number categoryDisplayName: description: Category display name type: string categoryName: description: Category name type: string findingId: description: Unique finding id type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string impactAvgActiveSessions: description: Impact in terms of average active sessions format: double type: number impactDbTimeInSecs: description: Impact in seconds format: double type: number impactPercent: description: Impact in terms of percentage of total activity format: double type: number message: description: Finding message type: string name: description: Finding name type: string taskId: description: Unique ADDM task id type: integer taskName: description: ADDM task name type: string timeAnalysisEnded: description: End Timestamp of snapshot format: date-time type: string timeAnalysisStarted: description: Start Timestamp of snapshot format: date-time type: string timestamp: description: Timestamp when finding was generated format: date-time type: string required: - id - taskId - taskName - findingId - timestamp - categoryName - categoryDisplayName - name - message - impactPercent - impactAvgActiveSessions type: object OpsiDataObjectDetailsInQuery: description: Details for OPSI data object used in a data object query. discriminator: propertyName: dataObjectDetailsTarget properties: dataObjectDetailsTarget: description: Data objects to which this OpsiDataObjectDetailsInQuery is applicable. enum: - INDIVIDUAL_OPSIDATAOBJECT - OPSIDATAOBJECTTYPE_OPSIDATAOBJECTS type: string x-obmcs-top-level-enum: '#/definitions/OpsiDataObjectDetailsTarget' queryParams: description: 'An array of query parameters to be applied, for the OPSI data objects targetted by dataObjectDetailsTarget, before executing the query. Refer to supportedQueryParams of OpsiDataObject for the supported query parameters. ' items: $ref: '#/components/schemas/OpsiDataObjectQueryParam' maxItems: 10 type: array required: - dataObjectDetailsTarget type: object ExadataInsightSummaryCollection: description: Collection of Exadata insight summary objects. properties: items: description: Array of Exadata insight summary objects. items: $ref: '#/components/schemas/ExadataInsightSummary' type: array required: - items type: object IngestSqlBucketDetails: description: 'Collection of SQL Bucket Metric Entries ' properties: items: description: List of SQL Bucket Metric Entries. items: $ref: '#/components/schemas/SqlBucket' type: array type: object AwrHub: description: Awr Hub resource. properties: awrMailboxUrl: description: Mailbox URL required for AWR hub and AWR source setup. maxLength: 1000 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of AWR Hub that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hubDstTimezoneVersion: description: Dst Time Zone Version of the AWR Hub maxLength: 255 minLength: 1 type: string id: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/AwrHubLifecycleState' objectStorageBucketName: description: Object Storage Bucket Name type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - operationsInsightsWarehouseId - id - compartmentId - displayName - objectStorageBucketName - timeCreated - lifecycleState type: object SqlPlanLine: description: SQL Plan Line type object. properties: accessPredicates: description: 'Access predicates Example: `"\"RESOURCE_ID\"=:1 AND \"QUERY_ID\"=:2"` ' type: string bytes: description: 'Bytes Example: `150` ' format: int64 type: integer cardinality: description: 'Cardinality Example: `1` ' format: int64 type: integer cost: description: 'Cost Example: `1` ' format: int64 type: integer cpuCost: description: 'CPU cost Example: `7321` ' format: int64 type: integer depth: description: 'Depth Example: `3` ' format: int64 type: integer distribution: description: 'Distribution Example: `"QC (RANDOM)"` ' type: string elapsedTimeInSec: description: 'Total elapsed time Example: `1.2` ' format: float type: number filterPredicates: description: 'Filter predicates Example: `"(INTERNAL_FUNCTION(\"J\".\"DATABASE_ROLE\") OR (\"J\".\"DATABASE_ROLE\" IS NULL AND SYS_CONTEXT(''userenv'',''database_role'')=''PRIMARY''))"` ' type: string forceMatchingSignature: description: 'Force matching signature Example: `"18067345456756876713"` ' type: string identifier: description: 'Identifier Example: `3` ' format: int64 type: integer ioCost: description: 'IO cost Example: `1` ' format: int64 type: integer objectAlias: description: 'Object Alias Example: `"PLAN_LINES@SEL$1"` ' type: string objectInstance: description: 'Object Instance Example: `37472` ' format: int64 type: integer objectName: description: 'Object Name Example: `"PLAN_LINES_PK"` ' type: string objectNode: description: 'Object Node Example: `"Q4000"` ' type: string objectOwner: description: 'Object Owner Example: `"TENANT_A#SCHEMA"` ' type: string objectType: description: 'Object Type Example: `"INDEX (UNIQUE)"` ' type: string operation: description: 'Operation Example: `"SELECT STATEMENT"` ' type: string optimizer: description: 'Optimizer Example: `"CLUSTER"` ' type: string options: description: 'Options Example: `"RANGE SCAN"` ' type: string other: description: 'Other Example: `` ' type: string otherTag: description: 'Other Tag Example: `"PARALLEL_COMBINED_WITH_PARENT"` ' type: string otherXML: description: 'Other SQL Example: `"18.0.0.04838927842709293936483892784"` ' type: string parentIdentifier: description: 'Parent Identifier Example: `2` ' format: int64 type: integer partitionIdentifier: description: 'Partition identifier Example: `8` ' format: int64 type: integer partitionStart: description: 'Partition start Example: `1` ' type: string partitionStop: description: 'Partition stop Example: `2` ' type: string planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer position: description: 'Position Example: `1` ' format: int64 type: integer projection: description: 'Projection Example: `"COUNT(*)[22]"` ' type: string qblockName: description: 'Qblock Name Example: `"SEL$1"` ' type: string remark: description: 'Remark Example: `""` ' type: string searchColumns: description: 'Search Columns Example: `3` ' format: int64 type: integer sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string tempSpace: description: 'Time space Example: `15614000` ' format: int64 type: integer timeCollected: description: 'Collection time stamp Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string timeGenerated: description: 'Generation time stamp Example: `"2020-05-05T02:10:00.000Z"` ' format: date-time type: string version: description: 'Version Example: `1` ' format: float type: number required: - sqlIdentifier - planHash - timeCollected - operation - identifier type: object x-example: "{\n \"version\":1.0,\n \"sqlIdentifier\":\"07rm5p65sc48u\",\n \"planHash\": 9820154385,\n \"forceMatchingSignature\": \"18067345456756876713\",\n \"timeGenerated\":\"2020-02-27T00:00:00.000Z\",\n \"timeCollected\":\"2020-02-27T00:00:00.000Z\",\n \"operation\":\"TABLE ACCESS\",\n \"remark\":\"\",\n \"options\":\"CLUSTER\",\n \"objectNode\":\":Q4000\",\n \"objectOwner\":\"SYS\",\n \"objectName\":\"USER$\",\n \"objectAlias\":\"USER$@SEL$1\",\n \"objectInstance\":10,\n \"objectType\":\"CLUSTER\",\n \"optimizer\":\"ALL_ROWS\",\n \"searchColumns\":1,\n \"identifier\":2,\n \"parentIdentifier\":1,\n \"depth\":1,\n \"position\":1,\n \"cost\":439,\n \"cardinality\":28,\n \"bytes\":980,\n \"other\":\"\",\n \"otherTag\":\"PARALLEL_COMBINED_WITH_PARENT\",\n \"partitionStart\":\"1\",\n \"partitionStop\":\"2\",\n \"partitionIdentifier\":8,\n \"distribution\":\"QC (RANDOM)\",\n \"cpuCost\":355900,\n \"ioCost\":5000,\n \"tempSpace\":15614000,\n \"accessPredicates\":\"\\\"USER#\\\"=:1\",\n \"filterPredicates\":\"(INTERNAL_FUNCTION(\\\"J\\\".\\\"DATABASE_ROLE\\\") OR (\\\"J\\\".\\\"DATABASE_ROLE\\\" IS NULL AND SYS_CONTEXT('userenv','database_role')='PRIMARY'))\",\n \"projection\":\"(rowset=256) \\\"J\\\".\\\"OBJ#\\\"[NUMBER,22], \\\"J\\\".\\\"CLASS_OID\\\"[NUMBER,22], \\\"J\\\".\\\"FLAGS\\\"[NUMBER,22], \\\"J\\\".\\\"JOB_STATUS\\\"[NUMBER,22], \\\"J\\\".\\\"NEXT_RUN_DATE\\\"[TIMESTAMP WITH TIME ZONE,13], \\\"J\\\".\\\"RETRY_COUNT\\\"[NUMBER,22], \\\"J\\\".\\\"JOB_DEST_ID\\\"[NUMBER,22]\",\n \"qblockName\":\"SEL$2\",\n \"elapsedTimeInSec\":1.2,\n \"otherXML\":\"18.0.0.04838927842709293936483892784\"\n}\n" DiskStatistics: description: Aggregated data per disk. properties: diskName: description: Name of the disk. type: string diskSizeInGBs: description: Size of the disk. format: double minimum: 0 type: number diskUnallocatedInGBs: description: Value for unallocated space in a disk. format: double minimum: 0 type: number diskUsageInGBs: description: Disk usage. format: double minimum: 0 type: number required: - diskName - diskUnallocatedInGBs - diskUsageInGBs - diskSizeInGBs type: object IngestDatabaseConfigurationResponseDetails: description: 'The response object returned from IngestDatabaseConfiguration operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object SummarizeAwrSourcesSummariesCollection: description: Collection of AwrSource summary objects. properties: items: description: Array of AwrSource summary objects. items: $ref: '#/components/schemas/AwrSourceSummary' type: array required: - items type: object SqlStatisticsTimeSeriesByPlanAggregation: description: SQL performance statistics for a given plan properties: planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer statistics: description: 'SQL performance statistics for a given plan ' items: $ref: '#/components/schemas/SqlStatisticsTimeSeries' type: array required: - planHash - statistics type: object AddmDbSchemaObjectSummary: description: Details for a given object id properties: id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string objectIdentifier: description: Object id (from RDBMS) type: integer objectName: description: Name of object type: string objectType: description: Type of the object (such as TABLE, INDEX) type: string owner: description: Owner of object type: string subObjectName: description: Subobject name; for example, partition name type: string required: - id - objectIdentifier - owner - objectName - objectType type: object AddmDbCollection: description: The result of ADDM databases properties: items: description: List of ADDM database summary data items: $ref: '#/components/schemas/AddmDbSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - items type: object AddmDbRecommendationCategorySummary: description: Recommendation category summary properties: displayName: description: Display name of recommendation category type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string name: description: Name of recommendation category type: string required: - id - name - displayName type: object SqlStatisticAggregation: description: SQL Statistics properties: category: description: 'SQL belongs to one or more categories based on the insights. ' items: type: string type: array databaseDetails: $ref: '#/components/schemas/DatabaseDetails' sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string statistics: $ref: '#/components/schemas/SqlStatistics' required: - sqlIdentifier - databaseDetails - category type: object AddmDbFindingCategoryCollection: description: 'List of finding categories ' properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of finding categories items: $ref: '#/components/schemas/AddmDbFindingCategorySummary' type: array required: - databaseDetailsItems - items type: object SummarizeHostInsightResourceCapacityTrendAggregationCollection: description: 'Top level response object. ' properties: capacityData: description: 'Capacity Data with timestamp. ' items: $ref: '#/components/schemas/HostResourceCapacityTrendAggregation' maxItems: 1000 type: array highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - usageUnit - itemDurationInMs - capacityData type: object IngestSqlTextResponseDetails: description: 'The response object returned from IngestSqlTextDetails operation. ' properties: message: description: 'Success message returned as a result of the upload. ' type: string required: - message type: object SummarizeExadataInsightResourceUtilizationInsightAggregation: description: 'Insights response containing utilization values for exadata systems. ' properties: exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string utilization: description: Collection of Exadata system utilization items: $ref: '#/components/schemas/ExadataInsightResourceInsightUtilizationItem' type: array required: - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - utilization type: object ImportableAgentEntitySummaryCollection: description: Collection of importable agent entity objects. properties: items: description: Array of importable agent entity objects. items: $ref: '#/components/schemas/ImportableAgentEntitySummary' type: array required: - items type: object ListObjects: description: List of the objects. properties: nextStartWith: description: Object names returned by a list query must be greater or equal to this parameter. type: string objects: description: List of the object summary data. items: $ref: '#/components/schemas/ObjectSummary' type: array prefixes: description: Array comprising of all the prefixes. items: type: string type: array required: - objects type: object SqlInventory: description: Inventory details. properties: sqlsAnalyzed: description: Total number of sqls analyzed by the query. Example `120` format: int64 type: integer totalDatabases: description: Total number of Databases. Example `400` format: int32 type: integer totalSqls: description: Total number of sqls. Example `2000` format: int64 type: integer required: - totalSqls - totalDatabases - sqlsAnalyzed type: object ChangeOperationsInsightsPrivateEndpointCompartmentDetails: description: The details used to change the compartment of a Operation Insights private endpoint. properties: compartmentId: description: The new compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private service accessed database. maxLength: 255 minLength: 1 type: string ResourceInsightCurrentUtilization: description: Current utilization(High/low) for cpu or storage properties: high: description: List of db ids with high usage example: '[id1,id2,id3]' items: type: string maxItems: 1000 type: array low: description: List of db ids with low usage example: '[id1, id2, id3]' items: type: string maxItems: 1000 type: array type: object CreateChargebackPlanDetails: description: The details used to create a new Ops Insights chargeback plan. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the chargeback plan. enum: - CHARGEBACK_EXADATA - CHARGEBACK_COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/ChargebackPlanEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object planCustomItems: description: List of chargeback plan customizations. items: $ref: '#/components/schemas/CreatePlanCustomItemDetails' maxItems: 25 type: array planDescription: description: Description of OPSI Chargeback Plan. example: Chargeback plan weighted for exadata maxLength: 400 type: string planName: description: Name for the OPSI Chargeback plan. example: Chargeback Plan weighted Allocation maxLength: 255 minLength: 1 type: string planType: description: 'Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. ' example: WEIGHTED_ALLOCATION maxLength: 255 minLength: 1 type: string required: - entitySource - planName - planType - compartmentId type: object DatabaseInsightSummary: description: Summary of a database insight resource. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseConnectionStatusDetails: description: A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection. type: string databaseDisplayName: description: The user-friendly name for the database. The name does not have to be unique. type: string databaseHostNames: description: The hostnames for the database. items: type: string type: array databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseName: description: The database name. The database name is unique within the tenancy. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the database entity. enum: - AUTONOMOUS_DATABASE - EM_MANAGED_EXTERNAL_DATABASE - MACS_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySourceAll' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the database. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer status: description: Indicates the status of a database insight in Operations Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the database insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the database insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - entitySource - databaseId type: object ChangeOpsiConfigurationCompartmentDetails: description: The information used to change the compartment of an OPSI configuration resource. properties: compartmentId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateDatabaseInsightDetails: description: The information about database to be analyzed. discriminator: propertyName: entitySource properties: compartmentId: description: Compartment Identifier of database maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the database entity. enum: - EM_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource - compartmentId type: object ChargebackPlanReport: description: A chargeback plan report that allows Ops Insights services to showcase chargeback costs. properties: reportId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string reportName: description: The chargeback plan report name. maxLength: 255 minLength: 1 type: string reportProperties: $ref: '#/components/schemas/ReportPropertyDetails' resourceId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string resourceType: description: 'Defines the type of resource (example: EXADATA, HOST) ' enum: - EXADATA_INSIGHT - DATABASE_INSIGHT - HOST_INSIGHT example: EXADATA_INSIGHT type: string timeCreated: description: The date and time the chargeback plan was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The time chargeback plan was updated. An RFC3339 formatted datetime string format: date-time type: string required: - reportId - reportName - resourceId - resourceType - timeCreated - timeUpdated - reportProperties type: object ImportableAgentEntitySummary: description: An agent entity that can be imported into Operations Insights. discriminator: propertyName: entitySource properties: entitySource: description: Source of the importable agent entity. enum: - MACS_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/ImportableAgentEntitySource' managementAgentDisplayName: description: The [Display Name](/iaas/Content/General/Concepts/identifiers.htm#Display) of the Management Agent maxLength: 255 minLength: 1 type: string managementAgentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent maxLength: 255 minLength: 1 type: string required: - entitySource - managementAgentId - managementAgentDisplayName type: object ChargebackPlanReportCollection: description: A collection of chargeback plan reports objects. properties: items: description: A list of ChargebackPlanReportSummary objects. items: $ref: '#/components/schemas/ChargebackPlanReportSummary' maxItems: 50 minItems: 0 type: array required: - items type: object HostPerformanceMetricGroup: description: 'Base Metric Group for Host performance metrics ' discriminator: propertyName: metricName properties: metricName: description: 'Name of the metric group ' enum: - HOST_CPU_USAGE - HOST_MEMORY_USAGE - HOST_NETWORK_ACTIVITY_SUMMARY - HOST_TOP_PROCESSES - HOST_K8S_WORKLOAD - HOST_K8S_CONTAINER - HOST_K8S_SERVICE - HOST_K8S_POD_STATUS - HOST_K8S_WORKLOAD_STATUS - HOST_SENSOR_STATUS type: string timeCollected: description: 'Collection timestamp Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string required: - metricName - timeCollected type: object SqlStatisticsTimeSeries: description: SQL performance statistics per database properties: name: description: 'SQL performance statistic name ' type: string values: description: 'SQL performance statistic value ' items: format: double type: number type: array required: - name - values type: object ChangeAutonomousDatabaseInsightAdvancedFeaturesDetails: description: Advanced feature details of autonomous database insight. properties: connectionDetails: $ref: '#/components/schemas/ConnectionDetails' credentialDetails: $ref: '#/components/schemas/CredentialDetails' opsiPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint maxLength: 255 minLength: 1 type: string required: - connectionDetails - credentialDetails type: object SqlText: description: SQL Text type object. properties: exactMatchingSignature: description: 'Exact matching signature Example: `"18067345456756876713"` ' type: string forceMatchingSignature: description: 'Force matching signature Example: `"18067345456756876713"` ' type: string sqlCommand: description: 'SQL command Example: `"SELECT"` ' type: string sqlFullText: description: 'Full SQL Text Example: `"SELECT username,profile,default_tablespace,temporary_tablespace FROM dba_users"` Disclaimer: SQL text being uploaded explicitly via APIs is not masked. Any sensitive literals contained in the sqlFullText column should be masked prior to ingestion. ' type: string sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeCollected: description: 'Collection timestamp Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string version: description: 'Version Example: `1` ' format: float type: number required: - sqlIdentifier - timeCollected - sqlCommand - sqlFullText type: object x-example: "{\n \"version\":1.0,\n \"sqlIdentifier\":\"07rm5p65sc48u\",\n \"timeCollected\":\"2020-06-30T00:00:00.000Z\",\n \"sqlCommand\":\"SELECT\",\n \"exactMatchingSignature\":\"1111111111111111111\",\n \"forceMatchingSignature\":\"1111111111111111111\",\n \"sqlFullText\":\"SELECT 1 from dual\"\n}\n" UpdateOpsiConfigurationDetails: description: Information to be updated in OPSI configuration resource. discriminator: propertyName: opsiConfigType properties: configItems: description: 'Array of configuration items with custom values. All and only configuration items requiring custom values should be part of this array. This array overwrites the existing custom configuration items array for this resource. ' items: $ref: '#/components/schemas/UpdateConfigurationItemDetails' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OPSI configuration. example: Custom configurations for user experience in the sales department compartment. maxLength: 400 type: string displayName: description: User-friendly display name for the OPSI configuration. The name does not have to be unique. example: Sales department configurations. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object opsiConfigType: description: OPSI configuration type. enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - opsiConfigType type: object AwrDatabaseMetricCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_METRICS_SET properties: items: description: A list of AWR metric summary data. items: $ref: '#/components/schemas/AwrDatabaseMetricSummary' type: array description: The AWR metrics time series summary data. type: object NewsContentTypesResource: description: Supported resources for the news report content types. enum: - HOST - DATABASE - EXADATA type: string AwrSnapshotSummary: description: The AWR snapshot summary of one snapshot. properties: awrSourceDatabaseId: description: DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string errorCount: description: The total number of errors. format: int64 type: integer instanceNumber: description: The database instance number. type: integer snapshotIdentifier: description: The identifier of the snapshot. type: integer timeDbStartup: description: The timestamp of the database startup. format: date-time type: string timeSnapshotBegin: description: The start time of the snapshot. format: date-time type: string timeSnapshotEnd: description: The end time of the snapshot. format: date-time type: string required: - awrSourceDatabaseId - snapshotIdentifier type: object SummarizeHostInsightsDiskStatisticsCollection: description: 'Top level response object. ' properties: itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer items: description: 'Collection of Data for all disks in a host. ' items: $ref: '#/components/schemas/DiskStatistics' maxItems: 30 type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - timeIntervalStart - timeIntervalEnd - usageUnit - itemDurationInMs - items type: object ReportPropertyDetails: description: Chargeback plan report properties. properties: analysisTimeInterval: description: 'Specify time period in ISO 8601 format with respect to current time. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M). ' type: string groupBy: description: Report filters used in grouping items: $ref: '#/components/schemas/ReportGroupingDetails' type: object timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - analysisTimeInterval - timeIntervalStart - timeIntervalEnd - groupBy type: object EnableDatabaseInsightDetails: description: The information about database to be analyzed. discriminator: propertyName: entitySource properties: entitySource: description: Source of the database entity. enum: - EM_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySource' required: - entitySource type: object AwrDatabaseSysstatCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_SYSSTAT_SET properties: items: description: A list of AWR SYSSTAT summary data. items: $ref: '#/components/schemas/AwrDatabaseSysstatSummary' type: array description: The AWR SYSSTAT time series summary data. type: object ChangeExternalMysqlDatabaseInsightConnectionDetails: description: 'MySQL support within the OCI Ops Insights service has been deprecated as of January 29, 2026. Connection details of an External MySQL database insight. ' properties: databaseConnectorId: description: The DBM owned database connector [OCID](/iaas/database-management/doc/view-connector-details.html) mapping to the database credentials and connection details. maxLength: 255 minLength: 1 type: string required: - databaseConnectorId type: object SummarizeDatabaseInsightResourceStatisticsAggregationCollection: description: Returns list of the Databases with resource statistics like usage, capacity, utilization and usage change percent. properties: highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer items: description: Collection of Resource Statistics items items: $ref: '#/components/schemas/ResourceStatisticsAggregation' type: array lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - usageUnit - resourceMetric - items - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold type: object DatabaseDetails: description: Partial information about the database which includes id, name, type. properties: cdbName: description: Name of the CDB.Only applies to PDB. maxLength: 255 minLength: 1 type: - string - 'null' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseDisplayName: description: The user-friendly name for the database. The name does not have to be unique. type: string databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseName: description: The database name. The database name is unique within the tenancy. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string instances: description: Array of hostname and instance name. items: $ref: '#/components/schemas/HostInstanceMap' type: array required: - id - databaseId - compartmentId - databaseName - databaseType type: object UpdateDatabaseInsightDetails: description: The information to be updated. discriminator: propertyName: entitySource properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the database entity. enum: - AUTONOMOUS_DATABASE - EM_MANAGED_EXTERNAL_DATABASE - MACS_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySourceAll' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource type: object IngestMySqlSqlStatsResponseDetails: description: 'The response object returned from IngestMySqlSqlStats operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object ChangeDatabaseInsightCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The OCID of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateChargebackPlanReportDetails: description: The details used to create a new Ops Insights chargeback plan report. properties: reportName: description: The chargeback plan report name. maxLength: 255 minLength: 1 type: string reportProperties: $ref: '#/components/schemas/ReportPropertyDetails' required: - reportName - reportProperties type: object CreateHostInsightDetails: description: The information about the host to be analyzed. discriminator: propertyName: entitySource properties: compartmentId: description: Compartment Identifier of host maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource - compartmentId type: object AwrDatabaseMetricSummary: description: The summary of the AWR metric data for a particular metric at a specific time. properties: avgValue: description: The average value of the sampling period. format: double type: number maxValue: description: The maximum value of the sampling period. format: double type: number minValue: description: The minimum value of the sampling period. format: double type: number name: description: The name of the metric. type: string timestamp: description: The time of the sampling. format: date-time type: string required: - name type: object ChargebackPlan: description: A chargeback plan that allows Ops Insights services to compute chargeback costs. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the chargeback plan. enum: - CHARGEBACK_EXADATA - CHARGEBACK_COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/ChargebackPlanEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource.' maxLength: 255 minLength: 1 type: string isCustomizable: default: false description: Indicates whether the chargeback plan can be customized. example: false type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Chargeback Plan lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' planCategory: description: Chargeback Plan category of the chargeback entity. It can be OOB, or CUSTOM. enum: - OOB - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/ChargebackPlanCategory' planCustomItems: description: List of chargeback plan customizations. items: $ref: '#/components/schemas/CreatePlanCustomItemDetails' maxItems: 25 type: array planDescription: description: Description of OPSI Chargeback Plan. example: Chargeback plan weighted for exadata maxLength: 400 type: string planName: description: Name for the OPSI Chargeback plan. example: Chargeback Plan weighted Allocation maxLength: 255 minLength: 1 type: string planType: description: 'Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. ' example: WEIGHTED_ALLOCATION maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the chargeback plan was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The time chargeback plan was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - planName - planType - timeCreated - lifecycleState type: object ResourceFilters: description: 'Information to filter the actual target resources in an operation. e.g: While querying a DATABASE_INSIGHTS_DATA_OBJECT using /opsiDataObjects/actions/queryData API, if resourceFilters is set with valid value for definedTagEquals field, only data of the database insights resources for which the specified freeform tags exist will be considered for the actual query scope. ' properties: compartmentIdInSubtree: default: false description: A flag to consider all resources within a given compartment and all sub-compartments. type: boolean definedTagEquals: description: 'A list of tag filters to apply. Only resources with a defined tag matching the value will be considered. Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". ' items: maxLength: 458 type: string type: array definedTagExists: description: 'A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be considered. Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag) or "{namespace}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". ' items: maxLength: 207 type: string type: array freeformTagEquals: description: 'A list of tag filters to apply. Only resources with a freeform tag matching the value will be considered. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND". ' items: maxLength: 357 type: string type: array freeformTagExists: description: 'A list of tag existence filters to apply. Only resources for which the specified freeform tags exist will be considered. The key for each tag is "{tagName}.true". All inputs are case-insensitive. Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported. Multiple values for different tag names are interpreted as "AND". ' items: maxLength: 106 type: string type: array type: object SummarizeExadataInsightResourceStatisticsAggregationCollection: description: Returns list of the resources with resource statistics like usage,capacity,utilization and usage change percent. properties: exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string items: description: Collection of Resource Statistics items items: $ref: '#/components/schemas/ExadataInsightResourceStatisticsAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - items - timeIntervalStart - timeIntervalEnd - usageUnit - exadataResourceMetric - exadataInsightId type: object AwrDatabaseWaitEventSummary: description: The summary of the AWR wait event time series data for one event. properties: avgWaitTimePerSec: description: The average wait time per second. format: double type: number name: description: The name of the event. type: string snapshotIdentifier: description: 'The ID of the snapshot. The snapshot identifier is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabaseSnapshots ' type: integer timeBegin: description: The begin time of the wait event. format: date-time type: string timeEnd: description: The end time of the wait event. format: date-time type: string waitsPerSec: description: The wait count per second. format: double type: number required: - name type: object ChangeKubeClusterInsightCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ResourceUsageSummary: description: Contains resource usage summary properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Change in resource utilization in percentage example: 5.2 format: double type: number utilizationPercent: description: Resource utilization in percentage example: 35.1 format: double type: number required: - exadataInsightId - usage - capacity - utilizationPercent - usageChangePercent type: object SummarizeHostInsightsTopProcessesUsageCollection: description: 'Top level response object. ' properties: items: description: List of usage data samples for a top process on a specific date. items: $ref: '#/components/schemas/TopProcessesUsage' type: array timestamp: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timestamp - items type: object NewsContentTypes: description: Content types that the news report can handle. properties: capacityPlanningResources: description: Supported resources for capacity planning content type. items: $ref: '#/components/schemas/NewsContentTypesResource' type: array sqlInsightsFleetAnalysisResources: description: Supported resources for SQL insights - fleet analysis content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array sqlInsightsPerformanceDegradationResources: description: Supported resources for SQL insights - performance degradation content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array sqlInsightsPlanChangesResources: description: Supported resources for SQL insights - plan changes content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array sqlInsightsTopDatabasesResources: description: Supported resources for SQL insights - top databases content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array sqlInsightsTopSqlByInsightsResources: description: Supported resources for SQL insights - top SQL by insights content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array sqlInsightsTopSqlResources: description: Supported resources for SQL insights - top SQL content type. items: $ref: '#/components/schemas/NewsSqlInsightsContentTypesResource' type: array type: object AwrDatabaseWaitEventCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_EVENT_SET properties: items: description: A list of AWR wait events. items: $ref: '#/components/schemas/AwrDatabaseWaitEventSummary' type: array description: The AWR wait event data. type: object AwrHubSummaryCollection: description: Collection of Hub resources. properties: items: description: Array of Hub summary objects. items: $ref: '#/components/schemas/AwrHubSummary' type: array required: - items WarehouseDataObjectDetails: description: Warehouse data object details. discriminator: propertyName: dataObjectType properties: dataObjectType: description: Type of the data object. enum: - VIEW - TABLE type: string x-obmcs-top-level-enum: '#/definitions/DataObjectType' required: - dataObjectType type: object HostConfigurationCollection: description: Collection of host insight configuration summary objects. properties: items: description: Array of host insight configurations summary objects. items: $ref: '#/components/schemas/HostConfigurationSummary' type: array required: - items type: object SummarizeExadataInsightResourceUsageAggregation: description: Resource usage summation for the current time period properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Percentage change in resource usage during the current period calculated using linear regression functions example: 10.23 format: double type: number usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - capacity - usage - usageUnit - usageChangePercent type: object ChangeChargebackPlanCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AddmDbParameterCategorySummary: description: Database parameter category summary properties: displayName: description: Display name of database parameter category type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string name: description: Name of database parameter category type: string required: - id - name - displayName type: object SummarizeHostInsightResourceUtilizationInsightAggregation: description: 'Insights response containing current/projected groups for CPU or memory. ' properties: currentUtilization: $ref: '#/components/schemas/ResourceInsightCurrentUtilization' highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer projectedUtilization: $ref: '#/components/schemas/ResourceInsightProjectedUtilization' resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - projectedUtilization - currentUtilization type: object ConfigurationItemsCollection: description: Collection of configuration item summary objects. discriminator: propertyName: opsiConfigType properties: configItems: description: Array of configuration item summary objects. items: $ref: '#/components/schemas/ConfigurationItemSummary' type: array opsiConfigType: description: OPSI configuration type. enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' required: - opsiConfigType type: object PeComanagedDatabaseHostDetails: description: Input Host Details used for connection requests for private endpoint accessed db resource. properties: hostIp: description: Host IP used for connection requests for Cloud DB resource. maxLength: 255 minLength: 1 type: string port: description: Listener port number used for connection requests for rivate endpoint accessed db resource. maximum: 65535 minimum: 1024 type: integer type: object InstanceMetrics: description: Object containing instance metrics. properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number hostName: description: The hostname of the database insight resource. maxLength: 255 minLength: 1 type: string instanceName: description: The instance name of the database insight resource. maxLength: 255 minLength: 1 type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Change in resource utilization in percentage example: 5.2 format: double type: number utilizationPercent: description: Resource utilization in percentage example: 35.1 format: double type: number type: object AwrDatabaseSqlReport: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_SQL_REPORT properties: content: description: The content of the report. type: string format: description: The format of the report. enum: - HTML - TEXT type: string description: The result of the AWR SQL report. type: object UpdateOperationsInsightsWarehouseUserDetails: description: The information to be updated. properties: connectionPassword: description: User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. format: password maxLength: 20 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isAwrDataAccess: description: Indicate whether user has access to AWR data. type: boolean isEmDataAccess: description: Indicate whether user has access to EM data. type: boolean isOpsiDataAccess: description: Indicate whether user has access to OPSI data. type: boolean type: object DataObjectBindParameter: description: Details for a bind parameter used in data object query. properties: dataType: description: Data type of the bind parameter. maxLength: 64 minLength: 1 type: string name: description: Name of the bind parameter. maxLength: 64 minLength: 1 type: string value: additionalProperties: true description: Value for the bind parameter. type: object required: - name - value - dataType type: object AddExadataInsightMembersDetails: description: The information about the members of Exadata system to be added. discriminator: propertyName: entitySource properties: entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' required: - entitySource type: object UpdateAwrHubDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of AWR Hub that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object SummarizeDatabaseInsightResourceForecastTrendAggregation: description: Forecast results from the selected time period. properties: highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer historicalData: description: Time series data used for the forecast analysis. items: $ref: '#/components/schemas/HistoricalDataItem' type: array lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer pattern: description: Time series patterns used in the forecasting. enum: - LINEAR - MONTHLY_SEASONS - MONTHLY_AND_YEARLY_SEASONS - WEEKLY_SEASONS - WEEKLY_AND_MONTHLY_SEASONS - WEEKLY_MONTHLY_AND_YEARLY_SEASONS - WEEKLY_AND_YEARLY_SEASONS - YEARLY_SEASONS type: string projectedData: description: Time series data result of the forecasting analysis. items: $ref: '#/components/schemas/ProjectedDataItem' type: array resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string selectedForecastAlgorithm: description: Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast. example: NaiveForecaster type: string tablespaceName: description: The name of tablespace. type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - usageUnit - pattern - tablespaceName - historicalData - projectedData type: object AwrDatabaseCpuUsageSummary: description: A summary of the AWR CPU resource limits and metrics. properties: avgUsageInSecs: description: The average CPU usage per second. format: double type: number timestamp: description: The timestamp for the CPU summary data. format: date-time type: string type: object ResourceStatisticsAggregation: description: Contains database details and resource statistics properties: currentStatistics: $ref: '#/components/schemas/ResourceStatistics' databaseDetails: $ref: '#/components/schemas/DatabaseDetails' type: object OperationsInsightsWarehouse: description: OPSI warehouse resource. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuAllocated: description: 'Number of CPUs allocated to OPSI Warehouse ADW. ' format: double type: number cpuUsed: description: 'Number of OCPUs used by OPSI Warehouse ADW. Can be fractional. ' format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of Ops Insights Warehouse that does not have to be unique. maxLength: 255 minLength: 1 type: string dynamicGroupId: description: OCID of the dynamic group created for the warehouse maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseLifecycleState' operationsInsightsTenancyId: description: Tenancy Identifier of Ops Insights service maxLength: 255 minLength: 1 type: string storageAllocatedInGBs: description: 'Storage allocated to OPSI Warehouse ADW. ' format: double type: number storageUsedInGBs: description: 'Storage by OPSI Warehouse ADW in GB. ' format: double type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeLastWalletRotated: description: The time at which the ADW wallet was last rotated for the Ops Insights Warehouse. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - displayName - cpuAllocated - timeCreated - lifecycleState type: object HostResourceStatistics: description: 'Contains host resource base statistics. ' discriminator: propertyName: resourceName properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number resourceName: description: Name of resource for host enum: - HOST_CPU_STATISTICS - HOST_MEMORY_STATISTICS - HOST_IO_STATISTICS type: string usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Change in resource utilization in percentage example: 5.2 format: double type: number utilizationPercent: description: 'Resource utilization in percentage. ' example: 35.1 format: double maximum: 100 type: number required: - usage - capacity - utilizationPercent - usageChangePercent - resourceName type: object IngestSqlTextDetails: description: 'Collection of SQL Text Entries ' properties: items: description: List of SQL Text Entries. items: $ref: '#/components/schemas/SqlText' type: array type: object ChangeOperationsInsightsWarehouseCompartmentDetails: description: The information to be updated. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SqlResponseTimeDistributionAggregationCollection: description: 'SQL response time distribution over the selected time window. ' properties: databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string items: description: Array of pre defined SQL response time bucket id and SQL executions count. items: $ref: '#/components/schemas/SqlResponseTimeDistributionAggregation' type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - sqlIdentifier - id - databaseId - timeIntervalStart - timeIntervalEnd - items type: object QueryDataObjectResultSetRowsCollection: description: Collection of result set rows from the data object query. discriminator: propertyName: format properties: format: description: Format type of data object query result set. enum: - JSON type: string required: - format type: object UpdateNewsReportDetails: description: The information about the news report to be updated. properties: areChildCompartmentsIncluded: default: false description: A flag to consider the resources within a given compartment and all sub-compartments. type: boolean contentTypes: $ref: '#/components/schemas/NewsContentTypes' dayOfWeek: description: Day of the week in which the news report will be sent if the frequency is set to WEEKLY. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY example: MONDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The description of the news report. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locale: description: Language of the news report. enum: - EN type: string x-obmcs-top-level-enum: '#/definitions/NewsLocale' name: description: The news report name. maxLength: 255 minLength: 1 type: string newsFrequency: description: News report frequency. enum: - WEEKLY example: WEEKLY type: string x-obmcs-top-level-enum: '#/definitions/NewsFrequency' onsTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ONS topic. maxLength: 255 minLength: 1 type: string status: description: Defines if the news report will be enabled or disabled. enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' type: object ChangeAwrHubSourceCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The OCID of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ExadataInsightResourceCapacityTrendAggregation: description: Resource Capacity samples properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number required: - endTimestamp - capacity type: object SqlInsightThresholds: description: Inventory details. properties: degradationInPct: default: 20 description: 'Degradation Percent Threshold is used to derive degrading SQLs. ' format: int32 type: integer improvedInPct: default: 20 description: 'Improved Percent Threshold is used to derive improving SQLs. ' format: int32 type: integer increaseInCPUInPct: default: 50 description: 'PctIncreaseInCPU is used for deriving insights for SQLs which are degrading or variant or inefficient. And these SQLs should also have increasing change in CPU Time beyond threshold. Insights are derived using linear regression. ' format: int32 type: integer increaseInIOInPct: default: 50 description: 'PctIncreaseInIO is used for deriving insights for SQLs which are degrading or variant or inefficient. And these SQLs should also have increasing change in IO Time beyond threshold. Insights are derived using linear regression. ' format: int32 type: integer increaseInInefficientWaitInPct: default: 50 description: 'PctIncreaseInIO is used for deriving insights for SQLs which are degrading or variant or inefficient. And these SQLs should also have increasing change in Other Wait Time beyond threshold. Insights are derived using linear regression. ' format: int32 type: integer inefficiencyInPct: default: 20 description: 'Inefficiency Percent Threshold is used to derive inefficient SQLs. ' format: int32 type: integer variability: default: 1.66 description: 'Variability Percent Threshold is used to derive variant SQLs. ' format: float type: number required: - degradationInPct - variability - inefficiencyInPct - increaseInIOInPct - increaseInCPUInPct - increaseInInefficientWaitInPct - improvedInPct type: object SummarizeExadataInsightResourceForecastTrendCollection: description: Usage and Forecast results with breakdown by databases, hosts or storage servers. properties: exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string items: description: Collection of id, name , daysToReach Capacity, historical usage and projected usage forecast. items: $ref: '#/components/schemas/ExadataInsightResourceForecastTrendSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataInsightId - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - items type: object SqlPlanInsightAggregationCollection: description: 'SQL plan insights response. ' properties: databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string insights: description: List of SQL plan insights. items: $ref: '#/components/schemas/SqlPlanInsights' type: array items: description: List of SQL plan statistics. items: $ref: '#/components/schemas/SqlPlanInsightAggregation' type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - sqlIdentifier - id - databaseId - timeIntervalStart - timeIntervalEnd - insights - items type: object SqlInsightAggregationCollection: description: 'SQL Insights response. ' properties: inventory: $ref: '#/components/schemas/SqlInventory' items: description: List of insights. items: $ref: '#/components/schemas/SqlInsightAggregation' type: array thresholds: $ref: '#/components/schemas/SqlInsightThresholds' timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - inventory - thresholds - items type: object OperationsInsightsWarehouseSummaryCollection: description: Collection of Operations Insights Warehouse summary objects. properties: items: description: Array of Operations Insights Warehouse summary objects. items: $ref: '#/components/schemas/OperationsInsightsWarehouseSummary' type: array required: - items type: object ObjectSummary: description: Summary resource object. properties: archivalState: description: Archival state of an object for those in the archival tier. enum: - ARCHIVED - RESTORING - RESTORED type: string x-obmcs-top-level-enum: '#/definitions/ArchivalState' etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string md5: description: Base64-encoded MD5 hash of the Awr Hub object data. type: string name: description: The name of the Awr Hub object. type: string size: description: Size of the Awr Hub object in bytes. format: int64 type: integer storageTier: description: The object's storage tier. enum: - STANDARD - INFREQUENTACCESS - ARCHIVE type: string x-obmcs-top-level-enum: '#/definitions/StorageTier' timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeModified: description: The date and time the Awr Hub object was modified format: date-time type: string type: object OpsiConfiguration: description: OPSI configuration. discriminator: propertyName: opsiConfigType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string configItems: description: Array of configuration item summary objects. items: $ref: '#/components/schemas/OpsiConfigurationConfigurationItemSummary' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OPSI configuration. example: Custom configurations for user experience in the sales department compartment. maxLength: 400 type: string displayName: description: User-friendly display name for the OPSI configuration. The name does not have to be unique. example: Sales department configurations. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: OPSI configuration resource lifecycle state. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationLifecycleState' opsiConfigType: description: OPSI configuration type. enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - opsiConfigType type: object ExadataInsightResourceCapacityTrendSummary: description: List of resource id, name , capacity time series data properties: capacityData: description: Time series data for capacity items: $ref: '#/components/schemas/ExadataInsightResourceCapacityTrendAggregation' type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string name: description: The name of the resource. maxLength: 255 minLength: 1 type: string required: - id - name - capacityData type: object ExadataInsightSummary: description: Summary of an Exadata insight resource. discriminator: propertyName: entitySource properties: chargebackPlanDetails: $ref: '#/components/schemas/ChargebackPlanDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataName: description: The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. maxLength: 255 minLength: 1 type: string exadataRackType: description: Operations Insights internal representation of the the Exadata system rack type. enum: - FULL - HALF - QUARTER - EIGHTH - FLEX - BASE - ELASTIC - ELASTIC_BASE - ELASTIC_LARGE type: string x-obmcs-top-level-enum: '#/definitions/ExadataRackType' exadataType: description: Operations Insights internal representation of the the Exadata system type. enum: - DBMACHINE - EXACS - EXACC type: string x-obmcs-top-level-enum: '#/definitions/ExadataType' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Exadata insight. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/ExadataInsightLifecycleState' status: description: Indicates the status of an Exadata insight in Operations Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' statusDetails: description: A message describing the status of the Exadata Resource. For example, it can be used to provide actionable information about the policies needed to access the Exadata Resource. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Exadata insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Exadata insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - entitySource - id - compartmentId - exadataName - status - timeCreated - lifecycleState - freeformTags - definedTags type: object AwrSnapshotCollection: description: The list of AWR snapshots for one database. properties: items: description: A list of AWR snapshot summary data. items: $ref: '#/components/schemas/AwrSnapshotSummary' type: array required: - items type: object SummarizeDatabaseInsightTablespaceUsageTrendAggregationCollection: description: 'Top level response object. ' properties: itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer items: description: 'Collection of Usage Data with time stamps for top five tablespace ' items: $ref: '#/components/schemas/TablespaceUsageTrendAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - timeIntervalStart - timeIntervalEnd - usageUnit - itemDurationInMs - items type: object IngestHostConfigurationResponseDetails: description: 'The response object returned from IngestHostConfiguration operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object UpdateEnterpriseManagerBridgeDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of Enterprise Manager Bridge maxLength: 400 type: string displayName: description: User-friedly name of Enterprise Manager Bridge that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object SqlSearchSummary: description: Database summary object resulting from a sql search operation. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseDisplayName: description: The user-friendly name for the database. The name does not have to be unique. type: string databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseName: description: The database name. The database name is unique within the tenancy. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string required: - id - databaseId - compartmentId - databaseName - databaseDisplayName - databaseType - databaseVersion type: object DatabaseInsightsCollection: description: Collection of database insight summary objects. properties: items: description: Array of database insight summary objects. items: $ref: '#/components/schemas/DatabaseInsightSummary' type: array required: - items type: object AddmDbFindingCategorySummary: description: Finding category summary properties: displayName: description: Display name of finding category type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string name: description: Name of finding category type: string required: - id - name - displayName type: object SummarizeDatabaseInsightResourceUsageTrendAggregationCollection: description: 'Top level response object. ' properties: itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageData: description: 'Usage Data with time stamps ' items: $ref: '#/components/schemas/ResourceUsageTrendAggregation' type: array usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - itemDurationInMs - usageData type: object ResourceCapacityTrendAggregation: description: Resource Capacity samples properties: baseCapacity: description: 'The base allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number required: - endTimestamp - capacity - baseCapacity type: object EnableHostInsightDetails: description: The information about the host to be analyzed. discriminator: propertyName: entitySource properties: entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' required: - entitySource type: object EnableAutonomousDatabaseInsightAdvancedFeaturesDetails: description: The advanced feature details for autonomous database to be enabled. properties: connectionDetails: $ref: '#/components/schemas/ConnectionDetails' credentialDetails: $ref: '#/components/schemas/CredentialDetails' opsiPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint maxLength: 255 minLength: 1 type: string required: - connectionDetails - credentialDetails type: object EnableExadataInsightDetails: description: The information about the Exadata system to be analyzed. discriminator: propertyName: entitySource properties: entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' required: - entitySource type: object CreatePlanCustomItemDetails: description: "Custom configuration item details for a chargeback plan. Example items for Exadata Insights Chargeback are \nstatistic(default value AVG), percentile, infrastructureCost, infrastructurePlanType, additionalServerCost and additionalServerPlanType.\n" properties: isCustomizable: default: false description: Indicates whether the chargeback plan customization item can be customized. example: false type: boolean name: description: Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. example: statistics maxLength: 255 minLength: 1 type: string value: description: Value of chargeback plan customization item. example: MAX maxLength: 255 minLength: 1 type: string type: object AwrSourceSummary: description: Summary of an AwrSource. properties: awrHubId: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string awrSourceDatabaseId: description: DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string hoursSinceLastImport: description: Number of hours since last AWR snapshots import happened from the Source database. format: double type: number maxSnapshotIdentifier: description: The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number minSnapshotIdentifier: description: The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number name: description: Database name of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string snapshotsUploaded: description: Number of AWR snapshots uploaded from the Source database. format: integer type: number timeFirstSnapshotGenerated: description: The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeLastSnapshotGenerated: description: The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string required: - awrHubId - name - awrSourceDatabaseId - snapshotsUploaded - minSnapshotIdentifier - maxSnapshotIdentifier - timeFirstSnapshotGenerated - timeLastSnapshotGenerated - hoursSinceLastImport type: object ExadataInsight: description: Exadata insight resource. discriminator: propertyName: entitySource properties: chargebackPlanDetails: $ref: '#/components/schemas/ChargebackPlanDetails' compartmentId: description: Compartment identifier of the Exadata insight resource maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataName: description: The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. maxLength: 255 minLength: 1 type: string exadataRackType: description: Exadata rack type. enum: - FULL - HALF - QUARTER - EIGHTH - FLEX - BASE - ELASTIC - ELASTIC_BASE - ELASTIC_LARGE type: string x-obmcs-top-level-enum: '#/definitions/ExadataRackType' exadataType: description: Operations Insights internal representation of the the Exadata system type. enum: - DBMACHINE - EXACS - EXACC type: string x-obmcs-top-level-enum: '#/definitions/ExadataType' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Exadata insight identifier maxLength: 255 minLength: 1 type: string isVirtualizedExadata: description: true if virtualization is used in the Exadata system type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Exadata insight. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/ExadataInsightLifecycleState' status: description: Indicates the status of an Exadata insight in Operations Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' statusDetails: description: A message describing the status of the Exadata Resource. For example, it can be used to provide actionable information about the policies needed to access the Exadata Resource. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Exadata insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Exadata insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - entitySource - id - compartmentId - exadataName - status - timeCreated - lifecycleState - freeformTags - definedTags type: object IngestHostConfigurationDetails: description: 'Contains the data to ingest for one or more host configuration metrics ' properties: items: description: Collection of one or more host configuration metric data points items: $ref: '#/components/schemas/HostConfigurationMetricGroup' maxItems: 100 minItems: 1 type: array required: - items type: object HostConfigurationSummary: description: Summary of a host configuration for a resource. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string coresPerSocket: description: 'Number of cores per socket. ' example: 24 minimum: 0 type: integer cpuArchitecture: description: CPU architechure example: GenuineIntel x86 maxLength: 255 minLength: 1 type: string cpuCacheInMBs: description: 'Size of cache memory in megabytes. ' example: 35.75 format: double minimum: 0 type: number cpuFrequencyInMhz: description: 'Clock frequency of the processor in megahertz. ' example: 2900 format: double minimum: 0 type: number cpuImplementation: description: Model name of processor. example: Intel(R) Xeon(R) Platinum 8268 CPU @ 2.90GHz maxLength: 255 minLength: 1 type: string cpuVendor: description: Name of the CPU vendor. example: GenuineIntel maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object gpuName: description: Name of the GPU. maxLength: 255 minLength: 1 type: string gpuVendor: description: Vendor of the GPU. maxLength: 255 minLength: 1 type: string hostInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource. maxLength: 255 minLength: 1 type: string hostName: description: The host name. The host name is unique amongst the hosts managed by the same management agent. maxLength: 255 minLength: 1 type: string isHyperThreadingEnabled: description: 'Indicates if hyper-threading is enabled or not ' example: true type: boolean platformType: description: 'Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. ' enum: - LINUX - SOLARIS - SUNOS - ZLINUX - WINDOWS - AIX - HP_UX - UNKNOWN type: string platformVendor: description: Platform vendor. example: Oracle maxLength: 255 minLength: 1 type: string platformVersion: description: Platform version. example: Oracle Linux Server release 7.9 maxLength: 255 minLength: 1 type: string threadsPerSocket: description: Number of threads per socket. example: 48 minimum: 0 type: integer totalCpus: description: 'Total CPU on this host. ' example: 384 minimum: 0 type: integer totalGpus: description: Total GPU(s) allocated in a Host. minimum: 0 type: integer totalMemoryInGBs: description: 'Total amount of usable physical memory in gibabytes ' example: 3 format: double minimum: 0 type: number totalSockets: description: Number of total sockets. example: 8 minimum: 0 type: integer required: - hostInsightId - entitySource - compartmentId - hostName - platformType - platformVersion - platformVendor - cpuArchitecture - totalCpus - totalMemoryInGBs - isHyperThreadingEnabled - cpuCacheInMBs - cpuVendor - cpuFrequencyInMhz - cpuImplementation - coresPerSocket - totalSockets - threadsPerSocket - definedTags - freeformTags type: object DataObjectColumnMetadata: description: Metadata of a column in a data object resultset. properties: category: description: Category of the column. enum: - DIMENSION - METRIC - TIME_DIMENSION - UNKNOWN type: string dataType: description: Type of a data object column. maxLength: 255 minLength: 1 type: string dataTypeName: description: Type name of a data object column. enum: - NUMBER - TIMESTAMP - VARCHAR2 - OTHER type: string description: description: Description of the column. maxLength: 400 minLength: 1 type: string displayName: description: Display name of the column. maxLength: 255 minLength: 1 type: string groupName: description: Group name of the column. maxLength: 255 minLength: 1 type: string name: description: Name of the column. maxLength: 255 minLength: 1 type: string unitDetails: $ref: '#/components/schemas/DataObjectColumnUnit' required: - name type: object UpdateKubeClusterInsightDetails: description: The information to be updated. discriminator: propertyName: entitySource properties: apiServerPort: description: The Kubernetes cluster API Server port. maximum: 65535 type: integer apiServerUrl: description: The Kubernetes cluster API server URL. maxLength: 512 minLength: 1 type: string certificateSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster certificate secret id. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Kubernetes cluster. enum: - OKE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/KubeClusterEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object serviceAccount: description: The Kubernetes cluster service account. maxLength: 255 minLength: 1 type: string tokenSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster token secret id. maxLength: 255 minLength: 1 type: string required: - entitySource type: object ExadataInsightResourceInsightUtilizationItem: description: Object containing current utilization, projected utilization, id and daysToReach high and low utilization value. properties: currentUtilization: description: Current utilization example: 5.2 format: double type: number daysToReachHighUtilization: description: Days to reach projected high utilization example: 5 type: - integer - 'null' daysToReachLowUtilization: description: Days to reach projected low utilization example: 5 type: - integer - 'null' exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string projectedUtilization: description: Projected utilization example: 5.1 format: double type: number required: - exadataInsightId - currentUtilization - projectedUtilization - daysToReachHighUtilization - daysToReachLowUtilization type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string format: date-time type: string required: - message - timestamp ResourceInsightProjectedUtilizationItem: description: Projected utilization object containing dbid and daysToReach value properties: daysToReach: description: Days to reach projected utilization example: 5 type: integer id: description: Db id example: id1 type: string required: - id - daysToReach type: object TopProcessesUsageTrendAggregation: description: Usage data per host top process properties: command: description: Command line and arguments used to launch process type: string processAlias: description: Host Process Alias maxLength: 1024 minimum: 0 type: string usageData: description: List of usage data samples for a top process items: $ref: '#/components/schemas/TopProcessesUsageTrend' type: array required: - command - usageData type: object PeComanagedDatabaseConnectionDetails: description: Connection details of the private endpoints. properties: hosts: description: List of hosts and port for private endpoint accessed database resource. items: $ref: '#/components/schemas/PeComanagedDatabaseHostDetails' type: array protocol: description: Protocol used for connection requests for private endpoint accssed database resource. enum: - TCP - TCPS type: string serviceName: description: Database service name used for connection requests. maxLength: 128 minLength: 1 type: string required: - hosts AwrHubSourceSummaryCollection: description: Collection of Awr Hub sources. properties: items: description: Array of Awr Hub source objects. items: $ref: '#/components/schemas/AwrHubSourceSummary' type: array required: - items NewsReport: description: News report resource. properties: areChildCompartmentsIncluded: default: false description: A flag to consider the resources within a given compartment and all sub-compartments. type: boolean compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string contentTypes: $ref: '#/components/schemas/NewsContentTypes' dayOfWeek: description: Day of the week in which the news report will be sent if the frequency is set to WEEKLY. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY example: MONDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The description of the news report. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the news report resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the news report. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locale: description: Language of the news report. enum: - EN type: string x-obmcs-top-level-enum: '#/definitions/NewsLocale' name: description: The news report name. maxLength: 255 minLength: 1 type: string newsFrequency: description: News report frequency. enum: - WEEKLY example: WEEKLY type: string x-obmcs-top-level-enum: '#/definitions/NewsFrequency' onsTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ONS topic. maxLength: 255 minLength: 1 type: string status: description: Indicates the status of a news report in Ops Insights. enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the news report was first enabled. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the news report was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - newsFrequency - contentTypes - onsTopicId type: object WorkRequest: description: A description of workrequest status properties: compartmentId: description: 'The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request enum: - ENABLE_DATABASE_INSIGHT - DISABLE_DATABASE_INSIGHT - UPDATE_DATABASE_INSIGHT - CREATE_DATABASE_INSIGHT - MOVE_DATABASE_INSIGHT - DELETE_DATABASE_INSIGHT - CREATE_ENTERPRISE_MANAGER_BRIDGE - UDPATE_ENTERPRISE_MANAGER_BRIDGE - MOVE_ENTERPRISE_MANAGER_BRIDGE - DELETE_ENTERPRISE_MANAGER_BRIDGE - ENABLE_HOST_INSIGHT - DISABLE_HOST_INSIGHT - UPDATE_HOST_INSIGHT - CREATE_HOST_INSIGHT - MOVE_HOST_INSIGHT - DELETE_HOST_INSIGHT - CREATE_EXADATA_INSIGHT - ENABLE_EXADATA_INSIGHT - DISABLE_EXADATA_INSIGHT - UPDATE_EXADATA_INSIGHT - MOVE_EXADATA_INSIGHT - DELETE_EXADATA_INSIGHT - ADD_EXADATA_INSIGHT_MEMBERS - EXADATA_AUTO_SYNC - UPDATE_OPSI_WAREHOUSE - CREATE_OPSI_WAREHOUSE - MOVE_OPSI_WAREHOUSE - DELETE_OPSI_WAREHOUSE - ROTATE_OPSI_WAREHOUSE_WALLET - UPDATE_OPSI_WAREHOUSE_USER - CREATE_OPSI_WAREHOUSE_USER - MOVE_OPSI_WAREHOUSE_USER - DELETE_OPSI_WAREHOUSE_USER - UPDATE_AWRHUB - CREATE_AWRHUB - MOVE_AWRHUB - DELETE_AWRHUB - UPDATE_PRIVATE_ENDPOINT - CREATE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - CHANGE_PE_COMANAGED_DATABASE_INSIGHT_DETAILS - UPDATE_OPSI_CONFIGURATION - CREATE_OPSI_CONFIGURATION - MOVE_OPSI_CONFIGURATION - DELETE_OPSI_CONFIGURATION - ENABLE_ADB_ADVANCED_FEATURES - DISABLE_ADB_ADVANCED_FEATURES - UPDATE_ADB_ADVANCED_FEATURES - CREATE_NEWS_REPORT - ENABLE_NEWS_REPORT - DISABLE_NEWS_REPORT - UPDATE_NEWS_REPORT - MOVE_NEWS_REPORT - DELETE_NEWS_REPORT - CREATE_AWRHUB_SOURCE - DELETE_AWRHUB_SOURCE - UPDATE_AWRHUB_SOURCE - MOVE_AWRHUB_SOURCE - ENABLE_AWRHUB_SOURCE - DISABLE_AWRHUB_SOURCE - CHANGE_MACS_MANAGED_CLOUD_DATABASE_INSIGHT_CONNECTION_DETAILS - TEST_MACS_MANAGED_CLOUD_DATABASE_INSIGHT_CONNECTION_DETAILS - CHANGE_EXTERNAL_MYSQL_DATABASE_INSIGHT_CONNECTION_DETAILS - CREATE_KUBE_CLUSTER_INSIGHT - ENABLE_KUBE_CLUSTER_INSIGHT - DISABLE_KUBE_CLUSTER_INSIGHT - UPDATE_KUBE_CLUSTER_INSIGHT - MOVE_KUBE_CLUSTER_INSIGHT - DELETE_KUBE_CLUSTER_INSIGHT - CREATE_CHARGE_BACK - ENABLE_CHARGE_BACK - DISABLE_CHARGE_BACK - UPDATE_CHARGE_BACK - MOVE_CHARGE_BACK - DELETE_CHARGE_BACK type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted SqlInsightAggregation: description: Represents a SQL Insight. properties: category: description: 'Insight category. It would be one of the following DEGRADING, VARIANT, INEFFICIENT, CHANGING_PLANS, IMPROVING, DEGRADING_VARIANT, DEGRADING_INEFFICIENT, DEGRADING_CHANGING_PLANS, DEGRADING_INCREASING_IO, DEGRADING_INCREASING_CPU, DEGRADING_INCREASING_INEFFICIENT_WAIT, DEGRADING_CHANGING_PLANS_AND_INCREASING_IO, DEGRADING_CHANGING_PLANS_AND_INCREASING_CPU, DEGRADING_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT,VARIANT_INEFFICIENT, VARIANT_CHANGING_PLANS, VARIANT_INCREASING_IO, VARIANT_INCREASING_CPU, VARIANT_INCREASING_INEFFICIENT_WAIT, VARIANT_CHANGING_PLANS_AND_INCREASING_IO, VARIANT_CHANGING_PLANS_AND_INCREASING_CPU, VARIANT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS, INEFFICIENT_INCREASING_INEFFICIENT_WAIT, INEFFICIENT_CHANGING_PLANS_AND_INCREASING_INEFFICIENT_WAIT ' type: string text: description: "Insight text.\nFor example `Degrading SQLs`, `Variant SQLs`,\n `Inefficient SQLs`, `Improving SQLs`, `SQLs with Plan Changes`,\n `Degrading SQLs have increasing IO Time above 50%`,\n `Degrading SQLs are variant`,\n `2 of the 2 variant SQLs have plan changes`,\n `Inefficient SQLs have increasing CPU Time above 50%\n" type: string values: description: 'SQL counts for a given insight. For example insight text `2 of 10 SQLs have degrading response time` will have values as [2,10]" ' items: type: integer type: array required: - text - values - category type: object HostInsightResourceStatisticsAggregation: description: 'Contains host details and resource statistics. ' properties: currentStatistics: $ref: '#/components/schemas/HostResourceStatistics' hostDetails: $ref: '#/components/schemas/HostDetails' required: - hostDetails - currentStatistics type: object SummarizeDatabaseInsightResourceCapacityTrendAggregationCollection: description: 'Collection of resource capacity trend. ' properties: capacityData: description: 'Capacity Data with time interval ' items: $ref: '#/components/schemas/ResourceCapacityTrendAggregation' type: array highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - usageUnit - itemDurationInMs - capacityData type: object SqlTextSummary: description: 'SQL Text details ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string sqlText: description: SQL Text type: string required: - sqlIdentifier - id - databaseId - sqlText type: object AddmDbParameterAggregationCollection: description: Summarizes AWR parameter change history over specified time period properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of AWR parameter change summaries items: $ref: '#/components/schemas/AddmDbParameterAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object AddmDbRecommendationAggregationCollection: description: Summarizes ADDM recommendations over specified time period properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of ADDM recommendation summaries items: $ref: '#/components/schemas/AddmDbRecommendationAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object KubeClusterInsightSummary: description: Summary of a Kubernetes cluster insight resource. discriminator: propertyName: entitySource properties: apiServerPort: description: The Kubernetes cluster API Server port. maximum: 65535 type: integer apiServerUrl: description: The Kubernetes cluster API server URL. maxLength: 512 minLength: 1 type: string certificateSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster certificate secret id. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Kubernetes cluster. enum: - OKE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/KubeClusterEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Kubernetes cluster insight resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Kubernetes cluster insight. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The Kubernetes cluster name. maxLength: 255 minLength: 1 type: string nodePools: description: List of K8s cluster node pools registered within Ops Insights. items: $ref: '#/components/schemas/KubeClusterNodePool' type: array serviceAccount: description: The Kubernetes cluster service account. maxLength: 255 minLength: 1 type: string status: description: Indicates the status of a Kubernetes cluster insight in Ops Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Kubernetes cluster insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Kubernetes cluster insight was updated. An RFC3339 formatted datetime string format: date-time type: string tokenSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster token secret id. maxLength: 255 minLength: 1 type: string required: - entitySource - id - compartmentId - name - status - timeCreated - lifecycleState - freeformTags - definedTags - apiServerUrl - apiServerPort type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource type: string identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - RELATED_RESOURCE_IDS - RESOURCE_NAME type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier AwrHubSource: description: Awr hub source object properties: associatedOpsiId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string associatedResourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string awrHubId: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string awrHubOpsiSourceId: description: The shorted string of the Awr Hub source database identifier. maxLength: 20 minLength: 1 type: string awrSourceDatabaseId: description: DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hoursSinceLastImport: description: Number of hours since last AWR snapshots import happened from the Source database. format: double type: number id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Awr Hub source database. maxLength: 255 minLength: 1 type: string isRegisteredWithAwrHub: description: This is `true` if the source databse is registered with a Awr Hub, otherwise `false` type: boolean lifecycleState: description: the current state of the source database enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceLifecycleState' maxSnapshotIdentifier: description: The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number minSnapshotIdentifier: description: The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number name: description: The name of the Awr Hub source database. maxLength: 30 minLength: 1 type: string sourceMailBoxUrl: description: Opsi Mailbox URL based on the Awr Hub and Awr Hub source. maxLength: 1000 minLength: 1 type: string status: description: Indicates the status of a source database in Operations Insights enum: - ACCEPTING - NOT_ACCEPTING - NOT_REGISTERED - TERMINATED example: ACCEPTING type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeFirstSnapshotGenerated: description: The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeLastSnapshotGenerated: description: The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string type: description: source type of the database enum: - ADW_S - ATP_S - ADW_D - ATP_D - EXTERNAL_PDB - EXTERNAL_NONCDB - COMANAGED_VM_CDB - COMANAGED_VM_PDB - COMANAGED_VM_NONCDB - COMANAGED_BM_CDB - COMANAGED_BM_PDB - COMANAGED_BM_NONCDB - COMANAGED_EXACS_CDB - COMANAGED_EXACS_PDB - COMANAGED_EXACS_NONCDB - LH_S - APEX_S - AJD_S - AVD_S - LH_D - APEX_D - AJD_D - AVD_D - UNDEFINED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceType' required: - name - awrHubId - compartmentId - type - id - awrHubOpsiSourceId - timeCreated - lifecycleState - status - sourceMailBoxUrl type: object KubeClusterInsight: description: Kubernetes cluster insight resource. discriminator: propertyName: entitySource properties: apiServerPort: description: The Kubernetes cluster API Server port. maximum: 65535 type: integer apiServerUrl: description: The Kubernetes cluster API server URL. maxLength: 512 minLength: 1 type: string certificateSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster certificate secret id. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment identifier of the Kubernetes cluster insight resource maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Kubernetes cluster. enum: - OKE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/KubeClusterEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Kubernetes cluster insight identifier maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Kubernetes cluster insight. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' name: description: The Kubernetes cluster name. maxLength: 255 minLength: 1 type: string nodePools: description: List of K8s cluster node pools registered within Ops Insights. items: $ref: '#/components/schemas/KubeClusterNodePool' type: array serviceAccount: description: The Kubernetes cluster service account. maxLength: 255 minLength: 1 type: string status: description: Indicates the status of a Kubernetes cluster insight in Ops Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Kubernetes cluster insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Kubernetes cluster insight was updated. An RFC3339 formatted datetime string format: date-time type: string tokenSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster token secret id. maxLength: 255 minLength: 1 type: string required: - entitySource - id - compartmentId - name - status - timeCreated - lifecycleState - freeformTags - definedTags type: object DatabaseConfigurationMetricGroup: description: 'Supported configuration metric groups for database capacity planning service. ' discriminator: propertyName: metricName properties: metricName: description: 'Name of the metric group. ' enum: - DB_EXTERNAL_PROPERTIES - DB_EXTERNAL_INSTANCE - DB_OS_CONFIG_INSTANCE - DB_PARAMETERS - DB_CONNECTION_STATUS - HOST_RESOURCE_ALLOCATION - ASM_ENTITY - EXADATA_CELL_CONFIG type: string timeCollected: description: 'Collection timestamp Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string required: - metricName type: object AwrDatabaseParameterChangeCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_DB_PARAMETER_CHANGE properties: items: description: A list of AWR database parameter change summary data. items: $ref: '#/components/schemas/AwrDatabaseParameterChangeSummary' type: array description: The AWR database parameter change history. type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp OpsiConfigurationConfigurationItemSummary: description: Configuration item summary. discriminator: propertyName: configItemType properties: configItemType: description: Type of configuration item. enum: - BASIC type: string x-obmcs-top-level-enum: '#/definitions/ConfigurationItemType' required: - configItemType type: object AwrDatabaseParameterChangeSummary: description: A summary of the changes made to a single AWR database parameter. properties: instanceNumber: description: The database instance number. type: integer isDefault: description: Indicates whether the parameter value in the end snapshot is the default. type: boolean previousValue: description: The previous value of the database parameter. type: string snapshotIdentifier: description: 'The ID of the snapshot with the parameter value changed. The snapshot identifier is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabaseSnapshots ' type: integer timeBegin: description: The start time of the interval. format: date-time type: string timeEnd: description: The end time of the interval. format: date-time type: string value: description: The current value of the database parameter. type: string valueModified: description: "Indicates whether the parameter has been modified after instance startup:\n - MODIFIED - Parameter has been modified with ALTER SESSION\n - SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM (which causes all the currently logged in sessions values to be modified)\n - FALSE - Parameter has not been modified after instance startup\n" type: string required: - snapshotIdentifier type: object OperationsInsightsWarehouseUser: description: OPSI warehouse User. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionPassword: description: User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. format: password maxLength: 20 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Hub User OCID maxLength: 255 minLength: 1 type: string isAwrDataAccess: description: Indicate whether user has access to AWR data. type: boolean isEmDataAccess: description: Indicate whether user has access to EM data. type: boolean isOpsiDataAccess: description: Indicate whether user has access to OPSI data. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseUserLifecycleState' name: description: Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - operationsInsightsWarehouseId - id - compartmentId - name - isAwrDataAccess - timeCreated - lifecycleState type: object ImportableEnterpriseManagerEntity: description: An Enterprise Manager entity that can be imported into Operations Insights. properties: enterpriseManagerEntityIdentifier: description: Enterprise Manager Entity Unique Identifier maxLength: 256 minLength: 1 type: string enterpriseManagerEntityName: description: Enterprise Manager Entity Name maxLength: 256 minLength: 1 type: string enterpriseManagerEntityType: description: Enterprise Manager Entity Type maxLength: 256 minLength: 1 type: string enterpriseManagerIdentifier: description: Enterprise Manager Unique Identifier maxLength: 256 minLength: 1 type: string opsiEntityType: description: Ops Insights internal representation of the resource type. type: string required: - enterpriseManagerIdentifier - enterpriseManagerEntityName - enterpriseManagerEntityType - enterpriseManagerEntityIdentifier type: object AwrDatabaseReport: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_DB_REPORT properties: content: description: The content of the report. type: string format: description: The format of the report. enum: - HTML - TEXT - XML type: string description: The result of the AWR report. type: object OperationsInsightsPrivateEndpoint: description: A private endpoint that allows Operation Insights services to connect to databases in a customer's virtual cloud network (VCN). properties: compartmentId: description: The compartment OCID of the Private service accessed database. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the private endpoint. type: string displayName: description: The display name of the private endpoint. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Private service accessed database. maxLength: 255 minLength: 1 type: string isUsedForRacDbs: default: false description: The flag is to identify if private endpoint is used for rac database or not. This flag is deprecated and no longer is used. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the private endpoint. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsPrivateEndpointLifecycleState' nsgIds: description: 'The OCIDs of the network security groups that the private endpoint belongs to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateEndpointStatusDetails: description: A message describing the status of the private endpoint connection of this resource. For example, it can be used to provide actionable information about the validity of the private endpoint connection. type: string privateIp: description: 'The private IP addresses assigned to the private endpoint. All IP addresses will be concatenated if it is RAC DBs. ' maxLength: 46 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: The OCID of the subnet. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string vcnId: description: The OCID of the VCN. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - vcnId - subnetId - lifecycleState type: object SqlStatisticsTimeSeriesAggregation: description: Database details and SQL performance statistics for a given database properties: databaseDetails: $ref: '#/components/schemas/DatabaseDetails' statistics: description: 'SQL performance statistics for a given database ' items: $ref: '#/components/schemas/SqlStatisticsTimeSeries' type: array required: - databaseDetails - statistics type: object CreateEnterpriseManagerBridgeDetails: description: The information about a Enterprise Manager bridge resource to be created properties: compartmentId: description: Compartment identifier of the Enterprise Manager bridge maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of Enterprise Manager Bridge maxLength: 400 type: string displayName: description: User-friedly name of Enterprise Manager Bridge that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object objectStorageBucketName: description: Object Storage Bucket Name type: string required: - compartmentId - displayName - objectStorageBucketName type: object QueryWarehouseDataObjectDataDetails: description: Information required to form and execute Operations Insights Warehouse data objects query. properties: query: $ref: '#/components/schemas/DataObjectQuery' required: - query type: object IoUsageTrend: description: Usage data for IO interface per usage unit. properties: diskBytesReadInMBs: description: MBs Read. format: double minimum: 0 type: number diskBytesWrittenInMBs: description: MBs Written. format: double minimum: 0 type: number diskIops: description: IO operations per second. format: double minimum: 0 type: number diskIopsRead: description: Read IO operations per second. format: double minimum: 0 type: number diskIopsWritten: description: Write IO operations per second. format: double minimum: 0 type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string required: - endTimestamp - diskBytesReadInMBs - diskBytesWrittenInMBs - diskIopsRead - diskIopsWritten - diskIops type: object HostDetails: description: Partial information about a host which includes id, name, type. properties: agentIdentifier: description: The identifier of the agent. type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string hostDisplayName: description: The user-friendly name for the host. The name does not have to be unique. maxLength: 255 minLength: 1 type: string hostName: description: The host name. The host name is unique amongst the hosts managed by the same management agent. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host. maxLength: 255 minLength: 1 type: string platformType: description: 'Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. ' enum: - LINUX - SOLARIS - SUNOS - ZLINUX - WINDOWS - AIX - HP_UX - UNKNOWN type: string required: - id - compartmentId - hostName - platformType - agentIdentifier type: object ImportableComputeEntitySummaryCollection: description: Collection of importable compute entity objects. properties: items: description: Array of importable compute entity objects. items: $ref: '#/components/schemas/ImportableComputeEntitySummary' type: array required: - items type: object OperationsInsightsWarehouseUserSummaryCollection: description: Collection of Operations Insights Warehouse User summary objects. properties: items: description: Array of Operations Insights Warehouse user summary objects. items: $ref: '#/components/schemas/OperationsInsightsWarehouseUserSummary' type: array required: - items type: object SqlBucket: description: Sql bucket type object. properties: bucketId: description: 'SQL Bucket ID, examples <= 3 secs, 3-10 secs, 10-60 secs, 1-5 min, > 5 min Example: `"<= 3 secs"` ' type: string cpuTimeInSec: description: 'Total CPU time Example: `1046` ' format: float type: number databaseType: description: Ops Insights internal representation of the database type. type: string executionsCount: description: 'Total number of executions Example: `60` ' format: int32 type: integer ioTimeInSec: description: 'Total IO time Example: `5810` ' format: float type: number otherWaitTimeInSec: description: 'Total other wait time Example: `24061` ' format: float type: number planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeCollected: description: 'Collection timestamp Example: `"2020-03-31T00:00:00.000Z"` ' format: date-time type: string totalTimeInSec: description: 'Total time Example: `30917` ' format: float type: number version: description: 'Version Example: `1` ' format: float type: number required: - timeCollected - sqlIdentifier - planHash - bucketId type: object x-example: "{\n \"version\":1.0,\n \"databaseType\":\"database\",\n \"timeCollected\":\"2020-06-30T00:00:00.000Z\",\n \"sqlIdentifier\":\"11aaxrj1gpgaa\",\n \"planHash\":\"9820154385\",\n \"bucketId\":\"<= 3 secs\",\n \"executionsCount\":60,\n \"cpuTimeInSec\": 1046,\n \"ioTimeInSec\": 5810,\n \"otherWaitTimeInSec\": 24061,\n \"totalTimeInSec\": 30917\n}\n" AwrDatabaseSnapshotRangeSummary: allOf: - $ref: '#/components/schemas/AwrDatabaseSummary' description: The summary data for a range of AWR snapshots. type: object EnterpriseManagerBridgeCollection: description: Collection of Enterprose Manager bridge summary objects. properties: items: description: Array of Enterprose Manager bridge summary objects. items: $ref: '#/components/schemas/EnterpriseManagerBridgeSummary' type: array required: - items type: object AwrDatabaseTopWaitEventCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_TOP_EVENT_SET properties: items: description: A list of AWR top event summary data. items: $ref: '#/components/schemas/AwrDatabaseTopWaitEventSummary' type: array description: The AWR top wait event data. type: object HostedEntityCollection: description: 'Returns a list of hosted entities for the specific host. ' properties: items: description: 'List of hosted entities details. ' items: $ref: '#/components/schemas/HostedEntitySummary' maxItems: 1000 type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - items type: object AwrQueryResult: description: The AWR query result. discriminator: propertyName: awrResultType properties: awrResultType: description: The result type of AWR query. enum: - AWRDB_SET - AWRDB_SNAPSHOT_RANGE_SET - AWRDB_SNAPSHOT_SET - AWRDB_METRICS_SET - AWRDB_SYSSTAT_SET - AWRDB_TOP_EVENT_SET - AWRDB_EVENT_SET - AWRDB_EVENT_HISTOGRAM - AWRDB_DB_PARAMETER_SET - AWRDB_DB_PARAMETER_CHANGE - AWRDB_ASH_CPU_USAGE_SET - AWRDB_DB_REPORT - AWRDB_SQL_REPORT type: string dbQueryTimeInSecs: description: The time taken to query the database tier (in seconds). format: double type: number name: description: The name of the query result. type: string version: description: The version of the query result. type: string required: - name - awrResultType type: object UpdateExadataInsightDetails: description: The information to be updated. discriminator: propertyName: entitySource properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource type: object DatabaseConfigurationCollection: description: Collection of database insight configuration summary objects. properties: items: description: Array of database insight configurations summary objects. items: $ref: '#/components/schemas/DatabaseConfigurationSummary' type: array required: - items type: object ConfigurationItemSummary: description: 'Configuration item summary. ' discriminator: propertyName: configItemType properties: configItemType: description: Type of configuration item. enum: - BASIC type: string x-obmcs-top-level-enum: '#/definitions/ConfigurationItemType' required: - configItemType type: object AddmDbSqlStatementCollection: description: Summarizes SQL statements over specified time period properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of SQL statements items: $ref: '#/components/schemas/AddmDbSqlStatementSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object AddmDbRecommendationAggregation: description: Summarizes a specific ADDM recommendation properties: frequencyCount: description: Number of occurrences for this recommendation type: integer id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string implementActions: description: 'Actions that can be performed to implement the recommendation (such as ''ALTER PARAMETER'', ''RUN SQL TUNING ADVISOR'') ' items: type: string type: array maxBenefitAvgActiveSessions: description: Maximum estimated benefit in terms of average active sessions format: double type: number maxBenefitPercent: description: Maximum estimated benefit in terms of percentage of total activity format: double type: number message: description: Recommendation message type: string overallBenefitPercent: description: Overall estimated benefit in terms of percentage of total activity format: double type: number rationale: description: Recommendation message type: string relatedObject: $ref: '#/components/schemas/RelatedObjectTypeDetails' requiresDbRestart: description: 'Indicates implementation of the recommended action requires a database restart in order for it to take effect. Possible values "Y", "N" and null. ' type: string type: description: Type of recommendation type: string required: - id - message type: object WarehouseDataObjectCollection: description: Collection of Warehouse data object summary objects. properties: items: description: Array of Warehouse data object summary objects. items: $ref: '#/components/schemas/WarehouseDataObjectSummary' type: array required: - items type: object CreateKubeClusterInsightDetails: description: The information about the Kubernetes cluster system to be analyzed. discriminator: propertyName: entitySource properties: apiServerPort: description: The Kubernetes cluster API Server port. maximum: 65535 type: integer apiServerUrl: description: The Kubernetes cluster API server URL. maxLength: 512 minLength: 1 type: string certificateSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster certificate secret id. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment identifier of the Kubernetes cluster insight resource maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Kubernetes cluster. enum: - OKE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/KubeClusterEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object serviceAccount: description: The Kubernetes cluster service account. maxLength: 255 minLength: 1 type: string tokenSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster token secret id. maxLength: 255 minLength: 1 type: string required: - entitySource - compartmentId - serviceAccount - tokenSecretId - certificateSecretId - apiServerUrl - apiServerPort type: object SqlPlanInsights: description: Represents collection of SQL Plan Insights. properties: category: description: 'SQL Insight category. For example PLANS_USED, MOST_EXECUTED, BEST_PERFORMER, WORST_PERFORMER, MOST_CPU or MOST_IO. ' type: string text: description: "SQL Plan Insight text.\nFor example `Number of Plans Used`, `Most Executed Plan`,\n `Best Performing Plan`, `Worst Performing Plan`,\n `Plan With Most IO`,\n `Plan with Most CPU`\n" type: string value: description: 'SQL execution plan hash value for a given insight. For example `Most Executed Plan` insight will have value as "3975467901" ' format: int64 type: integer required: - text - value - category type: object AddmDbFindingsTimeSeriesCollection: description: ADDM findings time series response. properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of ADDM finding time series data items: $ref: '#/components/schemas/AddmDbFindingsTimeSeriesSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object Error: description: An error has occurred. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error string. type: string required: - code - message type: object HostInsightSummaryCollection: description: Collection of host insight summary objects. properties: items: description: Array of host insight summary objects. items: $ref: '#/components/schemas/HostInsightSummary' type: array required: - items type: object AddmReport: description: ADDM Tasks. properties: addmReport: description: The complete ADDM report type: string databaseIdentifier: description: Internal id of the database. type: string snapshotIntervalEnd: description: AWR snapshot id. type: string snapshotIntervalStart: description: AWR snapshot id. type: string taskIdentifier: description: TASK_ID in the oracle database view DBA_ADDM_TASKS type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - taskIdentifier - databaseIdentifier - snapshotIntervalStart - snapshotIntervalEnd - addmReport type: object CredentialDetails: description: 'User credential details to connect to the database. ' discriminator: propertyName: credentialType properties: credentialSourceName: description: Credential source name that had been added in Management Agent wallet. This value is only required when Credential set by CREDENTIALS_BY_SOURCE and is optional properties for ther others. maxLength: 255 minLength: 1 type: string credentialType: description: 'CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database. ' enum: - CREDENTIALS_BY_SOURCE - CREDENTIALS_BY_VAULT - CREDENTIALS_BY_IAM type: string required: - credentialType NewsReportCollection: description: Collection of news reports summary objects. properties: items: description: Array of news reports summary objects. items: $ref: '#/components/schemas/NewsReportSummary' type: array required: - items type: object ChangeExadataInsightCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DatabaseInsight: description: Database insight resource. discriminator: propertyName: entitySource properties: compartmentId: description: Compartment identifier of the database maxLength: 255 minLength: 1 type: string databaseConnectionStatusDetails: description: A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the database entity. enum: - AUTONOMOUS_DATABASE - EM_MANAGED_EXTERNAL_DATABASE - MACS_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySourceAll' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Database insight identifier maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the database. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer status: description: Indicates the status of a database insight in Operations Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the database insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the database insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - entitySource - id - compartmentId - status - timeCreated - lifecycleState - freeformTags - definedTags type: object MySqlSqlStats: description: MySql Sql Stats type object. properties: commandType: description: Type of statement such as select, update or delete. maxLength: 128 minLength: 1 type: string cpuLatencyInPs: description: The total time spent on CPU (in picoseconds) for the current thread. format: int64 minimum: 0 type: integer digest: description: 'Unique SQL ID Digest for a MySql Statement. Example: `"c20fcea11911be36651b7ca7bd3712d4ed9ac1134cee9c6620039e1fb13b5eff"` ' maxLength: 65 type: string errCount: description: The total number of errors produced by occurrences of the statement. format: int64 minimum: 0 type: integer execCount: description: The total number of times the statement has executed. format: int64 minimum: 0 type: integer execCountSecondary: description: The total number of times a query was processed on the secondary engine (HEATWAVE) for occurrences of this statement Count. format: int64 minimum: 0 type: integer lockLatencyInPs: description: The total time waiting (in picoseconds) for locks by timed occurrences of the statement. format: int64 minimum: 0 type: integer maxControlledMemoryInBytes: description: The maximum amount of controlled memory (in bytes) used by the statement. format: int64 minimum: 0 type: integer maxTotalMemoryInBytes: description: The maximum amount of memory (in bytes) used by the statement. format: int64 minimum: 0 type: integer noGoodIndexUsedCount: description: The number of occurences of the statement where the server found no good index to use Count format: int64 minimum: 0 type: integer noIndexUsedCount: description: The number of occurences of the statement which performed a table scan without using an index Count format: int64 minimum: 0 type: integer perfSchemaUsedPercent: description: Percent of SQL statements in the perf schema table relative to max or overflow count set in @@GLOBAL.performance_schema_digests_size. format: int64 minimum: 0 type: integer rowsAffected: description: The total number of rows affected by occurrences of the statement. format: int64 minimum: 0 type: integer rowsExamined: description: The total number of rows read from storage engines by occurrences of the statement. format: int64 minimum: 0 type: integer rowsSent: description: The total number of rows returned by occurrences of the statement. format: int64 minimum: 0 type: integer rowsSorted: description: The total number of rows sorted by occurrences of the statement. format: int64 minimum: 0 type: integer schemaName: description: 'Name of Database Schema. Example: `"performance_schema"` ' type: string selectFullJoin: description: The total number of joins that perform table scans because they do not use indexes by occurrences of the statement. If this value is not 0 format: int64 minimum: 0 type: integer selectFullRangeJoin: description: The total number of joins that used a range search on a reference table by occurrences of the statement format: int64 minimum: 0 type: integer selectRange: description: The total number of joins that used ranges on the first table by occurrences of the statement. This is normally not a critical issue even if the value is quite large. Count format: int64 minimum: 0 type: integer selectRangeCheck: description: The total number of joins without keys that check for key usage after each row by occurrences of the statement. If this is not 0 format: int64 minimum: 0 type: integer selectScan: description: The total number of joins that did a full scan of the first table by occurrences of the statement Count format: int64 minimum: 0 type: integer sortMergePasses: description: The total number of sort merge passes by occurrences of the statement. format: int64 minimum: 0 type: integer sortRange: description: The total number of sorts that were done using ranges by occurrences of the statement. format: int64 minimum: 0 type: integer sortScan: description: The total number of sorts that were done by scanning the table by occurrences of the statement. format: int64 minimum: 0 type: integer timeCollected: description: 'Collection timestamp. Example: `"2020-03-31T00:00:00.000Z"` ' format: date-time type: string timeFirstSeen: description: 'The time at which statement was first seen. Example: `"2023-01-16 08:04:31.533577"` ' format: date-time type: string timeLastSeen: description: 'The time at which statement was most recently seen for all occurrences of the statement. Example: `"2023-01-30 02:17:08.067961"` ' format: date-time type: string tmpDiskTables: description: The total number of internal on-disk temporary tables created by occurrences of the statement. format: int64 minimum: 0 type: integer tmpTables: description: The total number of internal in-memory temporary tables created by occurrences of the statement Count format: int64 minimum: 0 type: integer totalLatencyInPs: description: The total wait time (in picoseconds) of timed occurrences of the statement. format: int64 minimum: 0 type: integer totalRows: description: Total number of SQL statements used in collection ranking calculation. format: int64 minimum: 0 type: integer warnCount: description: The total number of warnings produced by occurrences of the statement. format: int64 minimum: 0 type: integer required: - digest - timeCollected type: object OperationsInsightsWarehouseUserSummary: description: Summary of a Operations Insights Warehouse User. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionPassword: description: User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. format: password maxLength: 20 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Hub User OCID maxLength: 255 minLength: 1 type: string isAwrDataAccess: description: Indicate whether user has access to AWR data. type: boolean isEmDataAccess: description: Indicate whether user has access to EM data. type: boolean isOpsiDataAccess: description: Indicate whether user has access to OPSI data. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseUserLifecycleState' name: description: Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - operationsInsightsWarehouseId - id - compartmentId - name - isAwrDataAccess - timeCreated - lifecycleState type: object HostedEntitySummary: description: 'Information about a hosted entity which includes identifier, name, and type. ' properties: entityIdentifier: description: The identifier of the entity. maxLength: 255 minLength: 1 type: string entityName: description: The entity name. maxLength: 255 minLength: 1 type: string entityType: description: The entity type. maxLength: 255 minLength: 1 type: string required: - entityIdentifier - entityName - entityType type: object AddmDbRecommendationsTimeSeriesCollection: description: ADDM recommendations time series properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of ADDM recommendations time series data items: $ref: '#/components/schemas/AddmDbRecommendationsTimeSeriesSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object IngestMySqlSqlTextResponseDetails: description: 'The response object returned from IngestMySqlSqlTextDetails operation. ' properties: message: description: 'Success message returned as a result of the upload. ' type: string required: - message type: object DownloadOperationsInsightsWarehouseWalletDetails: description: Download Wallet details. properties: operationsInsightsWarehouseWalletPassword: description: User provided ADW wallet password for the Ops Insights Warehouse. format: password maxLength: 20 minLength: 1 type: string required: - operationsInsightsWarehouseWalletPassword type: object OpsiDataObjectSupportedQueryParam: description: Details of query parameter supported by an OPSI data object. properties: dataType: description: Data type of the for the query parameter. maxLength: 64 minLength: 1 type: string description: description: Description of the query parameter. maxLength: 255 minLength: 1 type: string name: description: Name of the query parameter. maxLength: 64 minLength: 1 type: string required: - name type: object UpdateChargebackPlanReportDetails: description: The details used to update a Ops Insights chargeback plan report. properties: reportName: description: The chargeback plan report name. maxLength: 255 minLength: 1 type: string reportProperties: $ref: '#/components/schemas/ReportPropertyDetails' required: - reportName - reportProperties type: object SqlPlanCollection: description: 'SQL Plans for the particular SQL. ' properties: databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string items: description: array of SQL Plans. items: $ref: '#/components/schemas/SqlPlanSummary' type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string required: - id - databaseId - sqlIdentifier - items type: object ChangeHostInsightCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The OCID of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ReportGroupingDetails: description: Report groupings properties: key: description: Selected grouping key. maxLength: 50 type: string value: description: Selected grouping value. maxLength: 256 type: string required: - key - value type: object TopProcessesUsageTrend: description: Aggregated data for top processes properties: bytesReadInMBs: description: MBs Read format: double minimum: 0 type: number bytesWrittenInMBs: description: MBs Written format: double minimum: 0 type: number containerId: description: Container id if this process corresponds to a running container in the host. maxLength: 1024 minimum: 0 type: string cpuUsage: description: Process CPU usage. format: double minimum: 0 type: number cpuUtilization: description: Process CPU utilization percentage format: double minimum: 0 type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string iops: description: IO operations per second format: double minimum: 0 type: number iopsRead: description: Read IO operations per second format: double minimum: 0 type: number iopsWritten: description: Write IO operations per second format: double minimum: 0 type: number maxProcessCount: description: Maximum number of processes running at time of collection minimum: 0 type: integer memoryUtilization: description: Process memory utilization percentage format: double minimum: 0 type: number physicalMemoryInMBs: description: Procress physical memory in Megabytes format: double minimum: 0 type: number virtualMemoryInMBs: description: Process virtual memory in Megabytes format: double minimum: 0 type: number required: - endTimestamp - cpuUsage - cpuUtilization - memoryUtilization - virtualMemoryInMBs - physicalMemoryInMBs - maxProcessCount - bytesReadInMBs - bytesWrittenInMBs - iopsRead - iopsWritten - iops type: object UpdateHostInsightDetails: description: The information to be updated. discriminator: propertyName: entitySource properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource type: object ConnectionDetails: description: Connection details to connect to the database. HostName, protocol, and port should be specified. properties: hostName: description: Name of the listener host that will be used to create the connect string to the database. maxLength: 255 minLength: 1 type: string port: description: Listener port number used for connection requests. maximum: 65535 minimum: 1024 type: integer protocol: description: Protocol used for connection requests. enum: - TCP - TCPS type: string serviceName: description: Database service name used for connection requests. maxLength: 128 minLength: 1 type: string required: - hostName - protocol - port - serviceName AwrReport: description: The result of the AWR report. properties: content: description: The content of the report. type: string format: description: The format of the report. enum: - HTML - TEXT type: string x-obmcs-top-level-enum: '#/definitions/AwrReportFormatType' required: - format type: object MySqlSqlText: description: MySql SQL Text type object. properties: commandType: description: 'SQL event name Example: `"SELECT"` ' type: string digest: description: 'digest Example: `"323k3k99ua09a90adf"` ' type: string digestText: description: 'The normalized statement string. Example: `"SELECT username,profile,default_tablespace,temporary_tablespace FROM dba_users"` ' type: string schemaName: description: 'Name of Database Schema. Example: `"performance_schema"` ' type: string timeCollected: description: 'Collection timestamp. Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string required: - digest - timeCollected - digestText type: object x-example: "{\n \"schemaName\":\"performance_schema\",\n \"digest\":\"07rm5p65sc48u\",\n \"timeCollected\":\"2020-06-30T00:00:00.000Z\",\n \"commandType\":\"SELECT\",\n \"digestText\":\"SELECT 1 from dual\"\n}\n" SummarizeExadataInsightResourceForecastTrendAggregation: description: Usage and Forecast results from the selected time period. properties: daysToReachCapacity: description: Days to reach capacity for a storage server type: - integer - 'null' exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string historicalData: description: Time series data used for the forecast analysis. items: $ref: '#/components/schemas/HistoricalDataItem' type: array pattern: description: Time series patterns used in the forecasting. enum: - LINEAR - MONTHLY_SEASONS - MONTHLY_AND_YEARLY_SEASONS - WEEKLY_SEASONS - WEEKLY_AND_MONTHLY_SEASONS - WEEKLY_MONTHLY_AND_YEARLY_SEASONS - WEEKLY_AND_YEARLY_SEASONS - YEARLY_SEASONS type: string projectedData: description: Time series data result of the forecasting analysis. items: $ref: '#/components/schemas/ProjectedDataItem' type: array selectedForecastAlgorithm: description: Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast. example: NaiveForecaster type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - pattern - daysToReachCapacity - historicalData - projectedData type: object AddmDbParameterCategoryCollection: description: List of database parameter categories properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of database parameter categories items: $ref: '#/components/schemas/AddmDbParameterCategorySummary' type: array required: - databaseDetailsItems - items type: object HostInstanceMap: description: Object containing hostname and instance name mapping. properties: hostName: description: The hostname of the database insight resource. maxLength: 255 minLength: 1 type: string instanceName: description: The instance name of the database insight resource. maxLength: 255 minLength: 1 type: string required: - hostName - instanceName type: object IngestHostMetricsDetails: description: 'Contains the data to ingest for one or more host performance metrics ' properties: items: description: Collection of one or more host performance metric data points items: $ref: '#/components/schemas/HostPerformanceMetricGroup' maxItems: 360 minItems: 1 type: array required: - items type: object ExadataMemberCollection: description: Partial definition of the exadata insight resource. properties: exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataName: description: The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. maxLength: 255 minLength: 1 type: string exadataRackType: description: Exadata rack type. enum: - FULL - HALF - QUARTER - EIGHTH - FLEX - BASE - ELASTIC - ELASTIC_BASE - ELASTIC_LARGE type: string x-obmcs-top-level-enum: '#/definitions/ExadataRackType' exadataType: description: Operations Insights internal representation of the the Exadata system type. enum: - DBMACHINE - EXACS - EXACC type: string x-obmcs-top-level-enum: '#/definitions/ExadataType' items: description: Collection of Exadata members items: $ref: '#/components/schemas/ExadataMemberSummary' type: array required: - exadataInsightId - exadataName - exadataDisplayName - exadataType - exadataRackType - items type: object AwrDatabaseWaitEventBucketSummary: description: A summary of the AWR wait event bucket and waits percentage. properties: category: description: The name of the wait event frequency category. Normally, it is the upper range of the waits within the AWR wait event bucket. type: string percentage: description: The percentage of waits in a wait event bucket over the total waits of the database. format: double type: number required: - category - percentage type: object KubeClusterInsightSummaryCollection: description: Collection of Kubernetes cluster insight summary objects. properties: items: description: Array of Kubernetes cluster insight summary objects. items: $ref: '#/components/schemas/KubeClusterInsightSummary' type: array required: - items type: object SummarizeDatabaseInsightResourceUtilizationInsightAggregation: description: 'Insights response containing current/projected groups for storage or CPU. ' properties: currentUtilization: $ref: '#/components/schemas/ResourceInsightCurrentUtilization' highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer projectedUtilization: $ref: '#/components/schemas/ResourceInsightProjectedUtilization' resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - projectedUtilization - currentUtilization type: object ImportableEnterpriseManagerEntityCollection: description: Collection of importable Enterprise Manager entity objects. properties: items: description: Array of importable Enterprise Manager entity objects. items: $ref: '#/components/schemas/ImportableEnterpriseManagerEntity' type: array required: - items type: object CreateOpsiConfigurationDetails: description: Information about OPSI configuration to be created. discriminator: propertyName: opsiConfigType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string configItems: description: 'Array of configuration items with custom values. All and only configuration items requiring custom values should be part of this array. ' items: $ref: '#/components/schemas/CreateConfigurationItemDetails' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OPSI configuration. example: Custom configurations for user experience in the sales department compartment. maxLength: 400 type: string displayName: description: User-friendly display name for the OPSI configuration. The name does not have to be unique. example: Sales department configurations. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object opsiConfigType: description: OPSI configuration type. enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - opsiConfigType type: object AwrDatabaseCpuUsageCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_ASH_CPU_USAGE_SET properties: databaseCpuCount: description: The number of CPUs available for the database to use. type: integer hostCpuCount: description: The number of available CPUs or processors. format: double type: number items: description: A list of AWR CPU usage summary data. items: $ref: '#/components/schemas/AwrDatabaseCpuUsageSummary' type: array numCpuCores: description: The number of available CPU cores, which include subcores of multicore and single-core CPUs. type: integer description: The AWR CPU usage data. type: object HistoricalDataItem: description: The historical timestamp and the corresponding resource value. properties: endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number required: - endTimestamp - usage type: object OpsiDataObject: description: OPSI data object. discriminator: propertyName: dataObjectType properties: columnsMetadata: description: Metadata of columns in a data object. items: $ref: '#/components/schemas/DataObjectColumnMetadata' type: array dataObjectType: description: Type of OPSI data object. enum: - DATABASE_INSIGHTS_DATA_OBJECT - HOST_INSIGHTS_DATA_OBJECT - EXADATA_INSIGHTS_DATA_OBJECT type: string x-obmcs-top-level-enum: '#/definitions/OpsiDataObjectType' description: description: Description of OPSI data object. maxLength: 400 type: string displayName: description: User-friendly name of OPSI data object. maxLength: 255 minLength: 1 type: string groupNames: description: Names of all the groups to which the data object belongs to. items: example: - Oracle - Sql - Database maxItems: 10 maxLength: 128 minLength: 1 type: string type: array identifier: description: Unique identifier of OPSI data object. maxLength: 255 minLength: 1 type: string name: description: Name of the data object, which can be used in data object queries just like how view names are used in a query. maxLength: 128 minLength: 1 type: string supportedQueryParams: description: Supported query parameters by this OPSI data object that can be configured while a data object query involving this data object is executed. items: $ref: '#/components/schemas/OpsiDataObjectSupportedQueryParam' type: array supportedQueryTimePeriod: description: 'Time period supported by the data object for quering data. Time period is in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. Examples: P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months). ' type: string required: - identifier - dataObjectType - displayName - columnsMetadata type: object OpsiDataObjectsCollection: description: Collection of OPSI data object summary objects. properties: items: description: Array of OPSI data object summary objects. items: $ref: '#/components/schemas/OpsiDataObjectSummary' type: array required: - items type: object ResourceInsightProjectedUtilization: description: Projected utilization(High/low) for cpu or storage properties: high: description: List of db ids with high usage example: '[{id:id1, daysToReach:5}, {id:id2, daysToReach:15}, {id:id3, daysToReach:25}]' items: $ref: '#/components/schemas/ResourceInsightProjectedUtilizationItem' maxItems: 1000 type: array low: description: List of db ids with low usage example: '[{id:id1, daysToReach:5}, {id:id2, daysToReach:15}, {id:id3, daysToReach:25}]' items: $ref: '#/components/schemas/ResourceInsightProjectedUtilizationItem' maxItems: 1000 type: array required: - low - high type: object ProjectedDataItem: description: 'The timestamp of the projected event and their corresponding resource value. `highValue` and `lowValue` are the uncertainty bounds of the corresponding value. ' properties: endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string highValue: description: Upper uncertainty bound of the current usage value. format: double type: number lowValue: description: Lower uncertainty bound of the current usage value. format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number required: - endTimestamp - usage - highValue - lowValue type: object EnterpriseManagerBridge: description: Enterprise Manager bridge resource. properties: compartmentId: description: Compartment identifier of the Enterprise Manager bridge maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of Enterprise Manager Bridge maxLength: 400 type: string displayName: description: User-friedly name of Enterprise Manager Bridge that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Enterprise Manager bridge identifier maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Enterprise Manager bridge. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' objectStorageBucketName: description: Object Storage Bucket Name type: string objectStorageNamespaceName: description: Object Storage Namespace Name type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Enterprise Manager bridge was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Enterprise Manager bridge was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - displayName - objectStorageNamespaceName - objectStorageBucketName - timeCreated - lifecycleState - freeformTags - definedTags type: object IngestHostMetricsResponseDetails: description: 'The response object returned from IngestHostMetrics operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object SummarizeHostInsightResourceForecastTrendAggregation: description: 'Forecast results from the selected time period. ' properties: highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer historicalData: description: Time series data used for the forecast analysis. items: $ref: '#/components/schemas/HistoricalDataItem' maxItems: 1000 type: array lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer pattern: description: Time series patterns used in the forecasting. enum: - LINEAR - MONTHLY_SEASONS - MONTHLY_AND_YEARLY_SEASONS - WEEKLY_SEASONS - WEEKLY_AND_MONTHLY_SEASONS - WEEKLY_MONTHLY_AND_YEARLY_SEASONS - WEEKLY_AND_YEARLY_SEASONS - YEARLY_SEASONS type: string projectedData: description: Time series data result of the forecasting analysis. items: $ref: '#/components/schemas/ProjectedDataItem' maxItems: 1000 type: array resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string selectedForecastAlgorithm: description: Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast. example: NaiveForecaster type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold - usageUnit - pattern - historicalData - projectedData type: object AwrDatabaseTopWaitEventSummary: description: A summary of the AWR top wait event data for one event. properties: avgWaitTimePerSec: description: The average wait time per second. format: double type: number name: description: The name of the event. type: string waitsPerSec: description: The wait count per second. format: double type: number required: - name type: object SqlPlanInsightAggregation: description: SQL execution plan Performance statistics. properties: cpuTimeInSec: description: CPU Time in seconds format: double type: number executionsCount: description: Total number of executions format: int64 type: integer inefficientWaitTimeInSec: description: Inefficient Wait Time in seconds format: double type: number ioTimeInSec: description: IO Time in seconds format: double type: number planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer required: - planHash - ioTimeInSec - cpuTimeInSec - inefficientWaitTimeInSec - executionsCount type: object IngestMySqlSqlTextDetails: description: 'Collection of SQL Text Entries ' properties: items: description: List of SQL Text Entries. items: $ref: '#/components/schemas/MySqlSqlText' type: array type: object AddmDbFindingAggregationCollection: description: Summarizes ADDM findings over specified time period properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of ADDM finding summaries items: $ref: '#/components/schemas/AddmDbFindingAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object RelatedObjectTypeDetails: description: Related object details discriminator: propertyName: type properties: type: description: Type of related object enum: - SCHEMA_OBJECT - SQL - DATABASE_PARAMETER type: string required: - type type: object AwrDatabaseSnapshotSummary: description: The AWR snapshot summary of one snapshot. properties: awrSourceDatabaseIdentifier: description: 'Internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDatabases ' type: string errorCount: description: The total number of errors. format: int64 type: integer instanceNumber: description: The database instance number. type: integer snapshotIdentifier: description: 'The ID of the snapshot. The snapshot identifier is not the [OCID](/Content/General/Concepts/identifiers.htm). It can be retrieved from the following endpoint: /awrHubs/{awrHubId}/awrDbSnapshots ' type: integer timeBegin: description: The start time of the snapshot. format: date-time type: string timeDbStartup: description: The timestamp of the database startup. format: date-time type: string timeEnd: description: The end time of the snapshot. format: date-time type: string required: - awrSourceDatabaseIdentifier - snapshotIdentifier type: object SqlResponseTimeDistributionAggregation: description: SQL Response time distribution entry. properties: bucketId: description: Response time bucket id type: string executionsCount: description: Total number of SQL executions format: int64 type: integer required: - bucketId - executionsCount type: object HostInsightHostRecommendations: description: 'Contains recommendations depending of resource metric received. ' discriminator: propertyName: metricRecommendationName properties: metricRecommendationName: description: Name of recommendations depending of resource metric received. enum: - HOST_CPU_RECOMMENDATIONS - HOST_MEMORY_RECOMMENDATIONS - HOST_NETWORK_RECOMMENDATIONS - HOST_STORAGE_RECOMMENDATIONS type: string required: - metricRecommendationName type: object OpsiDataObjectSummary: description: Summary of an OPSI data object. discriminator: propertyName: dataObjectType properties: dataObjectType: description: Type of OPSI data object. enum: - DATABASE_INSIGHTS_DATA_OBJECT - HOST_INSIGHTS_DATA_OBJECT - EXADATA_INSIGHTS_DATA_OBJECT type: string x-obmcs-top-level-enum: '#/definitions/OpsiDataObjectType' description: description: Description of OPSI data object. maxLength: 400 type: string displayName: description: User-friendly name of OPSI data object. maxLength: 255 minLength: 1 type: string groupNames: description: Names of all the groups to which the data object belongs to. items: example: - Oracle - Sql - Database maxItems: 10 maxLength: 128 minLength: 1 type: string type: array identifier: description: Unique identifier of OPSI data object. maxLength: 255 minLength: 1 type: string name: description: Name of the data object, which can be used in data object queries just like how view names are used in a query. maxLength: 128 minLength: 1 type: string required: - identifier - dataObjectType - displayName type: object HostInsight: description: Host insight resource. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostDisplayName: description: The user-friendly name for the host. The name does not have to be unique. maxLength: 255 minLength: 1 type: string hostName: description: The host name. The host name is unique amongst the hosts managed by the same management agent. maxLength: 255 minLength: 1 type: string hostType: description: Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the host. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer status: description: Indicates the status of a host insight in Operations Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the host insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the host insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - entitySource - id - hostName - compartmentId - status - timeCreated - lifecycleState - freeformTags - definedTags type: object UpdateOperationsInsightsPrivateEndpointDetails: description: The details used to update a Operation Insights private endpoint. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the private endpoint. maxLength: 1024 minLength: 1 type: string displayName: description: The display name of the private endpoint. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object nsgIds: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security groups that the Private service accessed the database. items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object type: object AddmDbFindingAggregation: description: Summarizes a specific ADDM finding properties: categoryDisplayName: description: Category display name type: string categoryName: description: Category name type: string findingId: description: Unique finding id type: string frequencyCount: description: Number of occurrences for this finding type: integer id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string impactAvgActiveSessions: description: Impact in terms of average active sessions format: double type: number impactMaxPercent: description: Maximum impact in terms of percentage of total activity format: double type: number impactOverallPercent: description: Overall impact in terms of percentage of total activity format: double type: number message: description: Finding message type: string name: description: Finding name type: string recommendationCount: description: Number of recommendations for this finding type: integer required: - id - findingId - categoryName - categoryDisplayName - name - message - impactOverallPercent - impactMaxPercent - frequencyCount - recommendationCount type: object IngestAddmReportsResponseDetails: description: 'The response object returned from IngestAddmReports operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object SummarizeHostInsightHostRecommendationAggregation: description: 'Returns list of hosts with resource statistics like usage, capacity, utilization, usage change percent and load. ' properties: details: $ref: '#/components/schemas/HostInsightHostRecommendations' itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - usageUnit - itemDurationInMs - timeIntervalStart - timeIntervalEnd type: object ExadataInsightResourceStatisticsAggregation: description: Contains resource details and current statistics discriminator: propertyName: exadataResourceType properties: exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string required: - exadataResourceType type: object ChargebackPlanSummary: description: Summary of a Ops Insights chargeback plan. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the chargeback plan. enum: - CHARGEBACK_EXADATA - CHARGEBACK_COMPUTE type: string x-obmcs-top-level-enum: '#/definitions/ChargebackPlanEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource.' maxLength: 255 minLength: 1 type: string isCustomizable: default: false description: Indicates whether the chargeback plan can be customized. example: false type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Chargeback Plan lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' planCategory: description: Chargeback Plan category of the chargeback entity. It can be OOB, or CUSTOM. enum: - OOB - CUSTOM type: string x-obmcs-top-level-enum: '#/definitions/ChargebackPlanCategory' planCustomItems: description: List of chargeback plan customizations. items: $ref: '#/components/schemas/CreatePlanCustomItemDetails' maxItems: 25 type: array planDescription: description: Description of OPSI Chargeback Plan. example: Chargeback plan weighted for exadata maxLength: 400 type: string planName: description: Name for the OPSI Chargeback plan. example: Chargeback Plan weighted Allocation maxLength: 255 minLength: 1 type: string planType: description: 'Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. ' example: WEIGHTED_ALLOCATION maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the chargeback plan was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The time chargeback plan was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - planType - planName - entitySource - compartmentId - timeCreated - timeUpdated - lifecycleState - freeformTags - definedTags - planCustomItems type: object AddmDbParameterChangeAggregationCollection: description: 'Summarizes AWR parameter change history over specified time period for specified parameter ' properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of AWR parameter changes items: $ref: '#/components/schemas/AddmDbParameterChangeAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object DatabaseConfigurationSummary: description: Summary of a database configuration for a resource. discriminator: propertyName: entitySource properties: cdbName: description: Name of the CDB.Only applies to PDB. maxLength: 255 minLength: 1 type: - string - 'null' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string databaseDisplayName: description: The user-friendly name for the database. The name does not have to be unique. type: string databaseInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string databaseName: description: The database name. The database name is unique within the tenancy. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the database entity. enum: - AUTONOMOUS_DATABASE - EM_MANAGED_EXTERNAL_DATABASE - MACS_MANAGED_EXTERNAL_DATABASE - PE_COMANAGED_DATABASE - MDS_MYSQL_DATABASE_SYSTEM - EXTERNAL_MYSQL_DATABASE_SYSTEM - MACS_MANAGED_CLOUD_DATABASE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseEntitySourceAll' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isAdvancedFeaturesEnabled: default: false description: Flag is to identify if advanced features for autonomous database is enabled or not type: boolean processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer required: - databaseInsightId - entitySource - compartmentId - databaseName - databaseDisplayName - databaseType - databaseVersion - cdbName - isAdvancedFeaturesEnabled - definedTags - freeformTags type: object ExadataInsightResourceForecastTrendSummary: description: List of resource id, name , capacity insight value, pattern, historical usage and projected data. properties: daysToReachCapacity: description: Days to reach capacity for a storage server type: - integer - 'null' historicalData: description: Time series data used for the forecast analysis. items: $ref: '#/components/schemas/HistoricalDataItem' type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string name: description: The name of the resource. maxLength: 255 minLength: 1 type: string pattern: description: Time series patterns used in the forecasting. enum: - LINEAR - MONTHLY_SEASONS - MONTHLY_AND_YEARLY_SEASONS - WEEKLY_SEASONS - WEEKLY_AND_MONTHLY_SEASONS - WEEKLY_MONTHLY_AND_YEARLY_SEASONS - WEEKLY_AND_YEARLY_SEASONS - YEARLY_SEASONS type: string projectedData: description: Time series data result of the forecasting analysis. items: $ref: '#/components/schemas/ProjectedDataItem' type: array selectedForecastAlgorithm: description: Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast. example: NaiveForecaster type: string required: - id - name - daysToReachCapacity - pattern - historicalData - projectedData type: object DataObjectQuery: description: Information required to form and execute query on a data object. discriminator: propertyName: queryType properties: bindParams: description: List of bind parameters to be applied in the query. items: $ref: '#/components/schemas/DataObjectBindParameter' maxItems: 100 type: array queryExecutionTimeoutInSeconds: description: Timeout (in seconds) to be set for the data object query execution. format: double type: number queryType: description: Type of Query enum: - TEMPLATIZED_QUERY - STANDARD_QUERY type: string required: - queryType type: object SqlStatisticsTimeSeriesByPlanAggregationCollection: description: 'SQL performance statistics by plan over the selected time window. ' properties: databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string endTimestamps: description: Array comprising of all the sampling period end timestamps in RFC 3339 format. example: - '2020-05-01T00:00:00.000Z' - '2020-05-02T00:00:00.000Z' items: format: date-time type: string type: array id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database insight resource. maxLength: 255 minLength: 1 type: string itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer items: description: array of SQL performance statistics by plans items: $ref: '#/components/schemas/SqlStatisticsTimeSeriesByPlanAggregation' type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - sqlIdentifier - id - databaseId - timeIntervalStart - timeIntervalEnd - itemDurationInMs - endTimestamps - items type: object AddmDbSqlStatementSummary: description: Details for a given SQL ID properties: id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string isSqlTextTruncated: description: SQL identifier type: boolean sqlCommand: description: SQL command name (such as SELECT, INSERT) type: string sqlIdentifier: description: SQL identifier type: string sqlText: description: First 3800 characters of the SQL text type: string required: - id - sqlIdentifier - sqlText - isSqlTextTruncated - sqlCommand type: object AwrDatabaseCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_SET properties: items: description: A list of AWR summary data. items: $ref: '#/components/schemas/AwrDatabaseSummary' type: array description: The result of AWR query. type: object ChangeEnterpriseManagerBridgeCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The OCID of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object IngestSqlStatsResponseDetails: description: 'The response object returned from IngestSqlStats operation. ' properties: message: description: 'Success message returned as a result of the upload. ' maxLength: 2000 minLength: 1 type: string required: - message type: object OperationsInsightsWarehouseSummary: description: Summary of a Operations Insights Warehouse resource. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string cpuAllocated: description: 'Number of CPUs allocated to OPSI Warehouse ADW. ' format: double type: number cpuUsed: description: 'Number of OCPUs used by OPSI Warehouse ADW. Can be fractional. ' format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of Ops Insights Warehouse that does not have to be unique. maxLength: 255 minLength: 1 type: string dynamicGroupId: description: OCID of the dynamic group created for the warehouse maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseLifecycleState' operationsInsightsTenancyId: description: Tenancy Identifier of Ops Insights service maxLength: 255 minLength: 1 type: string storageAllocatedInGBs: description: 'Storage allocated to OPSI Warehouse ADW. ' format: double type: number storageUsedInGBs: description: 'Storage by OPSI Warehouse ADW in GB. ' format: double type: number systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeLastWalletRotated: description: The time at which the ADW wallet was last rotated for the Ops Insights Warehouse. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - displayName - cpuAllocated - timeCreated - timeUpdated - lifecycleState type: object AddmDbParameterAggregation: description: Summarizes change history for specific database parameter properties: beginValue: description: Parameter value when time period began type: string defaultValue: description: Parameter default value type: string endValue: description: Parameter value when time period ended type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string instNum: description: Number of database instance type: integer isChanged: description: 'Indicates whether the parameter''s value changed during the selected time range (TRUE) or did not change during the selected time range (FALSE) ' type: boolean isDefault: description: 'Indicates whether the parameter''s end value was set to the default value (TRUE) or was specified in the parameter file (FALSE) ' type: boolean isHighImpact: description: "Indicates whether the parameter is a high impact parameter (TRUE) or not (FALSE) \n" type: boolean name: description: Name of parameter type: string valueModified: description: 'Indicates whether the parameter has been modified after instance starup MODIFIED - Parameter has been modified with ALTER SESSION SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM FALSE - Parameter has not been modified after instance starup ' type: string required: - id - name - isChanged type: object SqlStats: description: Sql Stats type object. properties: action: description: Contains the name of the action that was executing when the SQL statement was first parsed, which is set by calling DBMS_APPLICATION_INFO.SET_ACTION type: string applicationWaitTimeInUs: description: Application wait time (in microseconds) format: int64 minimum: 0 type: integer avgHardParseTimeInUs: description: Average hard parse time (in microseconds) used by this cursor format: int64 minimum: 0 type: integer avoidedExecutions: description: Number of executions attempted on this object, but prevented due to the SQL statement being in quarantine format: int64 type: integer bufferGets: description: Number of Buffer Gets format: int64 type: integer childNumber: description: Number of this child cursor format: int64 minimum: 0 type: integer clusterWaitTimeInUs: description: Cluster wait time (in microseconds). This value is specific to Oracle RAC format: int64 minimum: 0 type: integer commandType: description: Oracle command type definition format: int64 minimum: 0 type: integer concurrencyWaitTimeInUs: description: Concurrency wait time (in microseconds) format: int64 minimum: 0 type: integer cpuTimeInUs: description: CPU time (in microseconds) used by this cursor for parsing, executing, and fetching format: int64 minimum: 0 type: integer deltaCpuRank: description: Rank based on CPU Consumption format: int64 minimum: 0 type: integer deltaCpuTime: description: CPU time (in microseconds) for the cursor since the last AWR snapshot format: int64 type: integer deltaExecsRank: description: Rank based on number of execution format: int64 minimum: 0 type: integer deltaExecutionCount: description: Number of executions for the cursor since the last AWR snapshot format: int64 minimum: 0 type: integer deltaIoBytes: description: Number of I/O bytes exchanged between the Oracle database and the storage system for the cursor since the last AWR snapshot format: int64 minimum: 0 type: integer deltaIoRank: description: Rank based on I/O Consumption format: int64 minimum: 0 type: integer directReads: description: Number of direct reads format: int64 type: integer directWrites: description: Number of Direct writes format: int64 type: integer diskReads: description: Number of disk reads format: int64 type: integer elapsedTimeInUs: description: Elapsed time (in microseconds) used by this cursor for parsing, executing, and fetching. format: int64 minimum: 0 type: integer endOfFetchCount: description: Number of times this cursor was fully executed since the cursor was brought into the library cache format: int64 type: integer exactMatchingSignature: description: 'exact_matching_signature Example: `"18067345456756876713"` ' type: string executions: description: Number of executions format: int64 type: integer fetches: description: Number of fetches format: int64 type: integer forceMatchingSignature: description: 'force_matching_signature Example: `"18067345456756876713"` ' type: string fullPlanHashValue: description: Total Number of rows in SQLStats table type: string harmonicSum: description: Harmonic sum based on ranking parameters format: int64 minimum: 0 type: integer instanceName: description: 'Name of Database Instance Example: `"DB10902_1"` ' type: string invalidations: description: Number of times this child cursor has been invalidated format: int64 minimum: 0 type: integer ioCellOffloadEligibleBytes: description: Number of I/O bytes which can be filtered by the Exadata storage system format: int64 minimum: 0 type: integer ioCellOffloadReturnedBytes: description: Number of bytes that are returned by Exadata cell through the regular I/O path format: int64 minimum: 0 type: integer ioCellUncompressedBytes: description: Number of uncompressed bytes (that is, size after decompression) that are offloaded to the Exadata cells format: int64 minimum: 0 type: integer ioInterconnectBytes: description: Number of I/O bytes exchanged between Oracle Database and the storage system. Typically used for Cache Fusion or parallel queries format: int64 minimum: 0 type: integer javaExecTimeInUs: description: Java execution time (in microseconds) format: int64 minimum: 0 type: integer lastActiveTime: description: 'last_active_time Example: `"0000000099CCE300"` ' type: string loads: description: Number of times the object was either loaded or reloaded format: int64 minimum: 0 type: integer module: description: Module name type: string obsoleteCount: description: Number of times that a parent cursor became obsolete format: int64 minimum: 0 type: integer optimizerCost: description: Cost of this query given by the optimizer format: int64 minimum: 0 type: integer parseCalls: description: "Total integer of parse calls\n Example: `60`\n" format: int64 type: integer physicalReadBytes: description: Number of bytes read from disks by the monitored SQL format: int64 minimum: 0 type: integer physicalReadRequests: description: Number of physical read I/O requests issued by the monitored SQL. The requests may not be disk reads format: int64 minimum: 0 type: integer physicalWriteBytes: description: Number of bytes written to disks by the monitored SQL format: int64 minimum: 0 type: integer physicalWriteRequests: description: Number of physical write I/O requests issued by the monitored SQL format: int64 minimum: 0 type: integer planHashValue: description: Plan hash value for the SQL Execution Plan format: int64 type: integer plsqlExecTimeInUs: description: PL/SQL execution time (in microseconds) format: int64 minimum: 0 type: integer pxServersExecutions: description: Total number of executions performed by parallel execution servers (0 when the statement has never been executed in parallel) format: int64 minimum: 0 type: integer rowsProcessed: description: Number of row processed format: int64 type: integer serializableAborts: description: Number of serializable aborts format: int64 type: integer service: description: Service name type: string sharableMem: description: Total shared memory (in bytes) currently occupied by all cursors with this SQL text and plan format: int64 minimum: 0 type: integer sharableMemRank: description: Rank based on sharable memory format: int64 type: integer sorts: description: Number of sorts that were done for the child cursor format: int64 minimum: 0 type: integer sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string sqlPatch: description: SQL patch used for this statement, if any type: string sqlPlanBaseline: description: SQL plan baseline used for this statement, if any type: string sqlProfile: description: SQL profile used for this statement, if any type: string timeCollected: description: 'Collection timestamp Example: `"2020-03-31T00:00:00.000Z"` ' format: date-time type: string totalSharableMem: description: Total shared memory (in bytes) occupied by all cursors with this SQL text and plan if they were to be fully loaded in the shared pool (that is, cursor size) format: int64 minimum: 0 type: integer totalSqlCount: description: Total number of rows in SQLStats table format: int64 minimum: 0 type: integer typeCheckMem: description: Typecheck memory format: int64 minimum: 0 type: integer userIoWaitTimeInUs: description: User I/O wait time (in microseconds) format: int64 minimum: 0 type: integer usersExecuting: description: Number of users executing the statement format: int64 minimum: 0 type: integer usersOpening: description: Number of users that have any of the child cursors open format: int64 minimum: 0 type: integer versionCount: description: Number of cursors present in the cache with this SQL text and plan format: int64 minimum: 0 type: integer wtHarmonicSum: description: 'Weight based harmonic sum of ranking parameters ' format: int64 minimum: 0 type: integer required: - sqlIdentifier - planHashValue - timeCollected - instanceName type: object TopProcessesUsage: description: Aggregated data for top processes on a specific date. properties: bytesReadInMBs: description: MBs Read. format: double minimum: 0 type: number bytesWrittenInMBs: description: MBs Written. format: double minimum: 0 type: number command: description: Command line and arguments used to launch process. type: string containerId: description: Container id if this process corresponds to a running container in the host. maxLength: 1024 minimum: 0 type: string cpuUsage: description: Process CPU usage. format: double minimum: 0 type: number cpuUtilization: description: Process CPU utilization percentage. format: double minimum: 0 type: number iops: description: IO operations per second. format: double minimum: 0 type: number iopsRead: description: Read IO operations per second. format: double minimum: 0 type: number iopsWritten: description: Write IO operations per second. format: double minimum: 0 type: number maxProcessCount: description: Maximum number of processes running at time of collection. minimum: 0 type: integer memoryUtilization: description: Process memory utilization percentage. format: double minimum: 0 type: number physicalMemoryInMBs: description: Procress physical memory in Megabytes. format: double minimum: 0 type: number processAlias: description: Host Process Alias maxLength: 1024 minimum: 0 type: string processHash: description: Unique identifier for a process. type: string virtualMemoryInMBs: description: Process virtual memory in Megabytes. format: double minimum: 0 type: number required: - command - processHash - cpuUsage - cpuUtilization - memoryUtilization - virtualMemoryInMBs - physicalMemoryInMBs - maxProcessCount - bytesReadInMBs - bytesWrittenInMBs - iopsRead - iopsWritten - iops type: object SqlSearchCollection: description: 'Search SQL response. ' properties: items: description: List of Databases executing the sql. items: $ref: '#/components/schemas/SqlSearchSummary' maxItems: 20 type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string sqlText: description: 'SQL Statement Text ' type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - items type: object VmClusterSummary: description: Partial information about the VM Cluster which includes name, memory allocated etc. properties: cpuAllocated: description: The CPU allocated on a VM Cluster. minimum: 0 type: integer dbNodesCount: description: The number of DB nodes on a VM Cluster. minimum: 0 type: integer memoryAllocatedInGBs: description: The memory allocated on a VM Cluster. minimum: 0 type: integer vmclusterName: description: The name of the VM Cluster. maxLength: 255 minLength: 1 type: string required: - vmclusterName type: object TablespaceUsageTrendAggregation: description: Usage data per tablespace for a Pluggable database properties: tablespaceName: description: The name of tablespace. type: string tablespaceType: description: Type of tablespace type: string usageData: description: List of usage data samples for a tablespace items: $ref: '#/components/schemas/TablespaceUsageTrend' type: array required: - tablespaceName - tablespaceType - usageData type: object IngestSqlPlanLinesResponseDetails: description: 'The response object returned from IngestSqlPlanLines operation. ' properties: message: description: 'Success message returned as a result of the upload. ' type: string required: - message type: object CreateNewsReportDetails: description: The information about the news report to be created. properties: areChildCompartmentsIncluded: default: false description: A flag to consider the resources within a given compartment and all sub-compartments. type: boolean compartmentId: description: Compartment Identifier where the news report will be created. maxLength: 255 minLength: 1 type: string contentTypes: $ref: '#/components/schemas/NewsContentTypes' dayOfWeek: description: Day of the week in which the news report will be sent if the frequency is set to WEEKLY. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY example: MONDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The description of the news report. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object locale: description: Language of the news report. enum: - EN type: string x-obmcs-top-level-enum: '#/definitions/NewsLocale' name: description: The news report name. maxLength: 255 minLength: 1 type: string newsFrequency: description: News report frequency. enum: - WEEKLY example: WEEKLY type: string x-obmcs-top-level-enum: '#/definitions/NewsFrequency' onsTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ONS topic. maxLength: 255 minLength: 1 type: string status: description: Defines if the news report will be enabled or disabled. enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' required: - compartmentId - newsFrequency - onsTopicId - contentTypes - name - description - locale type: object ChargebackPlanReportSummary: description: Summary of a Ops Insights chargeback plan report properties: reportId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string reportName: description: The chargeback plan report name. maxLength: 255 minLength: 1 type: string reportProperties: $ref: '#/components/schemas/ReportPropertyDetails' resourceId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string resourceType: description: 'Defines the type of resource (example: EXADATA, HOST) ' enum: - EXADATA_INSIGHT - DATABASE_INSIGHT - HOST_INSIGHT example: EXADATA_INSIGHT type: string timeCreated: description: The date and time the chargeback plan was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string timeUpdated: description: The time chargeback plan was updated. An RFC3339 formatted datetime string format: date-time type: string required: - reportId - reportName - resourceId - resourceType - timeCreated - timeUpdated - reportProperties type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of workRequestLogEntries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object ExadataConfigurationSummary: description: Summary of a exadata configuration for a resource. discriminator: propertyName: entitySource properties: chargebackPlanDetails: $ref: '#/components/schemas/ChargebackPlanDetails' compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the exadata entity. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataName: description: The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. maxLength: 255 minLength: 1 type: string exadataRackType: description: Exadata rack type. enum: - FULL - HALF - QUARTER - EIGHTH - FLEX - BASE - ELASTIC - ELASTIC_BASE - ELASTIC_LARGE type: string x-obmcs-top-level-enum: '#/definitions/ExadataRackType' exadataShape: description: The shape of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string exadataType: description: Operations Insights internal representation of the the Exadata system type. enum: - DBMACHINE - EXACS - EXACC type: string x-obmcs-top-level-enum: '#/definitions/ExadataType' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object vmclusterDetails: description: Array of objects containing VM cluster information. items: $ref: '#/components/schemas/VmClusterSummary' type: array required: - exadataInsightId - entitySource - compartmentId - exadataName - exadataDisplayName - exadataType - exadataRackType - definedTags - freeformTags - exadataShape - chargebackPlanDetails type: object OperationsInsightsPrivateEndpointSummary: description: Summary of a Operation Insights private endpoint. properties: compartmentId: description: The compartment OCID of the Private service accessed database. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the private endpoint. type: string displayName: description: The display name of the private endpoint. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The OCID of the Private service accessed database. maxLength: 255 minLength: 1 type: string isUsedForRacDbs: default: false description: The flag to identify if private endpoint is used for rac database or not. This flag is deprecated and no longer is used. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Private endpoint lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsPrivateEndpointLifecycleState' privateEndpointStatusDetails: description: A message describing the status of the private endpoint connection of this resource. For example, it can be used to provide actionable information about the validity of the private endpoint connection. type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: The OCID of the subnet. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string vcnId: description: The OCID of the VCN. maxLength: 255 minLength: 1 type: string required: - id - displayName - compartmentId - vcnId - subnetId - timeCreated - lifecycleState type: object SqlStatisticAggregationCollection: description: 'SQL statistics response. ' properties: items: description: Array of SQLs along with its statistics statisfying the query criteria. items: $ref: '#/components/schemas/SqlStatisticAggregation' maxItems: 100 type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - items type: object SummarizeHostInsightResourceStatisticsAggregationCollection: description: 'Returns list of hosts with resource statistics like usage, capacity, utilization, usage change percent and load. ' properties: highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer items: description: Collection of Resource Statistics items items: $ref: '#/components/schemas/HostInsightResourceStatisticsAggregation' maxItems: 1000 type: array lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - usageUnit - items - timeIntervalStart - timeIntervalEnd - highUtilizationThreshold - lowUtilizationThreshold type: object AwrDatabaseParameterCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_DB_PARAMETER_SET properties: items: description: A list of AWR database parameter summary data. items: $ref: '#/components/schemas/AwrDatabaseParameterSummary' type: array description: The AWR database parameter data. type: object EnterpriseManagerBridgeSummary: description: Summary of a Enterprise Manager bridge resource. properties: compartmentId: description: Compartment identifier of the Enterprise Manager bridge maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of Enterprise Manager Bridge that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Enterprise Manager bridge identifier maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Enterprise Manager bridge. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' objectStorageBucketName: description: Object Storage Bucket Name type: string objectStorageNamespaceName: description: Object Storage Namespace Name type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the Enterprise Manager bridge was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Enterprise Manager bridge was updated. An RFC3339 formatted datetime string format: date-time type: string required: - id - compartmentId - displayName - objectStorageNamespaceName - objectStorageBucketName - timeCreated - lifecycleState - freeformTags - definedTags type: object CreateOperationsInsightsWarehouseUserDetails: description: The information about a Operations Insights Warehouse User to be created. Input compartmentId MUST be the root compartment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string connectionPassword: description: User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. format: password maxLength: 20 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isAwrDataAccess: description: Indicate whether user has access to AWR data. type: boolean isEmDataAccess: description: Indicate whether user has access to EM data. type: boolean isOpsiDataAccess: description: Indicate whether user has access to OPSI data. type: boolean name: description: Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string required: - operationsInsightsWarehouseId - compartmentId - name - connectionPassword - isAwrDataAccess type: object AddmDbParameterChangeAggregation: description: Change record for AWR database parameter properties: id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string instNum: description: Instance number type: integer previousValue: description: Previous value type: string snapshotId: description: AWR snapshot id which includes the parameter value change type: integer timeBegin: description: Begin time of interval which includes change format: date-time type: string timeEnd: description: End time of interval which includes change format: date-time type: string value: description: Current value type: string required: - id - timeBegin - timeEnd - instNum - snapshotId type: object SummarizeExadataInsightResourceUsageCollection: description: Resource usage , allocation, utilization and usage ChangePercent for the current time period properties: exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string items: description: Collection of Resource Usage Summary items items: $ref: '#/components/schemas/ResourceUsageSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - items type: object OperationsInsightsPrivateEndpointCollection: description: A collection of Operation Insights private endpoint objects. properties: items: description: A list of OperationsInsightsPrivateEndpointSummary objects. items: $ref: '#/components/schemas/OperationsInsightsPrivateEndpointSummary' type: array required: - items type: object AddmDbRecommendationsTimeSeriesSummary: description: ADDM recommendation properties: analysisAvgActiveSessions: description: DB avg active sessions for the snapshot format: double type: number analysisDbTimeInSecs: description: DB time in seconds for the snapshot format: double type: number id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string maxBenefitAvgActiveSessions: description: Maximum estimated benefit in terms of average active sessions format: double type: number maxBenefitDbTimeInSecs: description: Maximum estimated benefit in terms of seconds format: double type: number maxBenefitPercent: description: Maximum estimated benefit in terms of percentage of total activity format: double type: number relatedObject: $ref: '#/components/schemas/RelatedObjectTypeDetails' taskId: description: Unique ADDM task id type: integer taskName: description: ADDM task name type: string timeAnalysisEnded: description: End Timestamp of snapshot format: date-time type: string timeAnalysisStarted: description: Start Timestamp of snapshot format: date-time type: string timestamp: description: Timestamp when recommendation was generated format: date-time type: string type: description: Type of recommendation type: string required: - id - taskId - taskName - timestamp type: object WarehouseDataObjectSummary: description: Summary of a Warehouse data object. properties: dataObjectType: description: Type of the data object. enum: - VIEW - TABLE type: string x-obmcs-top-level-enum: '#/definitions/DataObjectType' details: $ref: '#/components/schemas/WarehouseDataObjectDetails' name: description: Name of the data object, which can be used in data object queries just like how view names are used in a query. maxLength: 128 minLength: 1 type: string owner: description: Owner of the data object, which can be used in data object queries in front of data object names just like SCHEMA.VIEW notation in queries. maxLength: 128 minLength: 1 type: string required: - dataObjectType type: object SummarizeHostInsightsTopProcessesUsageTrendCollection: description: 'Top level response object. ' properties: items: description: Collection of Usage Data with time stamps for top processes items: $ref: '#/components/schemas/TopProcessesUsageTrendAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - items type: object AddmDbRecommendationCategoryCollection: description: 'List of recommendation categories ' properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of recommendation categories items: $ref: '#/components/schemas/AddmDbRecommendationCategorySummary' type: array required: - databaseDetailsItems - items type: object ImportableComputeEntitySummary: description: A compute entity that can be imported into Operations Insights. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeDisplayName: description: The [Display Name](/iaas/Content/General/Concepts/identifiers.htm#Display) of the Compute Instance maxLength: 255 minLength: 1 type: string computeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Compute Instance maxLength: 255 minLength: 1 type: string entitySource: description: Source of the importable agent entity. enum: - MACS_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST example: MACS_MANAGED_CLOUD_HOST type: string x-obmcs-top-level-enum: '#/definitions/ImportableAgentEntitySource' required: - entitySource - computeId - computeDisplayName - compartmentId type: object IngestDatabaseConfigurationDetails: description: Database Configuration Metrics details. properties: items: description: Array of one or more database configuration metrics objects. items: $ref: '#/components/schemas/DatabaseConfigurationMetricGroup' maxItems: 1000 minItems: 1 type: array required: - items type: object UpdateOperationsInsightsWarehouseDetails: description: The information to be updated. properties: cpuAllocated: description: 'Number of CPUs allocated to OPSI Warehouse ADW. ' format: double type: number definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of Ops Insights Warehouse that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object storageAllocatedInGBs: description: 'Storage allocated to OPSI Warehouse ADW. ' format: double type: number type: object SummarizeDatabaseInsightResourceUsageAggregation: description: Resource usage summation for the current time period properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Percentage change in resource usage during the current period calculated using linear regression functions example: 10.23 format: double type: number usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - capacity - usage - usageUnit - usageChangePercent type: object TablespaceUsageTrend: description: Usage data samples properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number required: - endTimestamp - usage - capacity type: object ResourceUsageTrendAggregation: description: Aggregate usage samples properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number required: - endTimestamp - usage - capacity type: object SummarizeHostInsightIoUsageTrendAggregationCollection: description: Top level response object. properties: itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer items: description: Collection of Usage Data with time stamps for all IO interfaces. items: $ref: '#/components/schemas/IoUsageTrendAggregation' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - itemDurationInMs - items type: object EnableKubeClusterInsightDetails: description: The information about the Kubernetes cluster to be analyzed. discriminator: propertyName: entitySource properties: entitySource: description: Source of the Kubernetes cluster. enum: - OKE_CLUSTER type: string x-obmcs-top-level-enum: '#/definitions/KubeClusterEntitySource' required: - entitySource type: object AwrDatabaseSnapshotCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_SNAPSHOT_SET properties: items: description: A list of AWR snapshot summary data. items: $ref: '#/components/schemas/AwrDatabaseSnapshotSummary' type: array description: The list of AWR snapshots for one database. type: object SqlStatisticsTimeSeriesAggregationCollection: description: 'SQL performance statistics over the selected time window. ' properties: endTimestamps: description: Array comprising of all the sampling period end timestamps in RFC 3339 format. example: - '2020-05-01T00:00:00.000Z' - '2020-05-02T00:00:00.000Z' items: format: date-time type: string type: array itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer items: description: Array of SQL performance statistics across databases. items: $ref: '#/components/schemas/SqlStatisticsTimeSeriesAggregation' type: array sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - itemDurationInMs - sqlIdentifier - timeIntervalStart - timeIntervalEnd - items type: object SummarizeHostInsightResourceUsageTrendAggregationCollection: description: 'Top level response object. ' properties: itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageData: description: 'Usage Data with timestamp. ' items: $ref: '#/components/schemas/ResourceUsageTrendAggregation' maxItems: 1000 type: array usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - itemDurationInMs - usageData type: object AddmDbSummary: description: ADDM summary for a database properties: databaseDetails: $ref: '#/components/schemas/DatabaseDetails' maxOverallImpact: description: Maximum overall impact in terms of percentage of total activity format: double type: number mostFrequentCategoryDisplayName: description: Category display name type: string mostFrequentCategoryName: description: Category name type: string numberOfAddmTasks: description: Number of ADDM tasks type: integer numberOfFindings: description: Number of ADDM findings type: integer snapshotIntervalEnd: description: AWR snapshot id. type: string snapshotIntervalStart: description: AWR snapshot id. type: string timeFirstSnapshotBegin: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeLatestSnapshotEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - databaseDetails type: object ChargebackPlanDetails: description: 'Object containing chargeback plan details ' properties: planId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. ' maxLength: 255 minLength: 1 type: string planType: description: 'Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. ' example: WEIGHTED_ALLOCATION maxLength: 255 minLength: 1 type: string timeEnabled: description: The date and time the chargeback plan was enabled on the resource, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string type: object IngestSqlStatsDetails: description: 'Collection of SQL Stats Metric Entries ' properties: items: description: List of SQL Stats Metric Entries. items: $ref: '#/components/schemas/SqlStats' type: array type: object QueryOpsiDataObjectDataDetails: description: Information required to form and execute query on an OPSI data object. properties: dataObjectIdentifier: description: Unique OPSI data object identifier. maxLength: 255 minLength: 1 type: string dataObjects: description: Details of OPSI data objects used in the query. items: $ref: '#/components/schemas/OpsiDataObjectDetailsInQuery' type: array query: $ref: '#/components/schemas/DataObjectQuery' resourceFilters: $ref: '#/components/schemas/ResourceFilters' required: - query type: object UpdateAwrHubSourceDetails: description: Awr hub source update object information properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: description: source type of the database enum: - ADW_S - ATP_S - ADW_D - ATP_D - EXTERNAL_PDB - EXTERNAL_NONCDB - COMANAGED_VM_CDB - COMANAGED_VM_PDB - COMANAGED_VM_NONCDB - COMANAGED_BM_CDB - COMANAGED_BM_PDB - COMANAGED_BM_NONCDB - COMANAGED_EXACS_CDB - COMANAGED_EXACS_PDB - COMANAGED_EXACS_NONCDB - LH_S - APEX_S - AJD_S - AVD_S - LH_D - APEX_D - AJD_D - AVD_D - UNDEFINED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceType' type: object CreateOperationsInsightsPrivateEndpointDetails: description: The details used to create a new Operation Insights private endpoint. properties: compartmentId: description: The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private service accessed database. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: The description of the private endpoint. maxLength: 1024 minLength: 1 type: string displayName: description: The display name for the private endpoint. It is changeable. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isUsedForRacDbs: default: false description: 'This flag was previously used to create a private endpoint with scan proxy. Setting this to true will now create a private endpoint with a DNS proxy causing `isProxyEnabled` flag to be true; this is used exclusively for full feature support for dedicated Autonomous Databases. ' type: boolean nsgIds: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security groups that the private endpoint belongs to. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object subnetId: description: The Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private service accessed database. maxLength: 255 minLength: 1 type: string vcnId: description: The VCN [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Private service accessed database. maxLength: 255 minLength: 1 type: string required: - displayName - compartmentId - vcnId - subnetId - isUsedForRacDbs type: object ExadataMemberSummary: description: Lists name, display name and type of exadata member. properties: displayName: description: Display Name of exadata member target maxLength: 255 minLength: 1 type: string entityType: description: Entity type of exadata member target enum: - DATABASE - ILOM_SERVER - PDU - STORAGE_SERVER - CLUSTER_ASM - INFINIBAND_SWITCH - ETHERNET_SWITCH - HOST - VM_CLUSTER type: string name: description: Name of exadata member target maxLength: 255 minLength: 1 type: string required: - name - displayName - entityType type: object ChangeNewsReportCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The OCID of the compartment into which the resource will be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object IngestSqlPlanLinesDetails: description: 'Collection of SQL Plan Line Entries ' properties: items: description: List of SQL Plan Line Entries. items: $ref: '#/components/schemas/SqlPlanLine' type: array type: object CreateAwrHubDetails: description: The information about Hub to be analyzed. Input compartmentId MUST be the root compartment. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of AWR Hub that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object objectStorageBucketName: description: Object Storage Bucket Name type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string required: - operationsInsightsWarehouseId - compartmentId - displayName type: object OpsiConfigurationSummary: description: OPSI configuration summary. discriminator: propertyName: opsiConfigType properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OPSI configuration. example: Custom configurations for user experience in the sales department compartment. maxLength: 400 type: string displayName: description: User-friendly display name for the OPSI configuration. The name does not have to be unique. example: Sales department configurations. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: OPSI configuration resource lifecycle state. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationLifecycleState' opsiConfigType: description: OPSI configuration type. enum: - UX_CONFIGURATION type: string x-obmcs-top-level-enum: '#/definitions/OpsiConfigurationType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - opsiConfigType type: object SummarizeExadataInsightResourceCapacityTrendCollection: description: capacity results with breakdown by databases, hosts, storage servers or diskgroup. properties: exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string items: description: 'Capacity Data with time interval ' items: $ref: '#/components/schemas/ExadataInsightResourceCapacityTrendSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataInsightId - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - items type: object ResourceStatistics: description: Contains resource statistics with usage unit properties: baseCapacity: description: 'The base allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number instanceMetrics: description: Array of instance metrics items: $ref: '#/components/schemas/InstanceMetrics' type: array isAutoScalingEnabled: description: Indicates if auto scaling feature is enabled or disabled on a database. It will be false for all metrics other than CPU. example: true type: boolean isHeatWaveClusterAttached: default: false description: Specifies if MYSQL DB System has heatwave cluster attached. example: true type: boolean isHighlyAvailable: default: false description: Specifies if MYSQL DB System is highly available. example: true type: boolean totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Change in resource utilization in percentage example: 5.2 format: double type: number utilizationPercent: description: Resource utilization in percentage example: 35.1 format: double type: number required: - usage - capacity - utilizationPercent - usageChangePercent type: object IngestAddmReportsDetails: description: 'Collection of Addm reports ' properties: items: description: List of Addm reports items: $ref: '#/components/schemas/AddmReport' type: array required: - items type: object DataObjectColumnUnit: description: Unit details of a data object column. discriminator: propertyName: unitCategory properties: displayName: description: Display name of the column's unit. maxLength: 255 type: string unitCategory: description: Category of the column's unit. enum: - DATA_SIZE - TIME - POWER - TEMPERATURE - CORE - RATE - FREQUENCY - OTHER_STANDARD - CUSTOM type: string required: - unitCategory type: object WorkRequestCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of workRequests. items: $ref: '#/components/schemas/WorkRequest' type: array required: - items type: object NewsSqlInsightsContentTypesResource: description: Supported resources for the news report content types. enum: - DATABASE - EXADATA type: string AwrHubSourceSummary: description: Awr hub source object properties: associatedOpsiId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string associatedResourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string awrHubId: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string awrHubOpsiSourceId: description: The shorted string of the Awr Hub source database identifier. maxLength: 20 minLength: 1 type: string awrSourceDatabaseId: description: DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hoursSinceLastImport: description: Number of hours since last AWR snapshots import happened from the Source database. format: double type: number id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Awr Hub source database. maxLength: 255 minLength: 1 type: string isRegisteredWithAwrHub: description: This is `true` if the source databse is registered with a Awr Hub, otherwise `false` type: boolean lifecycleState: description: the current state of the source database enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceLifecycleState' maxSnapshotIdentifier: description: The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number minSnapshotIdentifier: description: The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number name: description: The name of the Awr Hub source database. maxLength: 30 minLength: 1 type: string sourceMailBoxUrl: description: Opsi Mailbox URL based on the Awr Hub and Awr Hub source. maxLength: 1000 minLength: 1 type: string status: description: Indicates the status of a source database in Operations Insights enum: - ACCEPTING - NOT_ACCEPTING - NOT_REGISTERED - TERMINATED example: ACCEPTING type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeFirstSnapshotGenerated: description: The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeLastSnapshotGenerated: description: The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string type: description: source type of the database enum: - ADW_S - ATP_S - ADW_D - ATP_D - EXTERNAL_PDB - EXTERNAL_NONCDB - COMANAGED_VM_CDB - COMANAGED_VM_PDB - COMANAGED_VM_NONCDB - COMANAGED_BM_CDB - COMANAGED_BM_PDB - COMANAGED_BM_NONCDB - COMANAGED_EXACS_CDB - COMANAGED_EXACS_PDB - COMANAGED_EXACS_NONCDB - LH_S - APEX_S - AJD_S - AVD_S - LH_D - APEX_D - AJD_D - AVD_D - UNDEFINED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceType' required: - name - awrHubId - compartmentId - type - id - awrHubOpsiSourceId - timeCreated - lifecycleState - status - sourceMailBoxUrl type: object TestMacsManagedCloudDatabaseInsightConnectionDetails: description: Connection details of a MACS-managed cloud database . properties: connectionCredentialDetails: $ref: '#/components/schemas/CredentialDetails' connectionDetails: $ref: '#/components/schemas/ConnectionDetails' managementAgentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent maxLength: 255 minLength: 1 type: string required: - managementAgentId - connectionDetails - connectionCredentialDetails type: object ChangeMacsManagedCloudDatabaseInsightConnectionDetails: description: Connection details of a MACS-managed cloud database insight. properties: connectionCredentialDetails: $ref: '#/components/schemas/CredentialDetails' connectionDetails: $ref: '#/components/schemas/ConnectionDetails' managementAgentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent maxLength: 255 minLength: 1 type: string required: - managementAgentId - connectionDetails - connectionCredentialDetails type: object AwrDatabaseSysstatSummary: description: The summary of the AWR SYSSTAT data. properties: avgValue: description: The average value of the SYSSTAT. The units are stats name/val per the time period {timeBegin - timeEnd}. format: double type: number category: description: The name of the SYSSTAT category. type: string currentValue: description: The last value of the SYSSTAT. The units are stats name/val per the time period {timeBegin - timeEnd}. format: double type: number name: description: The name of the SYSSTAT. type: string timeBegin: description: The start time of the SYSSTAT. format: date-time type: string timeEnd: description: The end time of the SYSSTAT. format: date-time type: string required: - name type: object AwrDatabaseSnapshotRangeCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_SNAPSHOT_RANGE_SET properties: items: description: A list of AWR snapshot range summary data. items: $ref: '#/components/schemas/AwrDatabaseSnapshotRangeSummary' type: array description: The AWR snapshot range list. type: object ExadataConfigurationCollection: description: Collection of exadata insight configuration summary objects. properties: items: description: Array of exadata insight configurations summary objects. items: $ref: '#/components/schemas/ExadataConfigurationSummary' type: array required: - items type: object CreateExadataInsightDetails: description: The information about the Exadata system to be analyzed. discriminator: propertyName: entitySource properties: compartmentId: description: Compartment Identifier of Exadata insight maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the Exadata system. enum: - EM_MANAGED_EXTERNAL_EXADATA - PE_COMANAGED_EXADATA - MACS_MANAGED_CLOUD_EXADATA type: string x-obmcs-top-level-enum: '#/definitions/ExadataEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - entitySource - compartmentId type: object IoUsageTrendAggregation: description: Usage data per io interface. properties: mountPoint: description: Mount point is specialized NTFS filesystem object. maxLength: 255 minLength: 1 type: string usageData: description: List of usage data samples for a IO interface. items: $ref: '#/components/schemas/IoUsageTrend' type: array required: - mountPoint - usageData type: object AddmDbSchemaObjectCollection: description: Summarizes Schema Objects over specified time period properties: databaseDetailsItems: description: List of database details data items: $ref: '#/components/schemas/DatabaseDetails' type: array items: description: List of Schema Objects items: $ref: '#/components/schemas/AddmDbSchemaObjectSummary' type: array timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string required: - timeIntervalStart - timeIntervalEnd - databaseDetailsItems - items type: object UpdateChargebackPlanDetails: description: The details used to update a Ops Insights chargeback plan. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object planCustomItems: description: List of chargeback plan customizations. items: $ref: '#/components/schemas/CreatePlanCustomItemDetails' maxItems: 25 type: array planDescription: description: Description of OPSI Chargeback Plan. example: Chargeback plan weighted for exadata maxLength: 400 type: string planName: description: Name for the OPSI Chargeback plan. example: Chargeback Plan weighted Allocation maxLength: 255 minLength: 1 type: string type: object EnablePlanExadataInsightDetails: description: The information about the chargeback plan to be enabled. properties: planId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. ' maxLength: 255 minLength: 1 type: string required: - planId type: object AwrDatabaseParameterSummary: description: The summary of the AWR change history data for a single database parameter. properties: beginValue: description: The parameter value when the period began. type: string endValue: description: The parameter value when the period ended. type: string instanceNumber: description: The database instance number. type: integer isChanged: description: Indicates whether the parameter value changed within the period. type: boolean isDefault: description: Indicates whether the parameter value in the end snapshot is the default. type: boolean name: description: The name of the parameter. type: string valueModified: description: "Indicates whether the parameter has been modified after instance startup:\n - MODIFIED - Parameter has been modified with ALTER SESSION\n - SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM (which causes all the currently logged in sessions values to be modified)\n - FALSE - Parameter has not been modified after instance startup\n" type: string required: - name type: object CreateAwrHubSourceDetails: description: payload to register Awr Hub source properties: associatedOpsiId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string associatedResourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string awrHubId: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object name: description: The name of the Awr Hub source database. maxLength: 30 minLength: 1 type: string type: description: source type of the database enum: - ADW_S - ATP_S - ADW_D - ATP_D - EXTERNAL_PDB - EXTERNAL_NONCDB - COMANAGED_VM_CDB - COMANAGED_VM_PDB - COMANAGED_VM_NONCDB - COMANAGED_BM_CDB - COMANAGED_BM_PDB - COMANAGED_BM_NONCDB - COMANAGED_EXACS_CDB - COMANAGED_EXACS_PDB - COMANAGED_EXACS_NONCDB - LH_S - APEX_S - AJD_S - AVD_S - LH_D - APEX_D - AJD_D - AVD_D - UNDEFINED type: string x-obmcs-top-level-enum: '#/definitions/AwrHubSourceType' required: - name - compartmentId - type - awrHubId type: object KubeClusterNodePool: description: A group of compute instances in the K8s cluster that serves as worker nodes for running K8s applications. properties: id: description: The identifier of the K8s cluster node pool. type: string name: description: Name of the K8s cluster node pool. type: string workerNodeCount: description: The total number of compute instances (worker nodes) in the node pool registered within Ops Insights. format: int64 type: integer type: object SqlPlanSummary: description: 'SQL Plan details ' properties: planContent: description: Plan XML Content type: string planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer required: - planHash - planContent type: object IngestSqlBucketResponseDetails: description: 'The response object returned from IngestSqlBucketDetails operation. ' properties: message: description: 'Success message returned as a result of the upload. ' type: string required: - message type: object OpsiDataObjectQueryParam: description: Details for a query parameter to be applied on an OPSI data object, when a data object query is executed. properties: name: description: Name of the query parameter. maxLength: 64 minLength: 1 type: string value: additionalProperties: true description: Value for the query parameter. type: object required: - name - value type: object SummarizeOperationsInsightsWarehouseResourceUsageAggregation: description: Details of resource usage by an Operations Insights Warehouse resource. properties: cpuUsed: description: 'Number of OCPUs used by OPSI Warehouse ADW. Can be fractional. ' format: double type: number id: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/OperationsInsightsWarehouseLifecycleState' storageUsedInGBs: description: 'Storage by OPSI Warehouse ADW in GB. ' format: double type: number required: - id - lifecycleState type: object SummarizeHostInsightResourceUsageAggregation: description: 'Resource usage summation for the current time period. ' properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number resourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageChangePercent: description: Percentage change in resource usage during the current period calculated using linear regression functions example: 10.23 format: double type: number usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - resourceMetric - timeIntervalStart - timeIntervalEnd - capacity - usage - usageUnit - usageChangePercent type: object SqlTextCollection: description: 'SQL Text for the particular SQL. ' properties: items: description: array of SQL Texts. items: $ref: '#/components/schemas/SqlTextSummary' type: array required: - items type: object AwrDatabaseWaitEventBucketCollection: allOf: - $ref: '#/components/schemas/AwrQueryResult' - discriminator: propertyName: AWRDB_EVENT_HISTOGRAM_SET properties: items: description: A list of AWR wait event buckets. items: $ref: '#/components/schemas/AwrDatabaseWaitEventBucketSummary' type: array totalWaits: description: The total waits of the database. format: int64 type: integer description: The percentage distribution of waits in the AWR wait event buckets. type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of workRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object HostInsightSummary: description: Summary of a host insight resource. discriminator: propertyName: entitySource properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object entitySource: description: Source of the host entity. enum: - MACS_MANAGED_EXTERNAL_HOST - EM_MANAGED_EXTERNAL_HOST - MACS_MANAGED_CLOUD_HOST - PE_COMANAGED_HOST - MACS_MANAGED_CLOUD_DB_HOST example: MACS_MANAGED_EXTERNAL_HOST type: string x-obmcs-top-level-enum: '#/definitions/HostEntitySource' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hostDisplayName: description: The user-friendly name for the host. The name does not have to be unique. maxLength: 255 minLength: 1 type: string hostName: description: The host name. The host name is unique amongst the hosts managed by the same management agent. maxLength: 255 minLength: 1 type: string hostType: description: Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST. type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host insight resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the host. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' opsiPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint maxLength: 255 minLength: 1 type: string processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer status: description: Indicates the status of a host insight in Ops Insights enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the host insight was first enabled. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the host insight was updated. An RFC3339 formatted datetime string format: date-time type: string required: - entitySource - id - compartmentId - hostName type: object HostResourceCapacityTrendAggregation: description: Host Resource Capacity samples properties: capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string required: - endTimestamp - capacity type: object CreateConfigurationItemDetails: description: Configuration item details for OPSI configuration creation. discriminator: propertyName: configItemType properties: configItemType: description: Type of configuration item. enum: - BASIC type: string x-obmcs-top-level-enum: '#/definitions/ConfigurationItemType' required: - configItemType type: object ChangePeComanagedDatabaseInsightDetails: description: Details of a Private Endpoint co-managed database insight. properties: connectionDetails: $ref: '#/components/schemas/PeComanagedDatabaseConnectionDetails' credentialDetails: $ref: '#/components/schemas/CredentialDetails' opsiPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint maxLength: 255 minLength: 1 type: string serviceName: description: Database service name used for connection requests. maxLength: 128 minLength: 1 type: string required: - serviceName - credentialDetails - opsiPrivateEndpointId type: object OpsiConfigurationsCollection: description: Collection of OPSI configuration summary objects. properties: items: description: Array of OPSI configuration summary objects. items: $ref: '#/components/schemas/OpsiConfigurationSummary' type: array required: - items type: object SummarizeExadataInsightResourceCapacityTrendAggregation: description: 'Collection of resource capacity trend. ' properties: capacityData: description: 'Capacity Data with time interval ' items: $ref: '#/components/schemas/ExadataInsightResourceCapacityTrendAggregation' type: array exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string required: - exadataResourceType - exadataResourceMetric - timeIntervalStart - timeIntervalEnd - usageUnit - itemDurationInMs - capacityData type: object UpdateConfigurationItemDetails: description: Configuration item details for OPSI configuration update. discriminator: propertyName: configItemType properties: configItemType: description: Type of configuration item. enum: - BASIC type: string x-obmcs-top-level-enum: '#/definitions/ConfigurationItemType' required: - configItemType type: object NewsReportSummary: description: Summary of a news report resource. properties: areChildCompartmentsIncluded: default: false description: A flag to consider the resources within a given compartment and all sub-compartments. type: boolean compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string contentTypes: $ref: '#/components/schemas/NewsContentTypes' dayOfWeek: description: Day of the week in which the news report will be sent if the frequency is set to WEEKLY. enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY example: MONDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'The description of the news report. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the news report resource. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the news report. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleState' locale: description: Language of the news report. enum: - EN type: string x-obmcs-top-level-enum: '#/definitions/NewsLocale' name: description: The news report name. maxLength: 255 minLength: 1 type: string newsFrequency: description: News report frequency. enum: - WEEKLY example: WEEKLY type: string x-obmcs-top-level-enum: '#/definitions/NewsFrequency' onsTopicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ONS topic. maxLength: 255 minLength: 1 type: string status: description: Indicates the status of a news report in Ops Insights. enum: - DISABLED - ENABLED - TERMINATED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/ResourceStatus' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the the news report was first enabled. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the news report was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - newsFrequency - contentTypes type: object AwrHubSummary: description: Summary Hub resource. properties: awrMailboxUrl: description: Mailbox URL required for AWR hub and AWR source setup. maxLength: 1000 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: User-friedly name of AWR Hub that does not have to be unique. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: Possible lifecycle states enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED example: ACTIVE type: string x-obmcs-top-level-enum: '#/definitions/AwrHubLifecycleState' objectStorageBucketName: description: Object Storage Bucket Name type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string required: - operationsInsightsWarehouseId - id - compartmentId - displayName - objectStorageBucketName - timeCreated - lifecycleState type: object HostConfigurationMetricGroup: description: 'Base Metric Group for Host configuration metrics ' discriminator: propertyName: metricName properties: metricName: description: 'Name of the metric group ' enum: - HOST_PRODUCT - HOST_RESOURCE_ALLOCATION - HOST_MEMORY_CONFIGURATION - HOST_HARDWARE_CONFIGURATION - HOST_CPU_HARDWARE_CONFIGURATION - HOST_NETWORK_CONFIGURATION - HOST_ENTITES - HOST_CONTAINERS type: string timeCollected: description: 'Collection timestamp Example: `"2020-05-06T00:00:00.000Z"` ' format: date-time type: string required: - metricName - timeCollected type: object SqlStatistics: description: Performance statistics for the SQL. properties: averageActiveSessions: description: Average Active Sessions represent the average active sessions at a point in time. It is the number of sessions that are either working or waiting. format: double type: number changeInAverageActiveSessionsInPct: description: Percent change in Average Active Sessions based on linear regression format: double type: number changeInCpuTimeInPct: description: Percent change in CPU Time based on linear regression format: double type: number changeInExecutionsPerHourInPct: description: Percent change in Executions per hour based on linear regression format: double type: number changeInInefficiencyInPct: description: Percent change in Inefficiency based on linear regression format: double type: number changeInInefficientWaitTimeInPct: description: Percent change in Inefficient Wait Time based on linear regression format: double type: number changeInIoTimeInPct: description: Percent change in IO Time based on linear regression format: double type: number changeInResponseTimeInPct: description: Percent change in Response Time based on linear regression format: double type: number cpuTimeInSec: description: CPU Time in seconds format: double type: number databaseTimeInSec: description: Database Time in seconds format: double type: number databaseTimePct: description: Percentage of Database Time format: double type: number executionsCount: description: Total number of executions format: int64 type: integer executionsPerHour: description: Number of executions per hour format: double type: number inefficiencyInPct: description: Percentage of Inefficiency. It is calculated by Total Database Time divided by Total Wait Time format: double type: number inefficientWaitTimeInSec: description: Inefficient Wait Time in seconds format: double type: number ioTimeInSec: description: I/O Time in seconds format: double type: number planCount: description: Number of SQL execution plans used by the SQL format: int64 type: integer responseTimeInSec: description: Response time is the average elaspsed time per execution. It is the ratio of Total Database Time to the number of executions format: double type: number variability: description: Variability is the ratio of the standard deviation in response time to the mean of response time of the SQL format: double type: number required: - databaseTimeInSec - executionsPerHour - executionsCount - cpuTimeInSec - ioTimeInSec - inefficientWaitTimeInSec - responseTimeInSec - planCount - variability - averageActiveSessions - databaseTimePct - inefficiencyInPct - changeInCpuTimeInPct - changeInIoTimeInPct - changeInInefficientWaitTimeInPct - changeInResponseTimeInPct - changeInAverageActiveSessionsInPct - changeInExecutionsPerHourInPct - changeInInefficiencyInPct type: object responses: '400': description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal Server Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Conflict headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '412': description: Precondition Failed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'For pagination of a list of items. The total number of items in the result. ' type: integer x-properties: addmReport: description: The complete ADDM report type: string apiServerPort: description: The Kubernetes cluster API Server port. maximum: 65535 type: integer apiServerUrl: description: The Kubernetes cluster API server URL. maxLength: 512 minLength: 1 type: string archival-state: description: Archival state of an Awr Hub object. This field is set only for Awr Hub objects in Archive tier. enum: - ARCHIVED - RESTORING - RESTORED type: string asmName: description: The ASM name. maxLength: 255 minLength: 1 type: string associatedOpsiId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string associatedResourceId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database id. maxLength: 255 minLength: 1 type: string awrHubDisplayName: description: User-friedly name of AWR Hub that does not have to be unique. maxLength: 255 minLength: 1 type: string awrHubDstTimezoneVersion: description: Dst Time Zone Version of the AWR Hub maxLength: 255 minLength: 1 type: string awrHubId: description: AWR Hub OCID maxLength: 255 minLength: 1 type: string awrHubOpsiSourceId: description: The shorted string of the Awr Hub source database identifier. maxLength: 20 minLength: 1 type: string awrMailboxUrl: description: Mailbox URL required for AWR hub and AWR source setup. maxLength: 1000 minLength: 1 type: string awrSourceDatabaseId: description: DatabaseId of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string awrSourceName: description: Database name of the Source database for which AWR Data will be uploaded to AWR Hub. maxLength: 255 minLength: 1 type: string baseCapacity: description: 'The base allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number cache-control: description: Cache-Control header. type: string capacity: description: 'The maximum allocated amount of the resource metric type (CPU, STORAGE) for a set of databases. ' example: 222.3 format: double type: number cdbName: description: Name of the CDB.Only applies to PDB. maxLength: 255 minLength: 1 type: - string - 'null' certificateSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster certificate secret id. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string computeDisplayName: description: The [Display Name](/iaas/Content/General/Concepts/identifiers.htm#Display) of the Compute Instance maxLength: 255 minLength: 1 type: string computeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Compute Instance maxLength: 255 minLength: 1 type: string configurationItemDescription: description: Description of configuration item . example: Maximum threshold to consider an resource to be in the high usage group. maxLength: 400 minLength: 1 type: string configurationItemDisplayName: description: User-friendly display name for the configuration item. example: Maximum CPU Threshold maxLength: 255 minLength: 1 type: string configurationItemName: description: Name of configuration item. example: maxCpuThreshold maxLength: 255 minLength: 1 type: string configurationItemUnit: description: Unit of configuration item. example: PERCENTAGE maxLength: 64 minLength: 1 type: string configurationItemUnitDisplayName: description: User-friendly display name for the configuration item unit. example: '%' maxLength: 64 minLength: 1 type: string configurationItemValue: description: Value of configuration item. example: HIGH maxLength: 255 minLength: 1 type: string connectorId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of External Database Connector maxLength: 255 minLength: 1 type: string content-disposition: description: Content-Disposition header. type: string content-encoding: description: Content-Encoding header. type: string content-language: description: Content-Language header. type: string content-length: description: The Awr Hub object size in bytes. format: int64 type: integer content-location: description: URI of the resource format: uri-reference type: string content-md5: description: Content-MD5 header. type: string content-range: description: Content-Range header. type: string content-type: description: Content-Type header. type: string coresPerSocket: description: 'Number of cores per socket. ' example: 24 minimum: 0 type: integer cpuArchitecture: description: CPU architechure example: GenuineIntel x86 maxLength: 255 minLength: 1 type: string cpuCacheInMBs: description: 'Size of cache memory in megabytes. ' example: 35.75 format: double minimum: 0 type: number cpuFrequencyInMhz: description: 'Clock frequency of the processor in megahertz. ' example: 2900 format: double minimum: 0 type: number cpuImplementation: description: Model name of processor. example: Intel(R) Xeon(R) Platinum 8268 CPU @ 2.90GHz maxLength: 255 minLength: 1 type: string cpuVendor: description: Name of the CPU vendor. example: GenuineIntel maxLength: 255 minLength: 1 type: string customPlanItemName: description: Name of chargeback plan customization item. Example items for Exadata Insights Chargeback are statistic, percentile, infrastructureCost, additionalServerCost etc. example: statistics maxLength: 255 minLength: 1 type: string customPlanItemValue: description: Value of chargeback plan customization item. example: MAX maxLength: 255 minLength: 1 type: string dataObjectColumnType: description: Type of a data object column. maxLength: 255 minLength: 1 type: string dataObjectColumnTypeName: description: Type name of a data object column. enum: - NUMBER - TIMESTAMP - VARCHAR2 - OTHER type: string dataObjectGroupNames: description: Names of all the groups to which the data object belongs to. items: example: - Oracle - Sql - Database maxItems: 10 maxLength: 128 minLength: 1 type: string type: array dataObjectName: description: Name of the data object, which can be used in data object queries just like how view names are used in a query. maxLength: 128 minLength: 1 type: string dataObjectOwner: description: Owner of the data object, which can be used in data object queries in front of data object names just like SCHEMA.VIEW notation in queries. maxLength: 128 minLength: 1 type: string databaseConnectionStatusDetails: description: A message describing the status of the database connection of this resource. For example, it can be used to provide actionable information about the permission and content validity of the database connection. type: string databaseConnectorId: description: The DBM owned database connector [OCID](/iaas/database-management/doc/view-connector-details.html) mapping to the database credentials and connection details. maxLength: 255 minLength: 1 type: string databaseDisplayName: description: The user-friendly name for the database. The name does not have to be unique. type: string databaseHostNames: description: The hostnames for the database. items: type: string type: array databaseId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the database. maxLength: 255 minLength: 1 type: string databaseIdentifier: description: Internal id of the database. type: string databaseInsightIdentifier: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database insight. maxLength: 255 minLength: 1 type: string databaseName: description: The database name. The database name is unique within the tenancy. type: string databaseType: description: Ops Insights internal representation of the database type. type: string databaseVersion: description: The version of the database. type: string daysToReachCapacity: description: Days to reach capacity for a storage server type: - integer - 'null' dbAdditionalDetails: description: 'Additional details of a database in JSON format. For autonomous databases, this is the AutonomousDatabase object serialized as a JSON string as defined in https://docs.cloud.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/. For EM, pass in null or an empty string. Note that this string needs to be escaped when specified in the curl command. ' example: "{\n \"additionalDatabaseStatus\": null,\n \"autonomousContainerDatabaseId\": null,\n \"compartmentId\": \"ocid1.compartment.oc1..example\",\n \"connectionStrings\": {\n \"allConnectionStrings\": {\n \"HIGH\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_high.adwc.oraclecloud.com\",\n \"MEDIUM\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_medium.adwc.oraclecloud.com\",\n \"LOW\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_low.adwc.oraclecloud.com\"\n },\n \"dedicated\": null,\n \"high\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_high.adwc.oraclecloud.com\",\n \"low\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_low.adwc.oraclecloud.com\",\n \"medium\": \"adb.us-phoenix-1.oraclecloud.com:1522/wxgnhti9ojdasld_ds158343668862_medium.adwc.oraclecloud.com\"\n },\n \"connectionUrls\": {\n \"apexUrl\": \"https://WXGNHTI9OJDASLD-DS158343668862.adb.us-phoenix-1.oraclecloudapps.com/ords/apex\",\n \"machineLearningUserManagementUrl\": \"https://adb.us-phoenix-1.oraclecloud.com/omlusers/tenancys/OCID1.TENANCY.OC1..EXAMPLE/databases/DS158343668862/index.html\",\n \"sqlDevWebUrl\": \"https://WXGNHTI9OJDASLD-DS158343668862.adb.us-phoenix-1.oraclecloudapps.com/ords/admin/_sdw/?nav=worksheet\"\n },\n \"cpuCoreCount\": 1,\n \"currentLagTimeInSeconds\": null,\n \"dataSafeStatus\": \"NOT_REGISTERED\",\n \"dataStorageSizeInTBs\": 1,\n \"dbAvailabilityType\": \"HIGH_AVAILABILITY\",\n \"dbName\": \"DS158343668862\",\n \"dbVersion\": \"18c\",\n \"dbWorkload\": \"DW\",\n \"definedTags\": { },\n \"displayName\": \"example autonomous database\",\n \"freeformTags\": { },\n \"id\": \"ocid1.autonomousdatabase.oc1.phx.example\",\n \"infrastructureType\": null,\n \"isAutoScalingEnabled\": true,\n \"isDedicated\": false,\n \"isFailedOver\": false,\n \"isFreeTier\": false,\n \"isPreview\": false,\n \"isRefreshableClone\": null,\n \"lagTimeInSeconds\": null,\n \"licenseModel\": \"LICENSE_INCLUDED\",\n \"lifecycleDetails\": null,\n \"lifecycleState\": \"AVAILABLE\",\n \"nsgIds\": null,\n \"openMode\": \"READ_WRITE\",\n \"permissionLevel\": \"UNRESTRICTED\",\n \"privateEndpoint\": null,\n \"privateEndpointLabel\": null,\n \"refreshableStatus\": null,\n \"serviceConsoleUrl\": \"https://adb.us-phoenix-1.oraclecloud.com/console/index.html?tenancy_name=OCID1.TENANCY.OC1..EXAMPLE&database_name=DS158343668862&service_type=ADW\",\n \"sourceId\": null,\n \"sqlWebDeveloperUrl\": null,\n \"standbyDb\": null,\n \"subnetId\": null,\n \"systemTags\": { },\n \"timeCreated\": \"2020-03-05T19:31:29.981Z\",\n \"timeDeletionOfFreeAutonomousDatabase\": null,\n \"timeMaintenanceBegin\": \"2020-03-15T00:00:00.000Z\",\n \"timeMaintenanceEnd\": \"2020-03-15T04:00:00.000Z\",\n \"timeReclamationOfFreeAutonomousDatabase\": null,\n \"usedDataStorageSizeInTBs\": 1,\n \"whitelistedIps\": null\n}\n" type: object dbmPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object diskgroupName: description: The diskgroup name. maxLength: 255 minLength: 1 type: string endTimestamp: description: The timestamp in which the current sampling period ends in RFC 3339 format. example: '2020-05-01T00:00:00.000Z' format: date-time type: string endTimestamps: description: Array comprising of all the sampling period end timestamps in RFC 3339 format. example: - '2020-05-01T00:00:00.000Z' - '2020-05-02T00:00:00.000Z' items: format: date-time type: string type: array enterpriseManagerBridgeDescription: description: Description of Enterprise Manager Bridge maxLength: 400 type: string enterpriseManagerBridgeDisplayName: description: User-friedly name of Enterprise Manager Bridge that does not have to be unique. maxLength: 255 minLength: 1 type: string enterpriseManagerBridgeId: description: OPSI Enterprise Manager Bridge OCID maxLength: 255 minLength: 1 type: string enterpriseManagerConsoleUrl: description: Enterprise Manager Console Url maxLength: 256 minLength: 1 type: string enterpriseManagerEntityDisplayName: description: Enterprise Manager Entity Display Name maxLength: 256 minLength: 1 type: string enterpriseManagerEntityIdentifier: description: Enterprise Manager Entity Unique Identifier maxLength: 256 minLength: 1 type: string enterpriseManagerEntityName: description: Enterprise Manager Entity Name maxLength: 256 minLength: 1 type: string enterpriseManagerEntityType: description: Enterprise Manager Entity Type maxLength: 256 minLength: 1 type: string enterpriseManagerIdentifier: description: Enterprise Manager Unique Identifier maxLength: 256 minLength: 1 type: string enterpriseManagerOmsVer: description: Enterprise Manager OMS Version maxLength: 256 minLength: 1 type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string exadataDisplayName: description: The user-friendly name for the Exadata system. The name does not have to be unique. maxLength: 255 minLength: 1 type: string exadataInfraId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string exadataInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Exadata insight. maxLength: 255 minLength: 1 type: string exadataName: description: The Exadata system name. If the Exadata systems managed by Enterprise Manager, the name is unique amongst the Exadata systems managed by the same Enterprise Manager. maxLength: 255 minLength: 1 type: string exadataResourceMetric: description: 'Defines the type of exadata resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - IOPS - THROUGHPUT example: STORAGE type: string exadataResourceType: description: 'Defines the resource type for an exadata (example: DATABASE, STORAGE_SERVER, HOST, DISKGROUP) ' enum: - DATABASE - HOST - STORAGE_SERVER - DISKGROUP example: DATABASE type: string exadataShape: description: The shape of the Exadata Infrastructure. maxLength: 255 minLength: 1 type: string expires: description: The date and time after which the Awr Hub object is no longer cached by a browser, proxy, or other caching entity. format: date-time type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object hasAwrDataAccess: description: Indicate whether user has access to AWR data. type: boolean hasEmDataAccess: description: Indicate whether user has access to EM data. type: boolean hasOpsiDataAccess: description: Indicate whether user has access to OPSI data. type: boolean highUtilizationThreshold: description: Percent value in which a resource metric is considered highly utilized. example: 80 type: integer hostDisplayName: description: The user-friendly name for the host. The name does not have to be unique. maxLength: 255 minLength: 1 type: string hostInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the host. maxLength: 255 minLength: 1 type: string hostName: description: The host name. The host name is unique amongst the hosts managed by the same management agent. maxLength: 255 minLength: 1 type: string hostProcessResourceMetric: description: 'Defines the type of resource metric for a process (CPU, Physical Memory, Virtual Memory) ' enum: - CPU - MEMORY - VIRTUAL_MEMORY example: CPU type: string hostResourceMetric: description: 'Defines the type of resource metric (CPU, Physical Memory, Logical Memory) ' enum: - CPU - MEMORY - LOGICAL_MEMORY - IO - GPU_TEMPERATURE - GPU_POWER example: CPU type: string hostType: description: Ops Insights internal representation of the host type. Possible value is EXTERNAL-HOST. type: string hoursSinceLastImport: description: Number of hours since last AWR snapshots import happened from the Source database. format: double type: number id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Awr Hub source database. maxLength: 255 minLength: 1 type: string instanceNumber: description: The database instance unique number. format: int64 type: integer instances: description: Array of hostname and instance name. items: $ref: '#/components/schemas/HostInstanceMap' type: array is-delete-marker: description: This is `true` if the deleted object is a delete marker, otherwise `false` type: boolean isAbandonedInstance: default: false description: Identify if an instance is abandoned. example: true type: boolean isAdvancedFeaturesEnabled: default: false description: Flag is to identify if advanced features for autonomous database is enabled or not type: boolean isAutoSyncEnabled: description: Set to true to enable automatic enablement and disablement of related targets from Enterprise Manager. New resources (e.g. Database Insights) will be placed in the same compartment as the related Exadata Insight. type: boolean isCustomizable: default: false description: Indicates whether the chargeback plan customization item can be customized. example: false type: boolean isHeatWaveClusterAttached: default: false description: Specifies if MYSQL DB System has heatwave cluster attached. example: true type: boolean isHighlyAvailable: default: false description: Specifies if MYSQL DB System is highly available. example: true type: boolean isHyperThreadingEnabled: description: 'Indicates if hyper-threading is enabled or not ' example: true type: boolean isRegisteredWithAwrHub: description: This is `true` if the source databse is registered with a Awr Hub, otherwise `false` type: boolean isVirtualizedExadata: description: true if virtualization is used in the Exadata system type: boolean itemDurationInMs: description: 'Time duration in milliseconds between data points (one hour or one day). ' example: '86400000' format: int64 type: integer kubeClusterInfraId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OKE (Oracle Kubernetes Engine) Infrastructure. maxLength: 255 minLength: 1 type: string kubeClusterInsightId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster. maxLength: 255 minLength: 1 type: string kubeClusterName: description: The Kubernetes cluster name. maxLength: 255 minLength: 1 type: string last-modified: description: The Awr Hub object modification time. format: date-time type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string location: description: URI of the resource format: uri-reference type: string lowUtilizationThreshold: description: Percent value in which a resource metric is considered lowly utilized. example: 20 type: integer managementAgentDisplayName: description: The [Display Name](/iaas/Content/General/Concepts/identifiers.htm#Display) of the Management Agent maxLength: 255 minLength: 1 type: string managementAgentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent maxLength: 255 minLength: 1 type: string maxSnapshotIdentifier: description: The maximum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number md5: description: Base64-encoded MD5 hash of the Awr Hub object data. type: string minSnapshotIdentifier: description: The minimum snapshot identifier of the source database for which AWR data is uploaded to AWR Hub. format: integer type: number mysqlDbAdditionalDetails: description: 'Additional details of a db system in JSON format. For MySQL DB System, this is the DbSystem object serialized as a JSON string as defined in https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/DbSystem/. ' example: "{\n \"id\": \"ocid1.mysqldbsystem.oc1.phx.example\",\n \"displayName\": \"mysql1\",\n \"description\": null,\n \"compartmentId\": \"ocid1.compartment.oc1..example\",\n \"subnetId\": \"ocid1.subnet.oc1.phx.example\",\n \"isHighlyAvailable\": false,\n \"currentPlacement\": {\n \"availabilityDomain\": \"AsSu:PHX-AD-1\",\n \"faultDomain\": \"FAULT-DOMAIN-1\"\n },\n \"isAnalyticsClusterAttached\": false,\n \"analyticsCluster\": null,\n \"isHeatWaveClusterAttached\": false,\n \"heatWaveCluster\": null,\n \"availabilityDomain\": \"AsSu:PHX-AD-1\",\n \"faultDomain\": \"FAULT-DOMAIN-1\",\n \"availabilityPolicy\": {\n \"isHighlyAvailable\": false\n },\n \"shapeName\": \"MySQL.HeatWave.VM.Standard.E3\",\n \"mysqlVersion\": \"8.0.30\",\n \"backupPolicy\": {\n \"isEnabled\": false,\n \"window\": \"09:57\",\n \"windowStartTime\": \"09:57\",\n \"retentionDays\": 7,\n \"retentionInDays\": 7,\n \"freeformTags\": null,\n \"definedTags\": null,\n \"pitrPolicy\": {\n \"isEnabled\": false\n }\n },\n \"source\": null,\n \"configurationId\": \"ocid1.mysqlconfiguration.oc1..example\",\n \"configurationRevisionId\": null,\n \"dataStorageSizeInGBs\": 1024,\n \"hostnameLabel\": null,\n \"ipAddress\": \"127.0.0.0\",\n \"port\": 3306,\n \"portX\": 33060,\n \"endpoints\": [\n {\n \"hostname\": null,\n \"ipAddress\": \"127.0.0.1\",\n \"port\": 3306,\n \"portX\": 33060,\n \"modes\": [\n \"READ\",\n \"WRITE\"\n ],\n \"status\": \"ACTIVE\",\n \"statusDetails\": null,\n \"resourceType\": \"DBSYSTEM\",\n \"resourceId\": \"ocid1.mysqlinstance.oc1.phx.example\",\n \"instanceId\": \"ocid1.mysqlinstance.oc1.phx.example\"\n }\n ],\n \"channels\": [],\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": null,\n \"maintenance\": {\n \"windowStartTime\": \"MONDAY 07:52\"\n },\n \"deletionPolicy\": {\n \"automaticBackupRetention\": \"DELETE\",\n \"finalBackup\": \"SKIP_FINAL_BACKUP\",\n \"isDeleteProtected\": false\n },\n \"timeCreated\": \"2022-10-04T16:02:47.457Z\",\n \"timeUpdated\": \"2023-02-15T10:34:36.303Z\",\n \"freeformTags\": {},\n \"definedTags\": {\n \"Oracle-Tags\": {\n \"CreatedBy\": \"opsi_test_user\",\n \"CreatedOn\": \"2022-10-04T16:02:46.405Z\"\n }\n },\n \"crashRecovery\": \"ENABLED\",\n \"pointInTimeRecoveryDetails\": null,\n \"databaseManagement\": null\n}\n" type: object name: description: The name of the Awr Hub object. type: string newsReportName: description: The news report name. maxLength: 255 minLength: 1 type: string nextStartWith: description: Object names returned by a list query must be greater or equal to this parameter. type: string numberOfSourceDatabases: description: Number of data sources in the tenancy that are offloading snapshots to OPSI AWR Warehouse. type: integer objectStorageBucketName: description: Object Storage Bucket Name type: string objectStorageNamespaceName: description: Object Storage Namespace Name type: string opc-client-request-id: description: Echoes back the value passed in the opc-client-request-id header, for use by clients when debugging. type: string opc-meta-*: description: The user-defined metadata for the Awr Hub object. type: string x-obmcs-header-collection: true x-obmcs-prefix: opc-meta- opc-multipart-md5: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string operationsInsightsTenancyId: description: Tenancy Identifier of Ops Insights service maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseDisplayName: description: User-friedly name of Ops Insights Warehouse that does not have to be unique. maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseId: description: OPSI Warehouse OCID maxLength: 255 minLength: 1 type: string operationsInsightsWarehouseWalletPassword: description: User provided ADW wallet password for the Ops Insights Warehouse. format: password maxLength: 20 minLength: 1 type: string opsiConfigurationDescription: description: Description of OPSI configuration. example: Custom configurations for user experience in the sales department compartment. maxLength: 400 type: string opsiConfigurationDisplayName: description: User-friendly display name for the OPSI configuration. The name does not have to be unique. example: Sales department configurations. type: string opsiConfigurationId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI configuration resource. ' maxLength: 255 minLength: 1 type: string opsiDataObjectDescription: description: Description of OPSI data object. maxLength: 400 type: string opsiDataObjectDisplayName: description: User-friendly name of OPSI data object. maxLength: 255 minLength: 1 type: string opsiDataObjectIdentifier: description: Unique identifier of OPSI data object. maxLength: 255 minLength: 1 type: string opsiEntityType: description: Ops Insights internal representation of the resource type. type: string opsiPrivateEndpointId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the OPSI private endpoint maxLength: 255 minLength: 1 type: string parentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster or DB System ID, depending on which configuration the resource belongs to. maxLength: 255 minLength: 1 type: string planDescription: description: Description of OPSI Chargeback Plan. example: Chargeback plan weighted for exadata maxLength: 400 type: string planHash: description: Plan hash value for the SQL Execution Plan format: int64 type: integer planId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of OPSI Chargeback plan resource. ' maxLength: 255 minLength: 1 type: string planName: description: Name for the OPSI Chargeback plan. example: Chargeback Plan weighted Allocation maxLength: 255 minLength: 1 type: string planType: description: 'Chargeback Plan type of the chargeback entity. For an Exadata it can be WEIGHTED_ALLOCATION, EQUAL_ALLOCATION, UNUSED_ALLOCATION. ' example: WEIGHTED_ALLOCATION maxLength: 255 minLength: 1 type: string platformName: description: Platform name. maxLength: 255 minLength: 1 type: string platformType: description: 'Platform type. Supported platformType(s) for MACS-managed external host insight: [LINUX, SOLARIS, WINDOWS]. Supported platformType(s) for MACS-managed cloud host insight: [LINUX]. Supported platformType(s) for EM-managed external host insight: [LINUX, SOLARIS, SUNOS, ZLINUX, WINDOWS, AIX, HP-UX]. ' enum: - LINUX - SOLARIS - SUNOS - ZLINUX - WINDOWS - AIX - HP_UX - UNKNOWN type: string platformVendor: description: Platform vendor. example: Oracle maxLength: 255 minLength: 1 type: string platformVersion: description: Platform version. example: Oracle Linux Server release 7.9 maxLength: 255 minLength: 1 type: string prefixes: description: Array comprising of all the prefixes. items: type: string type: array privateEndpointStatusDetails: description: A message describing the status of the private endpoint connection of this resource. For example, it can be used to provide actionable information about the validity of the private endpoint connection. type: string processorCount: description: Processor count. This is the OCPU count for Autonomous Database and CPU core count for other database types. type: integer queryDataObjectExecutionTimeInSeconds: description: 'Time taken for executing the data object query (in seconds). Consider optimizing the query or reducing the target data range, if query execution time is longer. ' format: double type: number queryDataObjectResultSetColumnType: description: Type of the column in a data object query result. maxLength: 255 minLength: 1 type: string queryDataObjectResultSetColumnTypeName: description: Type name of the column in a data object query result set. enum: - NUMBER - TIMESTAMP - VARCHAR2 - OTHER type: string queryDataObjectResultSetFormatType: description: Format type of data object query result set. enum: - JSON type: string reportId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string reportName: description: The chargeback plan report name. maxLength: 255 minLength: 1 type: string resourceId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Chargeback plan report. ' maxLength: 255 minLength: 1 type: string resourceMetric: description: 'Defines the type of resource metric (example: CPU, STORAGE) ' enum: - CPU - STORAGE - IO - MEMORY - MEMORY_PGA - MEMORY_SGA example: STORAGE type: string resourceType: description: 'Defines the type of resource (example: EXADATA, HOST) ' enum: - EXADATA_INSIGHT - DATABASE_INSIGHT - HOST_INSIGHT example: EXADATA_INSIGHT type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. format: integer type: number rootId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the root resource for a composite target. e.g. for ExaCS members the rootId will be the OCID of the Exadata Infrastructure resource. maxLength: 255 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object selectedForecastAlgorithm: description: Auto-ML algorithm leveraged for the forecast. Only applicable for Auto-ML forecast. example: NaiveForecaster type: string serviceAccount: description: The Kubernetes cluster service account. maxLength: 255 minLength: 1 type: string serviceName: description: Database service name used for connection requests. maxLength: 128 minLength: 1 type: string shapeName: description: 'The shape of the primary instances of MYSQL DB system. The shape determines resources allocated to a DB System - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM shapes. ' example: MySQL.VM.Standard.E4.1.8GB type: string size: description: Size of the Awr Hub object in bytes. format: int64 type: integer snapshotIdentifier: description: AWR snapshot id. type: string snapshotsUploaded: description: Number of AWR snapshots uploaded from the Source database. format: integer type: number sourceMailBoxUrl: description: Opsi Mailbox URL based on the Awr Hub and Awr Hub source. maxLength: 1000 minLength: 1 type: string sourceName: description: The name of the Awr Hub source database. maxLength: 30 minLength: 1 type: string sqlIdentifier: description: 'Unique SQL_ID for a SQL Statement. ' maxLength: 13 type: string statusDetails: description: A message describing the status of the Exadata Resource. For example, it can be used to provide actionable information about the policies needed to access the Exadata Resource. type: string storage-tier: description: The storage tier that the Awr Hub object is stored in. enum: - STANDARD - INFREQUENTACCESS - ARCHIVE type: string storageServerDisplayName: description: The user-friendly name for the storage server. The name does not have to be unique. maxLength: 255 minLength: 1 type: string storageServerName: description: The storage server name. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object tablespaceName: description: The name of tablespace. type: string taskIdentifier: description: TASK_ID in the oracle database view DBA_ADDM_TASKS type: string tenancyId: description: Tenancy Identifier maxLength: 255 minLength: 1 type: string threadsPerSocket: description: Number of threads per socket. example: 48 minimum: 0 type: integer time-of-archival: description: Time that the Awr Hub object is returned to the archived state. format: date-time type: string timeCreated: description: The time at which the resource was first created. An RFC3339 formatted datetime string format: date-time type: string timeFirstSnapshotGenerated: description: The time at which the earliest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeIntervalEnd: description: The end timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeIntervalStart: description: The start timestamp that was passed into the request. example: '2020-12-06T00:00:00.000Z' format: date-time type: string timeLastSnapshotGenerated: description: The time at which the latest snapshot was generated in the source database for which data is uploaded to AWR Hub. An RFC3339 formatted datetime string format: date-time type: string timeLastWalletRotated: description: The time at which the ADW wallet was last rotated for the Ops Insights Warehouse. An RFC3339 formatted datetime string format: date-time type: string timeModified: description: The date and time the Awr Hub object was modified format: date-time type: string timeUpdated: description: The time at which the resource was last updated. An RFC3339 formatted datetime string format: date-time type: string tokenSecretId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the K8s cluster token secret id. maxLength: 255 minLength: 1 type: string totalCpus: description: 'Total CPU on this host. ' example: 384 minimum: 0 type: integer totalHostCapacity: description: 'The maximum host CPUs (cores x threads/core) on the underlying infrastructure. This only applies to CPU and does not not apply for Autonomous Databases. ' example: 222.3 format: double type: number totalMemoryInGBs: description: 'Total amount of usable physical memory in gibabytes ' example: 3 format: double minimum: 0 type: number totalSockets: description: Number of total sockets. example: 8 minimum: 0 type: integer unusedInstance: description: Identify unused instances based on cpu, memory and network metrics. enum: - IN_USE - NOT_IN_USE - IS_NOT_DETERMINED type: string usage: description: 'Total amount used of the resource metric type (CPU, STORAGE). ' example: 34.5 format: double type: number usageUnit: description: Displays usage unit ( CORES, GB , PERCENT, MBPS) enum: - CORES - GB - MBPS - IOPS - PERCENT - WATTS - CELSIUS example: CORES type: string utilizationPercent: description: 'Resource utilization in percentage. ' example: 35.1 format: double maximum: 100 type: number version-id: description: VersionId of the requested Awr Hub object. type: string vmclusterId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VM Cluster. maxLength: 255 minLength: 1 type: string warehouseCpuAllocated: description: 'Number of CPUs allocated to OPSI Warehouse ADW. ' format: double type: number warehouseCpuUsed: description: 'Number of OCPUs used by OPSI Warehouse ADW. Can be fractional. ' format: double type: number warehouseDynamicGroupId: description: OCID of the dynamic group created for the warehouse maxLength: 255 minLength: 1 type: string warehouseStorageAllocatedInGBs: description: 'Storage allocated to OPSI Warehouse ADW. ' format: double type: number warehouseStorageUsedInGBs: description: 'Storage by OPSI Warehouse ADW in GB. ' format: double type: number warehouseUserConnectionPassword: description: User provided connection password for the AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. format: password maxLength: 20 minLength: 1 type: string warehouseUserId: description: Hub User OCID maxLength: 255 minLength: 1 type: string warehouseUserName: description: Username for schema which would have access to AWR Data, Enterprise Manager Data and Ops Insights OPSI Hub. maxLength: 255 minLength: 1 type: string x-common-splat-settings: - throttling: perTenantSpectreLimitKey: opsi-per-tenant-throttling-limits spectreLimitKey: opsi-per-user-throttling-limits - throttling: perTenantSpectreLimitKey: data-objects-opsi-per-tenant-throttling-limits spectreLimitKey: data-objects-opsi-per-user-throttling-limits - throttling: perTenantSpectreLimitKey: genai-session-opsi-per-tenant-throttling-limits spectreLimitKey: opsi-per-user-throttling-limits - throttling: perTenantSpectreLimitKey: genai-selectwidgets-opsi-per-tenant-throttling-limits spectreLimitKey: opsi-per-user-throttling-limits - throttling: perTenantSpectreLimitKey: genai-semanticextract-opsi-per-tenant-throttling-limits spectreLimitKey: opsi-per-user-throttling-limits - throttling: perTenantSpectreLimitKey: genai-chatproxy-opsi-per-tenant-throttling-limits spectreLimitKey: opsi-per-user-throttling-limits x-obmcs-client-retries-enabled: true