Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OperationsInsightsClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • OperationsInsightsClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new OperationsInsightsClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): OperationsInsightsClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "OperationsInsights"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://operationsinsights.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

addExadataInsightMembers

  • Add new members (e.g. databases and hosts) to an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddExadataInsightMembers API.

    Parameters

    Returns Promise<AddExadataInsightMembersResponse>

    AddExadataInsightMembersResponse

changeAutonomousDatabaseInsightAdvancedFeatures

changeAwrHubSourceCompartment

  • Moves an AwrHubSource resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAwrHubSourceCompartment API.

    Parameters

    Returns Promise<ChangeAwrHubSourceCompartmentResponse>

    ChangeAwrHubSourceCompartmentResponse

changeDatabaseInsightCompartment

  • Moves a DatabaseInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeDatabaseInsightCompartment API.

    Parameters

    Returns Promise<ChangeDatabaseInsightCompartmentResponse>

    ChangeDatabaseInsightCompartmentResponse

changeEnterpriseManagerBridgeCompartment

  • Moves a EnterpriseManagerBridge resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeEnterpriseManagerBridgeCompartment API.

    Parameters

    Returns Promise<ChangeEnterpriseManagerBridgeCompartmentResponse>

    ChangeEnterpriseManagerBridgeCompartmentResponse

changeExadataInsightCompartment

  • Moves an Exadata insight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeExadataInsightCompartment API.

    Parameters

    Returns Promise<ChangeExadataInsightCompartmentResponse>

    ChangeExadataInsightCompartmentResponse

changeHostInsightCompartment

  • Moves a HostInsight resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeHostInsightCompartment API.

    Parameters

    Returns Promise<ChangeHostInsightCompartmentResponse>

    ChangeHostInsightCompartmentResponse

changeNewsReportCompartment

  • Moves a news report resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeNewsReportCompartment API.

    Parameters

    Returns Promise<ChangeNewsReportCompartmentResponse>

    ChangeNewsReportCompartmentResponse

changeOperationsInsightsPrivateEndpointCompartment

changeOperationsInsightsWarehouseCompartment

  • Moves a Operations Insights Warehouse resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeOperationsInsightsWarehouseCompartment API.

    Parameters

    Returns Promise<ChangeOperationsInsightsWarehouseCompartmentResponse>

    ChangeOperationsInsightsWarehouseCompartmentResponse

changeOpsiConfigurationCompartment

changePeComanagedDatabaseInsight

  • Change the connection details of a co-managed database insight. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangePeComanagedDatabaseInsight API.

    Parameters

    Returns Promise<ChangePeComanagedDatabaseInsightResponse>

    ChangePeComanagedDatabaseInsightResponse

close

  • close(): void

createAwrHub

  • Create a AWR hub resource for the tenant in Operations Insights. This resource will be created in root compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAwrHub API.

    Parameters

    Returns Promise<CreateAwrHubResponse>

    CreateAwrHubResponse

createAwrHubSource

  • Register Awr Hub source

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAwrHubSource API.

    Parameters

    Returns Promise<CreateAwrHubSourceResponse>

    CreateAwrHubSourceResponse

createDatabaseInsight

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDatabaseInsight API.

    Parameters

    Returns Promise<CreateDatabaseInsightResponse>

    CreateDatabaseInsightResponse

createEnterpriseManagerBridge

createExadataInsight

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateExadataInsight API.

    Parameters

    Returns Promise<CreateExadataInsightResponse>

    CreateExadataInsightResponse

createHostInsight

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateHostInsight API.

    Parameters

    Returns Promise<CreateHostInsightResponse>

    CreateHostInsightResponse

createNewsReport

  • Create a news report in Ops Insights. The report will be enabled in Ops Insights. Insights will be emailed as per selected frequency.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateNewsReport API.

    Parameters

    Returns Promise<CreateNewsReportResponse>

    CreateNewsReportResponse

createOperationsInsightsPrivateEndpoint

createOperationsInsightsWarehouse

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateOperationsInsightsWarehouse API.

    Parameters

    Returns Promise<CreateOperationsInsightsWarehouseResponse>

    CreateOperationsInsightsWarehouseResponse

createOperationsInsightsWarehouseUser

  • Create a Operations Insights Warehouse user resource for the tenant in Operations Insights. This resource will be created in root compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateOperationsInsightsWarehouseUser API.

    Parameters

    Returns Promise<CreateOperationsInsightsWarehouseUserResponse>

    CreateOperationsInsightsWarehouseUserResponse

createOpsiConfiguration

createWaiters

  • Creates a new OperationsInsightsWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns OperationsInsightsWaiter

    The service waiters.

deleteAwrHub

  • Deletes an AWR hub. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAwrHub API.

    Parameters

    Returns Promise<DeleteAwrHubResponse>

    DeleteAwrHubResponse

deleteAwrHubObject

  • Deletes an Awr Hub object. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAwrHubObject API.

    Parameters

    Returns Promise<DeleteAwrHubObjectResponse>

    DeleteAwrHubObjectResponse

deleteAwrHubSource

  • Deletes an Awr Hub source object. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAwrHubSource API.

    Parameters

    Returns Promise<DeleteAwrHubSourceResponse>

    DeleteAwrHubSourceResponse

deleteDatabaseInsight

  • Deletes a database insight. The database insight will be deleted and cannot be enabled again. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDatabaseInsight API.

    Parameters

    Returns Promise<DeleteDatabaseInsightResponse>

    DeleteDatabaseInsightResponse

deleteEnterpriseManagerBridge

  • Deletes an Operations Insights Enterprise Manager bridge. If any database insight is still referencing this bridge, the operation will fail. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteEnterpriseManagerBridge API.

    Parameters

    Returns Promise<DeleteEnterpriseManagerBridgeResponse>

    DeleteEnterpriseManagerBridgeResponse

deleteExadataInsight

  • Deletes an Exadata insight. The Exadata insight will be deleted and cannot be enabled again. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteExadataInsight API.

    Parameters

    Returns Promise<DeleteExadataInsightResponse>

    DeleteExadataInsightResponse

deleteHostInsight

  • Deletes a host insight. The host insight will be deleted and cannot be enabled again. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteHostInsight API.

    Parameters

    Returns Promise<DeleteHostInsightResponse>

    DeleteHostInsightResponse

deleteNewsReport

  • Deletes a news report. The news report will be deleted and cannot be enabled again. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteNewsReport API.

    Parameters

    Returns Promise<DeleteNewsReportResponse>

    DeleteNewsReportResponse

deleteOperationsInsightsPrivateEndpoint

deleteOperationsInsightsWarehouse

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteOperationsInsightsWarehouse API.

    Parameters

    Returns Promise<DeleteOperationsInsightsWarehouseResponse>

    DeleteOperationsInsightsWarehouseResponse

deleteOperationsInsightsWarehouseUser

deleteOpsiConfiguration

disableAutonomousDatabaseInsightAdvancedFeatures

disableAwrHubSource

  • Disables a Awr Hub source database in Operations Insights. This will stop the Awr data flow for the given Awr Hub source. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableAwrHubSource API.

    Parameters

    Returns Promise<DisableAwrHubSourceResponse>

    DisableAwrHubSourceResponse

disableDatabaseInsight

  • Disables a database in Operations Insights. Database metric collection and analysis will be stopped. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableDatabaseInsight API.

    Parameters

    Returns Promise<DisableDatabaseInsightResponse>

    DisableDatabaseInsightResponse

disableExadataInsight

  • Disables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be stopped. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableExadataInsight API.

    Parameters

    Returns Promise<DisableExadataInsightResponse>

    DisableExadataInsightResponse

disableHostInsight

  • Disables a host in Ops Insights. Host metric collection and analysis will be stopped. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DisableHostInsight API.

    Parameters

    Returns Promise<DisableHostInsightResponse>

    DisableHostInsightResponse

downloadOperationsInsightsWarehouseWallet

enableAutonomousDatabaseInsightAdvancedFeatures

enableAwrHubSource

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableAwrHubSource API.

    Parameters

    Returns Promise<EnableAwrHubSourceResponse>

    EnableAwrHubSourceResponse

enableDatabaseInsight

  • Enables a database in Operations Insights. Database metric collection and analysis will be started. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableDatabaseInsight API.

    Parameters

    Returns Promise<EnableDatabaseInsightResponse>

    EnableDatabaseInsightResponse

enableExadataInsight

  • Enables an Exadata system in Operations Insights. Exadata-related metric collection and analysis will be started. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableExadataInsight API.

    Parameters

    Returns Promise<EnableExadataInsightResponse>

    EnableExadataInsightResponse

enableHostInsight

  • Enables a host in Ops Insights. Host metric collection and analysis will be started. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use EnableHostInsight API.

    Parameters

    Returns Promise<EnableHostInsightResponse>

    EnableHostInsightResponse

getAwrDatabaseReport

  • Gets the AWR report for the specified database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrDatabaseReport API.

    Parameters

    Returns Promise<GetAwrDatabaseReportResponse>

    GetAwrDatabaseReportResponse

getAwrDatabaseSqlReport

  • Gets the SQL health check report for one SQL of the specified database.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrDatabaseSqlReport API.

    Parameters

    Returns Promise<GetAwrDatabaseSqlReportResponse>

    GetAwrDatabaseSqlReportResponse

getAwrHub

  • Gets details of an AWR hub. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrHub API.

    Parameters

    Returns Promise<GetAwrHubResponse>

    GetAwrHubResponse

getAwrHubObject

  • Gets the Awr Hub object metadata and body. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrHubObject API.

    Parameters

    Returns Promise<GetAwrHubObjectResponse>

    GetAwrHubObjectResponse

getAwrHubSource

  • Gets the Awr Hub source object. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrHubSource API.

    Parameters

    Returns Promise<GetAwrHubSourceResponse>

    GetAwrHubSourceResponse

getAwrReport

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAwrReport API.

    Parameters

    Returns Promise<GetAwrReportResponse>

    GetAwrReportResponse

getDatabaseInsight

  • Gets details of a database insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDatabaseInsight API.

    Parameters

    Returns Promise<GetDatabaseInsightResponse>

    GetDatabaseInsightResponse

getEnterpriseManagerBridge

  • Gets details of an Operations Insights Enterprise Manager bridge. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetEnterpriseManagerBridge API.

    Parameters

    Returns Promise<GetEnterpriseManagerBridgeResponse>

    GetEnterpriseManagerBridgeResponse

getExadataInsight

  • Gets details of an Exadata insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetExadataInsight API.

    Parameters

    Returns Promise<GetExadataInsightResponse>

    GetExadataInsightResponse

getHostInsight

  • Gets details of a host insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHostInsight API.

    Parameters

    Returns Promise<GetHostInsightResponse>

    GetHostInsightResponse

getNewsReport

  • Gets details of a news report. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNewsReport API.

    Parameters

    Returns Promise<GetNewsReportResponse>

    GetNewsReportResponse

getOperationsInsightsPrivateEndpoint

getOperationsInsightsWarehouse

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetOperationsInsightsWarehouse API.

    Parameters

    Returns Promise<GetOperationsInsightsWarehouseResponse>

    GetOperationsInsightsWarehouseResponse

getOperationsInsightsWarehouseUser

getOpsiConfiguration

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetOpsiConfiguration API.

    Parameters

    Returns Promise<GetOpsiConfigurationResponse>

    GetOpsiConfigurationResponse

getOpsiDataObject

  • Gets details of an OPSI data object. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetOpsiDataObject API.

    Parameters

    Returns Promise<GetOpsiDataObjectResponse>

    GetOpsiDataObjectResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

headAwrHubObject

  • Gets the Awr Hub object's user-defined metadata and entity tag (ETag).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use HeadAwrHubObject API.

    Parameters

    Returns Promise<HeadAwrHubObjectResponse>

    HeadAwrHubObjectResponse

ingestAddmReports

  • This endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestAddmReports API.

    Parameters

    Returns Promise<IngestAddmReportsResponse>

    IngestAddmReportsResponse

ingestDatabaseConfiguration

  • This is a generic ingest endpoint for all database configuration metrics. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestDatabaseConfiguration API.

    Parameters

    Returns Promise<IngestDatabaseConfigurationResponse>

    IngestDatabaseConfigurationResponse

ingestHostConfiguration

  • This is a generic ingest endpoint for all the host configuration metrics This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestHostConfiguration API.

    Parameters

    Returns Promise<IngestHostConfigurationResponse>

    IngestHostConfigurationResponse

ingestHostMetrics

  • This is a generic ingest endpoint for all the host performance metrics This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestHostMetrics API.

    Parameters

    Returns Promise<IngestHostMetricsResponse>

    IngestHostMetricsResponse

ingestSqlBucket

  • The sqlbucket endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestSqlBucket API.

    Parameters

    Returns Promise<IngestSqlBucketResponse>

    IngestSqlBucketResponse

ingestSqlPlanLines

  • The SqlPlanLines endpoint takes in a JSON payload, persists it in Operation Insights ingest pipeline. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestSqlPlanLines API.

    Parameters

    Returns Promise<IngestSqlPlanLinesResponse>

    IngestSqlPlanLinesResponse

ingestSqlStats

  • The SQL Stats endpoint takes in a JSON payload, persists it in Ops Insights ingest pipeline. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestSqlStats API.

    Parameters

    Returns Promise<IngestSqlStatsResponse>

    IngestSqlStatsResponse

ingestSqlText

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use IngestSqlText API.

    Parameters

    Returns Promise<IngestSqlTextResponse>

    IngestSqlTextResponse

listAddmDbFindingCategories

listAddmDbFindingsTimeSeries

  • Get the ADDM findings time series for the specified databases for a given time period.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAddmDbFindingsTimeSeries API.

    Parameters

    Returns Promise<ListAddmDbFindingsTimeSeriesResponse>

    ListAddmDbFindingsTimeSeriesResponse

listAddmDbParameterCategories

  • Gets list of ADDM database parameter categories for the specified databases.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAddmDbParameterCategories API.

    Parameters

    Returns Promise<ListAddmDbParameterCategoriesResponse>

    ListAddmDbParameterCategoriesResponse

listAddmDbRecommendationCategories

listAddmDbRecommendationsTimeSeries

listAddmDbs

  • Gets a list of ADDM database information

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAddmDbs API.

    Parameters

    Returns Promise<ListAddmDbsResponse>

    ListAddmDbsResponse

listAwrDatabaseSnapshots

  • Lists AWR snapshots for the specified database in the AWR.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrDatabaseSnapshots API.

    Parameters

    Returns Promise<ListAwrDatabaseSnapshotsResponse>

    ListAwrDatabaseSnapshotsResponse

listAwrDatabases

  • Gets the list of databases and their snapshot summary details available in the AWRHub.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrDatabases API.

    Parameters

    Returns Promise<ListAwrDatabasesResponse>

    ListAwrDatabasesResponse

listAwrHubObjects

  • Gets a list of Awr Hub objects. Awr Hub id needs to specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrHubObjects API.

    Parameters

    Returns Promise<ListAwrHubObjectsResponse>

    ListAwrHubObjectsResponse

listAwrHubSources

  • Gets a list of Awr Hub source objects. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrHubSources API.

    Parameters

    Returns Promise<ListAwrHubSourcesResponse>

    ListAwrHubSourcesResponse

listAwrHubs

  • Gets a list of AWR hubs. Either compartmentId or id must be specified. All these resources are expected to be in root compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrHubs API.

    Parameters

    Returns Promise<ListAwrHubsResponse>

    ListAwrHubsResponse

listAwrSnapshots

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAwrSnapshots API.

    Parameters

    Returns Promise<ListAwrSnapshotsResponse>

    ListAwrSnapshotsResponse

listDatabaseConfigurations

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseConfigurations API.

    Parameters

    Returns Promise<ListDatabaseConfigurationsResponse>

    ListDatabaseConfigurationsResponse

listDatabaseInsights

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDatabaseInsights API.

    Parameters

    Returns Promise<ListDatabaseInsightsResponse>

    ListDatabaseInsightsResponse

listEnterpriseManagerBridges

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListEnterpriseManagerBridges API.

    Parameters

    Returns Promise<ListEnterpriseManagerBridgesResponse>

    ListEnterpriseManagerBridgesResponse

listExadataConfigurations

  • Gets a list of exadata insight configurations. Either compartmentId or exadataInsightsId query parameter must be specified. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListExadataConfigurations API.

    Parameters

    Returns Promise<ListExadataConfigurationsResponse>

    ListExadataConfigurationsResponse

listExadataInsights

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListExadataInsights API.

    Parameters

    Returns Promise<ListExadataInsightsResponse>

    ListExadataInsightsResponse

listHostConfigurations

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostConfigurations API.

    Parameters

    Returns Promise<ListHostConfigurationsResponse>

    ListHostConfigurationsResponse

listHostInsights

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostInsights API.

    Parameters

    Returns Promise<ListHostInsightsResponse>

    ListHostInsightsResponse

listHostedEntities

  • Get a list of hosted entities details.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListHostedEntities API.

    Parameters

    Returns Promise<ListHostedEntitiesResponse>

    ListHostedEntitiesResponse

listImportableAgentEntities

  • Gets a list of agent entities available to add a new hostInsight. An agent entity is "available" and will be shown if all the following conditions are true:

    1. The agent OCID is not already being used for an existing hostInsight.
    2. The agent availabilityStatus = 'ACTIVE'
    3. The agent lifecycleState = 'ACTIVE'

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListImportableAgentEntities API.

    Parameters

    Returns Promise<ListImportableAgentEntitiesResponse>

    ListImportableAgentEntitiesResponse

listImportableComputeEntities

  • Gets a list of available compute intances running cloud agent to add a new hostInsight. An Compute entity is "available" and will be shown if all the following conditions are true:

    1. Compute is running OCA
    2. OCI Management Agent is not enabled or If OCI Management Agent is enabled 2.1 The agent OCID is not already being used for an existing hostInsight. 2.2 The agent availabilityStatus = 'ACTIVE' 2.3 The agent lifecycleState = 'ACTIVE'

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListImportableComputeEntities API.

    Parameters

    Returns Promise<ListImportableComputeEntitiesResponse>

    ListImportableComputeEntitiesResponse

listImportableEnterpriseManagerEntities

  • Gets a list of importable entities for an Operations Insights Enterprise Manager bridge that have not been imported before.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListImportableEnterpriseManagerEntities API.

    Parameters

    Returns Promise<ListImportableEnterpriseManagerEntitiesResponse>

    ListImportableEnterpriseManagerEntitiesResponse

listNewsReports

  • Gets a list of news reports based on the query parameters specified. Either compartmentId or id query parameter must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListNewsReports API.

    Parameters

    Returns Promise<ListNewsReportsResponse>

    ListNewsReportsResponse

listOperationsInsightsPrivateEndpoints

listOperationsInsightsWarehouseUsers

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOperationsInsightsWarehouseUsers API.

    Parameters

    Returns Promise<ListOperationsInsightsWarehouseUsersResponse>

    ListOperationsInsightsWarehouseUsersResponse

listOperationsInsightsWarehouses

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOperationsInsightsWarehouses API.

    Parameters

    Returns Promise<ListOperationsInsightsWarehousesResponse>

    ListOperationsInsightsWarehousesResponse

listOpsiConfigurations

  • Gets a list of OPSI configuration resources based on the query parameters specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOpsiConfigurations API.

    Parameters

    Returns Promise<ListOpsiConfigurationsResponse>

    ListOpsiConfigurationsResponse

listOpsiDataObjects

  • Gets a list of OPSI data objects based on the query parameters specified. CompartmentId id query parameter must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListOpsiDataObjects API.

    Parameters

    Returns Promise<ListOpsiDataObjectsResponse>

    ListOpsiDataObjectsResponse

listSqlPlans

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlPlans API.

    Parameters

    Returns Promise<ListSqlPlansResponse>

    ListSqlPlansResponse

listSqlSearches

  • Search SQL by SQL Identifier across databases in a compartment and in all sub-compartments if specified. And get the SQL Text and the details of the databases executing the SQL for a given time period.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlSearches API.

    Parameters

    Returns Promise<ListSqlSearchesResponse>

    ListSqlSearchesResponse

listSqlTexts

  • Query SQL Warehouse to get the full SQL Text for a SQL in a compartment and in all sub-compartments if specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSqlTexts API.

    Parameters

    Returns Promise<ListSqlTextsResponse>

    ListSqlTextsResponse

listWarehouseDataObjects

  • Gets a list of Warehouse data objects (e.g: views, tables), based on the query parameters specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWarehouseDataObjects API.

    Parameters

    Returns Promise<ListWarehouseDataObjectsResponse>

    ListWarehouseDataObjectsResponse

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a (paginated) list of logs for a given work request.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

putAwrHubObject

  • Creates a new object or overwrites an existing object with the same name to the Awr Hub.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use PutAwrHubObject API.

    Parameters

    Returns Promise<PutAwrHubObjectResponse>

    PutAwrHubObjectResponse

queryOpsiDataObjectData

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use QueryOpsiDataObjectData API.

    Parameters

    Returns Promise<QueryOpsiDataObjectDataResponse>

    QueryOpsiDataObjectDataResponse

queryWarehouseDataObjectData

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use QueryWarehouseDataObjectData API.

    Parameters

    Returns Promise<QueryWarehouseDataObjectDataResponse>

    QueryWarehouseDataObjectDataResponse

rotateOperationsInsightsWarehouseWallet

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

summarizeAddmDbFindings

  • Summarizes ADDM findings for the specified databases.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAddmDbFindings API.

    Parameters

    Returns Promise<SummarizeAddmDbFindingsResponse>

    SummarizeAddmDbFindingsResponse

summarizeAddmDbParameterChanges

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAddmDbParameterChanges API.

    Parameters

    Returns Promise<SummarizeAddmDbParameterChangesResponse>

    SummarizeAddmDbParameterChangesResponse

summarizeAddmDbParameters

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAddmDbParameters API.

    Parameters

    Returns Promise<SummarizeAddmDbParametersResponse>

    SummarizeAddmDbParametersResponse

summarizeAddmDbRecommendations

summarizeAddmDbSchemaObjects

  • Summarizes Schema objects for the specified databases for the specified objectIdentifiers

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAddmDbSchemaObjects API.

    Parameters

    Returns Promise<SummarizeAddmDbSchemaObjectsResponse>

    SummarizeAddmDbSchemaObjectsResponse

summarizeAddmDbSqlStatements

  • Summarizes SQL Statements for the specified databases for the specified sqlIdentifiers

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAddmDbSqlStatements API.

    Parameters

    Returns Promise<SummarizeAddmDbSqlStatementsResponse>

    SummarizeAddmDbSqlStatementsResponse

summarizeAwrDatabaseCpuUsages

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseCpuUsages API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseCpuUsagesResponse>

    SummarizeAwrDatabaseCpuUsagesResponse

summarizeAwrDatabaseMetrics

  • Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseMetrics API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseMetricsResponse>

    SummarizeAwrDatabaseMetricsResponse

summarizeAwrDatabaseParameterChanges

  • 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}

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseParameterChanges API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseParameterChangesResponse>

    SummarizeAwrDatabaseParameterChangesResponse

summarizeAwrDatabaseParameters

  • 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}

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseParameters API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseParametersResponse>

    SummarizeAwrDatabaseParametersResponse

summarizeAwrDatabaseSnapshotRanges

summarizeAwrDatabaseSysstats

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseSysstats API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseSysstatsResponse>

    SummarizeAwrDatabaseSysstatsResponse

summarizeAwrDatabaseTopWaitEvents

summarizeAwrDatabaseWaitEventBuckets

summarizeAwrDatabaseWaitEvents

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeAwrDatabaseWaitEvents API.

    Parameters

    Returns Promise<SummarizeAwrDatabaseWaitEventsResponse>

    SummarizeAwrDatabaseWaitEventsResponse

summarizeAwrSourcesSummaries

summarizeConfigurationItems

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeConfigurationItems API.

    Parameters

    Returns Promise<SummarizeConfigurationItemsResponse>

    SummarizeConfigurationItemsResponse

summarizeDatabaseInsightResourceCapacityTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceCapacityTrend API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceCapacityTrendResponse>

    SummarizeDatabaseInsightResourceCapacityTrendResponse

summarizeDatabaseInsightResourceForecastTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceForecastTrend API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceForecastTrendResponse>

    SummarizeDatabaseInsightResourceForecastTrendResponse

summarizeDatabaseInsightResourceStatistics

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceStatistics API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceStatisticsResponse>

    SummarizeDatabaseInsightResourceStatisticsResponse

summarizeDatabaseInsightResourceUsage

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceUsage API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceUsageResponse>

    SummarizeDatabaseInsightResourceUsageResponse

summarizeDatabaseInsightResourceUsageTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceUsageTrend API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceUsageTrendResponse>

    SummarizeDatabaseInsightResourceUsageTrendResponse

summarizeDatabaseInsightResourceUtilizationInsight

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightResourceUtilizationInsight API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightResourceUtilizationInsightResponse>

    SummarizeDatabaseInsightResourceUtilizationInsightResponse

summarizeDatabaseInsightTablespaceUsageTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeDatabaseInsightTablespaceUsageTrend API.

    Parameters

    Returns Promise<SummarizeDatabaseInsightTablespaceUsageTrendResponse>

    SummarizeDatabaseInsightTablespaceUsageTrendResponse

summarizeExadataInsightResourceCapacityTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceCapacityTrend API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceCapacityTrendResponse>

    SummarizeExadataInsightResourceCapacityTrendResponse

summarizeExadataInsightResourceCapacityTrendAggregated

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceCapacityTrendAggregated API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceCapacityTrendAggregatedResponse>

    SummarizeExadataInsightResourceCapacityTrendAggregatedResponse

summarizeExadataInsightResourceForecastTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceForecastTrend API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceForecastTrendResponse>

    SummarizeExadataInsightResourceForecastTrendResponse

summarizeExadataInsightResourceForecastTrendAggregated

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceForecastTrendAggregated API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceForecastTrendAggregatedResponse>

    SummarizeExadataInsightResourceForecastTrendAggregatedResponse

summarizeExadataInsightResourceStatistics

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceStatistics API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceStatisticsResponse>

    SummarizeExadataInsightResourceStatisticsResponse

summarizeExadataInsightResourceUsage

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceUsage API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceUsageResponse>

    SummarizeExadataInsightResourceUsageResponse

summarizeExadataInsightResourceUsageAggregated

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceUsageAggregated API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceUsageAggregatedResponse>

    SummarizeExadataInsightResourceUsageAggregatedResponse

summarizeExadataInsightResourceUtilizationInsight

  • 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. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataInsightResourceUtilizationInsight API.

    Parameters

    Returns Promise<SummarizeExadataInsightResourceUtilizationInsightResponse>

    SummarizeExadataInsightResourceUtilizationInsightResponse

summarizeExadataMembers

  • Lists the software and hardware inventory of the Exadata System. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeExadataMembers API.

    Parameters

    Returns Promise<SummarizeExadataMembersResponse>

    SummarizeExadataMembersResponse

summarizeHostInsightDiskStatistics

summarizeHostInsightHostRecommendation

summarizeHostInsightNetworkUsageTrend

summarizeHostInsightResourceCapacityTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceCapacityTrend API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceCapacityTrendResponse>

    SummarizeHostInsightResourceCapacityTrendResponse

summarizeHostInsightResourceForecastTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceForecastTrend API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceForecastTrendResponse>

    SummarizeHostInsightResourceForecastTrendResponse

summarizeHostInsightResourceStatistics

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceStatistics API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceStatisticsResponse>

    SummarizeHostInsightResourceStatisticsResponse

summarizeHostInsightResourceUsage

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceUsage API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceUsageResponse>

    SummarizeHostInsightResourceUsageResponse

summarizeHostInsightResourceUsageTrend

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceUsageTrend API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceUsageTrendResponse>

    SummarizeHostInsightResourceUsageTrendResponse

summarizeHostInsightResourceUtilizationInsight

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightResourceUtilizationInsight API.

    Parameters

    Returns Promise<SummarizeHostInsightResourceUtilizationInsightResponse>

    SummarizeHostInsightResourceUtilizationInsightResponse

summarizeHostInsightStorageUsageTrend

summarizeHostInsightTopProcessesUsage

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightTopProcessesUsage API.

    Parameters

    Returns Promise<SummarizeHostInsightTopProcessesUsageResponse>

    SummarizeHostInsightTopProcessesUsageResponse

summarizeHostInsightTopProcessesUsageTrend

  • 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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeHostInsightTopProcessesUsageTrend API.

    Parameters

    Returns Promise<SummarizeHostInsightTopProcessesUsageTrendResponse>

    SummarizeHostInsightTopProcessesUsageTrendResponse

summarizeOperationsInsightsWarehouseResourceUsage

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeOperationsInsightsWarehouseResourceUsage API.

    Parameters

    Returns Promise<SummarizeOperationsInsightsWarehouseResourceUsageResponse>

    SummarizeOperationsInsightsWarehouseResourceUsageResponse

summarizeSqlInsights

  • Query 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 types in a compartment and in all sub-compartments if specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlInsights API.

    Parameters

    Returns Promise<SummarizeSqlInsightsResponse>

    SummarizeSqlInsightsResponse

summarizeSqlPlanInsights

  • Query SQL Warehouse to get the performance insights on the execution plans for a given SQL for a given time period. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlPlanInsights API.

    Parameters

    Returns Promise<SummarizeSqlPlanInsightsResponse>

    SummarizeSqlPlanInsightsResponse

summarizeSqlResponseTimeDistributions

  • Query 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlResponseTimeDistributions API.

    Parameters

    Returns Promise<SummarizeSqlResponseTimeDistributionsResponse>

    SummarizeSqlResponseTimeDistributionsResponse

summarizeSqlStatistics

  • Query SQL Warehouse to get the performance statistics for SQLs taking greater than X% database time for a given time period across the given databases or database types in a compartment and in all sub-compartments if specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlStatistics API.

    Parameters

    Returns Promise<SummarizeSqlStatisticsResponse>

    SummarizeSqlStatisticsResponse

summarizeSqlStatisticsTimeSeries

  • Query SQL Warehouse to get the performance statistics time series for a given SQL across given databases for a given time period in a compartment and in all sub-compartments if specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlStatisticsTimeSeries API.

    Parameters

    Returns Promise<SummarizeSqlStatisticsTimeSeriesResponse>

    SummarizeSqlStatisticsTimeSeriesResponse

summarizeSqlStatisticsTimeSeriesByPlan

  • Query SQL Warehouse to get the performance statistics time series for a given SQL by execution plans for a given time period. Either databaseId or id must be specified.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SummarizeSqlStatisticsTimeSeriesByPlan API.

    Parameters

    Returns Promise<SummarizeSqlStatisticsTimeSeriesByPlanResponse>

    SummarizeSqlStatisticsTimeSeriesByPlanResponse

updateAwrHub

  • Updates the configuration of a hub . This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAwrHub API.

    Parameters

    Returns Promise<UpdateAwrHubResponse>

    UpdateAwrHubResponse

updateAwrHubSource

  • Update Awr Hub Source object. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAwrHubSource API.

    Parameters

    Returns Promise<UpdateAwrHubSourceResponse>

    UpdateAwrHubSourceResponse

updateDatabaseInsight

  • Updates configuration of a database insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDatabaseInsight API.

    Parameters

    Returns Promise<UpdateDatabaseInsightResponse>

    UpdateDatabaseInsightResponse

updateEnterpriseManagerBridge

updateExadataInsight

  • Updates configuration of an Exadata insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateExadataInsight API.

    Parameters

    Returns Promise<UpdateExadataInsightResponse>

    UpdateExadataInsightResponse

updateHostInsight

  • Updates configuration of a host insight. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateHostInsight API.

    Parameters

    Returns Promise<UpdateHostInsightResponse>

    UpdateHostInsightResponse

updateNewsReport

  • Updates the configuration of a news report. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateNewsReport API.

    Parameters

    Returns Promise<UpdateNewsReportResponse>

    UpdateNewsReportResponse

updateOperationsInsightsPrivateEndpoint

updateOperationsInsightsWarehouse

  • 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateOperationsInsightsWarehouse API.

    Parameters

    Returns Promise<UpdateOperationsInsightsWarehouseResponse>

    UpdateOperationsInsightsWarehouseResponse

updateOperationsInsightsWarehouseUser

updateOpsiConfiguration

  • Updates an OPSI configuration resource with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateOpsiConfiguration API.

    Parameters

    Returns Promise<UpdateOpsiConfigurationResponse>

    UpdateOpsiConfigurationResponse