Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.
To install and configure Oracle REST Data Services refer to the Oracle® REST Data Services Installation and Configuration Guide.
An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration.
The pattern for the API document URL is:
https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path>
Where, the <my database> and <my schema> variables can be optional, depending on the ORDS configuration and the service invoked.'
version: 2026.03.26
title: Oracle REST Data Services Monitoring API
contact:
name: Oracle REST Data Services
url: https://www.oracle.com/database/technologies/appdev/rest.html
x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API.
tags:
- name: Monitoring
description: Services related to monitoring the Oracle database instance.
paths:
/database/monitoring/alerts/:
get:
tags:
- Monitoring
summary: Get all alerts
description: Returns records from V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Returns database alerts.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlerts'
x-internal-id: database-monitoring-alerts--get
x-filename-id: database-monitoring-alerts-get
/database/monitoring/alerts/{record_id}:
get:
tags:
- Monitoring
summary: Get an alert record
description: Returns specific alert record from V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
parameters:
- name: record_id
in: path
description: Identifier for the alert record.
required: true
schema:
type: number
responses:
'200':
description: Information on a specific alert.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlertsItem'
x-internal-id: database-monitoring-alerts-{record_id}-get
x-filename-id: database-monitoring-alerts-record_id-get
/database/monitoring/alerts_recent_summaries/by_message_level:
get:
tags:
- Monitoring
summary: Get count of recent alerts by message level
description: Group by message level on V$DIAG_ALERT_EXT originating within the last 7 days. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Summary of alerts from the last 7 days, aggregated by message level.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlertsSummaryMessageLevelItem'
x-internal-id: database-monitoring-alerts_recent_summaries-by_message_level-get
x-filename-id: database-monitoring-alerts_recent_summaries-by_message_level-get
/database/monitoring/alerts_recent_summaries/by_message_type:
get:
tags:
- Monitoring
summary: Get count of recent alerts by message type
description: Group by message type on V$DIAG_ALERT_EXT originating within the last 7 days. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Summary of alerts from the last 7 days, aggregated by message type.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlertsSummaryMessageTypeItem'
x-internal-id: database-monitoring-alerts_recent_summaries-by_message_type-get
x-filename-id: database-monitoring-alerts_recent_summaries-by_message_type-get
/database/monitoring/alerts_summaries/by_message_level:
get:
tags:
- Monitoring
summary: Get count of alerts by message level
description: Group by message level on V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Summary of alerts, broken down by message level.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlertsSummaryMessageLevelItem'
x-internal-id: database-monitoring-alerts_summaries-by_message_level-get
x-filename-id: database-monitoring-alerts_summaries-by_message_level-get
/database/monitoring/alerts_summaries/by_message_type:
get:
tags:
- Monitoring
summary: Get count of alerts by message type
description: Group by message type on V$DIAG_ALERT_EXT. In an Oracle RAC environment, data returned by this service may vary according to the instance to which a session is connected. A client requires SQL Administrator role to invoke this service.
parameters: []
responses:
'200':
description: Summary of alerts broken down by message type.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringAlertsSummaryMessageTypeItem'
x-internal-id: database-monitoring-alerts_summaries-by_message_type-get
x-filename-id: database-monitoring-alerts_summaries-by_message_type-get
/database/monitoring/session_limits:
get:
tags:
- Monitoring
summary: Get all session limits
description: Get all resource limits for sessions using GV$RESOURCE_LIMIT view. Since GV$RESOURCE_LIMIT exposes global level information, it can only be queried from CDB$ROOT or in a non-CDB database. A client requires SQL Administrator role to invoke this service.
parameters: []
responses:
'200':
description: All session limits in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLimitsItem'
x-internal-id: database-monitoring-session_limits-get
x-filename-id: database-monitoring-session_limits-get
/database/monitoring/session_locks/:
get:
tags:
- Monitoring
summary: Get all locks held in the database
description: Get all locks that are held in the database using DBA_LOCK view. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All locks held in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocks'
x-internal-id: database-monitoring-session_locks--get
x-filename-id: database-monitoring-session_locks-get
/database/monitoring/session_locks/{session_id},{lock_id1},{lock_id2}:
get:
tags:
- Monitoring
summary: Get a specific session lock record
description: Returns the corresponding record from DBA_LOCK view. A client requires SQL Administrator role to invoke this service.
parameters:
- name: session_id
in: path
description: Session holding or acquiring the lock.
required: true
schema:
type: number
- name: lock_id1
in: path
description: Type-specific lock identifier, part 1.
required: true
schema:
type: string
- name: lock_id2
in: path
description: Type-specific lock identifier, part 2.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific lock.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
x-internal-id: database-monitoring-session_locks-{session_id},{lock_id1},{lock_id2}-get
x-filename-id: database-monitoring-session_locks-session_id-lock_id1-lock_id2-get
/database/monitoring/session_locks/holding/:
get:
tags:
- Monitoring
summary: Get all locks that are blocking other sessions
description: Using DBA_LOCKS and DBA_BLOCKERS views, this service returns a list of DBA_LOCKS records where the session is not waiting for a locked object but is holding a lock on an object for which another session is waiting. In an Oracle RAC environment, this only applies if the blocker is on the same instance. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All locks that are blocking other sessions.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocksHolding'
x-internal-id: database-monitoring-session_locks-holding--get
x-filename-id: database-monitoring-session_locks-holding-get
/database/monitoring/session_locks/holding/{session_id},{lock_id1},{lock_id2}:
get:
tags:
- Monitoring
summary: Get a session lock that is blocking other sessions
description: Using DBA_LOCKS and DBA_BLOCKERS views, this service returns a specific DBA_LOCKS record where the session is not waiting for a locked object but is holding a lock on an object for which another session is waiting. In an Oracle RAC environment, this only applies if the blocker is on the same instance. A client requires SQL Administrator role to invoke this service.
parameters:
- name: session_id
in: path
description: Session identifier.
required: true
schema:
type: number
- name: lock_id1
in: path
description: Type-specific lock identifier, part 1.
required: true
schema:
type: string
- name: lock_id2
in: path
description: Type-specific lock identifier, part 2.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific session lock.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
x-internal-id: database-monitoring-session_locks-holding-{session_id},{lock_id1},{lock_id2}-get
x-filename-id: database-monitoring-session_locks-holding-session_id-lock_id1-lock_id2-get
/database/monitoring/session_locks/waiting/:
get:
tags:
- Monitoring
summary: Get all locks that sessions are waiting on
description: Using DBA_LOCKS and DBA_WAITERS views, this service returns a list of DBA_LOCKS records for sessions that are waiting on locks held by other sessions. In an Oracle RAC environment, this only applies if the waiter is on the same instance. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All locks in the database that sessions are waiting on.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocksWaiting'
x-internal-id: database-monitoring-session_locks-waiting--get
x-filename-id: database-monitoring-session_locks-waiting-get
/database/monitoring/session_locks/waiting/{session_id},{lock_id1},{lock_id2}:
get:
tags:
- Monitoring
summary: Get a specific lock that a session is waiting on
description: Using DBA_LOCKS and DBA_WAITERS views, this service returns the corresponding DBA_LOCKS records for session that is waiting on locks held by other sessions. In an Oracle RAC environment, this only applies if the waiter is on the same instance. A client requires SQL Administrator role to invoke this service.
parameters:
- name: session_id
in: path
description: Session identifier.
required: true
schema:
type: number
- name: lock_id1
in: path
description: Type-specific lock identifier, part 1.
required: true
schema:
type: string
- name: lock_id2
in: path
description: Type-specific lock identifier, part 2.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific lock that a session is waiting on.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
x-internal-id: database-monitoring-session_locks-waiting-{session_id},{lock_id1},{lock_id2}-get
x-filename-id: database-monitoring-session_locks-waiting-session_id-lock_id1-lock_id2-get
/database/monitoring/session_summaries/by_type:
get:
tags:
- Monitoring
summary: Get count of different session types
description: Group by session type on GV$SESSION. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Summary of different session types in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionTypeSummariesItem'
x-internal-id: database-monitoring-session_summaries-by_type-get
x-filename-id: database-monitoring-session_summaries-by_type-get
/database/monitoring/session_wait_classes/:
get:
tags:
- Monitoring
summary: Get all session wait class records
description: Returns all records from GV$SESSION_WAIT_CLASS. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Summary of session wait classes in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionWaitClasses'
x-internal-id: database-monitoring-session_wait_classes--get
x-filename-id: database-monitoring-session_wait_classes-get
/database/monitoring/session_wait_classes/{sid},{serial_number},{wait_class_number}:
get:
tags:
- Monitoring
summary: Get a specific session wait class record
description: Returns the corresponding record from GV$SESSION_WAIT_CLASS. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session identifier.
required: true
schema:
type: number
- name: serial_number
in: path
description: Session serial number.
required: true
schema:
type: number
- name: wait_class_number
in: path
description: Number of the wait class.
required: true
schema:
type: number
responses:
'200':
description: Information on the specified session wait class.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionWaitClassesItem'
x-internal-id: database-monitoring-session_wait_classes-{sid},{serial_number},{wait_class_number}-get
x-filename-id: database-monitoring-session_wait_classes-sid-serial_number-wait_class_number-get
/database/monitoring/session_waits/:
get:
tags:
- Monitoring
summary: Get all session waits
description: Returns all records from GV$SESSION_WAIT.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All session wait records from GV$SESSION_WAIT. A client requires SQL Administrator role to invoke this service.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionWaits'
x-internal-id: database-monitoring-session_waits--get
x-filename-id: database-monitoring-session_waits-get
/database/monitoring/session_waits/{sid},{seq_number}:
get:
tags:
- Monitoring
summary: Get a specific session wait
description: Returns the corresponding record from GV$SESSION_WAIT. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session identifier.
required: true
schema:
type: number
- name: seq_number
in: path
description: Wait sequence number.
required: true
schema:
type: number
responses:
'200':
description: Information on the specified session wait.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionWaitsItem'
x-internal-id: database-monitoring-session_waits-{sid},{seq_number}-get
x-filename-id: database-monitoring-session_waits-sid-seq_number-get
/database/monitoring/sessions/:
get:
tags:
- Monitoring
summary: Get all current sessions
description: Returns all records on GV$SESSION. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All current sessions in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessions'
x-internal-id: database-monitoring-sessions--get
x-filename-id: database-monitoring-sessions-get
/database/monitoring/sessions/{sid},{serial_number}/:
get:
tags:
- Monitoring
summary: Get a session
description: Returns the GV$SESSION for the specified Session Identifier and Session Serial Number. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session identifier.
required: true
schema:
type: number
- name: serial_number
in: path
description: Session serial number.
required: true
schema:
type: number
responses:
'200':
description: Information on the specified session.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionsItem'
x-internal-id: database-monitoring-sessions-{sid},{serial_number}--get
x-filename-id: database-monitoring-sessions-sid-serial_number-get
/database/monitoring/sessions/{sid},{serial_number}/long_running_operations:
get:
tags:
- Monitoring
summary: Get all long running operations for a session
description: Returns all records from GV$SESSION_LONGOPS for a specific session. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session identifier.
required: true
schema:
type: number
- name: serial_number
in: path
description: Session serial number.
required: true
schema:
type: number
responses:
'200':
description: Information on long running operations for the session.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionsLongRunningOperationItem'
x-internal-id: database-monitoring-sessions-{sid},{serial_number}-long_running_operations-get
x-filename-id: database-monitoring-sessions-sid-serial_number-long_running_operations-get
/database/monitoring/sessions/{sid},{serial_number}/process:
get:
tags:
- Monitoring
summary: Get current active process for a session
description: Returns all records from GV$PROCESS for a specific session. A client requires SQL Administrator role to invoke this service.
parameters:
- name: sid
in: path
description: Session identifier.
required: true
schema:
type: number
- name: serial_number
in: path
description: Session serial number.
required: true
schema:
type: number
responses:
'200':
description: Description of actives processes for a session.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringSessionsProcessItem'
x-internal-id: database-monitoring-sessions-{sid},{serial_number}-process-get
x-filename-id: database-monitoring-sessions-sid-serial_number-process-get
/database/monitoring/wait_class_totals:
get:
tags:
- Monitoring
summary: Get time totals for all registered wait classes
description: Returns all the records from GV$SYSTEM_WAIT_CLASS, except 'Idle' wait class. A client requires SQL Administrator role to invoke this service.
parameters: []
responses:
'200':
description: Summary information on the wait class time totals.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringWaitClassTotalsItem'
x-internal-id: database-monitoring-wait_class_totals-get
x-filename-id: database-monitoring-wait_class_totals-get
/database/monitoring/waits_recent:
get:
tags:
- Monitoring
summary: Get wait time summary from recent active session history records
description: Oracle Diagnostics Pack licence is required for this service. Group by sample_time and wait_class on GV$ACTIVE_SESSION_HISTORY for records with sample_time within the last 7 days. Note that time waited is in microseconds. A client requires SQL Administrator role to invoke this service.
parameters: []
responses:
'200':
description: Wait time summary from active session history records within the last 7 days.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringWaitsRecentItem'
x-internal-id: database-monitoring-waits_recent-get
x-filename-id: database-monitoring-waits_recent-get
/database/monitoring/wait_class_metrics:
get:
tags:
- Monitoring
summary: Get all wait class metrics
description: Returns all records from GV$WAITCLASSMETRIC for all GV$SYSTEM_WAIT_CLASS records except 'Idle' wait class. A client requires SQL Administrator role to invoke this service.
parameters: []
responses:
'200':
description: Wait class metrics records.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitoringWaitClassMetricsItem'
x-internal-id: database-monitoring-wait_class_metrics-get
x-filename-id: database-monitoring-wait_class_metrics-get
components:
schemas:
MonitoringAlerts:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringAlertsItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionLocksItem:
type: object
description: This object is represents a record on DBA_LOCK view. DBA_LOCK lists all locks or latches held in the database, and all outstanding requests for a lock or latch. The list of attributes may vary depending on database version.
properties:
session_id:
type: integer
description: Session holding or acquiring the lock.
lock_type:
type: string
description: Lock type.
mode_held:
type: string
description: Lock mode.
mode_requested:
type: string
description: Lock mode requested.
lock_id1:
type: string
description: Type-specific lock identifier, part 1.
lock_id2:
type: string
description: Type-specific lock identifier, part 2.
last_convert:
type: integer
description: The last convert.
blocking_others:
type: string
description: Whether the lock is currently blocking others.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringWaitsRecentItem:
type: object
description: A summary of time waited for each wait class in GV$ACTIVE_SESSION_HISTORY.
properties:
items:
type: array
items:
type: object
properties:
sample_time:
type: string
description: Time at which the sample was taken.
wait_class:
type: string
description: Wait class name of the event for which the session was waiting at the time of sampling.
time_waited:
type: integer
description: Amount of time (in microseconds) spent in waits from this wait class at the time of sampling.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionWaitClassesItem:
type: object
description: This object represents a record from GV$SESSION_WAIT_CLASS view. GV$SESSION_WAIT_CLASS displays the time spent in various wait event operations on a per-session basis. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
sid:
type: integer
description: Session identifier.
serial#:
type: integer
description: Serial number.
wait_class_id:
type: integer
description: Identifier of the wait class.
wait_class#:
type: integer
description: Number of the wait class.
wait_class:
type: string
description: Name of the wait class.
total_waits:
type: integer
description: Number of times waits of the class occurred for the session.
time_waited:
type: integer
description: Amount of time spent in the wait class by the session.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringWaitClassTotalsItem:
type: object
description: Time totals for each registered wait class
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
wait_class_id:
type: integer
description: Identifier of the wait class.
wait_class#:
type: integer
description: Number of the wait class.
wait_class:
type: string
description: Name of the wait class.
total_waits:
type: integer
description: Number of times waits of the class occurred.
time_waited:
type: integer
description: Amount of time (in hundredths of a second) spent in the wait by all sessions in the instance.
total_waits_fg:
type: integer
description: Number of times waits from this wait class occurred in foreground sessions.
time_waited_fg:
type: integer
description: Amount of time (in hundredths of a second) spent in waits from this wait class in foreground sessions.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionLocksHolding:
type: object
description: This collection represents database locks held by sessions that are blocking other sessions. The list of attributes may vary depending on database version.
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionLocks:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringAlertsSummaryMessageLevelItem:
type: object
description: This object represents a summary of V$DIAG_ALERT_EXT records by message level. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
con_id:
type: integer
description: The ID of the container to which the data pertains.
message_level:
type: integer
description: Level the message belongs to. Lower level values imply higher severity for errors.
message_level_name:
type: string
description: A text description of the corresponding message level value.
number_of_messages:
type: integer
description: The count of records that have this message level.
latest_messages:
type: string
description: The text of the last 5 messages at this message level.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
LinkRelation:
type: object
properties:
rel:
type: string
href:
type: string
required:
- rel
- href
MonitoringSessionWaits:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionWaitsItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringAlertsSummaryMessageTypeItem:
type: object
description: This object represents a summary of V$DIAG_ALERT_EXT records by message type. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
con_id:
type: integer
description: The ID of the container to which the data pertains.
message_type:
type: integer
description: Type of the message, indicating that a different type of response is required.
message_type_name:
type: string
description: A text description of the corresponding message type value.
number_of_messages:
type: integer
description: The count of records that have this message type.
latest_messages:
type: string
description: The text of the last 5 messages at this message type.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionWaitClasses:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionWaitClassesItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionsLongRunningOperationItem:
type: object
description: This object represents operations for a specific session that run for longer than 6 seconds (in absolute time).
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
sid:
type: integer
description: Identifier of the session processing the long-running operation. If multiple sessions are cooperating in the long-running operation, then SID corresponds to the main or master session.
serial#:
type: integer
description: Serial number of the session processing the long-running operation. If multiple sessions are cooperating in the long-running operation, then SERIAL# corresponds to the main or master session. SERIAL# is used to uniquely identify a session's objects. Guarantees that session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID.
opname:
type: string
description: Brief description of the operation.
target:
type: string
description: Object on which the operation is carried out.
target_desc:
type: string
description: Description of the target.
sofar:
type: integer
description: Units of work done so far for the operation specified in the OPNAME column.
totalwork:
type: integer
description: Total units of work for the operation specified in the OPNAME column.
units:
type: string
description: Units of measurement.
start_time:
type: string
description: Starting time of the operation.
last_update_time:
type: string
description: Time when statistics were last updated for the operation.
timestamp:
type: string
description: Timestamp specific to the operation.
time_remaining:
type: integer
description: Estimate (in seconds) of time remaining for the operation to complete.
elapsed_seconds:
type: integer
description: Number of elapsed seconds from the start of the operations.
context:
type: integer
description: Context.
message:
type: string
description: Statistics summary message.
username:
type: string
description: User ID of the user performing the operation.
sql_address:
type: string
description: Used with sql_hash_value to identify the SQL statement that is currently being executed.
sql_hash_value:
type: integer
description: Used with SQL_ADDRESS to identify the SQL statement that is currently being executed.
sql_id:
type: string
description: SQL identifier of the SQL statement that is currently being executed.
sql_plan_hash_value:
type: integer
description: Used with the value of the SQL_ADDRESS column to identify the SQL statement associated with the operation.
sql_exec_start:
type: string
description: Time when the execution of the SQL currently executed by this session started; NULL if SQL_ID is NULL.
sql_exec_id:
type: integer
description: SQL execution identifier; NULL if SQL_ID is NULL or if the execution of that SQL has not yet started.
sql_plan_line_id:
type: integer
description: SQL plan line ID corresponding to the long operation; NULL if the long operation is not associated with a line of the execution plan.
sql_plan_operation:
type: string
description: Plan operation name; NULL if SQL_PLAN_LINE_ID is NULL.
sql_plan_options:
type: string
description: Plan operation options; NULL if SQL_PLAN_LINE_ID is NULL.
qcsid:
type: integer
description: Session identifier of the parallel coordinator.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
Filter:
type: object
description: See Oracle REST Data Services production documentation 'Filtering in Queries' section.
externalDocs:
url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/
anyOf:
- type: object
description: Any key / value pair for specifying a Filter Criteria.
- type: object
properties:
$orderby:
description: Specify which properties to order the result set by.
type: object
$asof:
description: Specify a time related query parameter to limit the results. Parameter value can be a System Change Number or a Date.
type: object
MonitoringSessionsProcessItem:
type: object
description: This object represents information about the currently active processes for a specific session. Data is retrieved from GV$PROCESS view.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
addr:
type: string
description: Address of the process state object.
pid:
type: integer
description: Oracle process identifier.
sosid:
type: string
description: Operating system (process, thread) identifier.
spid:
type: string
description: Operating system process identifier.
stid:
type: string
description: Operating system thread identifier.
execution_type:
type: string
description: Operating system execution type.
pname:
type: string
description: Name of this process.
username:
type: string
description: Operating system process username.
serial#:
type: integer
description: Process serial number.
terminal:
type: string
description: Operating system terminal identifier.
program:
type: string
description: Program in progress.
traceid:
type: string
description: Trace file identifier.
tracefile:
type: string
description: Trace file name of the process.
background:
type: string
description: 1 for a SYSTEM background process; NULL for foreground processes or non-SYSTEM background processes.
latchwait:
type: string
description: Address of the latch the process is waiting for; NULL if none.
latchspin:
type: string
description: This column is obsolete.
pga_used_mem:
type: integer
description: PGA memory currently used by the process (in bytes).
pga_alloc_mem:
type: integer
description: PGA memory currently allocated by the process (including free PGA memory not yet released to the operating system by the server process), in bytes.
pga_freeable_mem:
type: integer
description: Allocated PGA memory which can be freed (in bytes).
pga_max_mem:
type: integer
description: Maximum PGA memory ever allocated by the process (in bytes).
numa_default:
type: integer
description: The NUMA processor group of this process at initialization time.
numa_curr:
type: integer
description: The NUMA processor group of this process currently.
cpu_used:
type: integer
description: Tracks the CPU used by this process (in microseconds) from the time it was spawned.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionLimitsItem:
type: object
description: This object is used to monitor the consumption of session resources in the database. Since GV$RESOURCE_LIMIT exposes global/ CDB level information, it can only be queried from CDB$ROOT or in a non-CDB database. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
resource_name:
type: string
description: Name of the resource. This will always be session in this case.
current_utilization:
type: integer
description: Number of (resources, locks, or processes) currently being used.
max_utilization:
type: integer
description: Maximum consumption of this resource since the last instance start-up.
initial_allocation:
type: string
description: Initial allocation. This will be equal to the value specified for the resource in the initialization parameter file (UNLIMITED for infinite allocation).
limit_value:
type: string
description: The maximum value of utilization that will be allowed.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringAlertsItem:
type: object
description: This object represents an alert log record from V$DIAG_ALERT_EXT. V$DIAG_ALERT_EXT shows the contents of the XML-based alert log in the Automatic Diagnostic Repository (ADR). The list of attributes may vary depending on database version.
properties:
con_id:
type: integer
description: The ID of the container to which the data pertains.
adr_home:
type: string
description: Directory location of the Automatic Diagnostic Repository (ADR).
originating_timestamp:
type: string
description: Date and time when the message was generated.
normalized_timestamp:
type: string
description: Date and time when the message originated, normalized for clock drift to the Oracle Enterprise Manager repository time.
organization_id:
type: string
description: ID of the organization that wrote the originating component, usually the domain of the organization.
component_id:
type: string
description: ID of the product or component that originated the message.
host_id:
type: string
description: DNS hostname of originating host.
host_address:
type: string
description: IP of other network address of the originating host for the message.
message_type:
type: integer
description: Type of the message, indicating that a different type of response is required.
message_type_name:
type: string
description: A text description of the corresponding message type value.
message_level:
type: integer
description: Level the message belongs to. Lower level values imply higher severity for errors.
message_level_name:
type: string
description: A text description of the corresponding message level value.
message_id:
type: string
description: ID of the message.
message_group:
type: string
description: Name of the group to which the message belongs.
client_id:
type: string
description: ID of the client or security group that the message relates to.
module_id:
type: string
description: ID of the module that originated the message. This value is unique within a component.
process_id:
type: string
description: ID of the process that originated the message.
thread_id:
type: string
description: ID of the thread of the process that originated the message.
user_id:
type: string
description: ID of the user that originated the message.
detailed_location:
type: string
description: Absolute pathname of supplemental detail file on the originating host.
upstream_comp_id:
type: string
description: ID of a component that the originating component is working with on the upstream (client) side.
downstream_comp_id:
type: string
description: ID of a component that the originating component is working with on the downstream (server) side.
execution_context_id:
type: string
description: Identifies the thread of execution that the originating component participates in.
execution_context_sequence:
type: integer
description: Execution sequence of the thread that the originating component participates in.
error_instance_id:
type: integer
description: ID of the instance where error occurred.
error_instance_sequence:
type: integer
description: Instance sequence where error occurred.
message_text:
type: string
description: Fully formed and localized text of the message.
message_arguments:
type: string
description: Arguments to be bound with the generic text of the message.
supplemental_attributes:
type: string
description: Supplemental attributes that are specific to a message. This field contains the impacts for an incident type error message.
supplemental_details:
type: string
description: Supplemental data that is specific to a particular program and error message required to complete the diagnosis.
partition:
type: integer
description: Segment number of physical file.
record_id:
type: integer
description: Record number for the message (this value is same as the row number).
filename:
type: string
description: Physical file on disk.
problem_key:
type: string
description: Describes the key for the current problem that the message is associated with.
version:
type: integer
description: Oracle ARB logging standard version number for the message.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionWaitsItem:
type: object
description: This object represents a record from GV$SESSION_WAIT view. GV$SESSION_WAIT displays the current or last wait for each session. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
sid:
type: integer
description: Session identifier.
seq#:
type: integer
description: A number that uniquely identifies the current or last wait (incremented for each wait).
event:
type: string
description: If the session is currently waiting, then the resource or event for which the session is waiting. If the session is not in a wait, then the resource or event for which the session most recently waited.
p1text:
type: string
description: Description of the first wait event parameter.
p1:
type: integer
description: First wait event parameter (in decimal).
p1raw:
type: string
description: First wait event parameter (in hexadecimal).
p2text:
type: string
description: Description of the second wait event parameter.
p2:
type: integer
description: Second wait event parameter (in decimal).
p2raw:
type: string
description: Second wait event parameter (in hexadecimal).
p3text:
type: string
description: Description of the third wait event parameter.
p3:
type: integer
description: Third wait event parameter (in decimal).
p3raw:
type: string
description: Third wait event parameter (in hexadecimal).
wait_class_id:
type: integer
description: Identifier of the class of the wait event.
wait_class#:
type: integer
description: Number of the class of the wait event.
wait_class:
type: string
description: Name of the class of the wait event.
wait_time:
type: integer
description: If the session is currently waiting, then the value is 0. If the session is not in a wait, then the value indicates the duration of the last wait.
seconds_in_wait:
type: integer
description: If the session is currently waiting, then the value is the amount of time waited for the current wait. If the session is not in a wait, then the value is the amount of time since the start of the last wait.
state:
type: string
description: Wait state.
wait_time_micro:
type: integer
description: Amount of time waited (in microseconds). If the session is currently waiting, then the value is the time spent in the current wait. If the session is currently not in a wait, then the value is the amount of time waited in the last wait.
time_remaining_micro:
type: integer
description: Amount of time remaining remaining before a timeout. This field may indicate that a timeout has occurred, or that no timeout will occur.
time_since_last_wait_micro:
type: integer
description: Time elapsed since the end of the last wait (in microseconds). If the session is currently in a wait, then the value is 0.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessions:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionsItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionsItem:
type: object
description: This object represents a record from GV$SESSION view. GV$SESSION displays session information for each current session. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
saddr:
type: string
description: Session address.
sid:
type: integer
description: Session identifier.
serial#:
type: integer
description: Session serial number. Used to uniquely identify a session's objects. Guarantees that session-level commands are applied to the correct session objects if the session ends and another session begins with the same session ID.
audsid:
type: integer
description: Auditing session ID.
paddr:
type: string
description: Address of the process that owns the session.
user#:
type: integer
description: Oracle user identifier.
username:
type: string
description: Oracle username.
command:
type: integer
description: Command in progress (last statement parsed).
ownerid:
type: integer
description: Identifier of the user who owns the migratable session.
taddr:
type: string
description: Address of the transaction state object.
lockwait:
type: string
description: Address of the lock the session is waiting for; NULL if none.
status:
type: string
description: Status of the session.
server:
type: string
description: Server type.
schema#:
type: integer
description: Schema user identifier.
schemaname:
type: string
description: Schema user name.
osuser:
type: string
description: Operating system client user name.
process:
type: string
description: Operating system client process ID.
machine:
type: string
description: Operating system machine name.
port:
type: integer
description: Client port number.
terminal:
type: string
description: Operating system terminal name.
program:
type: string
description: Operating system program name.
type:
type: string
description: Session type.
sql_address:
type: string
description: Used with sql_hash_value to identify the SQL statement that is currently being executed.
sql_hash_value:
type: integer
description: Used with SQL_ADDRESS to identify the SQL statement that is currently being executed.
sql_id:
type: string
description: SQL identifier of the SQL statement that is currently being executed.
sql_child_number:
type: integer
description: Child number of the SQL statement that is currently being executed.
sql_exec_start:
type: string
description: Time when the execution of the SQL currently executed by this session started; NULL if SQL_ID is NULL.
sql_exec_id:
type: integer
description: SQL execution identifier; NULL if SQL_ID is NULL or if the execution of that SQL has not yet started.
prev_sql_addr:
type: string
description: Used with PREV_HASH_VALUE to identify the last SQL statement executed.
prev_hash_value:
type: integer
description: Used with SQL_HASH_VALUE to identify the last SQL statement executed.
prev_sql_id:
type: string
description: SQL identifier of the last SQL statement executed.
prev_child_number:
type: integer
description: Child number of the last SQL statement executed.
prev_exec_start:
type: string
description: SQL execution start of the last executed SQL statement.
prev_exec_id:
type: integer
description: SQL execution identifier of the last executed SQL statement.
plsql_entry_object_id:
type: integer
description: Object ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack.
plsql_entry_subprogram_id:
type: integer
description: Subprogram ID of the top-most PL/SQL subprogram on the stack; NULL if there is no PL/SQL subprogram on the stack.
plsql_object_id:
type: integer
description: Object ID of the currently executing PL/SQL subprogram; NULL if executing SQL.
plsql_subprogram_id:
type: integer
description: Subprogram ID of the currently executing PL/SQL object; NULL if executing SQL.
module:
type: string
description: Name of the currently executing module as set by calling the DBMS_APPLICATION_INFO.SET_MODULE procedure.
module_hash:
type: integer
description: Hash value of the MODULE column.
action:
type: string
description: Name of the currently executing action as set by calling the DBMS_APPLICATION_INFO.SET_ACTION procedure.
action_hash:
type: integer
description: Hash value of the ACTION column.
client_info:
type: string
description: Information set by the DBMS_APPLICATION_INFO.SET_CLIENT_INFO procedure.
fixed_table_sequence:
type: integer
description: This contains a number that increases every time the session completes a call to the database and there has been an intervening select from a dynamic performance table. This column can be used by performance monitors to monitor statistics in the database.
row_wait_obj#:
type: integer
description: Object ID for the table containing the row specified in row_wait_row#.
row_wait_file#:
type: integer
description: Identifier for the data file containing the row specified in row_wait_row#. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1.
row_wait_block#:
type: integer
description: Identifier for the block containing the row specified in row_wait_row#. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1.
row_wait_row#:
type: integer
description: Current row being locked. This property is valid only if the session is currently waiting for another transaction to commit and the value of row_wait_obj# is not -1.
top_level_call#:
type: integer
description: Oracle top level call number.
logon_time:
type: string
description: Time of logon.
last_call_et:
type: integer
description: If the session STATUS is currently ACTIVE, then the value represents the elapsed time (in seconds) since the session has become active. If the session STATUS is currently INACTIVE, then the value represents the elapsed time (in seconds) since the session has become inactive.
pdml_enabled:
type: string
description: This column has been replaced by the PDML_STATUS column.
failover_type:
type: string
description: Indicates whether and to what extent transparent application failover (TAF) is enabled for the session.
failover_method:
type: string
description: Indicates the transparent application failover method for the session.
failed_over:
type: string
description: Indicates whether the session is running in failover mode and failover has occurred (YES) or not (NO).
resource_consumer_group:
type: string
description: Name of the session's current resource consumer group.
pdml_status:
type: string
description: If ENABLED, the session is in a PARALLEL DML enabled mode. If DISABLED, PARALLEL DML enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL DML.
pddl_status:
type: string
description: If ENABLED, the session is in a PARALLEL DDL enabled mode. If DISABLED, PARALLEL DDL enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL DDL.
pq_status:
type: string
description: If ENABLED, the session is in a PARALLEL QUERY enabled mode. If DISABLED, PARALLEL QUERY enabled mode is not supported for the session. If FORCED, the session has been altered to force PARALLEL QUERY.
current_queue_duration:
type: integer
description: If queued (1), the current amount of time the session has been queued. If not currently queued, the value is 0.
client_identifier:
type: string
description: Client identifier of the session.
blocking_session_status:
type: string
description: This column provides details on whether there is a blocking session.
blocking_instance:
type: integer
description: Instance identifier of the blocking session. This column is valid only if BLOCKING_SESSION_STATUS has the value VALID.
blocking_session:
type: integer
description: Session identifier of the blocking session. This column is valid only if BLOCKING_SESSION_STATUS has the value VALID.
final_blocking_session_status:
type: string
description: The final blocking session is the final element in the wait chain constructed by following the sessions that are blocked by one another starting with this session. In the case of a cyclical wait chain, one of the sessions in the wait chain will be chosen as the final blocker.
final_blocking_instance:
type: integer
description: Instance identifier of the final blocking session. This column is valid only if FINAL_BLOCKING_SESSION_STATUS has the value VALID.
final_blocking_session:
type: integer
description: Session identifier of the blocking session. This column is valid only if FINAL_BLOCKING_SESSION_STATUS has the value VALID.
seq#:
type: integer
description: A number that uniquely identifies the current or last wait (incremented for each wait).
event#:
type: integer
description: If the session is currently waiting, then the number of the resource or event for which the session is waiting. If the session is not in a wait, then the number of the resource or event for which the session most recently waited.
event:
type: string
description: If the session is currently waiting, then the resource or event for which the session is waiting. If the session is not in a wait, then the resource or event for which the session most recently waited.
p1text:
type: string
description: Description of the first wait event parameter.
p1:
type: integer
description: First wait event parameter (in decimal).
p1raw:
type: string
description: First wait event parameter (in hexadecimal).
p2text:
type: string
description: Description of the second wait event parameter.
p2:
type: integer
description: Second wait event parameter (in decimal).
p2raw:
type: string
description: Second wait event parameter (in hexadecimal).
p3text:
type: string
description: Description of the third wait event parameter.
p3:
type: integer
description: Third wait event parameter (in decimal).
p3raw:
type: string
description: Third wait event parameter (in hexadecimal).
wait_class_id:
type: integer
description: Identifier of the class of the wait event.
wait_class#:
type: integer
description: Number of the class of the wait event.
wait_class:
type: string
description: Name of the class of the wait event.
wait_time:
type: integer
description: If the session is currently waiting, then the value is 0. If the session is not in a wait, then the value indicates the duration of the last wait.
seconds_in_wait:
type: integer
description: If the session is currently waiting, then the value is the amount of time waited for the current wait. If the session is not in a wait, then the value is the amount of time since the start of the last wait.
state:
type: string
description: Wait state.
wait_time_micro:
type: integer
description: Amount of time waited (in microseconds). If the session is currently waiting, then the value is the time spent in the current wait. If the session is currently not in a wait, then the value is the amount of time waited in the last wait.
time_remaining_micro:
type: integer
description: Amount of time remaining remaining before a timeout. This field may indicate that a timeout has occurred, or that no timeout will occur.
time_since_last_wait_micro:
type: integer
description: Time elapsed since the end of the last wait (in microseconds). If the session is currently in a wait, then the value is 0.
service_name:
type: string
description: Service name of the session.
sql_trace:
type: string
description: Indicates whether SQL tracing is enabled (ENABLED) or disabled (DISABLED).
sql_trace_waits:
type: string
description: Indicates whether wait tracing is enabled (TRUE) or not (FALSE).
sql_trace_binds:
type: string
description: Indicates whether bind tracing is enabled (TRUE) or not (FALSE).
sql_trace_plan_stats:
type: string
description: Frequency at which row source statistics are dumped in the trace files for each cursor.
session_edition_id:
type: integer
description: Shows the value that, in the session, would be reported by sys_context('USERENV', 'SESSION_EDITION_ID').
creator_addr:
type: string
description: Address of the creating process or circuit.
creator_serial#:
type: integer
description: Serial number of the creating process or circuit.
ecid:
type: string
description: Execution context identifier (sent by Application Server).
sql_translation_profile_id:
type: integer
description: Object number of the SQL translation profile.
pga_tunable_mem:
type: integer
description: The amount of tunable PGA memory (in bytes).
shard_ddl_status:
type: string
description: Indicates whether shard DDL is enabled in the current session (ENABLED) or not (DISABLED). This value is only relevant for the shard catalog database.
con_id:
type: integer
description: The ID of the container to which the data pertains.
external_name:
type: string
description: External name of the database user. For enterprise users, returns the Oracle Internet Directory DN.
plsql_debugger_connected:
type: string
description: Indicates whether the session is connected to a PL/SQL debugger.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionLocksWaiting:
type: object
description: This collection represents database locks held by sessions that are waiting on other sessions. The list of attributes may vary depending on database version.
properties:
items:
type: array
items:
$ref: '#/components/schemas/MonitoringSessionLocksItem'
hasMore:
type: boolean
description: Indicates if there are more records to be retrieved.
limit:
type: integer
description: The actual page size limit on number of records applied by the server.
offset:
type: integer
description: The actual index from which the item resources are returned.
count:
type: integer
description: Total number of records in the current response.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringWaitClassMetricsItem:
type: object
description: This object combines data from GV$WAITCLASSMETRIC and GV$SYSTEM_WAIT_CLASS views to represent metric values of wait classes for the most recent 60-second interval.
properties:
items:
type: array
items:
type: object
properties:
begin_time:
type: string
description: Begin time of the interval.
end_time:
type: string
description: End time of the interval.
intsize_csec:
type: integer
description: Interval size (in hundredths of a second).
average_waiter_count:
type: integer
description: Average waiter count.
dbtime_in_wait:
type: integer
description: Percent of database time spent in the wait.
wait_count:
type: integer
description: Number of times waited.
wait_count_fg:
type: integer
description: Number of times foreground processes waited.
wait_class_id:
type: integer
description: Identifier of the wait class.
wait_class#:
type: integer
description: Number of the wait class.
wait_class:
type: string
description: Name of the wait class.
total_waits:
type: integer
description: Number of times waits of the class occurred.
time_waited:
type: integer
description: Amount of time (in hundredths of a second) spent in the wait by all sessions in the instance.
total_waits_fg:
type: integer
description: Number of times waits from this wait class occurred in foreground sessions.
time_waited_fg:
type: integer
description: Amount of time (in hundredths of a second) spent in waits from this wait class in foreground sessions.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
MonitoringSessionTypeSummariesItem:
type: object
description: Using data from GV$SESSION this object represents a summary of the number of sessions in different states aggregated across different session types (BACKGROUND and USER).
properties:
items:
type: array
items:
type: object
properties:
inst_id:
type: integer
description: Oracle Real Application Clusters instance number for which this data relates to. In a non-RAC database this number will be 1.
type:
type: string
description: Session type.
number_of_sessions:
type: integer
description: Total number of sessions of this type.
number_of_active_sessions:
type: integer
description: Total number of active sessions of this type.
number_of_inactive_sessions:
type: integer
description: Total number of inactive sessions of this type.
number_of_active_blocking_sess:
type: integer
description: Total number of active blocking sessions of this type.
number_of_act_non_blocking_ses:
type: integer
description: Total number of active non-blocking sessions of this type.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
examples:
FilterCriteria:
summary: Implicit EQUALS operator for a number. Supports String and Dates too.
value:
SALARY: 1000
OrderByProperty:
summary: Order by with literals.
value:
$orderby:
SALARY: ASC
ENAME: DESC
FilterAndOrder:
summary: Filter criteria supports a wide range of operators. In this example LIKE operator ($like) is used. See Oracle REST Data Services production documentation 'Filtering in Queries' section for further information on the operators available.
value:
ENAME:
$like: AX%
$orderby:
ENAME: ASC
parameters:
Filter:
name: q
in: query
description: Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.
required: false
schema:
$ref: '#/components/schemas/Filter'
examples:
FilterCriteriaExample:
$ref: '#/components/examples/FilterCriteria'
OrderByPropertyExample:
$ref: '#/components/examples/OrderByProperty'
FilterAndOrderExample:
$ref: '#/components/examples/FilterAndOrder'
Limit:
name: limit
in: query
description: The maximum number of records to return.
required: false
schema:
type: integer
format: int32
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
OAuth2:
type: oauth2
flows:
implicit:
authorizationUrl: /oauth/auth
scopes: {}
authorizationCode:
authorizationUrl: /oauth/auth
tokenUrl: /oauth/token
scopes: {}
clientCredentials:
tokenUrl: /oauth/token
scopes: {}
externalDocs:
description: Oracle REST Data Services product documentation.
url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/