DiagnosabilityClient

class oci.database_management.DiagnosabilityClient(config, **kwargs)

Use the Database Management API to monitor and manage resources such as Oracle Databases, MySQL Databases, and External Database Systems. For more information, see [Database Management](/iaas/database-management/home.htm).

Methods

__init__(config, **kwargs) Creates a new service client
list_alert_logs(managed_database_id, **kwargs) Lists the alert logs for the specified Managed Database.
list_attention_logs(managed_database_id, …) Lists the attention logs for the specified Managed Database.
summarize_alert_log_counts(…) Get the counts of alert logs for the specified Managed Database.
summarize_attention_log_counts(…) Get the counts of attention logs for the specified Managed Database.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

  • circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
  • circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
  • client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
list_alert_logs(managed_database_id, **kwargs)

Lists the alert logs for the specified Managed Database.

Parameters:
  • managed_database_id (str) –

    (required) The OCID of the Managed Database.

  • time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to timestamp to filter the logs.
  • time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to timestamp to filter the logs.
  • level_filter (str) –

    (optional) The optional parameter to filter the alert logs by log level.

    Allowed values are: “CRITICAL”, “SEVERE”, “IMPORTANT”, “NORMAL”, “ALL”

  • type_filter (str) –

    (optional) The optional parameter to filter the attention or alert logs by type.

    Allowed values are: “UNKNOWN”, “INCIDENT_ERROR”, “ERROR”, “WARNING”, “NOTIFICATION”, “TRACE”, “ALL”

  • log_search_text (str) – (optional) The optional query parameter to filter the attention or alert logs by search text.
  • is_regular_expression (bool) – (optional) The flag to indicate whether the search text is regular expression or not.
  • sort_by (str) –

    (optional) The possible sortBy values of attention logs.

    Allowed values are: “LEVEL”, “TYPE”, “MESSAGE”, “TIMESTAMP”

  • sort_order (str) –

    (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.

    Allowed values are: “ASC”, “DESC”

  • page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of records returned in the paginated response.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_named_credential_id (str) – (optional) The OCID of the Named Credential.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertLogCollection
Return type:

Response
Example:

Click here to see an example of how to use list_alert_logs API.

list_attention_logs(managed_database_id, **kwargs)

Lists the attention logs for the specified Managed Database.

Parameters:
  • managed_database_id (str) –

    (required) The OCID of the Managed Database.

  • time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to timestamp to filter the logs.
  • time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to timestamp to filter the logs.
  • urgency_filter (str) –

    (optional) The optional parameter to filter the attention logs by urgency.

    Allowed values are: “IMMEDIATE”, “SOON”, “DEFERRABLE”, “INFO”, “ALL”

  • type_filter (str) –

    (optional) The optional parameter to filter the attention or alert logs by type.

    Allowed values are: “UNKNOWN”, “INCIDENT_ERROR”, “ERROR”, “WARNING”, “NOTIFICATION”, “TRACE”, “ALL”

  • log_search_text (str) – (optional) The optional query parameter to filter the attention or alert logs by search text.
  • is_regular_expression (bool) – (optional) The flag to indicate whether the search text is regular expression or not.
  • sort_by (str) –

    (optional) The possible sortBy values of attention logs.

    Allowed values are: “URGENCY”, “TYPE”, “MESSAGE”, “TIMESTAMP”, “SCOPE”, “TARGET_USER”

  • sort_order (str) –

    (optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.

    Allowed values are: “ASC”, “DESC”

  • page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of records returned in the paginated response.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_named_credential_id (str) – (optional) The OCID of the Named Credential.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AttentionLogCollection
Return type:

Response
Example:

Click here to see an example of how to use list_attention_logs API.

summarize_alert_log_counts(managed_database_id, **kwargs)

Get the counts of alert logs for the specified Managed Database.

Parameters:
  • managed_database_id (str) –

    (required) The OCID of the Managed Database.

  • time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to timestamp to filter the logs.
  • time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to timestamp to filter the logs.
  • level_filter (str) –

    (optional) The optional parameter to filter the alert logs by log level.

    Allowed values are: “CRITICAL”, “SEVERE”, “IMPORTANT”, “NORMAL”, “ALL”

  • group_by (str) –

    (optional) The optional parameter used to group different alert logs.

    Allowed values are: “LEVEL”, “TYPE”

  • type_filter (str) –

    (optional) The optional parameter to filter the attention or alert logs by type.

    Allowed values are: “UNKNOWN”, “INCIDENT_ERROR”, “ERROR”, “WARNING”, “NOTIFICATION”, “TRACE”, “ALL”

  • log_search_text (str) – (optional) The optional query parameter to filter the attention or alert logs by search text.
  • is_regular_expression (bool) – (optional) The flag to indicate whether the search text is regular expression or not.
  • page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of records returned in the paginated response.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_named_credential_id (str) – (optional) The OCID of the Named Credential.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AlertLogCountsCollection
Return type:

Response
Example:

Click here to see an example of how to use summarize_alert_log_counts API.

summarize_attention_log_counts(managed_database_id, **kwargs)

Get the counts of attention logs for the specified Managed Database.

Parameters:
  • managed_database_id (str) –

    (required) The OCID of the Managed Database.

  • time_greater_than_or_equal_to (datetime) – (optional) The optional greater than or equal to timestamp to filter the logs.
  • time_less_than_or_equal_to (datetime) – (optional) The optional less than or equal to timestamp to filter the logs.
  • urgency_filter (str) –

    (optional) The optional parameter to filter the attention logs by urgency.

    Allowed values are: “IMMEDIATE”, “SOON”, “DEFERRABLE”, “INFO”, “ALL”

  • group_by (str) –

    (optional) The optional parameter used to group different attention logs.

    Allowed values are: “URGENCY”, “TYPE”

  • type_filter (str) –

    (optional) The optional parameter to filter the attention or alert logs by type.

    Allowed values are: “UNKNOWN”, “INCIDENT_ERROR”, “ERROR”, “WARNING”, “NOTIFICATION”, “TRACE”, “ALL”

  • log_search_text (str) – (optional) The optional query parameter to filter the attention or alert logs by search text.
  • is_regular_expression (bool) – (optional) The flag to indicate whether the search text is regular expression or not.
  • page (str) – (optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
  • limit (int) – (optional) The maximum number of records returned in the paginated response.
  • opc_request_id (str) – (optional) The client request ID for tracing.
  • opc_named_credential_id (str) – (optional) The OCID of the Named Credential.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. This operation will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type AttentionLogCountsCollection
Return type:

Response
Example:

Click here to see an example of how to use summarize_attention_log_counts API.