openapi: 3.2.0 info: description: "Use the Database Management API to monitor and manage resources such as\nOracle Databases, MySQL Databases, and External Database Systems. \nFor more information, see [Database Management](/iaas/database-management/home.htm).\n" title: Database Management Diagnosability API version: '20201101' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Database Management API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/e7e7138b3ad5254432bc9203d07c08e1e84e00d89a283cd6935a4ef61a6929cf.yaml what: the harvested document for Database Management API servers: - url: http://dbmgmt.{region}.oci.oraclecloud.com/20201101 - url: https://dbmgmt.{region}.oci.oraclecloud.com/20201101 tags: - name: diagnosability paths: /managedDatabases/{managedDatabaseId}/alertLogCounts: get: description: 'Get the counts of alert logs for the specified Managed Database. ' operationId: SummarizeAlertLogCounts parameters: - $ref: '#/components/parameters/ManagedDatabaseIdPathParam' - $ref: '#/components/parameters/LogBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/LogEndTimeOptionalQueryParam' - $ref: '#/components/parameters/AlertLogLevelFilterOptionalQueryParam' - $ref: '#/components/parameters/AlertLogGroupByOptionalQueryParam' - $ref: '#/components/parameters/LogTypeFilterOptionalQueryParam' - $ref: '#/components/parameters/LogSearchTextFilterOptionalQueryParam' - $ref: '#/components/parameters/IsLogSearchTextRegularExpressionQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NamedCredentialIdHeader' responses: 200: description: The counts of the alert logs was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertLogCountsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' tags: - diagnosability x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/alertLogCounts?groupBy=LEVEL\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"managedDatabaseId\",\n \"items\": [\n {\n \"category\": \"critical\",\n \"count\": 20\n },\n {\n \"category\": \"important\",\n \"count\": 30\n }\n ]\n}\n" x-related-resource: '#/definitions/ManagedDatabase' /managedDatabases/{managedDatabaseId}/alertLogs: get: description: 'Lists the alert logs for the specified Managed Database. ' operationId: ListAlertLogs parameters: - $ref: '#/components/parameters/ManagedDatabaseIdPathParam' - $ref: '#/components/parameters/LogBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/LogEndTimeOptionalQueryParam' - $ref: '#/components/parameters/AlertLogLevelFilterOptionalQueryParam' - $ref: '#/components/parameters/LogTypeFilterOptionalQueryParam' - $ref: '#/components/parameters/LogSearchTextFilterOptionalQueryParam' - $ref: '#/components/parameters/IsLogSearchTextRegularExpressionQueryParam' - $ref: '#/components/parameters/AlertLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NamedCredentialIdHeader' responses: 200: description: The alert logs list was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AlertLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' tags: - diagnosability x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/alertLogs?timeGreaterThanOrEqualTo=2022-01-01T22:00:00.00Z&timeLessThanOrEqualTo=2022-02-04T22:00:00.00Z\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"managedDatabaseId\",\n \"items\": [\n {\n \"messageLevel\": \"NORMAL\",\n \"timestamp\": \"2022-01-23T20:35:57.699Z\",\n \"messageType\": \"WARNING\",\n \"messageContent\": \"Archived Log entry 14003 added for thread 1.\",\n \"supplementalDetail\": \"Shutdown is initiated by sqlplus@perf (TNS V1-V3).\",\n \"fileLocation\": \"/ade/b/2345/oracle/diag/rdbms/smece2/alert.log\"\n }\n ]\n}\n" x-related-resource: '#/definitions/ManagedDatabase' /managedDatabases/{managedDatabaseId}/attentionLogCounts: get: description: 'Get the counts of attention logs for the specified Managed Database. ' operationId: SummarizeAttentionLogCounts parameters: - $ref: '#/components/parameters/ManagedDatabaseIdPathParam' - $ref: '#/components/parameters/LogBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/LogEndTimeOptionalQueryParam' - $ref: '#/components/parameters/AttentionLogUrgencyFilterOptionalQueryParam' - $ref: '#/components/parameters/AttentionLogGroupByOptionalQueryParam' - $ref: '#/components/parameters/LogTypeFilterOptionalQueryParam' - $ref: '#/components/parameters/LogSearchTextFilterOptionalQueryParam' - $ref: '#/components/parameters/IsLogSearchTextRegularExpressionQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NamedCredentialIdHeader' responses: 200: description: The counts of the attention logs was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AttentionLogCountsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' tags: - diagnosability x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/attentionLogsCounts?groupBy=URGENCY\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"managedDatabaseId\",\n \"items\": [\n {\n \"category\": \"deferrable\",\n \"count\": 20\n },\n {\n \"category\": \"immediate\",\n \"count\": 30\n }\n ]\n}\n" x-related-resource: '#/definitions/ManagedDatabase' /managedDatabases/{managedDatabaseId}/attentionLogs: get: description: 'Lists the attention logs for the specified Managed Database. ' operationId: ListAttentionLogs parameters: - $ref: '#/components/parameters/ManagedDatabaseIdPathParam' - $ref: '#/components/parameters/LogBeginTimeOptionalQueryParam' - $ref: '#/components/parameters/LogEndTimeOptionalQueryParam' - $ref: '#/components/parameters/AttentionLogUrgencyFilterOptionalQueryParam' - $ref: '#/components/parameters/LogTypeFilterOptionalQueryParam' - $ref: '#/components/parameters/LogSearchTextFilterOptionalQueryParam' - $ref: '#/components/parameters/IsLogSearchTextRegularExpressionQueryParam' - $ref: '#/components/parameters/AttentionLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NamedCredentialIdHeader' responses: 200: description: The attention logs list was retrieved successfully. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AttentionLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' tags: - diagnosability x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/attentionLogs?timeGreaterThanOrEqualTo=2022-01-01T22:00:00.00Z&timeLessThanOrEqualTo=2022-02-04T22:00:00.00Z\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"managedDatabaseId\",\n \"items\": [\n {\n \"messageUrgency\": \"INFO\",\n \"timestamp\": \"2022-01-23T20:35:57.699Z\",\n \"messageType\": \"NOTIFICATION\",\n \"messageContent\": \"Archived Log entry 14003 added for thread 1.\",\n \"scope\": 35,\n \"targetUser\": \"Clusterware Admin\",\n \"cause\": \"A command to shutdown the instance was executed.\",\n \"action\": \"Check alert log for progress and completion of command.\",\n \"supplementalDetail\": \"Shutdown is initiated by sqlplus@perf (TNS V1-V3).\",\n \"fileLocation\": \"/ade/b/2345/oracle/diag/rdbms/smece2/attention.log\"\n }\n ]\n}\n" x-related-resource: '#/definitions/ManagedDatabase' components: parameters: PaginationTokenQueryParam: description: '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. ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 1024 minLength: 1 LogBeginTimeOptionalQueryParam: description: The optional greater than or equal to timestamp to filter the logs. in: query name: timeGreaterThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time LogSearchTextFilterOptionalQueryParam: description: The optional query parameter to filter the attention or alert logs by search text. in: query name: logSearchText required: false x-default-description: 'null' schema: type: string LogTypeFilterOptionalQueryParam: description: The optional parameter to filter the attention or alert logs by type. in: query name: typeFilter required: false schema: type: string enum: - UNKNOWN - INCIDENT_ERROR - ERROR - WARNING - NOTIFICATION - TRACE - ALL default: ALL AlertLogLevelFilterOptionalQueryParam: description: The optional parameter to filter the alert logs by log level. in: query name: levelFilter required: false schema: type: string enum: - CRITICAL - SEVERE - IMPORTANT - NORMAL - ALL default: ALL AttentionLogSortByQueryParam: description: The possible sortBy values of attention logs. in: query name: sortBy required: false schema: type: string enum: - URGENCY - TYPE - MESSAGE - TIMESTAMP - SCOPE - TARGET_USER default: TIMESTAMP PaginationLimitQueryParam: description: The maximum number of records returned in the paginated response. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 NamedCredentialIdHeader: description: The OCID of the Named Credential. in: header name: opc-named-credential-id required: false x-default-description: 'null' schema: type: string SortOrderQueryParam: description: The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC IsLogSearchTextRegularExpressionQueryParam: description: The flag to indicate whether the search text is regular expression or not. in: query name: isRegularExpression required: false schema: type: boolean default: false AlertLogGroupByOptionalQueryParam: description: The optional parameter used to group different alert logs. in: query name: groupBy required: false schema: type: string enum: - LEVEL - TYPE default: TYPE AlertLogSortByQueryParam: description: The possible sortBy values of attention logs. in: query name: sortBy required: false schema: type: string enum: - LEVEL - TYPE - MESSAGE - TIMESTAMP default: TIMESTAMP RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string ManagedDatabaseIdPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database. in: path name: managedDatabaseId required: true schema: type: string maxLength: 255 minLength: 1 AttentionLogUrgencyFilterOptionalQueryParam: description: The optional parameter to filter the attention logs by urgency. in: query name: urgencyFilter required: false schema: type: string enum: - IMMEDIATE - SOON - DEFERRABLE - INFO - ALL default: ALL LogEndTimeOptionalQueryParam: description: The optional less than or equal to timestamp to filter the logs. in: query name: timeLessThanOrEqualTo required: false x-default-description: 'null' schema: type: string format: date-time AttentionLogGroupByOptionalQueryParam: description: The optional parameter used to group different attention logs. in: query name: groupBy required: false schema: type: string enum: - URGENCY - TYPE default: TYPE schemas: Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message AttentionLogCountSummary: description: 'The details for one attention log count entry. ' properties: category: description: The category of different attention logs. enum: - UNKNOWN - INCIDENT_ERROR - ERROR - WARNING - NOTIFICATION - TRACE - IMMEDIATE - SOON - DEFERRABLE - INFO - OTHER type: string count: default: 0 description: The count of attention logs with specific category. type: integer required: - category - count type: object AlertLogCountsCollection: description: The collection of the counts of different level or type of alert logs. properties: items: description: An array of the counts of different urgency or type of alert logs. items: $ref: '#/components/schemas/AlertLogCountSummary' type: array managedDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database. type: string required: - managedDatabaseId - items type: object AttentionLogSummary: description: 'The details for one attention log entry. ' properties: action: description: The recommended action to handle the attention log. type: string cause: description: The cause of the attention log. type: string fileLocation: description: The attention log file location. type: string messageContent: description: The contents of the attention log message. type: string messageType: description: The type of attention log message. enum: - UNKNOWN - INCIDENT_ERROR - ERROR - WARNING - NOTIFICATION - TRACE - OTHER type: string messageUrgency: description: The urgency of the attention log. enum: - IMMEDIATE - SOON - DEFERRABLE - INFO - OTHER type: string scope: description: The database scope for the attention log. type: string supplementalDetail: description: The supplemental details of the attention log. type: string targetUser: description: The user who must act on the attention log message. type: string timestamp: description: The date and time the attention log was created. format: date-time type: string required: - messageUrgency - messageType type: object AttentionLogCountsCollection: description: The collection of the counts of different urgency or type of attention logs. properties: items: description: An array of the counts of different urgency or type of attention logs. items: $ref: '#/components/schemas/AttentionLogCountSummary' type: array managedDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database. type: string required: - managedDatabaseId - items type: object AlertLogSummary: description: 'The detail for one alert log entry. ' properties: fileLocation: description: The alert log file location. type: string messageContent: description: The contents of the alert log message. type: string messageLevel: description: The level of the alert log. enum: - CRITICAL - SEVERE - IMPORTANT - NORMAL - OTHER type: string messageType: description: The type of alert log message. enum: - UNKNOWN - INCIDENT_ERROR - ERROR - WARNING - NOTIFICATION - TRACE - OTHER type: string supplementalDetail: description: The supplemental details of the alert log. type: string timestamp: description: The date and time the alert log was created. format: date-time type: string required: - messageLevel - messageType type: object AlertLogCountSummary: description: 'The details for one alert log count entry. ' properties: category: description: The category of different alert logs. enum: - UNKNOWN - INCIDENT_ERROR - ERROR - WARNING - NOTIFICATION - TRACE - CRITICAL - SEVERE - IMPORTANT - NORMAL - OTHER type: string count: default: 0 description: The count of alert logs with specific category. type: integer required: - category - count type: object AlertLogCollection: description: The list of alert logs. properties: items: description: An array of the alert logs. items: $ref: '#/components/schemas/AlertLogSummary' type: array managedDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database. type: string required: - managedDatabaseId - items type: object AttentionLogCollection: description: The list of attention logs. properties: items: description: An array of the attention logs. items: $ref: '#/components/schemas/AttentionLogSummary' type: array managedDatabaseId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database. type: string required: - managedDatabaseId - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-location: description: Content Location of the resource. format: uri-reference type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: Location of the resource. format: uri-reference type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string x-properties: Sunset: description: 'Sunset date when this operation will stop working, in format, Fri, 29 Jan 2027 00:00:00 GMT. ' type: string cloudDbSystemConnectorCredentialName: description: 'The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899 ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object externalDbSystemConnectorCredentialName: description: 'The name of the credential information that used to connect to the DB system resource. The name should be in "x.y" format, where the length of "x" has a maximum of 64 characters, and length of "y" has a maximum of 199 characters. The name strings can contain letters, numbers and the underscore character only. Other characters are not valid, except for the "." character that separates the "x" and "y" portions of the name. *IMPORTANT* - The name must be unique within the OCI region the credential is being created in. If you specify a name that duplicates the name of another credential within the same OCI region, you may overwrite or corrupt the credential that is already using the name. For example: inventorydb.abc112233445566778899 ' maxLength: 255 minLength: 1 type: string externalLicenseModel: description: 'The Oracle license model that applies to the external database. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object licenseModel: description: 'The Oracle license model that applies to the database management resources. ' enum: - LICENSE_INCLUDED - BRING_YOUR_OWN_LICENSE type: string lifecycleState: description: The current lifecycle state of the database resource. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.oci.dpd.dbmgmt