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 Db Management 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: dbManagement
paths:
/autonomousDatabases/{autonomousDatabaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified Autonomous Database.
'
operationId: DisableAutonomousDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/AutonomousDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableAutonomousDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the Autonomous Database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for a database.
tags:
- dbManagement
x-example: "POST /20201101/autonomousDatabases/<autonomousDatabaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: AUTONOMOUS_DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/autonomousDatabases/{autonomousDatabaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables a Database Management feature for the specified Autonomous Database.
'
operationId: EnableAutonomousDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/AutonomousDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableAutonomousDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the Autonomous Database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management feature for the Autonomous Database.
tags:
- dbManagement
x-example: "POST /20201101/autonomousDatabases/<autonomousDatabaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": {\n \"connectionString\": {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"SSL_DETAILS\",\n \"userName\": \"dbsnmp\",\n \"passwordSecretId\": \"ocid1.vaultsecret....\",\n \"role\": \"NORMAL\",\n \"sslSecretId\": \"ocid1.vaultsecret....\"\n }\n },\n \"connectorDetails\": {\n \"connectorType\": \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\"\n } \n }\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: AUTONOMOUS_DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/autonomousDatabases/{autonomousDatabaseId}/actions/modifyDatabaseManagement:
post:
description: 'Modifies the Database Management feature for the specified Autonomous Database.
'
operationId: ModifyAutonomousDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/AutonomousDatabaseIdPathParam'
- $ref: '#/components/parameters/ModifyAutonomousDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being modified for the Autonomous Database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies Database Management feature for the Autonomous Database.
tags:
- dbManagement
x-example: "POST /20201101/autonomousDatabases/<AutonomousDatabaseIdPathParam>/actions/modifyDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n {\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": { \n \"connectionString\": {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"userName\": \"dbsnmp\",\n \"passwordSecretId\": \"ocid1.vaultsecret....\",\n \"role\": \"NORMAL\" \n }\n }\n \"connectorDetails\" : {\n \"connectorType\" : \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\"\n }\n }\n }\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/cloudAsmInstances:
get:
description: Lists the ASM instances in the specified cloud ASM.
operationId: ListCloudAsmInstances
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudAsmIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud ASM instances 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/CloudAsmInstanceCollection'
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'
summary: Lists the cloud ASM instances.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsmInstances?compartmentId=<compartmentId>&cloudAsmId=<cloudAsmId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsmInstance'
/cloudAsmInstances/{cloudAsmInstanceId}:
get:
description: 'Gets the details for the cloud ASM instance specified by `cloudAsmInstanceId`.
'
operationId: GetCloudAsmInstance
parameters:
- $ref: '#/components/parameters/CloudAsmInstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud ASM instance details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudAsmInstance'
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'
summary: Gets the cloud ASM instance details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsmInstances/<cloudAsmInstanceId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsmInstance'
put:
description: 'Updates the cloud ASM instance specified by `cloudAsmInstanceId`.
'
operationId: UpdateCloudAsmInstance
parameters:
- $ref: '#/components/parameters/CloudAsmInstanceIdPathParam'
- $ref: '#/components/parameters/UpdateCloudAsmInstanceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The request was successfully received and the cloud ASM instance is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudAsmInstance'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud ASM instance.
tags:
- dbManagement
x-example: "PUT /20201101/cloudAsmInstances/<cloudAsmInstanceId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/CloudAsmInstance'
/cloudAsms:
get:
description: Lists the ASMs in the specified cloud DB system.
operationId: ListCloudAsms
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud ASMs 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/CloudAsmCollection'
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'
summary: Lists the cloud ASMs.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
/cloudAsms/{cloudAsmId}:
get:
description: 'Gets the details for the cloud ASM specified by `cloudAsmId`.
'
operationId: GetCloudAsm
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud ASM details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudAsm'
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'
summary: Gets the cloud ASM details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms/<cloudAsmId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
put:
description: 'Updates the cloud ASM specified by `cloudAsmId`.
'
operationId: UpdateCloudAsm
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/UpdateCloudAsmDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud ASM is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud ASM.
tags:
- dbManagement
x-example: "PUT /20201101/cloudAsms/<cloudAsmId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cloudConnectorId\": \"ocid1.test.oc1..EXAMPLE-cloudConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/CloudAsm'
/cloudAsms/{cloudAsmId}/configuration:
get:
description: 'Gets configuration details including disk groups for the cloud ASM specified by `cloudAsmId`.
'
operationId: GetCloudAsmConfiguration
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The cloud ASM configuration details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudAsmConfiguration'
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'
summary: Gets the cloud ASM configuration.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms/<cloudAsmId>/configuration
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
/cloudAsms/{cloudAsmId}/diskGroups:
get:
description: 'Lists ASM disk groups for the cloud ASM specified by `cloudAsmId`.
'
operationId: ListCloudAsmDiskGroups
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The cloud ASM disk groups were 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/CloudAsmDiskGroupCollection'
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'
summary: Lists the cloud ASM disk groups.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms/<cloudAsmId>/diskGroups
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
/cloudAsms/{cloudAsmId}/metrics:
get:
description: 'Gets metrics for the cloud ASM specified by `cloudAsmId`.
'
operationId: SummarizeCloudAsmMetrics
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The cloud ASM metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the cloud ASM metrics.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms/<cloudAsmId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
/cloudAsms/{cloudAsmId}/users:
get:
description: 'Lists ASM users for the cloud ASM specified by `cloudAsmId`.
'
operationId: ListCloudAsmUsers
parameters:
- $ref: '#/components/parameters/CloudAsmIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The cloud ASM users were 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/CloudAsmUserCollection'
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'
summary: Lists the cloud ASM users.
tags:
- dbManagement
x-example: 'GET /20201101/cloudAsms/<cloudAsmId>/users
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudAsm'
/cloudClusterInstances:
get:
description: Lists the cluster instances in the specified cloud cluster.
operationId: ListCloudClusterInstances
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudClusterIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud cluster instances 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/CloudClusterInstanceCollection'
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'
summary: Lists the cloud cluster instances.
tags:
- dbManagement
x-example: 'GET /20201101/cloudClusterInstances?compartmentId=<compartmentId>&cloudClusterId<cloudClusterId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudClusterInstance'
/cloudClusterInstances/{cloudClusterInstanceId}:
get:
description: 'Gets the details for the cloud cluster instance specified by `cloudClusterInstanceId`.
'
operationId: GetCloudClusterInstance
parameters:
- $ref: '#/components/parameters/CloudClusterInstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud cluster instance details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudClusterInstance'
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'
summary: Gets the cloud cluster instance details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudClusterInstances/<cloudClusterInstanceId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudClusterInstance'
put:
description: 'Updates the cloud cluster instance specified by `cloudClusterInstanceId`.
'
operationId: UpdateCloudClusterInstance
parameters:
- $ref: '#/components/parameters/CloudClusterInstanceIdPathParam'
- $ref: '#/components/parameters/UpdateCloudClusterInstanceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud cluster instance is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud cluster instance.
tags:
- dbManagement
x-example: "PUT /20201101/cloudClusterInstances/<cloudClusterInstanceId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cloudConnectorId\": \"ocid1.test.oc1..EXAMPLE-cloudConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/CloudClusterInstance'
/cloudClusters:
get:
description: Lists the clusters in the specified cloud DB system.
operationId: ListCloudClusters
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud clusters 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/CloudClusterCollection'
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'
summary: Lists the cloud clusters.
tags:
- dbManagement
x-example: 'GET /20201101/cloudClusters?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudCluster'
/cloudClusters/{cloudClusterId}:
get:
description: 'Gets the details for the cloud cluster specified by `cloudClusterId`.
'
operationId: GetCloudCluster
parameters:
- $ref: '#/components/parameters/CloudClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud cluster details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudCluster'
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'
summary: Gets the cloud cluster details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudClusters/<cloudClusterId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudCluster'
put:
description: 'Updates the cloud cluster specified by `cloudClusterId`.
'
operationId: UpdateCloudCluster
parameters:
- $ref: '#/components/parameters/CloudClusterIdPathParam'
- $ref: '#/components/parameters/UpdateCloudClusterDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud cluster is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud cluster.
tags:
- dbManagement
x-example: "PUT /20201101/cloudClusters/<cloudClusterId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cloudConnectorId\": \"ocid1.test.oc1..EXAMPLE-cloudConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/CloudCluster'
/cloudClusters/{cloudClusterId}/metrics:
get:
description: 'Gets metrics for the cloud cluster specified by `cloudClusterId`.
'
operationId: SummarizeCloudClusterMetrics
parameters:
- $ref: '#/components/parameters/CloudClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The cloud cluster metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the cloud cluster metrics.
tags:
- dbManagement
x-example: 'GET /20201101/cloudClusters/<cloudClusterId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudCluster'
/cloudDatabases:
get:
description: Lists the cloud databases in the specified compartment or in the specified DB system.
operationId: ListCloudDatabases
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdMandatoryQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud databases in a cloud DB system 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/CloudDatabaseCollection'
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'
summary: Lists the cloud databases in a cloud database system.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDatabases?cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/cloudDbHomes:
get:
description: Lists the DB homes in the specified cloud DB system.
operationId: ListCloudDbHomes
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud DB homes 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/CloudDbHomeCollection'
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'
summary: Lists the cloud DB homes.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbHomes?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbHome'
/cloudDbHomes/{cloudDbHomeId}:
get:
description: 'Gets the details for the cloud DB home specified by `cloudDbHomeId`.
'
operationId: GetCloudDbHome
parameters:
- $ref: '#/components/parameters/CloudDbHomeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud DB home details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbHome'
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'
summary: Gets the cloud DB home details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbHomes/<cloudDbHomeId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbHome'
put:
description: 'Updates the cloud DB home specified by `cloudDbHomeId`.
'
operationId: UpdateCloudDbHome
parameters:
- $ref: '#/components/parameters/CloudDbHomeIdPathParam'
- $ref: '#/components/parameters/UpdateCloudDbHomeDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The request was successfully received and the cloud DB home is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbHome'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud DB home.
tags:
- dbManagement
x-example: "PUT /20201101/cloudDbHomes/<cloudDbHomeId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/CloudDbHome'
/cloudDbNodes:
get:
description: Lists the cloud DB nodes in the specified cloud DB system.
operationId: ListCloudDbNodes
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud DB nodes 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/CloudDbNodeCollection'
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'
summary: Lists the cloud DB nodes.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbNodes?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbNode'
/cloudDbNodes/{cloudDbNodeId}:
get:
description: 'Gets the details for the cloud DB node specified by `cloudDbNodeId`.
'
operationId: GetCloudDbNode
parameters:
- $ref: '#/components/parameters/CloudDbNodeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud DB node details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbNode'
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'
summary: Gets the cloud DB node details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbNodes/<cloudDbNodeId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbNode'
put:
description: 'Updates the cloud DB node specified by `cloudDbNodeId`.
'
operationId: UpdateCloudDbNode
parameters:
- $ref: '#/components/parameters/CloudDbNodeIdPathParam'
- $ref: '#/components/parameters/UpdateCloudDbNodeDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud DB node is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud DB node.
tags:
- dbManagement
x-example: "PUT /20201101/cloudDbNodes/<cloudDbNodeId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cloudConnectorId\": \"ocid1.test.oc1..EXAMPLE-cloudConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/CloudDbNode'
/cloudDbNodes/{cloudDbNodeId}/metrics:
get:
description: 'Gets metrics for the cloud DB node specified by `cloudDbNodeId`.
'
operationId: SummarizeCloudDbNodeMetrics
parameters:
- $ref: '#/components/parameters/CloudDbNodeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The cloud DB node metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the cloud DB nodemetrics.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbNodes/<cloudDbNodeId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbNode'
/cloudDbSystemConnectors:
get:
description: Lists the cloud connectors in the specified cloud DB system.
operationId: ListCloudDbSystemConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud connectors 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/CloudDbSystemConnectorCollection'
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'
summary: Lists the cloud connectors.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystemConnectors?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemConnector'
post:
description: Creates a new cloud connector.
operationId: CreateCloudDbSystemConnector
parameters:
- $ref: '#/components/parameters/CreateCloudDbSystemConnectorDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The cloud connector was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a cloud connector.
tags:
- dbManagement
x-example: "POST /20201101/cloudDbSystemConnectors\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"connectorType\": \"MACS\",\n \"cloudDbSystemId\": \"ocid1.test.oc1..EXAMPLE-cloudDbSystemId-Value\",\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"agentId\": \"ocid1.test.oc1..EXAMPLE-agentId-Value\",\n \"connectionInfo\": {\n \"componentType\": \"ASM\",\n \"connectionString\": {\n \"hosts\": [\"EXAMPLE-hostName-Value1\" , \"EXAMPLE-hostName-Value2\"],\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"EXAMPLE-service-Value\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"EXAMPLE-credentialName-Value\",\n \"userName\": \"EXAMPLE-userName-Value\",\n \"passwordSecretId\": \"ocid1.test.oc1..EXAMPLE-passwordSecretId-Value\",\n \"role\": \"SYSASM\"\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemConnector'
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}:
delete:
description: 'Deletes the cloud connector specified by `cloudDbSystemConnectorId`.
'
operationId: DeleteCloudDbSystemConnector
parameters:
- $ref: '#/components/parameters/CloudDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The cloud connector was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the cloud connector.
tags:
- dbManagement
x-example: 'DELETE /20201101/cloudDbSystemConnectors/<cloudDbSystemConnectorId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CloudDbSystemConnector'
get:
description: 'Gets the details for the cloud connector specified by `cloudDbSystemConnectorId`.
'
operationId: GetCloudDbSystemConnector
parameters:
- $ref: '#/components/parameters/CloudDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud connector details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemConnector'
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'
summary: Gets the cloud connector details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystemConnectors/<cloudDbSystemConnectorId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemConnector'
put:
description: Updates the cloud connector specified by `cloudDbSystemConnectorId`.
operationId: UpdateCloudDbSystemConnector
parameters:
- $ref: '#/components/parameters/CloudDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/UpdateCloudDbSystemConnectorDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request was successfully received and the cloud connector is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud connector.
tags:
- dbManagement
x-example: "PUT /20201101/cloudDbSystemConnectors/<cloudDbSystemConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"connectorType\": \"MACS\",\n \"connectionInfo\": {\n \"componentType\": \"ASM\",\n \"connectionString\": {\n \"hosts\": [\"EXAMPLE-hostName-Value\", \"EXAMPLE-hostName-Value2\"],\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"EXAMPLE-service-Value\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"EXAMPLE-credentialName-Value\",\n \"userName\": \"EXAMPLE-userName-Value\",\n \"passwordSecretId\": \"ocid1.test.oc1..EXAMPLE-passwordSecretId-Value\",\n \"role\": \"SYSASM\"\n }\n }\n}\n"
x-related-resource: '#/definitions/CloudDbSystemConnector'
/cloudDbSystemConnectors/{cloudDbSystemConnectorId}/actions/checkConnectionStatus:
post:
description: 'Checks the status of the cloud DB system component connection specified in this connector.
This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
'
operationId: CheckCloudDbSystemConnectorConnectionStatus
parameters:
- $ref: '#/components/parameters/CloudDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The connection was successfully checked and the status is returned
in `CloudDbSystemConnector`.
'
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Checks the connectivity status of a cloud connector.
tags:
- dbManagement
x-example: 'POST /20201101/cloudDbSystemConnectors/<cloudDbSystemConnectorId>/actions/checkConnectionStatus
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemConnector'
/cloudDbSystemDiscoveries:
get:
description: Lists the cloud DB system discovery resources in the specified compartment.
operationId: ListCloudDbSystemDiscoveries
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud DB system discovery resources 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/CloudDbSystemDiscoveryCollection'
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'
summary: Lists the cloud DB system discovery resources.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystemDiscoveries?compartmentId=<compartmentId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
post:
description: 'Creates a cloud DB system discovery resource and initiates the discovery process.
'
operationId: CreateCloudDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CreateCloudDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The cloud DB system discovery resource was successfully created and discovery is being run.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a cloud DB system discovery resource.
tags:
- dbManagement
x-example: "POST /20201101/cloudDbSystemDiscoveries\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.test.oc1..EXAMPLE-compartmentId-Value\",\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"agentId\": \"ocid1.test.oc1..EXAMPLE-agentId-Value\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
/cloudDbSystemDiscoveries/{cloudDbSystemDiscoveryId}:
delete:
description: 'Deletes the cloud DB system discovery resource specified by `cloudDbSystemDiscoveryId`.
'
operationId: DeleteCloudDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CloudDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The cloud DB system discovery resource was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the cloud DB system discovery resource.
tags:
- dbManagement
x-example: 'DELETE /20201101/cloudDbSystemDiscoveries/<cloudDbSystemDiscoveryId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
get:
description: 'Gets the details for the cloud DB system discovery resource specified by `cloudDbSystemDiscoveryId`.
'
operationId: GetCloudDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CloudDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud DB system discovery details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemDiscovery'
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'
summary: Gets the cloud DB system discovery details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystemDiscoveries/<cloudDbSystemDiscoveryId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
patch:
description: 'Patches the cloud DB system discovery specified by `cloudDbSystemDiscoveryId`.
'
operationId: PatchCloudDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CloudDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/PatchCloudDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The cloud DB system discovery was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud DB system discovery.
tags:
- dbManagement
x-example: "PATCH /20201101/cloudDbSystemDiscoveries/<cloudDbSystemDiscoveryId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"operation\": \"MERGE\",\n \"selection\": \"discoveredComponents[?componentId==]\",\n \"value\":\n {\n \"displayName\": \"myExampleDb\",\n \"compartmentId\": \"ocid1.compartment.oc1.\",\n \"isSelectedForMonitoring\": true,\n \"connector\": {\n \"connectorType\": \"MACS\",\n \"agentId\": \"ocid1.managementagent.oc1.\",\n \"connectionInfo\": {\n \"componentType\": \"DATABASE\",\n \"connectionString\": {\n \"hostName\": \"example.host.com\",\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"exampleDbService\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"myExampleDbCred\",\n \"userName\": \"exampleUser\",\n \"passwordSecretId\": \"ocid1.vaultsecret.oc1.\",\n \"role\": \"NORMAL\"\n }\n }\n }\n }\n }\n ]\n}\n"
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
put:
description: 'Updates the cloud DB system discovery specified by `cloudDbSystemDiscoveryId`.
'
operationId: UpdateCloudDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CloudDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/UpdateCloudDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The cloud DB system discovery was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud DB system discovery.
tags:
- dbManagement
x-example: "PUT /20201101/cloudDbSystemDiscoveries/<cloudDbSystemDiscoveryId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\"\n}\n"
x-related-resource: '#/definitions/CloudDbSystemDiscovery'
/cloudDbSystems:
get:
description: Lists the cloud DB systems in the specified compartment.
operationId: ListCloudDbSystems
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DbaasParentInfrastructureIdQueryParam'
- $ref: '#/components/parameters/CloudDbSystemDeploymentTypeQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/CloudDbSystemLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud DB systems 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/CloudDbSystemCollection'
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'
summary: Lists the cloud DB systems.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystems?compartmentId=<compartmentId>&deploymentType=<deploymentType>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystem'
post:
description: 'Creates a cloud DB system and its related resources.
'
operationId: CreateCloudDbSystem
parameters:
- $ref: '#/components/parameters/CreateCloudDbSystemDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The request was successfully received and the cloud DB system is being created.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a cloud DB system.
tags:
- dbManagement
x-example: "POST /20201101/cloudDbSystems\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"dbSystemDiscoveryId\": \"ocid1.test.oc1..EXAMPLE-cloudDbSystemDiscoveryId-Value\",\n \"compartmentId\": \"ocid1.test.oc1..EXAMPLE-compartmentId-Value\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}:
delete:
description: 'Deletes the cloud DB system specified by `cloudDbSystemId`.
'
operationId: DeleteCloudDbSystem
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud DB system is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the cloud DB system.
tags:
- dbManagement
x-example: 'DELETE /20201101/cloudDbSystems/<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CloudDbSystem'
get:
description: 'Gets the details for the cloud DB system specified by `cloudDbSystemId`.
'
operationId: GetCloudDbSystem
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud DB system details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystem'
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'
summary: Gets the cloud DB system details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystems/<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystem'
put:
description: 'Updates the cloud DB system specified by `cloudDbSystemId`.
'
operationId: UpdateCloudDbSystem
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/UpdateCloudDbSystemDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The cloud DB system was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudDbSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud DB system.
tags:
- dbManagement
x-example: "PUT /20201101/cloudDbSystems/<cloudDbSystemId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\"\n}\n"
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}/actions/disableDatabaseManagement:
post:
description: 'Disables Database Management service for all the components of the specified
cloud DB system (except databases).
'
operationId: DisableCloudDbSystemDatabaseManagement
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management service is being disabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management service for the cloud DB system.
tags:
- dbManagement
x-example: 'POST /20201101/cloudDbSystems/<cloudDbSystemId>/actions/disableDatabaseManagement
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: CLOUD_DATABASE_MANAGEMENT
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}/actions/disableStackMonitoring:
post:
description: 'Disables Stack Monitoring for all the components of the specified
cloud DB system (except databases).
'
operationId: DisableCloudDbSystemStackMonitoring
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Stack Monitoring is being disabled for the cloud DB system components.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Stack monitoring service for the cloud DB system.
tags:
- dbManagement
x-example: 'POST /20201101/cloudDbSystems/<cloudDbSystemId>/actions/disableStackMonitoring
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: CLOUD_STACK_MONITORING
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}/actions/enableDatabaseManagement:
post:
description: 'Enables Database Management service for all the components of the specified
cloud DB system (except databases).
'
operationId: EnableCloudDbSystemDatabaseManagement
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/EnableCloudDbSystemDatabaseManagementDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management service is being enabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management service for the cloud DB system.
tags:
- dbManagement
x-example: "POST /20201101/cloudDbSystems/<cloudDbSystemId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isEnabled\": true,\n \"metadata\": \"{ \\\"EXAMPLE-key\\\": \\\"EXAMPLE-Value\\\" }\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: CLOUD_DATABASE_MANAGEMENT
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}/actions/enableStackMonitoring:
post:
description: 'Enables Stack Monitoring for all the components of the specified
cloud DB system (except databases).
'
operationId: EnableCloudDbSystemStackMonitoring
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/EnableCloudDbSystemStackMonitoringDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Stack Monitoring is being enabled for the cloud DB system components.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Stack Monitoring service for the cloud DB system.
tags:
- dbManagement
x-example: "POST /20201101/cloudDbSystems/<cloudDbSystemId>/actions/enableStackMonitoring\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isEnabled\" : true,\n \"metadata\" : \"{ \\\"EXAMPLE-key\\\": \\\"EXAMPLE-Value\\\" }\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: CLOUD_STACK_MONITORING
x-related-resource: '#/definitions/CloudDbSystem'
/cloudDbSystems/{cloudDbSystemId}/availabilityMetrics:
get:
description: 'Gets availability metrics for the components present in the cloud DB system specified by `cloudDbSystemId`.
'
operationId: SummarizeCloudDbSystemAvailabilityMetrics
parameters:
- $ref: '#/components/parameters/CloudDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/ComponentTypesFilterQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
responses:
200:
description: The availability metrics for the cloud DB system components were 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/MetricsAggregationRangeCollection'
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'
summary: Gets availability metrics for the cloud DB system components.
tags:
- dbManagement
x-example: 'GET /20201101/cloudDbSystems/<cloudDbSystemId>/availabilityMetrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudDbSystem'
/cloudExadataInfrastructures:
get:
description: 'Lists the Exadata infrastructure resources in the specified compartment.
'
operationId: ListCloudExadataInfrastructures
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata infrastructure resources in the specified compartment 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/CloudExadataInfrastructureCollection'
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'
summary: Lists the Exadata infrastructures.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataInfrastructures?compartmentId=<compartmentId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"INFRASTRUCTURE_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\"\n } ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
post:
description: "Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure.\nThe following resource/subresources are created:\n Infrastructure\n Storage server connectors\n Storage servers\n Storage grids\n"
operationId: CreateCloudExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CreateCloudExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The OCI resource for the Exadata infrastructure was created and the Monitoring service was enabled successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataInfrastructure'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an OCI resource for the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /v1/cloudExadataInfrastructures/\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.348Z\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exaInfra01010201-sGrid\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.349Z\"\n },\n \"vmClusters\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.vmcluster.01\",\n \"displayName\" : \"vmcluster-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataInfrastructures/actions/discoverExadataInfrastructure:
post:
description: "Completes the Exadata system prechecking on the following:\n\n- Verifies if the ASM connector is defined for each VM Cluster or return 400 status code with CONNECTOR_NOT_DEFINED error code.\n- Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with\nINVALID_AGENT error code.\n\nStarts the discovery process for the Exadata system infrastructure. The following resources/components are discovered\n\n- Exadata storage servers from each VM Cluster\n- Exadata storage grid for all Exadata storage servers\n- Exadata infrastructure\n\nThe same API covers both new discovery and rediscovery cases.\n For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden.\n For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones\n should be removed based on the unique key defined for each resource/sub-resource.\n"
operationId: DiscoverCloudExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DiscoverCloudExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Exadata infrastructure was discovered successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataInfrastructureDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Start the discovery process for Exadata system infrastructure from the specified agent.
tags:
- dbManagement
x-example: "POST /20201101/cloudExadataInfrastructures/actions/discoverExadataInfrastructure\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"entityType\" : \"INFRASTRUCTURE_DISCOVER\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"discoveryKey\" : \"hkfc71122838358MAexadiscovery\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"gridHomePath\" : \"/u01/app/19.0.0.0/grid\",\n \"vmClusterIds\" : [ {\n \"entityType\" : \"VM_CLUSTER_DISCOVER_SUMMARY\",\n \"id\" : \"ocid1.vmcluster.01\",\n \"displayName\" : \"vmcluster-phcustch\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaamcirv2h2okvki2t2itiprns7qs7zvhuvhnkmqre5uaorxpksqwtq\"\n } ],\n \"storageGrid\" : {\n \"entityType\" : \"STORAGE_GRID_DISCOVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"countOfStorageServersDiscovered\" : 3\n },\n \"storageServers\" : [ ...]}\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}:
delete:
description: 'Deletes the Exadata infrastructure specified by exadataInfrastructureId.
'
operationId: DeleteCloudExadataInfrastructure
parameters:
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The Exadata infrastructure is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the Exadata infrastructure.
tags:
- dbManagement
x-example: 'DELETE /20201101/CloudExadataInfrastructure/<cloudExadataInfrastructureId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CloudExadataInfrastructure'
get:
description: 'Gets the details for the Exadata infrastructure specified by exadataInfrastructureId. It includes the VMCluster and storage grid within the
Exadata infrastructure.
'
operationId: GetCloudExadataInfrastructure
parameters:
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata infrastructure details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataInfrastructure'
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'
summary: Gets the Exadata infrastructure details.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataInfrastructures/<cloudExadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\"\n },\n \"vmClusters\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.vmcluster.01\",\n \"displayName\" : \"vmcluster-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
put:
description: 'Updates the details for the Exadata infrastructure specified by exadataInfrastructureId.
'
operationId: UpdateCloudExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/UpdateCloudExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Exadata infrastructure details were updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataInfrastructure'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /v1/cloudExadataInfrastructures/<cloudExadataInfrastructureId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"UPDATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.263Z\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.263Z\",\n \"lifecycleDetails\" : \"all server sources created\"\n },\n \"vmClusters\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.vmcluster.01\",\n \"displayName\" : \"vmcluster-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/changeCompartment:
post:
description: 'Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.
'
operationId: ChangeCloudExadataInfrastructureCompartment
parameters:
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/ChangeCloudExadataInfrastructureCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the change compartment action is being performed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves the Exadata infrastructure and its resources to a different compartment.
tags:
- dbManagement
x-example: "POST /20201101/cloudExadataInfrastructures/<cloudExadataInfrastructureId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/disableDatabaseManagement:
post:
description: 'Disables Database Management for the Exadata infrastructure specified by exadataInfrastructureId.
It covers the following components:
- Exadata infrastructure
- Exadata storage grid
- Exadata storage server
Note that Database Management will not be disabled for the VM Clusters within the Exadata infrastructure and should be disabled explicitly, if required.
'
operationId: DisableCloudExadataInfrastructureManagement
parameters:
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management is being disabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management for the Exadata infrastructure.
tags:
- dbManagement
x-example: 'POST /20201101/cloudExadataInfrastructures/<cloudExadataInfrastructureId>/actions/disableDatabaseManagement
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: MANAGEDEXADATA
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataInfrastructures/{cloudExadataInfrastructureId}/actions/enableDatabaseManagement:
post:
description: "Enables Database Management for the Exadata infrastructure specified by exadataInfrastructureId. It covers the following \ncomponents:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n"
operationId: EnableCloudExadataInfrastructureManagement
parameters:
- $ref: '#/components/parameters/CloudExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/EnableCloudExadataInfrastructureManagementDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management Service is being enabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management for the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /20201101/cloudExadataInfrastructures/<cloudExadataInfrastructureId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: MANAGEDEXADATA
x-related-resource: '#/definitions/CloudExadataInfrastructure'
/cloudExadataStorageConnectors:
get:
description: 'Lists the Exadata storage server connectors for the specified Exadata infrastructure.
'
operationId: ListCloudExadataStorageConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CloudExadataInfrastructureIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata storage server connectors for the specified Exadata infrastructure 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/CloudExadataStorageConnectorCollection'
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'
summary: Lists the connectors.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageConnectors?compartmentId=<compartmentId>&exadataInfrastructureId=<exadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.250c0aff2cc24cc08e478f6c420e6def\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-16T15:16:54.572Z\",\n \"timeUpdated\" : \"2022-12-16T15:16:54.572Z\",\n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n }, {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.02bf3e1b3a104c8ab886bbd6f8ef4118\",\n \"displayName\" : \"exaInfra01celadm02-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T22:57:51.279Z\",\n \"timeUpdated\" : \"2022-12-15T22:57:51.279Z\",\n \"connectionUri\" : \"https://exaInfra01celadm02.us.oracle.com/MS/RESTService/\"\n }]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageConnector'
post:
description: 'Creates the Exadata storage server connector after validating the connection information.
'
operationId: CreateCloudExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CreateCloudExadataStorageConnectorBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Exadata storage server connector was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an Exadata storage server connector.
tags:
- dbManagement
x-example: "POST /20201101/cloudExadataStorageConnectors\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\",\n \"displayName\" : \"exaInfra01celadm01-conn\",\n \"lifecycleState\" : \"CREATING\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm01.us.oracle.com/MS/RESTService/\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageConnector'
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}:
delete:
description: 'Deletes the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: DeleteCloudExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CloudExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The Exadata storage server connector was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the exadata connector.
tags:
- dbManagement
x-example: 'DELETE /20201101/cloudExadataStorageConnectors/<exadataStorageConnector>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/CloudExadataStorageConnector'
get:
description: 'Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: GetCloudExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CloudExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the Exadata storage server connector were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageConnector'
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'
summary: Gets the Exadata storage server connector details.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageConnectors/<exadataStorageConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.fc06271028be42eca303530853c9216d\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-11-03T22:51:12.725Z\",\n \"timeUpdated\" : \"2022-11-03T22:51:12.725Z\",\n \"lifecycleDetails\" : \"AGENT_CREDENTIAL_UPSERTING\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageConnector'
put:
description: 'Updates the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: UpdateCloudExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CloudExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/UpdateCloudExadataStorageConnectorDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server connector was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an Exadata storage server connector.
tags:
- dbManagement
x-example: "PUT /20201101/cloudExadataStorageConnectors/<exadataStorageConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\",\n \"displayName\" : \"exaInfra01celadm01-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T16:39:54.735Z\",\n \"timeUpdated\" : \"2022-12-15T16:39:54.735Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm01.us.oracle.com/MS/RESTService/\"\n}\n"
x-related-resource: '#/definitions/CloudExadataStorageConnector'
/cloudExadataStorageConnectors/{cloudExadataStorageConnectorId}/actions/checkStatus:
post:
description: 'Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.
'
operationId: CheckCloudExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CloudExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The status of the Exadata storage server connection was checked successfully.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageConnectorStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Checks the connectivity status of the Exadata storage server connection.
tags:
- dbManagement
x-example: "POST /20201101/cloudExadataStorageConnectors/<exadataStorageConnectorId>/actions/checkStatus\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.06ff8e793d0247efb2d2bcc4256b554d\",\n \"status\" : \"SUCCEEDED\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageConnector'
/cloudExadataStorageGrids/{cloudExadataStorageGridId}:
get:
description: 'Gets the details for the Exadata storage server grid specified by exadataStorageGridId.
'
operationId: GetCloudExadataStorageGrid
parameters:
- $ref: '#/components/parameters/CloudExadataStorageGridIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server grid summary was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageGrid'
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'
summary: Gets the Exadata storage server grid details.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageGrids/<cloudExadataStorageGridId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_GRID\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.a7fc4e70bb004bea94aca42ba7fff082\",\n \"displayName\" : \"exaInfra01010201-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T21:35:44.106Z\",\n \"timeUpdated\" : \"2022-11-03T21:35:44.106Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"storageServers\" : [ ... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageGrid'
put:
description: 'Updates the Exadata storage server grid specified by exadataStorageGridId.
'
operationId: UpdateCloudExadataStorageGrid
parameters:
- $ref: '#/components/parameters/CloudExadataStorageGridIdPathParam'
- $ref: '#/components/parameters/UpdateCloudExadataStorageGridDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Exadata storage server grid was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageGrid'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the Exadata storage server grid details.
tags:
- dbManagement
x-example: "PUT /20201101/cloudExadataStorageGrids/<cloudExadataStorageGridId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/CloudExadataStorageGrid'
/cloudExadataStorageServers:
get:
description: 'Lists the Exadata storage servers for the specified Exadata infrastructure.
'
operationId: ListCloudExadataStorageServers
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CloudExadataInfrastructureIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata storage servers for the specified Exadata infrastructure 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/CloudExadataStorageServerCollection'
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'
summary: Lists the exadata storage servers.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageConnectors?compartmentId=<compartmentId>&exadataInfrastructureId=<exadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"STORAGE_SERVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.edef6bc336c24ee086a5806c03aa0c7d\",\n \"displayName\" : \"exaInfra01celadm02\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1345NM50BU\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T22:02:26.264Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.264Z\",\n \"lifecycleDetails\" : \"source created/updated. \",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.5\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connectorId\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.02bf3e1b3a104c8ab886bbd6f8ef4118\"\n }, {\n \"resourceType\" : \"STORAGE_SERVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.3c6212d3fd5d4dcfa6883798e8dac8c5\",\n \"displayName\" : \"exaInfra01celadm01\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1346NM502U\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.349Z\",\n \"lifecycleDetails\" : \"source created/updated. \",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.4\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connectorId\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\"\n } ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageServer'
/cloudExadataStorageServers/{cloudExadataStorageServerId}:
get:
description: 'Gets the summary for the Exadata storage server specified by exadataStorageServerId.
'
operationId: GetCloudExadataStorageServer
parameters:
- $ref: '#/components/parameters/CloudExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server summary was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageServer'
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'
summary: Gets the Exadata storage server summary.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageServers/<cloudExadataStorageServerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_SERVER\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.f2ebbd0cd8fe40eeb05ce9d3f2b5b351\",\n \"displayName\" : \"exaInfra01celadm03\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1346NM502X\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T21:35:44.106Z\",\n \"timeUpdated\" : \"2022-11-03T21:35:44.106Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.6\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connector\" : {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.fc06271028be42eca303530853c9216d\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T22:51:12.725Z\",\n \"timeUpdated\" : \"2022-11-03T22:51:12.725Z\",\n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageServer'
put:
description: 'Updates the Exadata storage server specified by exadataStorageServerId.
'
operationId: UpdateCloudExadataStorageServer
parameters:
- $ref: '#/components/parameters/CloudExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/UpdateCloudExadataStorageServerDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Exadata storage server was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudExadataStorageServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the Exadata storage server.
tags:
- dbManagement
x-example: "PUT /20201101/cloudExadataStorageServers/<cloudExadataStorageServerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/CloudExadataStorageServer'
/cloudExadataStorageServers/{cloudExadataStorageServerId}/iormPlan:
get:
description: 'Get the IORM plan from the specific Exadata storage server.
'
operationId: GetCloudIormPlan
parameters:
- $ref: '#/components/parameters/CloudExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The IORM plan from the specified Exadata storage server was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudIormPlan'
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'
summary: Gets the IORM plan from the specified Exadata storage server.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageServers/<cloudExadataStorageServerId>/iormPlan\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"planStatus\": \"ACTIVE\",\n \"planObjective\": \"BASIC\",\n \"dbPlan\": {\n \"items\": [\n {\n \"name\": \"other\",\n \"share\": 0,\n \"level\": 1,\n \"allocation\": 10,\n \"limit\": 0,\n \"isFlashCacheOn\": false,\n \"isPmemCacheOn\": false,\n \"isFlashLogOn\": false,\n \"isPmemLogOn\": false,\n \"type\": \"DATABASE\",\n \"role\": \"NONE\"\n },\n {\n \"name\": \"EDM1\",\n \"share\": 0,\n \"level\": 0,\n \"allocation\": 0,\n \"limit\": 40,\n \"isFlashCacheOn\": false,\n \"isPmemCacheOn\": false,\n \"isFlashLogOn\": false,\n \"isPmemLogOn\": false,\n \"flashCacheLimit\": \"100M\",\n \"flashCacheMin\": \"5M\",\n \"type\": \"DATABASE\",\n \"role\": \"NONE\"\n }\n ]\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageServer'
/cloudExadataStorageServers/{cloudExadataStorageServerId}/openAlertHistory:
get:
description: 'Gets the open alerts from the specified Exadata storage server.
'
operationId: GetCloudOpenAlertHistory
parameters:
- $ref: '#/components/parameters/CloudExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The open alerts from the specified Exadata storage server were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudOpenAlertHistory'
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'
summary: Get open alerts from the specific Exadata storage server.
tags:
- dbManagement
x-example: "GET /20201101/cloudExadataStorageServers/<cloudExadataStorageServerId>/openAlertHistory\n Host: dbmgmt.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"alerts\": [\n {\n \"severity\": \"WARNING\",\n \"type\": \"STATEFUL\",\n \"timeStartAt\": \"2023-02-17T11:06:40.000Z\",\n \"message\": \"The changes are listed in /var/log\"\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudExadataStorageServer'
/cloudListeners:
get:
description: Lists the listeners in the specified cloud DB system.
operationId: ListCloudListeners
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CloudDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of cloud listeners 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/CloudListenerCollection'
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'
summary: Lists the cloud listeners.
tags:
- dbManagement
x-example: 'GET /20201101/cloudListeners?compartmentId=<compartmentId>&cloudDbSystemId=<cloudDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudListener'
/cloudListeners/{cloudListenerId}:
get:
description: 'Gets the details for the cloud listener specified by `cloudListenerId`.
'
operationId: GetCloudListener
parameters:
- $ref: '#/components/parameters/CloudListenerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The cloud listener details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CloudListener'
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'
summary: Gets the cloud listener details.
tags:
- dbManagement
x-example: 'GET /20201101/cloudListeners/<cloudListenerId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudListener'
put:
description: 'Updates the cloud listener specified by `cloudListenerId`.
'
operationId: UpdateCloudListener
parameters:
- $ref: '#/components/parameters/CloudListenerIdPathParam'
- $ref: '#/components/parameters/UpdateCloudListenerDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the cloud listener is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a cloud listener.
tags:
- dbManagement
x-example: "PUT /20201101/cloudListeners/<cloudListenerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cloudConnectorId\": \"ocid1.test.oc1..EXAMPLE-cloudConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/CloudListener'
/cloudListeners/{cloudListenerId}/metrics:
get:
description: 'Gets metrics for the cloud listener specified by `cloudListenerId`.
'
operationId: SummarizeCloudListenerMetrics
parameters:
- $ref: '#/components/parameters/CloudListenerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The cloud listener metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the cloud listener metrics.
tags:
- dbManagement
x-example: 'GET /20201101/cloudListeners/<cloudListenerId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudListener'
/cloudListeners/{cloudListenerId}/services:
get:
description: 'Lists the database services registered with the specified cloud listener
for the specified Managed Database.
'
operationId: ListCloudListenerServices
parameters:
- $ref: '#/components/parameters/CloudListenerIdPathParam'
- $ref: '#/components/parameters/ManagedDatabaseIdRequiredQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The database services registered with the cloud listener were 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/CloudListenerServiceCollection'
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'
summary: Lists the database services registered with the cloud listener.
tags:
- dbManagement
x-example: 'GET /20201101/cloudListeners/<cloudListenerId>/services?managedDatabaseId=<managedDatabaseId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/CloudListener'
/databaseFleetBackupMetrics:
get:
description: "Gets the fleet of container databases (CDBs) and their backup details and metrics, in a compartment or Database Group. \nThe databaseHostedIn query parameter must be provided to list either cloud or external databases. \nEither the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the HA and backup metrics.\n"
operationId: GetDatabaseFleetBackupMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DatabaseHostedInQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FleetPaginationLimitQueryParam'
- $ref: '#/components/parameters/HAFleetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
responses:
200:
description: The backup details and metrics for a fleet of cloud or external databases were 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/DatabaseFleetBackupMetrics'
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'
summary: Gets the health metrics for a fleet of databases.
tags:
- dbManagement
x-example: 'GET /20201101/databaseFleetBackupMetrics?compartmentId=<compartmentId>&cloudType=<CLOUD_DB>
&startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/databaseFleetDataguardMetrics:
get:
description: 'Gets the fleet of Oracle Data Guard-enabled container databases (CDBs) along with Data Guard metrics and standby databases, in a compartment or Database Group.
Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the list of databases and Data Guard metrics.
'
operationId: GetDatabaseFleetDataguardMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FleetPaginationLimitQueryParam'
- $ref: '#/components/parameters/HAFleetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
responses:
200:
description: The Data Guard metrics for the Oracle Data Guard-enabled container databases (CDBs) were 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/DatabaseFleetDataguardMetrics'
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'
summary: Gets the dataguard enabled databases in fleet with dataguard metrics.
tags:
- dbManagement
x-example: 'GET /20201101/databaseFleetDataguardMetrics?compartmentId=<compartmentId>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/databaseFleetHaOverviewMetrics:
get:
description: 'Gets the fleet of container databases (CDBs) and their HA and backup metrics in a compartment or in a Database Group.
Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the HA and backup metrics.
'
operationId: GetDatabaseFleetHaOverviewMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FleetPaginationLimitQueryParam'
- $ref: '#/components/parameters/HAFleetSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
responses:
200:
description: The HA and backup metrics for the fleet of databases were 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/DatabaseFleetHaOverviewMetrics'
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'
summary: Gets the list fleet databases with HA and backup metrics.
tags:
- dbManagement
x-example: 'GET /20201101/fleetHaOverview?compartmentId=<compartmentId>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/databaseHomeMetrics:
get:
description: Gets a summary of the activity and resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory for a Managed Database.
operationId: GetDatabaseHomeMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdRequiredQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
responses:
200:
description: The activity and resource usage metrics for a Managed Database were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseHomeMetrics'
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'
summary: Gets a summary of the activity and resource usage metrics for a Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/databaseHomeMetrics?managedDatabaseId=<managedDatabaseId>
&startTime=<startTime>&endTime=<endTime>
<authorization and other headers>
'
/databases/{databaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified Oracle cloud database.
'
operationId: DisableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/DatabaseIdPathParam'
- $ref: '#/components/parameters/DisableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the cloud database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for a database.
tags:
- dbManagement
x-example: "POST /20201101/databases/<databaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/databases/{databaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables a Database Management feature for the specified cloud database.
'
operationId: EnableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/DatabaseIdPathParam'
- $ref: '#/components/parameters/EnableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the cloud database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management feature for the Oracle cloud Database.
tags:
- dbManagement
x-example: "POST /20201101/databases/<databaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": {\n \"connectionString\" : {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\" : {\n \"credentialType\" : \"DETAILS\",\n \"userName\" : \"dbsnmp\",\n \"passwordSecretId\" : \"ocid1.vaultsecret....\",\n \"role\" : \"NORMAL\"\n }\n },\n \"connectorDetails\" : {\n \"connectorType\" : \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\",\n }\n } \n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/databases/{databaseId}/actions/modifyDatabaseManagement:
post:
description: 'Modifies a Database Management feature for the specified Oracle cloud database.
'
operationId: ModifyDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/DatabaseIdPathParam'
- $ref: '#/components/parameters/ModifyDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being modified for the cloud database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies Database Management feature for the cloud Database.
tags:
- dbManagement
x-example: "POST /20201101/databases/<databaseId>/actions/modifyDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": {\n \"connectionString\" : {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\" : {\n \"credentialType\" : \"DETAILS\",\n \"userName\" : \"dbsnmp\",\n \"passwordSecretId\" : \"ocid1.vaultsecret....\",\n \"role\" : \"NORMAL\"\n }\n },\n \"connectorDetails\" : {\n \"connectorType\" : \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\",\n } \n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/dbManagementPrivateEndpoints:
get:
description: 'Gets a list of Database Management private endpoints.
'
operationId: ListDbManagementPrivateEndpoints
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/VcnIdQueryParam'
- $ref: '#/components/parameters/IsClusterDbManagementPrivateEndpointQueryParam'
- $ref: '#/components/parameters/IsDnsResolutionEnabledPrivateEndpointQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Database Management private endpoints 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/DbManagementPrivateEndpointCollection'
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'
summary: Gets a list of Database Management private endpoints.
tags:
- dbManagement
x-related-resource: '#/definitions/DbManagementPrivateEndpoint'
post:
description: 'Creates a new Database Management private endpoint.
'
operationId: CreateDbManagementPrivateEndpoint
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request to create a new Database Management private endpoint was received successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: 'The full URI of the Database Management private endpoint.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbManagementPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a new Database Management private endpoint.
tags:
- dbManagement
x-related-resource: '#/definitions/DbManagementPrivateEndpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDbManagementPrivateEndpointDetails'
description: Details used to create a new Database Management private endpoint.
required: true
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}:
delete:
description: Deletes a specific Database Management private endpoint.
operationId: DeleteDbManagementPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DbManagementPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request to delete a Database Management private endpoint was received successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a specific Database Management private endpoint.
tags:
- dbManagement
x-related-resource: '#/definitions/DbManagementPrivateEndpoint'
get:
description: Gets the details of a specific Database Management private endpoint.
operationId: GetDbManagementPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DbManagementPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the Database Management private endpoint were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbManagementPrivateEndpoint'
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'
summary: Gets the details of a specific Database Management private endpoint.
tags:
- dbManagement
put:
description: Updates one or more attributes of a specific Database Management private endpoint.
operationId: UpdateDbManagementPrivateEndpoint
parameters:
- $ref: '#/components/parameters/DbManagementPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Database Management private endpoint was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DbManagementPrivateEndpoint'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates one or more attributes of a specific Database Management private endpoint.
tags:
- dbManagement
x-related-resource: '#/definitions/DbManagementPrivateEndpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDbManagementPrivateEndpointDetails'
description: The details used to update a Database Management private endpoint.
required: true
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/actions/changeCompartment:
post:
description: Moves the Database Management private endpoint and its dependent resources to the specified compartment.
operationId: ChangeDbManagementPrivateEndpointCompartment
parameters:
- $ref: '#/components/parameters/DbManagementPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The Database Management private endpoint was moved to another compartment successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
tags:
- dbManagement
x-related-resource: '#/definitions/DbManagementPrivateEndpoint'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeDbManagementPrivateEndpointCompartmentDetails'
description: The details used to move the Database Management private endpoint to another compartment.
required: true
/dbManagementPrivateEndpoints/{dbManagementPrivateEndpointId}/associatedDatabases:
get:
description: Gets the list of databases using a specific Database Management private endpoint.
operationId: ListAssociatedDatabases
parameters:
- $ref: '#/components/parameters/DbManagementPrivateEndpointIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/AssociatedDatabaseSortByQueryParam'
responses:
200:
description: The list of databases using a specific Database Management private endpoint 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/AssociatedDatabaseCollection'
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'
summary: Gets the list of databases using a specific Database Management private endpoint.
tags:
- dbManagement
x-related-resource: '#/definitions/AssociatedDatabaseSummary'
/exadataInfrastructureFleetMetrics:
get:
description: "Gets the health metrics for a fleet of Exadata infrastructure in a compartment. \nThe CompartmentId query parameters must be provided to retrieve the health metrics.\n"
operationId: GetExadataInfrastructureFleetHealthMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/CompareBaselineTimeQueryParam'
- $ref: '#/components/parameters/CompareTargetTimeQueryParam'
- $ref: '#/components/parameters/CompareTypeQueryParam'
- $ref: '#/components/parameters/FilterByExadataInfrastructureDeploymentTypeParam'
- $ref: '#/components/parameters/FilterByExadataInfrastructureLifecycleStateParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The Exadata infrastructure fleet metrics for a compartment were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExadataInfrastructureFleetHealthMetrics'
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'
summary: Gets the health metrics for a fleet of Exadata infrastructure.
tags:
- dbManagement
x-example: 'GET /20201101/exadataInfrastructureFleetMetrics?compartmentId=<compartmentId>&compareBaselineTime=<compareBaselineTime>
&compareTargetTime=<compareTargetTime>&compareType=<compareType>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/externalAsmInstances:
get:
description: Lists the ASM instances in the specified external ASM.
operationId: ListExternalAsmInstances
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalAsmIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external ASM instances 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/ExternalAsmInstanceCollection'
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'
summary: Lists the external ASM instances.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsmInstances?compartmentId=<compartmentId>&externalAsmId=<externalAsmId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsmInstance'
/externalAsmInstances/{externalAsmInstanceId}:
get:
description: 'Gets the details for the external ASM instance specified by `externalAsmInstanceId`.
'
operationId: GetExternalAsmInstance
parameters:
- $ref: '#/components/parameters/ExternalAsmInstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external ASM instance details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAsmInstance'
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'
summary: Gets the external ASM instance details.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsmInstances/<externalAsmInstanceId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsmInstance'
put:
description: 'Updates the external ASM instance specified by `externalAsmInstanceId`.
'
operationId: UpdateExternalAsmInstance
parameters:
- $ref: '#/components/parameters/ExternalAsmInstanceIdPathParam'
- $ref: '#/components/parameters/UpdateExternalAsmInstanceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The request was successfully received and the external ASM instance is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAsmInstance'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external ASM instance.
tags:
- dbManagement
x-example: "PUT /20201101/externalAsmInstances/<externalAsmInstanceId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/ExternalAsmInstance'
/externalAsms:
get:
description: Lists the ASMs in the specified external DB system.
operationId: ListExternalAsms
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external ASMs 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/ExternalAsmCollection'
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'
summary: Lists the external ASMs.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
/externalAsms/{externalAsmId}:
get:
description: 'Gets the details for the external ASM specified by `externalAsmId`.
'
operationId: GetExternalAsm
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external ASM details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAsm'
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'
summary: Gets the external ASM details.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms/<externalAsmId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
put:
description: 'Updates the external ASM specified by `externalAsmId`.
'
operationId: UpdateExternalAsm
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/UpdateExternalAsmDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external ASM is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external ASM.
tags:
- dbManagement
x-example: "PUT /20201101/externalAsms/<externalAsmId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalConnectorId\": \"ocid1.test.oc1..EXAMPLE-externalConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalAsm'
/externalAsms/{externalAsmId}/configuration:
get:
description: 'Gets configuration details including disk groups for the external ASM specified by `externalAsmId`.
'
operationId: GetExternalAsmConfiguration
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The external ASM configuration details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalAsmConfiguration'
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'
summary: Gets the external ASM configuration.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms/<externalAsmId>/configuration
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
/externalAsms/{externalAsmId}/diskGroups:
get:
description: 'Lists ASM disk groups for the external ASM specified by `externalAsmId`.
'
operationId: ListExternalAsmDiskGroups
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The external ASM disk groups were 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/ExternalAsmDiskGroupCollection'
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'
summary: Lists the external ASM disk groups.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms/<externalAsmId>/diskGroups
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
/externalAsms/{externalAsmId}/metrics:
get:
description: 'Gets metrics for the external ASM specified by `externalAsmId`.
'
operationId: SummarizeExternalAsmMetrics
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The external ASM metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the external ASM metrics.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms/<externalAsmId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
/externalAsms/{externalAsmId}/users:
get:
description: 'Lists ASM users for the external ASM specified by `externalAsmId`.
'
operationId: ListExternalAsmUsers
parameters:
- $ref: '#/components/parameters/ExternalAsmIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The external ASM users were 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/ExternalAsmUserCollection'
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'
summary: Lists the external ASM users.
tags:
- dbManagement
x-example: 'GET /20201101/externalAsms/<externalAsmId>/users
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalAsm'
/externalClusterInstances:
get:
description: Lists the cluster instances in the specified external cluster.
operationId: ListExternalClusterInstances
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalClusterIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external cluster instances 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/ExternalClusterInstanceCollection'
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'
summary: Lists the external cluster instances.
tags:
- dbManagement
x-example: 'GET /20201101/externalClusterInstances?compartmentId=<compartmentId>&externalClusterId<externalClusterId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalClusterInstance'
/externalClusterInstances/{externalClusterInstanceId}:
get:
description: 'Gets the details for the external cluster instance specified by `externalClusterInstanceId`.
'
operationId: GetExternalClusterInstance
parameters:
- $ref: '#/components/parameters/ExternalClusterInstanceIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external cluster instance details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalClusterInstance'
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'
summary: Gets the external cluster instance details.
tags:
- dbManagement
x-example: 'GET /20201101/externalClusterInstances/<externalClusterInstanceId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalClusterInstance'
put:
description: 'Updates the external cluster instance specified by `externalClusterInstanceId`.
'
operationId: UpdateExternalClusterInstance
parameters:
- $ref: '#/components/parameters/ExternalClusterInstanceIdPathParam'
- $ref: '#/components/parameters/UpdateExternalClusterInstanceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external cluster instance is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external cluster instance.
tags:
- dbManagement
x-example: "PUT /20201101/externalClusterInstances/<externalClusterInstanceId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalConnectorId\": \"ocid1.test.oc1..EXAMPLE-externalConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalClusterInstance'
/externalClusters:
get:
description: Lists the clusters in the specified external DB system.
operationId: ListExternalClusters
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external clusters 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/ExternalClusterCollection'
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'
summary: Lists the external clusters.
tags:
- dbManagement
x-example: 'GET /20201101/externalClusters?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalCluster'
/externalClusters/{externalClusterId}:
get:
description: 'Gets the details for the external cluster specified by `externalClusterId`.
'
operationId: GetExternalCluster
parameters:
- $ref: '#/components/parameters/ExternalClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external cluster details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalCluster'
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'
summary: Gets the external cluster details.
tags:
- dbManagement
x-example: 'GET /20201101/externalClusters/<externalClusterId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalCluster'
put:
description: 'Updates the external cluster specified by `externalClusterId`.
'
operationId: UpdateExternalCluster
parameters:
- $ref: '#/components/parameters/ExternalClusterIdPathParam'
- $ref: '#/components/parameters/UpdateExternalClusterDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external cluster is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external cluster.
tags:
- dbManagement
x-example: "PUT /20201101/externalClusters/<externalClusterId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalConnectorId\": \"ocid1.test.oc1..EXAMPLE-externalConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalCluster'
/externalClusters/{externalClusterId}/metrics:
get:
description: 'Gets metrics for the external cluster specified by `externalClusterId`.
'
operationId: SummarizeExternalClusterMetrics
parameters:
- $ref: '#/components/parameters/ExternalClusterIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The external cluster metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the external cluster metrics.
tags:
- dbManagement
x-example: 'GET /20201101/externalClusters/<externalClusterId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalCluster'
/externalDatabases:
get:
description: Lists the external databases in the specified compartment or in the specified DB system.
operationId: ListExternalDatabases
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/ExternalDatabaseIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external databases 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/ExternalDatabaseCollection'
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'
summary: Lists the external databases.
tags:
- dbManagement
x-example: 'GET /20201101/externalDatabases?externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
/externalDbHomes:
get:
description: Lists the DB homes in the specified external DB system.
operationId: ListExternalDbHomes
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external DB homes 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/ExternalDbHomeCollection'
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'
summary: Lists the external DB homes.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbHomes?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbHome'
/externalDbHomes/{externalDbHomeId}:
get:
description: 'Gets the details for the external DB home specified by `externalDbHomeId`.
'
operationId: GetExternalDbHome
parameters:
- $ref: '#/components/parameters/ExternalDbHomeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external DB home details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbHome'
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'
summary: Gets the external DB home details.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbHomes/<externalDbHomeId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbHome'
put:
description: 'Updates the external DB home specified by `externalDbHomeId`.
'
operationId: UpdateExternalDbHome
parameters:
- $ref: '#/components/parameters/ExternalDbHomeIdPathParam'
- $ref: '#/components/parameters/UpdateExternalDbHomeDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The request was successfully received and the external DB home is being updated.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbHome'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external DB home.
tags:
- dbManagement
x-example: "PUT /20201101/externalDbHomes/<externalDbHomeId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/ExternalDbHome'
/externalDbNodes:
get:
description: Lists the external DB nodes in the specified external DB system.
operationId: ListExternalDbNodes
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external DB nodes 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/ExternalDbNodeCollection'
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'
summary: Lists the external DB nodes.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbNodes?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbNode'
/externalDbNodes/{externalDbNodeId}:
get:
description: 'Gets the details for the external DB node specified by `externalDbNodeId`.
'
operationId: GetExternalDbNode
parameters:
- $ref: '#/components/parameters/ExternalDbNodeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external DB node details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbNode'
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'
summary: Gets the external DB node details.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbNodes/<externalDbNodeId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbNode'
put:
description: 'Updates the external DB node specified by `externalDbNodeId`.
'
operationId: UpdateExternalDbNode
parameters:
- $ref: '#/components/parameters/ExternalDbNodeIdPathParam'
- $ref: '#/components/parameters/UpdateExternalDbNodeDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external DB node is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external DB node.
tags:
- dbManagement
x-example: "PUT /20201101/externalDbNodes/<externalDbNodeId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalConnectorId\": \"ocid1.test.oc1..EXAMPLE-externalConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalDbNode'
/externalDbNodes/{externalDbNodeId}/metrics:
get:
description: 'Gets metrics for the external DB node specified by `externalDbNodeId`.
'
operationId: SummarizeExternalDbNodeMetrics
parameters:
- $ref: '#/components/parameters/ExternalDbNodeIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The external DB node metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the external DB nodemetrics.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbNodes/<externalDbNodeId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbNode'
/externalDbSystemConnectors:
get:
description: Lists the external connectors in the specified external DB system.
operationId: ListExternalDbSystemConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external connectors 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/ExternalDbSystemConnectorCollection'
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'
summary: Lists the external connectors.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystemConnectors?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemConnector'
post:
description: Creates a new external connector.
operationId: CreateExternalDbSystemConnector
parameters:
- $ref: '#/components/parameters/CreateExternalDbSystemConnectorDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The external connector was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an external connector.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystemConnectors\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"connectorType\": \"MACS\",\n \"externalDbSystemId\": \"ocid1.test.oc1..EXAMPLE-externalDbSystemId-Value\",\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"agentId\": \"ocid1.test.oc1..EXAMPLE-agentId-Value\",\n \"connectionInfo\": {\n \"componentType\": \"ASM\",\n \"connectionString\": {\n \"hosts\": [\"EXAMPLE-hostName-Value1\" , \"EXAMPLE-hostName-Value2\"],\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"EXAMPLE-service-Value\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"EXAMPLE-credentialName-Value\",\n \"userName\": \"EXAMPLE-userName-Value\",\n \"passwordSecretId\": \"ocid1.test.oc1..EXAMPLE-passwordSecretId-Value\",\n \"role\": \"SYSASM\"\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemConnector'
/externalDbSystemConnectors/{externalDbSystemConnectorId}:
delete:
description: 'Deletes the external connector specified by `externalDbSystemConnectorId`.
'
operationId: DeleteExternalDbSystemConnector
parameters:
- $ref: '#/components/parameters/ExternalDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The external connector was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the external connector.
tags:
- dbManagement
x-example: 'DELETE /20201101/externalDbSystemConnectors/<externalDbSystemConnectorId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalDbSystemConnector'
get:
description: 'Gets the details for the external connector specified by `externalDbSystemConnectorId`.
'
operationId: GetExternalDbSystemConnector
parameters:
- $ref: '#/components/parameters/ExternalDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external connector details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemConnector'
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'
summary: Gets the external connector details.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystemConnectors/<externalDbSystemConnectorId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemConnector'
put:
description: Updates the external connector specified by `externalDbSystemConnectorId`.
operationId: UpdateExternalDbSystemConnector
parameters:
- $ref: '#/components/parameters/ExternalDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/UpdateExternalDbSystemConnectorDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request was successfully received and the external connector is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external connector.
tags:
- dbManagement
x-example: "PUT /20201101/externalDbSystemConnectors/<externalDbSystemConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"connectorType\": \"MACS\",\n \"connectionInfo\": {\n \"componentType\": \"ASM\",\n \"connectionString\": {\n \"hosts\": [\"EXAMPLE-hostName-Value\", \"EXAMPLE-hostName-Value2\"],\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"EXAMPLE-service-Value\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"EXAMPLE-credentialName-Value\",\n \"userName\": \"EXAMPLE-userName-Value\",\n \"passwordSecretId\": \"ocid1.test.oc1..EXAMPLE-passwordSecretId-Value\",\n \"role\": \"SYSASM\"\n }\n }\n}\n"
x-related-resource: '#/definitions/ExternalDbSystemConnector'
/externalDbSystemConnectors/{externalDbSystemConnectorId}/actions/checkConnectionStatus:
post:
description: 'Checks the status of the external DB system component connection specified in this connector.
This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
'
operationId: CheckExternalDbSystemConnectorConnectionStatus
parameters:
- $ref: '#/components/parameters/ExternalDbSystemConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The connection was successfully checked and the status is returned
in `ExternalDbSystemConnector`.
'
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Checks the connectivity status of an external connector.
tags:
- dbManagement
x-example: 'POST /20201101/externalDbSystemConnectors/<externalDbSystemConnectorId>/actions/checkConnectionStatus
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemConnector'
/externalDbSystemDiscoveries:
get:
description: Lists the external DB system discovery resources in the specified compartment.
operationId: ListExternalDbSystemDiscoveries
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external DB system discovery resources 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/ExternalDbSystemDiscoveryCollection'
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'
summary: Lists the external DB system discovery resources.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystemDiscoveries?compartmentId=<compartmentId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
post:
description: 'Creates an external DB system discovery resource and initiates the discovery process.
'
operationId: CreateExternalDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/CreateExternalDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The external DB system discovery resource was successfully created and discovery is being run.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an external DB system discovery resource.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystemDiscoveries\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.test.oc1..EXAMPLE-compartmentId-Value\",\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"agentId\": \"ocid1.test.oc1..EXAMPLE-agentId-Value\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
/externalDbSystemDiscoveries/{externalDbSystemDiscoveryId}:
delete:
description: 'Deletes the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.
'
operationId: DeleteExternalDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/ExternalDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The external DB system discovery resource was successfully deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the external DB system discovery resource.
tags:
- dbManagement
x-example: 'DELETE /20201101/externalDbSystemDiscoveries/<externalDbSystemDiscoveryId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
get:
description: 'Gets the details for the external DB system discovery resource specified by `externalDbSystemDiscoveryId`.
'
operationId: GetExternalDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/ExternalDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external DB system discovery details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemDiscovery'
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'
summary: Gets the external DB system discovery details.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystemDiscoveries/<externalDbSystemDiscoveryId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
patch:
description: 'Patches the external DB system discovery specified by `externalDbSystemDiscoveryId`.
'
operationId: PatchExternalDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/ExternalDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/PatchExternalDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The external DB system discovery was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external DB system discovery.
tags:
- dbManagement
x-example: "PATCH /20201101/externalDbSystemDiscoveries/<externalDbSystemDiscoveryId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"operation\": \"MERGE\",\n \"selection\": \"discoveredComponents[?componentId==]\",\n \"value\":\n {\n \"displayName\": \"myExampleDb\",\n \"compartmentId\": \"ocid1.compartment.oc1.\",\n \"isSelectedForMonitoring\": true,\n \"connector\": {\n \"connectorType\": \"MACS\",\n \"agentId\": \"ocid1.managementagent.oc1.\",\n \"connectionInfo\": {\n \"componentType\": \"DATABASE\",\n \"connectionString\": {\n \"hostName\": \"example.host.com\",\n \"port\": 1521,\n \"protocol\": \"TCP\",\n \"service\": \"exampleDbService\"\n },\n \"connectionCredentials\": {\n \"credentialType\": \"DETAILS\",\n \"credentialName\": \"myExampleDbCred\",\n \"userName\": \"exampleUser\",\n \"passwordSecretId\": \"ocid1.vaultsecret.oc1.\",\n \"role\": \"NORMAL\"\n }\n }\n }\n }\n }\n ]\n}\n"
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
put:
description: 'Updates the external DB system discovery specified by `externalDbSystemDiscoveryId`.
'
operationId: UpdateExternalDbSystemDiscovery
parameters:
- $ref: '#/components/parameters/ExternalDbSystemDiscoveryIdPathParam'
- $ref: '#/components/parameters/UpdateExternalDbSystemDiscoveryDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The external DB system discovery was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystemDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external DB system discovery.
tags:
- dbManagement
x-example: "PUT /20201101/externalDbSystemDiscoveries/<externalDbSystemDiscoveryId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalDbSystemDiscovery'
/externalDbSystems:
get:
description: Lists the external DB systems in the specified compartment.
operationId: ListExternalDbSystems
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external DB systems 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/ExternalDbSystemCollection'
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'
summary: Lists the external DB systems.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystems?compartmentId=<compartmentId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystem'
post:
description: 'Creates an external DB system and its related resources.
'
operationId: CreateExternalDbSystem
parameters:
- $ref: '#/components/parameters/CreateExternalDbSystemDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
201:
description: The request was successfully received and the external DB system is being created.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an external DB system.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystems\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\",\n \"dbSystemDiscoveryId\": \"ocid1.test.oc1..EXAMPLE-externalDbSystemDiscoveryId-Value\",\n \"compartmentId\": \"ocid1.test.oc1..EXAMPLE-compartmentId-Value\",\n \"databaseManagementConfig\": {\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}:
delete:
description: 'Deletes the external DB system specified by `externalDbSystemId`.
'
operationId: DeleteExternalDbSystem
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external DB system is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the external DB system.
tags:
- dbManagement
x-example: 'DELETE /20201101/externalDbSystems/<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalDbSystem'
get:
description: 'Gets the details for the external DB system specified by `externalDbSystemId`.
'
operationId: GetExternalDbSystem
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external DB system details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystem'
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'
summary: Gets the external DB system details.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystems/<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystem'
put:
description: 'Updates the external DB system specified by `externalDbSystemId`.
'
operationId: UpdateExternalDbSystem
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/UpdateExternalDbSystemDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The external DB system was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDbSystem'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external DB system.
tags:
- dbManagement
x-example: "PUT /20201101/externalDbSystems/<externalDbSystemId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"EXAMPLE-displayName-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/actions/changeCompartment:
post:
description: 'Moves the external DB system and its related resources (excluding databases) to the specified compartment.
'
operationId: ChangeExternalDbSystemCompartment
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/ChangeExternalDbSystemCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the change compartment action is being performed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves an external DB system to a different compartment.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystems/<externalDbSystemId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.test.oc1..EXAMPLE-compartmentId-Value\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/actions/disableDatabaseManagement:
post:
description: 'Disables Database Management service for all the components of the specified
external DB system (except databases).
'
operationId: DisableExternalDbSystemDatabaseManagement
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management service is being disabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management service for the external DB system.
tags:
- dbManagement
x-example: 'POST /20201101/externalDbSystems/<externalDbSystemId>/actions/disableDatabaseManagement
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: DATABASE_MANAGEMENT
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/actions/disableStackMonitoring:
post:
description: 'Disables Stack Monitoring for all the components of the specified
external DB system (except databases).
'
operationId: DisableExternalDbSystemStackMonitoring
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Stack Monitoring is being disabled for the external DB system components.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Stack monitoring service for the external DB system.
tags:
- dbManagement
x-example: 'POST /20201101/externalDbSystems/<externalDbSystemId>/actions/disableStackMonitoring
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: STACK_MONITORING
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/actions/enableDatabaseManagement:
post:
description: 'Enables Database Management service for all the components of the specified
external DB system (except databases).
'
operationId: EnableExternalDbSystemDatabaseManagement
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/EnableExternalDbSystemDatabaseManagementDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management service is being enabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management service for the external DB system.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystems/<externalDbSystemId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: DATABASE_MANAGEMENT
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/actions/enableStackMonitoring:
post:
description: 'Enables Stack Monitoring for all the components of the specified
external DB system (except databases).
'
operationId: EnableExternalDbSystemStackMonitoring
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/EnableExternalDbSystemStackMonitoringDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Stack Monitoring is being enabled for the external DB system components.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Stack Monitoring service for the external DB system.
tags:
- dbManagement
x-example: "POST /20201101/externalDbSystems/<externalDbSystemId>/actions/enableStackMonitoring\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isEnabled\" : true,\n \"metadata\" : \"{ \\\"EXAMPLE-key\\\": \\\"EXAMPLE-Value\\\" }\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: STACK_MONITORING
x-related-resource: '#/definitions/ExternalDbSystem'
/externalDbSystems/{externalDbSystemId}/availabilityMetrics:
get:
description: 'Gets availability metrics for the components present in the external DB system specified by `externalDbSystemId`.
'
operationId: SummarizeExternalDbSystemAvailabilityMetrics
parameters:
- $ref: '#/components/parameters/ExternalDbSystemIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/ComponentTypesFilterQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
responses:
200:
description: The availability metrics for the external DB system components were 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/MetricsAggregationRangeCollection'
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'
summary: Gets availability metrics for the external DB system components.
tags:
- dbManagement
x-example: 'GET /20201101/externalDbSystems/<externalDbSystemId>/availabilityMetrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalDbSystem'
/externalExadataInfrastructures:
get:
description: 'Lists the Exadata infrastructure resources in the specified compartment.
'
operationId: ListExternalExadataInfrastructures
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata infrastructure resources in the specified compartment 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/ExternalExadataInfrastructureCollection'
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'
summary: Lists the external Exadata infrastructures.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataInfrastructures?compartmentId=<compartmentId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"INFRASTRUCTURE_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\"\n } ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
post:
description: "Creates an OCI resource for the Exadata infrastructure and enables the Monitoring service for the Exadata infrastructure.\nThe following resource/subresources are created:\n Infrastructure\n Storage server connectors\n Storage servers\n Storage grids\n"
operationId: CreateExternalExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CreateExternalExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The OCI resource for the Exadata infrastructure was created and the Monitoring service was enabled successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataInfrastructure'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an OCI resource for the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /v1/externalExadataInfrastructures/\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.348Z\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exaInfra01010201-sGrid\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.349Z\"\n },\n \"databaseSystems\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.externaldbsystem.01\",\n \"displayName\" : \"externaldbsystem-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataInfrastructures/actions/discoverExadataInfrastructure:
post:
description: "Completes the Exadata system prechecking on the following:\n\n- Verifies if the DB systems are valid RAC DB systems or return 400 status code with NON_RAC_DATABASE_SYSTEM error code.\n- Verifies if the ASM connector defined for each DB system or return 400 status code with CONNECTOR_NOT_DEFINED error code.\n- Verifies if the agents associated with ASM are valid and could be used for the Exadata storage servers or return 400 status code with \nINVALID_AGENT error code.\n- Verifies if it is an Exadata system or return 400 status code with INVALID_EXADATA_SYSTEM error code.\n\nStarts the discovery process for the Exadata system infrastructure. The following resources/components are discovered\n\n- Exadata storage servers from each DB systems\n- Exadata storage grid for all Exadata storage servers\n- Exadata infrastructure\n\nThe same API covers both new discovery and rediscovery cases.\n For the new discovery case, new managed resources/sub-resources are created or the existing ones are overridden.\n For rediscovery case, the existing managed resources/sub-resources are checked to find out which ones should be added or which ones \nshould be\n removed based on the unique key defined for each resource/sub-resource.\n"
operationId: DiscoverExternalExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/DiscoverExternalExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Exadata infrastructure was discovered successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataInfrastructureDiscovery'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Start the discovery process for Exadata system infrastructure from the specified agent.
tags:
- dbManagement
x-example: "POST /v1/externalExadataInfrastructures/actions/discoverExadataInfrastructure\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"entityType\" : \"INFRASTRUCTURE_DISCOVER\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"discoveryKey\" : \"hkfc71122838358MAexadiscovery\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"gridHomePath\" : \"/u01/app/19.0.0.0/grid\",\n \"dbSystems\" : [ {\n \"entityType\" : \"DATABASE_SYSTEM_DISCOVER_SUMMARY\",\n \"id\" : \"ocid1.externaldbsystem.01\",\n \"displayName\" : \"externaldbsystem-phcustch\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"compartmentId\" : \"ocid1.compartment.oc1..aaaaaaaamcirv2h2okvki2t2itiprns7qs7zvhuvhnkmqre5uaorxpksqwtq\"\n } ],\n \"storageGrid\" : {\n \"entityType\" : \"STORAGE_GRID_DISCOVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"discoverStatus\" : \"PREV_DISCOVERED\",\n \"countOfStorageServersDiscovered\" : 3\n },\n \"storageServers\" : [ ...]}\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataInfrastructures/{externalExadataInfrastructureId}:
delete:
description: 'Deletes the Exadata infrastructure specified by externalExadataInfrastructureId.
'
operationId: DeleteExternalExadataInfrastructure
parameters:
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The Exadata infrastructure is being deleted.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the Exadata infrastructure.
tags:
- dbManagement
x-example: 'DELETE /20201101/ExternalExadataInfrastructure/<externalExadataInfrastructureId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
get:
description: 'Gets the details for the Exadata infrastructure specified by externalExadataInfrastructureId. It includes the DB systems and storage grid within the
Exadata infrastructure.
'
operationId: GetExternalExadataInfrastructure
parameters:
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata infrastructure details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataInfrastructure'
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'
summary: Gets the Exadata infrastructure details.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataInfrastructures/<externalExadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-16T15:12:53.206Z\",\n \"lifecycleDetails\" : \"all server sources created\"\n },\n \"databaseSystems\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.externaldbsystem.01\",\n \"displayName\" : \"externaldbsystem-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
put:
description: 'Updates the details for the Exadata infrastructure specified by externalExadataInfrastructureId.
'
operationId: UpdateExternalExadataInfrastructure
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/UpdateExternalExadataInfrastructureDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Exadata infrastructure details were updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataInfrastructure'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /v1/externalExadataInfrastructures/<externalExadataInfrastructureId>\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"INFRASTRUCTURE\",\n \"id\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.baa0fec7647948fba9cffaa80c619fc1\",\n \"displayName\" : \"exadata-exaInfra01\",\n \"lifecycleState\" : \"UPDATING\",\n \"timeCreated\" : \"2022-12-15T15:25:02.348Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.263Z\",\n \"compartmentId\" : \"ocid1.compartment.oc1..sampleUniqueComId01\",\n \"licenseModel\" : \"LICENSE_INCLUDED\",\n \"storageGrid\" : {\n \"resourceType\" : \"STORAGE_GRID_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.b205cb1aa4ac4fc1b8df66c54585389a\",\n \"displayName\" : \"exadata-exaInfra01-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.263Z\",\n \"lifecycleDetails\" : \"all server sources created\"\n },\n \"databaseSystems\" : [ {\n \"resourceType\" : \"DATABASE_SYSTEM_SUMMARY\",\n \"id\" : \"ocid.externaldbsystem.01\",\n \"displayName\" : \"externaldbsystem-phcustch\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2218-07-17T18:40:00.011Z\",\n \"timeUpdated\" : \"3169-03-16T00:00:00.011Z\",\n \"lifecycleDetails\" : \" \"\n } ],\n \"databaseCompartments\" : [... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/changeCompartment:
post:
description: 'Moves the Exadata infrastructure and its related resources (Exadata storage server, Exadata storage server connectors and Exadata storage server grid) to the specified compartment.
'
operationId: ChangeExternalExadataInfrastructureCompartment
parameters:
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/ChangeExternalExadataInfrastructureCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the change compartment action is being performed.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves the Exadata infrastructure and its resources to a different compartment.
tags:
- dbManagement
x-example: "POST /20201101/externalExadataInfrastructures/<externalExadataInfrastructureId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/disableDatabaseManagement:
post:
description: 'Disables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId.
It covers the following components:
- Exadata infrastructure
- Exadata storage grid
- Exadata storage server
Note that Database Management will not be disabled for the DB systems within the Exadata infrastructure and should be disabled explicitly, if required.
'
operationId: DisableExternalExadataInfrastructureManagement
parameters:
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management is being disabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management for the Exadata infrastructure.
tags:
- dbManagement
x-example: 'POST /20201101/externalExadataInfrastructures/<externalExadataInfrastructureId>/actions/disableDatabaseManagement
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: EXADATA
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataInfrastructures/{externalExadataInfrastructureId}/actions/enableDatabaseManagement:
post:
description: "Enables Database Management for the Exadata infrastructure specified by externalExadataInfrastructureId. It covers the following \ncomponents:\n\n- Exadata infrastructure\n- Exadata storage grid\n- Exadata storage server\n"
operationId: EnableExternalExadataInfrastructureManagement
parameters:
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdPathParam'
- $ref: '#/components/parameters/EnableExternalExadataInfrastructureManagementDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and Database Management Service is being enabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management for the Exadata infrastructure.
tags:
- dbManagement
x-example: "POST /20201101/externalExadataInfrastructures/<externalExadataInfrastructureId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: EXADATA
x-related-resource: '#/definitions/ExternalExadataInfrastructure'
/externalExadataStorageConnectors:
get:
description: 'Lists the Exadata storage server connectors for the specified Exadata infrastructure.
'
operationId: ListExternalExadataStorageConnectors
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata storage server connectors for the specified Exadata infrastructure 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/ExternalExadataStorageConnectorCollection'
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'
summary: Lists the external connectors.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageConnectors?compartmentId=<compartmentId>&exadataInfrastructureId=<externalExadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.250c0aff2cc24cc08e478f6c420e6def\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-16T15:16:54.572Z\",\n \"timeUpdated\" : \"2022-12-16T15:16:54.572Z\",\n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n }, {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.02bf3e1b3a104c8ab886bbd6f8ef4118\",\n \"displayName\" : \"exaInfra01celadm02-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T22:57:51.279Z\",\n \"timeUpdated\" : \"2022-12-15T22:57:51.279Z\",\n \"connectionUri\" : \"https://exaInfra01celadm02.us.oracle.com/MS/RESTService/\"\n }]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
post:
description: 'Creates the Exadata storage server connector after validating the connection information.
'
operationId: CreateExternalExadataStorageConnector
parameters:
- $ref: '#/components/parameters/CreateExternalExadataStorageConnectorBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Exadata storage server connector was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an Exadata storage server connector.
tags:
- dbManagement
x-example: "POST /20201101/externalExadataStorageConnectors\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\",\n \"displayName\" : \"exaInfra01celadm01-conn\",\n \"lifecycleState\" : \"CREATING\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm01.us.oracle.com/MS/RESTService/\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}:
delete:
description: 'Deletes the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: DeleteExternalExadataStorageConnector
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The Exadata storage server connector was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes the external connector.
tags:
- dbManagement
x-example: 'DELETE /20201101/ExternalExadataStorageConnector/<externalExadataStorageConnector>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
get:
description: 'Gets the details for the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: GetExternalExadataStorageConnector
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the Exadata storage server connector were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageConnector'
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'
summary: Gets the Exadata storage server connector details.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageConnectors/<externalExadataStorageConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.fc06271028be42eca303530853c9216d\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"CREATING\",\n \"timeCreated\" : \"2022-11-03T22:51:12.725Z\",\n \"timeUpdated\" : \"2022-11-03T22:51:12.725Z\",\n \"lifecycleDetails\" : \"AGENT_CREDENTIAL_UPSERTING\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
put:
description: 'Updates the Exadata storage server connector specified by exadataStorageConnectorId.
'
operationId: UpdateExternalExadataStorageConnector
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/UpdateExternalExadataStorageConnectorDetailsBodyParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server connector was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an Exadata storage server connector.
tags:
- dbManagement
x-example: "PUT /20201101/externalExadataStorageConnectors/<externalExadataStorageConnectorId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_CONNECTOR\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\",\n \"displayName\" : \"exaInfra01celadm01-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T16:39:54.735Z\",\n \"timeUpdated\" : \"2022-12-15T16:39:54.735Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"agentId\" : \"ocid1.managementagent.oc1.iad.sampleUniqueAgentId01\",\n \"connectionUri\" : \"https://exaInfra01celadm01.us.oracle.com/MS/RESTService/\"\n}\n"
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
/externalExadataStorageConnectors/{externalExadataStorageConnectorId}/actions/checkStatus:
post:
description: 'Checks the status of the Exadata storage server connection specified by exadataStorageConnectorId.
'
operationId: CheckExternalExadataStorageConnector
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The status of the Exadata storage server connection was checked successfully.
'
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageConnectorStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Checks the connectivity status of the Exadata storage server connection.
tags:
- dbManagement
x-example: "POST /20201101/externalExadataStorageConnectors/<externalExadataStorageConnectorId>/actions/checkStatus\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.06ff8e793d0247efb2d2bcc4256b554d\",\n \"status\" : \"SUCCEEDED\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageConnector'
/externalExadataStorageGrids/{externalExadataStorageGridId}:
get:
description: 'Gets the details for the Exadata storage server grid specified by exadataStorageGridId.
'
operationId: GetExternalExadataStorageGrid
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageGridIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server grid summary was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageGrid'
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'
summary: Gets the Exadata storage server grid details.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageGrids/<externalExadataStorageGridId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_GRID\",\n \"id\" : \"ocid1.EXADATA_STORAGE_GRID.oc1.a7fc4e70bb004bea94aca42ba7fff082\",\n \"displayName\" : \"exaInfra01010201-sGrid\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T21:35:44.106Z\",\n \"timeUpdated\" : \"2022-11-03T21:35:44.106Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"storageServers\" : [ ... ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageGrid'
put:
description: 'Updates the Exadata storage server grid specified by exadataStorageGridId.
'
operationId: UpdateExternalExadataStorageGrid
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageGridIdPathParam'
- $ref: '#/components/parameters/UpdateExternalExadataStorageGridDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Exadata storage server grid was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageGrid'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the Exadata storage server grid details.
tags:
- dbManagement
x-example: "PUT /20201101/externalExadataStorageGrids/<externalExadataStorageGridId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/ExternalExadataStorageGrid'
/externalExadataStorageServers:
get:
description: 'Lists the Exadata storage servers for the specified Exadata infrastructure.
'
operationId: ListExternalExadataStorageServers
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdQueryParam'
- $ref: '#/components/parameters/DisplayNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of Exadata storage servers for the specified Exadata infrastructure 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/ExternalExadataStorageServerCollection'
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'
summary: Lists the external storage servers.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageServers?compartmentId=<compartmentId>&externalExadataInfrastructureId=<externalExadataInfrastructureId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\" : [ {\n \"resourceType\" : \"STORAGE_SERVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.edef6bc336c24ee086a5806c03aa0c7d\",\n \"displayName\" : \"exaInfra01celadm02\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1345NM50BU\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T22:02:26.264Z\",\n \"timeUpdated\" : \"2022-12-15T22:02:26.264Z\",\n \"lifecycleDetails\" : \"source created/updated. \",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.5\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connectorId\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.02bf3e1b3a104c8ab886bbd6f8ef4118\"\n }, {\n \"resourceType\" : \"STORAGE_SERVER_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.3c6212d3fd5d4dcfa6883798e8dac8c5\",\n \"displayName\" : \"exaInfra01celadm01\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1346NM502U\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-12-15T15:25:02.349Z\",\n \"timeUpdated\" : \"2022-12-15T15:25:02.349Z\",\n \"lifecycleDetails\" : \"source created/updated. \",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.4\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connectorId\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.9567ccf62a1d4ed2823df146b215ff03\"\n } ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageServer'
/externalExadataStorageServers/{externalExadataStorageServerId}:
get:
description: 'Gets the summary for the Exadata storage server specified by exadataStorageServerId.
'
operationId: GetExternalExadataStorageServer
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Exadata storage server summary was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageServer'
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'
summary: Gets the Exadata storage server summary.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageServers/<externalExadataStorageServerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"resourceType\" : \"STORAGE_SERVER\",\n \"id\" : \"ocid1.EXADATA_STORAGE_SERVER.oc1.f2ebbd0cd8fe40eeb05ce9d3f2b5b351\",\n \"displayName\" : \"exaInfra01celadm03\",\n \"version\" : \"OSS_20.1.7.0.0_LINUX.X64_210205\",\n \"internalId\" : \"1346NM502X\",\n \"status\" : \"online\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T21:35:44.106Z\",\n \"timeUpdated\" : \"2022-11-03T21:35:44.106Z\",\n \"exadataInfrastructureId\" : \"ocid1.EXADATA_INFRASTRUCTURE.oc1.bfdf14956ddf4a8cbb8e01a40d1838e5\",\n \"makeModel\" : \"Oracle Corporation SUN FIRE X4270 M3 High Performance\",\n \"ipAddress\" : \"192.168.211.6\",\n \"cpuCount\" : 24,\n \"memoryGB\" : 63.0,\n \"connector\" : {\n \"resourceType\" : \"STORAGE_CONNECTOR_SUMMARY\",\n \"id\" : \"ocid1.EXADATA_STORAGE_CONNECTOR.oc1.fc06271028be42eca303530853c9216d\",\n \"displayName\" : \"exaInfra01celadm03-conn\",\n \"lifecycleState\" : \"ACTIVE\",\n \"timeCreated\" : \"2022-11-03T22:51:12.725Z\",\n \"timeUpdated\" : \"2022-11-03T22:51:12.725Z\", \n \"connectionUri\" : \"https://exaInfra01celadm03.us.oracle.com/MS/RESTService/\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageServer'
put:
description: 'Updates the Exadata storage server specified by exadataStorageServerId.
'
operationId: UpdateExternalExadataStorageServer
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/UpdateExternalExadataStorageServerDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Exadata storage server was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalExadataStorageServer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates the Exadata storage server.
tags:
- dbManagement
x-example: "PUT /20201101/externalExadataStorageServers/<externalExadataStorageServerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/ExternalExadataStorageServer'
/externalExadataStorageServers/{externalExadataStorageServerId}/iormPlan:
get:
description: 'Get the IORM plan from the specific Exadata storage server.
'
operationId: GetIormPlan
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The IORM plan from the specified Exadata storage server was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/IormPlan'
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'
summary: Gets the IORM plan from the specified Exadata storage server.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageServerId/<externalExadataStorageServerId>/iormPlan\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"planStatus\": \"ACTIVE\",\n \"planObjective\": \"BASIC\",\n \"dbPlan\": {\n \"items\": [\n {\n \"name\": \"other\",\n \"share\": 0,\n \"level\": 1,\n \"allocation\": 10,\n \"limit\": 0,\n \"isFlashCacheOn\": false,\n \"isPmemCacheOn\": false,\n \"isFlashLogOn\": false,\n \"isPmemLogOn\": false,\n \"type\": \"DATABASE\",\n \"role\": \"NONE\"\n },\n {\n \"name\": \"EDM1\",\n \"share\": 0,\n \"level\": 0,\n \"allocation\": 0,\n \"limit\": 40,\n \"isFlashCacheOn\": false,\n \"isPmemCacheOn\": false,\n \"isFlashLogOn\": false,\n \"isPmemLogOn\": false,\n \"flashCacheLimit\": \"100M\",\n \"flashCacheMin\": \"5M\",\n \"type\": \"DATABASE\",\n \"role\": \"NONE\"\n }\n ]\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageServer'
/externalExadataStorageServers/{externalExadataStorageServerId}/openAlertHistory:
get:
description: 'Gets the open alerts from the specified Exadata storage server.
'
operationId: GetOpenAlertHistory
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The open alerts from the specified Exadata storage server were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OpenAlertHistory'
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'
summary: Get open alerts from the specific Exadata storage server.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageServers/<externalExadataStorageServerId>/openAlertHistory\n Host: dbmgmt.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"alerts\": [\n {\n \"severity\": \"WARNING\",\n \"type\": \"STATEFUL\",\n \"timeStartAt\": \"2023-02-17T11:06:40.000Z\",\n \"message\": \"The changes are listed in /var/log\"\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageServer'
/externalExadataStorageServers/{externalExadataStorageServerId}/topSqlCpuActivity:
get:
description: 'Gets the SQL IDs with the top CPU activity from the Exadata storage server.
'
operationId: GetTopSqlCpuActivity
parameters:
- $ref: '#/components/parameters/ExternalExadataStorageServerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: A summary of sql top CPU activity.
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/TopSqlCpuActivity'
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'
summary: Get the SQL IDs with top cpu activity from Exadata storage server.
tags:
- dbManagement
x-example: "GET /20201101/externalExadataStorageServers/<externalExadataStorageServerId>/sqlTopCpuActivity\n Host: dbmgmt.us-phoenix-1.oraclecloud.com\n <authorization and other headers>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"activity\": [\n {\n \"databaseName\": \"other\",\n \"sqlId\": \"0000000000000\",\n \"cpuActivity\": 0.3508469\n },\n {\n \"databaseName\": \"CDB1.DBMAN_LAD\",\n \"sqlId\": \"g9wsbkb2jag3j\",\n \"cpuActivity\": 0.0013826478\n },\n {\n \"databaseName\": \"EDM1.PERFAPAC\",\n \"sqlId\": \"0000000000000\",\n \"cpuActivity\": 0.0013826478\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalExadataStorageServer'
/externalListeners:
get:
description: Lists the listeners in the specified external DB system.
operationId: ListExternalListeners
parameters:
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/ExternalDbSystemIdQueryParam'
- $ref: '#/components/parameters/DisplayNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The list of external listeners 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/ExternalListenerCollection'
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'
summary: Lists the external listeners.
tags:
- dbManagement
x-example: 'GET /20201101/externalListeners?compartmentId=<compartmentId>&externalDbSystemId=<externalDbSystemId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalListener'
/externalListeners/{externalListenerId}:
get:
description: 'Gets the details for the external listener specified by `externalListenerId`.
'
operationId: GetExternalListener
parameters:
- $ref: '#/components/parameters/ExternalListenerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external listener details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalListener'
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'
summary: Gets the external listener details.
tags:
- dbManagement
x-example: 'GET /20201101/externalListeners/<externalListenerId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalListener'
put:
description: 'Updates the external listener specified by `externalListenerId`.
'
operationId: UpdateExternalListener
parameters:
- $ref: '#/components/parameters/ExternalListenerIdPathParam'
- $ref: '#/components/parameters/UpdateExternalListenerDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the external listener is being updated.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates an external listener.
tags:
- dbManagement
x-example: "PUT /20201101/externalListeners/<externalListenerId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"externalConnectorId\": \"ocid1.test.oc1..EXAMPLE-externalConnectorId-Value\"\n}\n"
x-related-resource: '#/definitions/ExternalListener'
/externalListeners/{externalListenerId}/metrics:
get:
description: 'Gets metrics for the external listener specified by `externalListenerId`.
'
operationId: SummarizeExternalListenerMetrics
parameters:
- $ref: '#/components/parameters/ExternalListenerIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsStartTimeQueryParam'
- $ref: '#/components/parameters/DbSystemMetricsEndTimeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The external listener metrics were 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/MetricsAggregationRangeCollection'
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'
summary: Gets the external listener metrics.
tags:
- dbManagement
x-example: 'GET /20201101/externalListeners/<externalListenerId>/metrics?startTime=<startTime>&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalListener'
/externalListeners/{externalListenerId}/services:
get:
description: 'Lists the database services registered with the specified external listener
for the specified Managed Database.
'
operationId: ListExternalListenerServices
parameters:
- $ref: '#/components/parameters/ExternalListenerIdPathParam'
- $ref: '#/components/parameters/ManagedDatabaseIdRequiredQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByNameQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The database services registered with the external listener were 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/ExternalListenerServiceCollection'
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'
summary: Lists the database services registered with the external listener.
tags:
- dbManagement
x-example: 'GET /20201101/externalListeners/<externalListenerId>/services?managedDatabaseId=<managedDatabaseId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalListener'
/externalMySqlDatabaseConnectors:
get:
deprecated: true
description: 'Gets the list of External MySQL Database connectors.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListMySqlDatabaseConnectors
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ExternalDatabaseIdQueryParam'
- $ref: '#/components/parameters/FilterByNameParam'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of MySQL Database connectors 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/MySqlConnectorCollection'
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'
summary: 'Lists External MySql Connectors.
'
tags:
- dbManagement
x-example: 'GET /20201101/externalMySqlDatabaseConnectors?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
deprecated: true
description: 'Creates an external MySQL connector resource.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: CreateExternalMySqlDatabaseConnector
parameters:
- $ref: '#/components/parameters/CreateExternalMySqlDatabaseConnectorDetails'
- $ref: '#/components/parameters/IsTestConnectionParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The external MySQL Database Connector resource is successfully created.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabaseConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an external MySQL Database Connector resource.
tags:
- dbManagement
x-example: "POST /20201101/externalMySqlDatabaseConnectors\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \n \"displayName\": \"EXAMPLE-displayName-Value\",\n\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalMySqlDatabaseConnector'
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}:
delete:
deprecated: true
description: 'Deletes the Oracle Cloud Infrastructure resource representing an external MySQL database connector.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: DeleteExternalMySqlDatabaseConnector
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'The request to delete the ExternalMySqlDatabase Connector resource was accepted.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the External MySQL Database Connector resource.
tags:
- dbManagement
x-example: 'DELETE /20160918/externalMySqlDatabase/<externalMySqlDatabaseConnectorId>
Host: database.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalMySqlDatabaseConnector'
get:
deprecated: true
description: 'Retrieves the MySQL database connector.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetExternalMySqlDatabaseConnector
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseConnectorIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The connector information was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabaseConnector'
400:
$ref: '#/components/responses/400'
401:
description: Authorization information is missing or invalid. If autorization information is provided, check if correct privileges are assigned to the user calling this API.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get External MySQL Connector
tags:
- dbManagement
x-example: 'GET /20201101/externalMySqlDatabaseConnectors/<externalMySqlDatabaseConnectorId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalMySqlDatabase'
put:
deprecated: true
description: 'Updates the External Mysql Database Connector.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: UpdateExternalMysqlDatabaseConnector
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseConnectorIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UpdateExternalMySqlDatabaseConnectorDetails'
responses:
202:
description: The External Mysql Database was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabaseConnector'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates External Mysql Database Connector.
tags:
- dbManagement
x-related-resource: '#/definitions/ExternalMySqlDatabaseConnector'
/externalMySqlDatabaseConnectors/{externalMySqlDatabaseConnectorId}/actions/checkConnectionStatus:
post:
deprecated: true
description: 'Check the status of the external database connection specified in this connector.
This operation will refresh the connectionStatus and timeConnectionStatusLastUpdated fields.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: CheckExternalMySqlDatabaseConnectorConnectionStatus
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseConnectorIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request was successfully received and the status of the external database connection is being checked.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Check the status of the external database connection specified in this connector.
tags:
- dbManagement
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: SPECIAL_UPDATE
identifier: EXTERNAL_MYSQL_DATABASE
x-related-resource: '#/definitions/ExternalMySqlDatabaseConnector'
/externalMySqlDatabases:
get:
deprecated: true
description: 'Gets the list of External MySQL Databases.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: ListExternalMySqlDatabases
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/FilterByNameParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of MySQL Databases 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/ExternalMySqlDatabaseCollection'
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'
summary: 'Lists External MySql databases in a given compartment.
'
tags:
- dbManagement
x-example: 'GET /20201101/externalMySqlDatabases?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
post:
deprecated: true
description: 'Creates an external MySQL database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: CreateExternalMySqlDatabase
parameters:
- $ref: '#/components/parameters/CreateExternalMySqlDatabaseDetails'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The external MySQL resource is successfully created.
headers:
content-location:
description: Content Location of the resource.
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabase'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an external MySQL database resource.
tags:
- dbManagement
x-example: "POST /20201101/externalMySqlDatabase\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"dbName\": \"ExternalDB>\",\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalMySqlDatabase'
/externalMySqlDatabases/{externalMySqlDatabaseId}:
delete:
deprecated: true
description: 'Deletes the Oracle Cloud Infrastructure resource representing an external MySQL database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: DeleteExternalMySqlDatabase
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'The request to delete the ExternalMySqlDatabase resource was accepted.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the External MySQL Database resource.
tags:
- dbManagement
x-example: 'DELETE /20160918/externalMySqlDatabase/<externalMySqlDatabaseId>
Host: database.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ExternalMySqlDatabase'
get:
deprecated: true
description: 'Retrieves the external MySQL database information.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: GetExternalMySqlDatabase
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The external database information was retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabase'
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'
summary: Get External MySQL database information.
tags:
- dbManagement
x-example: 'GET /20201101/externalMySqlDatabases/<externalMySqlDatabaseId>/sqlData
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ExternalMySqlDatabase'
put:
deprecated: true
description: 'Updates the External Mysql Database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: UpdateExternalMysqlDatabase
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UpdateExternalMySqlDatabaseDetails'
responses:
200:
description: The External Mysql Database was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalMySqlDatabase'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates External Mysql Database.
tags:
- dbManagement
x-related-resource: '#/definitions/ExternalMySqlDatabase'
/externalMySqlDatabases/{externalMySqlDatabaseId}/actions/disableDatabaseManagement:
post:
deprecated: true
description: 'Disables Database Management for an external MySQL Database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: DisableExternalMySqlDatabaseManagement
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request was successfully received and Database Management is being disabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Disables Database Management for an external MySQL Database.
tags:
- dbManagement
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: EXTERNAL_MYSQL_DATABASE
x-related-resource: '#/definitions/ExternalMySqlDatabase'
/externalMySqlDatabases/{externalMySqlDatabaseId}/actions/enableDatabaseManagement:
post:
deprecated: true
description: 'Enables Database Management for an external MySQL Database.
MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
'
operationId: EnableExternalMySqlDatabaseManagement
parameters:
- $ref: '#/components/parameters/ExternalMySqlDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableExternalDatabaseManagementDetails'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The request was successfully received and Database Management is being enabled.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
summary: Enables Database Management for an external MySQL Database resource.
tags:
- dbManagement
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: EXTERNAL_MYSQL_DATABASE
x-related-resource: '#/definitions/ExternalMySqlDatabase'
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified external container database.
'
operationId: DisableExternalContainerDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableExternalContainerDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the external container database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for an external container Database.
tags:
- dbManagement
x-example: "POST /20201101/externalcontainerdatabases/<externalContainerDatabaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: EXTERNAL_CONTAINER_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables a Database Management feature for the specified external container database.
'
operationId: EnableExternalContainerDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableExternalContainerDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the external container database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management feature for the external Database.
tags:
- dbManagement
x-example: "POST /20201101/externalcontainerdatabases/<externalContainerDatabaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"connectorDetails\" : {\n \"connectorType\" : \"EXTERNAL\",\n \"databaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\",\n },\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: EXTERNAL_CONTAINER_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/externalcontainerdatabases/{externalContainerDatabaseId}/actions/modifyDatabaseManagement:
post:
description: 'Modifies a Database Management feature for the specified external container database.
'
operationId: ModifyExternalContainerDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalContainerDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableExternalContainerDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being modified for the external container database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies Database Management feature for the external Database.
tags:
- dbManagement
x-example: "POST /20201101/externalcontainerdatabases/<externalContainerDatabaseId>/actions/modifyDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"isAutoEnablePluggableDatabase\" : true\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified external non-container database.
'
operationId: DisableExternalNonContainerDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableExternalNonContainerDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the external non-container database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for an external non-container Database.
tags:
- dbManagement
x-example: "POST /20201101/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: EXTERNAL_NON_CONTAINER_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/externalnoncontainerdatabases/{externalNonContainerDatabaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables Database Management feature for the specified external non-container database.
'
operationId: EnableExternalNonContainerDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalNonContainerDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableExternalNonContainerDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the external non-container database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables a Database Management feature for the external non-container database.
tags:
- dbManagement
x-example: "POST /20201101/externalnoncontainerdatabases/<externalNonContainerDatabaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"connectorDetails\" : {\n \"connectorType\" : \"EXTERNAL\",\n \"databaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\",\n },\n \"licenseModel\": \"BRING_YOUR_OWN_LICENSE\"\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: EXTERNAL_NON_CONTAINER_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified external pluggable database.
'
operationId: DisableExternalPluggableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableExternalPluggableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the external pluggable database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for an external pluggable Database.
tags:
- dbManagement
x-example: "POST /20201101/externalpluggabledatabases/<externalPluggableDatabaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: EXTERNAL_PLUGGABLE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/externalpluggabledatabases/{externalPluggableDatabaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables a Database Management feature for the specified external pluggable database.
'
operationId: EnableExternalPluggableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/ExternalPluggableDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableExternalPluggableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the external pluggable database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management feature for the external pluggable Database.
tags:
- dbManagement
x-example: "POST /20201101/externalpluggabledatabases/<externalPluggableDatabaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"connectorDetails\" : {\n \"connectorType\" : \"EXTERNAL\",\n \"databaseConnectorId\": \"ocid1.externaldatabaseconnector..unique_ID\",\n }\n }\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: EXTERNAL_PLUGGABLE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/fleetMetrics:
get:
description: 'Gets the health metrics for a fleet of databases in a compartment or in a Managed Database Group.
Either the CompartmentId or the ManagedDatabaseGroupId query parameters must be provided to retrieve the health metrics.
'
operationId: GetDatabaseFleetHealthMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CompareBaselineTimeQueryParam'
- $ref: '#/components/parameters/CompareTargetTimeQueryParam'
- $ref: '#/components/parameters/CompareTypeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
- $ref: '#/components/parameters/FilterByDatabaseTypeParam'
- $ref: '#/components/parameters/FilterByDatbaseSubTypeParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/FleetPaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/FilterByDatabaseDeploymentTypeParam'
- $ref: '#/components/parameters/FilterByDatabaseVersionParam'
- $ref: '#/components/parameters/FilterByDefinedTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagEqualsQueryParam'
- $ref: '#/components/parameters/FilterByDefinedTagExistsQueryParam'
- $ref: '#/components/parameters/FilterByFreeformTagExistsQueryParam'
responses:
200:
description: The database fleet metrics for a compartment or Managed Database Group were 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/DatabaseFleetHealthMetrics'
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'
summary: Gets the health metrics for a fleet of databases.
tags:
- dbManagement
x-example: 'GET /20201101/fleetMetrics?compartmentId=<compartmentId>&compareBaselineTime=<compareBaselineTime>
&compareTargetTime=<compareTargetTime>&compareType=<compareType>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/jobExecutions:
get:
description: 'Gets the job execution for a specific ID or the list of job executions for a job, job run, Managed Database or Managed Database Group
in a specific compartment. Only one of the parameters, ID, jobId, jobRunId, managedDatabaseId or managedDatabaseGroupId should be provided.
If none of these parameters is provided, all the job executions in the compartment are listed. Job executions can also be filtered
based on the name and status parameters.
'
operationId: ListJobExecutions
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/JobIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/JobExecutionStatusQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/JobRunIdQueryParam'
responses:
200:
description: The job executions 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/JobExecutionCollection'
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'
summary: Lists job executions.
tags:
- dbManagement
x-example: 'GET /20201101/jobExecutions
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JobExecution'
/jobExecutions/{jobExecutionId}:
get:
description: 'Gets the details of the job execution specified by jobExecutionId.
'
operationId: GetJobExecution
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/JobExecutionIdPathParam'
responses:
200:
description: The job execution details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JobExecution'
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'
summary: Gets job execution details.
tags:
- dbManagement
x-example: 'GET /20201101/jobExecutions/<jobExecutionId>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
/jobExecutionsStatus:
get:
description: Gets the number of job executions grouped by status for a job, Managed Database, or Database Group in a specific compartment. Only one of the parameters, jobId, managedDatabaseId, or managedDatabaseGroupId should be provided.
operationId: SummarizeJobExecutionsStatuses
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseIdQueryParam'
- $ref: '#/components/parameters/StartTimeJobQueryParam'
- $ref: '#/components/parameters/EndTimeJobQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The job execution status summary was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JobExecutionsStatusSummaryCollection'
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'
summary: Gets a summary of the status of job executions.
tags:
- dbManagement
x-example: 'GET /20201101/jobExecutionStatusSummary?compartmentId=<compartmentId>&managedDatabaseId=<managedDatabaseId>&limit=10
&startTime=<startTime>&endTime=<endTime>
<authorization and other headers>
'
/jobRuns:
get:
description: 'Gets the job run for a specific ID or the list of job runs for a job, Managed Database or Managed Database Group
in a specific compartment. Only one of the parameters, ID, jobId, managedDatabaseId, or managedDatabaseGroupId
should be provided. If none of these parameters is provided, all the job runs in the compartment are listed.
Job runs can also be filtered based on name and runStatus parameters.
'
operationId: ListJobRuns
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/JobIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/JobRunStatusQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The job runs 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/JobRunCollection'
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'
summary: Lists job runs.
tags:
- dbManagement
x-example: 'GET /20201101/jobRuns?compartmentId=<compartmentId>&jobId=<jobId>&limit=10
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/JobRun'
/jobRuns/{jobRunId}:
get:
description: 'Gets the details of the job run specified by jobRunId.
'
operationId: GetJobRun
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/JobRunIdPathParam'
responses:
200:
description: The job run details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/JobRun'
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'
summary: Gets job run details.
tags:
- dbManagement
x-example: 'GET /20201101/jobRuns/<jobRunId>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
/jobs:
get:
description: 'Gets the job for a specific ID or the list of jobs for a Managed Database or Managed Database Group
in a specific compartment. Only one of the parameters, ID, managedDatabaseId or managedDatabaseGroupId,
should be provided. If none of these parameters is provided, all the jobs in the compartment are listed.
Jobs can also be filtered based on the name and lifecycleState parameters.
'
operationId: ListJobs
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseGroupIdQueryParam'
- $ref: '#/components/parameters/ManagedDatabaseIdQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/JobLifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The job 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/JobCollection'
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'
summary: Lists jobs.
tags:
- dbManagement
x-example: 'GET /20201101/jobs?compartmentId=<compartmentId>&managedDatabaseId=<managedDatabaseId>&limit=10
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Job'
post:
description: 'Creates a job to be executed on a Managed Database or Managed Database Group. Only one
of the parameters, managedDatabaseId or managedDatabaseGroupId should be provided as
input in CreateJobDetails resource in request body.
'
operationId: CreateJob
parameters:
- $ref: '#/components/parameters/CreateJobDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The job details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: A link to the created job.
schema:
type: string
format: url
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/Job'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a job.
tags:
- dbManagement
x-example: "POST /20201101/jobs\nHost: dbmgmt.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"name\": \"TestJob\",\n \"description\": \"Job to fetch the Performance data from database.\",\n \"databaseType\":\"CDB\",\n \"managedDatabaseId\": \"ocid1.externalcontainerdatabase.oc1..<unique_ID>\",\n \"scheduleType\": \"IMMEDIATE\",\n \"jobType\": \"SQL\",\n \"timeout\": \"5m\",\n \"resultLocation\": {\n \"type\": \"OBJECT_STORAGE\",\n \"namespaceName\": \"TestNamespace\",\n \"bucketName\": \"resultBucket\"\n },\n \"sqlType\": \"QUERY\",\n \"operationType\": \"EXECUTE_SQL\",\n \"sqlText\": \"SELECT SYSTIMESTAMP FROM DUAL\",\n \"userName\": \"TestJobUser\",\n \"password\": \"example-password\",\n \"role\": \"NORMAL\"\n}\n"
/jobs/{jobId}:
delete:
description: Deletes the job specified by jobId.
operationId: DeleteJob
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The job was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a job.
tags:
- dbManagement
x-example: 'DELETE /20201101/jobs/<jobId>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Job'
get:
description: 'Gets the details of the job specified by jobId.
'
operationId: GetJob
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/JobIdPathParam'
responses:
200:
description: The job details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: A link to the created job.
schema:
type: string
format: url
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/Job'
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'
summary: Gets job details.
tags:
- dbManagement
x-example: 'GET /20201101/jobs/<jobId>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: 'Updates the details of the recurring scheduled job specified by jobId. Note that non-recurring (one time) jobs cannot be updated.
'
operationId: UpdateJob
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/UpdateJobDetailsBodyParam'
responses:
200:
description: The job details were updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates job details.
tags:
- dbManagement
x-example: "PUT /20201101/jobs/<jobId>\nHost: dbmgmt.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"description\": \"Job to fetch the Performance data from database.\",\n \"timeout\": \"5m\",\n \"resultLocation\": {\n \"type\": \"OBJECT_STORAGE\",\n \"namespaceName\": \"TestNamespace\",\n \"bucketName\": \"resultBucket\"\n },\n \"scheduleDetails\": {\n \"startTime\": \"2021-07-11T21:46:38.076Z\",\n \"endTime\": \"2022-07-11T21:46:38.076Z\",\n \"intervalType\": \"DAILY\",\n \"intervalValue\": \"2\",\n },\n \"sqlText\": \"SELECT SYSTIMESTAMP FROM DUAL\",\n \"userName\": \"TestJobUser\",\n \"secretId\": \"ocid1.vaultsecret.oc1.<unique_ID>\",\n \"role\": \"NORMAL\"\n}\n"
/jobs/{jobId}/actions/changeCompartment:
post:
description: 'Moves a job.
'
operationId: ChangeJobCompartment
parameters:
- $ref: '#/components/parameters/JobIdPathParam'
- $ref: '#/components/parameters/ChangeJobCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The job was moved to the destination compartment successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves a job to a different compartment.
tags:
- dbManagement
x-example: "POST /20201101/jobs/<jobId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/Job'
/managedDatabaseGroups:
get:
description: 'Gets the Managed Database Group for a specific ID or the list of Managed Database Groups in
a specific compartment. Managed Database Groups can also be filtered based on the name parameter.
Only one of the parameters, ID or name should be provided. If none of these parameters is provided,
all the Managed Database Groups in the compartment are listed.
'
operationId: ListManagedDatabaseGroups
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/LifecycleStateQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of Managed Database Groups 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/ManagedDatabaseGroupCollection'
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'
summary: 'Lists Managed Database Groups.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabaseGroups?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabaseGroup'
post:
description: 'Creates a Managed Database Group. The group does not contain any
Managed Databases when it is created, and they must be added later.
'
operationId: CreateManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/CreateManagedDatabaseGroupDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Managed Database Group was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: A link to the newly created Managed Database Group.
schema:
type: string
format: url
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/ManagedDatabaseGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a Managed Database Group.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabaseGroups\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"name\": \"TestGroup\",\n \"description\": \"Sales test database group\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabaseGroup'
/managedDatabaseGroups/{managedDatabaseGroupId}:
delete:
description: 'Deletes the Managed Database Group specified by managedDatabaseGroupId.
If the group contains Managed Databases, then it cannot be deleted.
'
operationId: DeleteManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The Managed Database Group was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Managed Database Group.
tags:
- dbManagement
x-example: 'DELETE /20201101/managedDatabaseGroups/<managedDatabaseGroupId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabaseGroup'
get:
description: 'Gets the details of the Managed Database Group specified by managedDatabaseGroupId.
'
operationId: GetManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Managed Database Group details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedDatabaseGroup'
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'
summary: Gets Managed Database Group details.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabaseGroups/<managedDatabaseGroupId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabaseGroup'
put:
description: 'Updates the Managed Database Group specified by managedDatabaseGroupId.
'
operationId: UpdateManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UpdateManagedDatabaseGroupDetailsBodyParam'
responses:
200:
description: The Managed Database Group was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedDatabaseGroup'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Managed Database Group.
tags:
- dbManagement
x-example: "PUT /20201101/managedDatabaseGroups/<managedDatabaseGroupId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"description\": \"Test database group\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabaseGroup'
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/addManagedDatabase:
post:
description: 'Adds a Managed Database to a specific Managed Database Group.
After the database is added, it will be included in the
management activities performed on the Managed Database Group.
'
operationId: AddManagedDatabaseToManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/AddManagedDatabaseToManagedDatabaseGroupDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Managed Database was added to the Managed Database Group successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Adds a Managed Database to a Managed Database Group.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabaseGroups/<managedDatabaseGroupId>/actions/addManagedDatabase\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"<managedDatabaseId>\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabaseGroup'
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/changeCompartment:
post:
description: 'Moves a Managed Database Group to a different compartment.
The destination compartment must not have a Managed Database Group
with the same name.
'
operationId: ChangeManagedDatabaseGroupCompartment
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/ChangeManagedDatabaseGroupCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The Managed Database Group was moved to the destination compartment successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves a Managed Database Group.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabaseGroups/<managedDatabaseGroupId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabaseGroup'
/managedDatabaseGroups/{managedDatabaseGroupId}/actions/removeManagedDatabase:
post:
description: 'Removes a Managed Database from a Managed Database Group. Any management
activities that are currently running on this database will continue to
run to completion. However, any activities scheduled to run in the future
will not be performed on this database.
'
operationId: RemoveManagedDatabaseFromManagedDatabaseGroup
parameters:
- $ref: '#/components/parameters/ManagedDatabaseGroupIdPathParam'
- $ref: '#/components/parameters/RemoveManagedDatabaseFromManagedDatabaseGroupDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The Managed Database was removed from the Managed Database Group successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Removes a Managed Database from a Managed Database Group.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabaseGroups/<managedDatabaseGroupId>/actions/removeManagedDatabase\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"managedDatabaseId\": \"<managedDatabaseId>\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabaseGroup'
/managedDatabases:
get:
description: 'Gets the Managed Database for a specific ID or the list of Managed Databases in a specific compartment.
Managed Databases can be filtered based on the name parameter. Only one of the parameters, ID or name
should be provided. If neither of these parameters is provided, all the Managed Databases in the compartment
are listed. Managed Databases can also be filtered based on the deployment type and management option.
If the deployment type is not specified or if it is `ONPREMISE`, then the management option is not
considered and Managed Databases with `ADVANCED` management option are listed.
'
operationId: ListManagedDatabases
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/IdOptionalQueryParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/ManagementOptionQueryParam'
- $ref: '#/components/parameters/DeploymentTypeQueryParam'
- $ref: '#/components/parameters/ExternalExadataInfrastructureIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of Managed Databases 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/ManagedDatabaseCollection'
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'
summary: 'Lists Managed Databases.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}:
get:
description: 'Gets the details of the Managed Database specified by managedDatabaseId.
'
operationId: GetManagedDatabase
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Managed Database details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedDatabase'
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'
summary: Gets Managed Database details.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
put:
description: 'Updates the Managed Database specified by managedDatabaseId.
'
operationId: UpdateManagedDatabase
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UpdateManagedDatabaseDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
200:
description: The Managed Database details were updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/ManagedDatabase'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates Managed Database details.
tags:
- dbManagement
x-example: "PUT /20201101/managedDatabases/<managedDatabaseId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"freeformTags\": {\"tagKey\" : \"tagValue\"},\n \"definedTags\": { \"tagNamespace\" : {\"tagKey\" : \"tagValue\"} }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/actions/changeDatabaseParameters:
post:
description: 'Changes database parameter values. There are two kinds of database
parameters:
- Dynamic parameters: They can be changed for the current Oracle
Database instance. The changes take effect immediately.
- Static parameters: They cannot be changed for the current instance.
You must change these parameters and then restart the database before
changes take effect.
**Note:** If the instance is started using a text initialization
parameter file, the parameter changes are applicable only for the
current instance. You must update them manually to be passed to
a future instance.
'
operationId: ChangeDatabaseParameters
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ChangeDatabaseParametersDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The changes to database parameter values were executed. You can
check the status for each parameter in the response.
'
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/UpdateDatabaseParametersResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes database parameter values.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/actions/changeDatabaseParameters\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"userName\": \"TestUser\",\n \"password\": \"example-password\",\n \"role\": \"NORMAL\"\n },\n \"scope\": \"BOTH\",\n \"parameters\": [\n {\n \"name\": \"open_cursors\",\n \"value\": \"500\",\n \"updateComment\": \"Increase open cursors\"\n },\n {\n \"name\": \"sql_trace\",\n \"value\": \"false\",\n \"updateComment\": \"Disable sql trace\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/actions/generateAwrSnapshot:
post:
description: 'Creates an AWR snapshot for the target database.
'
operationId: GenerateAwrSnapshot
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/OptionalRequestIdAddm'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The ID of the newly generated AWR snapshot was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about
a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotDetails'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates an AWR snapshot for the target database.
tags:
- dbManagement
x-example: 'POST /20201101/managedDatabases/<databaseId>/actions/generateAwrSnapshot
Host: database.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/managedDatabases/{managedDatabaseId}/actions/resetDatabaseParameters:
post:
description: 'Resets database parameter values to their default or startup values.
'
operationId: ResetDatabaseParameters
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ResetDatabaseParametersDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The database parameters reset operation was executed. You can
check the status for each parameter in the response.
'
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/UpdateDatabaseParametersResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Resets database parameter values.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/actions/resetDatabaseParameters\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"userName\": \"TestUser\",\n \"password\": \"example-password\",\n \"role\": \"NORMAL\"\n },\n \"scope\": \"BOTH\",\n \"parameters\": [\n \"open_cursors\"\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/actions/runHistoricAddm:
post:
description: 'Creates and executes a historic ADDM task using the specified AWR snapshot IDs. If an existing ADDM task
uses the provided awr snapshot IDs, the existing task will be returned.
'
operationId: RunHistoricAddm
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/OptionalRequestIdAddm'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: 'The historic ADDM task for the specified AWR snapshot IDs was retrieved successfully.
If an ADDM task does not exist for the specified snapshot IDs, then a new task is created.
'
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/HistoricAddmResult'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates and executes a historic ADDM task using the specified AWR snapshot IDs.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<databaseId>/actions/runHistoricAddm\nHost: database.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"startSnapshotId\" : 123,\n \"endSnapshotId\" : 127\n}\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunHistoricAddmDetails'
description: The details of the ADDM task, which include the beginning and ending AWR snapshot IDs.
required: true
/managedDatabases/{managedDatabaseId}/addmTasks:
get:
description: 'Lists the metadata for each ADDM task who''s end snapshot time falls within the provided start and end time. Details include
the name of the ADDM task, description, user, status and creation date time.
'
operationId: AddmTasks
parameters:
- $ref: '#/components/parameters/OptionalRequestIdAddm'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ListAddmStartTimeQueryParam'
- $ref: '#/components/parameters/ListAddmEndTimeQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/ListAddmSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of ADDM tasks metadata 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/AddmTasksCollection'
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'
summary: Lists the ADDM tasks who's end snapshot time falls within the provided time range.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/{managedDatabaseId}/addmTasks?startTime=2022-16-02T22:00:00.00Z&endTime=2022-17-02T22:00:00.00Z&pageToken=token&limit=limitToken
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
/managedDatabases/{managedDatabaseId}/asmProperties:
get:
description: Gets the list of ASM properties for the specified managedDatabaseId.
operationId: ListAsmProperties
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The list of ASM properties 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/AsmPropertyCollection'
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'
summary: Gets a list of ASM properties for a Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/asmProperties
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/availabilityMetrics:
get:
description: 'Gets the availability metrics related to managed database for the Oracle
database specified by managedDatabaseId.
'
operationId: SummarizeManagedDatabaseAvailabilityMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
responses:
200:
description: 'The availability metrics for a given managed database.
'
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/MetricsAggregationRangeCollection'
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'
summary: 'Gets availability metrics of given managed database.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/availabilityMetrics?startTime=<startTime>
&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges:
get:
description: 'Summarizes the AWR snapshot ranges that contain continuous snapshots, for the specified Managed Database.
'
operationId: SummarizeAwrDbSnapshotRanges
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EntityNameOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/AwrDbSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of AWR snapshot ranges was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbSnapshotRangeCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes AWR snapshot ranges.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/awrDbSnapshotRanges\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SNAPSHOT_RANGE_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"dbId\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [\"1\"],\n \"timeDbStartup\": \"2020-10-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-10-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-11-04T19:00:29Z\",\n \"firstSnapshotId\": 2,\n \"latestSnapshotId\": 5,\n \"snapshotCount\": 4,\n \"snapshotIntervalInMin\": 60,\n \"containerId\": 0,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"dbId\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [\"1\"],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotId\": 48,\n \"latestSnapshotId\": 248,\n \"snapshotCount\": 201,\n \"snapshotIntervalInMin\": 60,\n \"containerId\": 0,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"dbId\": 1586624638,\n \"dbName\":\"db2\",\n \"instanceList\": [\"1\"],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotId\": 4,\n \"latestSnapshotId\": 8,\n \"snapshotCount\": 5,\n \"snapshotIntervalInMin\": 60,\n \"containerId\": 0,\n \"dbVersion\": \"18.0.0.0.0\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs:
get:
description: 'Gets the list of databases and their snapshot summary details available in the AWR of the specified Managed Database.
'
operationId: ListAwrDbs
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EntityNameOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/AwrDbSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of databases and their snapshot summary details was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets a list of AWR database information.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/AwrDbs\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SET\",\n \"version\": \"1.0\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [{\n \"dbId\": 1586624637,\n \"dbName\":\"PGVADW1(Linux x86 64-bit)\",\n \"instanceList\": [\"1\"],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:00Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotId\": 48,\n \"latestSnapshotId\": 248,\n \"snapshotCount\": 201,\n \"snapshotIntervalInMin\": 60,\n \"containerId\": 0,\n \"dbVersion\": \"19.0.0.0.0\"\n },{\n \"dbId\": 1586624638,\n \"dbName\":\"db2\",\n \"instanceList\": [\"1\"],\n \"timeDbStartup\": \"2020-11-24T18:53Z\",\n \"timeFirstSnapshotBegin\": \"2020-11-26T18:00:13Z\",\n \"timeLatestSnapshotEnd\": \"2020-12-04T19:00:29Z\",\n \"firstSnapshotId\": 4,\n \"latestSnapshotId\": 8,\n \"snapshotCount\": 5,\n \"snapshotIntervalInMin\": 60,\n \"containerId\": 0,\n \"dbVersion\": \"18.0.0.0.0\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbCpuUsages:
get:
description: 'Summarizes the AWR CPU resource limits and metrics for the specified database in AWR.
'
operationId: SummarizeAwrDbCpuUsages
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/SessionTypeQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbCpuSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of AWR CPU resource limit and metric samples was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbCpuUsageCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes AWR CPU usage data.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbCpuUsages\n snapshotIdGreaterThanOrEqualTo=5&snapshotIdLessThanOrEqualTo=10\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_ASH_CPU_USAGE_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"numCpuCores\": 11,\n \"cpuCount\": 8,\n \"numCpus\": 8,\n \"items\": [\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\":.66\n },\n {\n \"timestamp\": \"2020-12-04T14:02:00Z\", \"avgValue\":.68\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbMetrics:
get:
description: 'Summarizes the metric samples for the specified database in the AWR. The metric samples are summarized based on the Time dimension for each metric.
'
operationId: SummarizeAwrDbMetrics
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/EntityNamesQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbNameSampledTimeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of the AWR metric samples was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbMetricCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes metric samples for the specified database.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrMetricCollection?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=average active sessions\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_METRICS_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": .66, \"minValue\": 0.5, \"maxValue\": 0.8, \"name\":\"Average Active Sessions\"\n },\n {\n \"timestamp\": \"2020-12-04T14:01:00Z\", \"avgValue\": .6, \"minValue\": 0.4, \"maxValue\": 0.9, \"name\":\"Average Active Sessions\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges:
get:
description: 'Summarizes the database parameter change history for one database parameter of the specified database in AWR. One change history record contains
the previous value, the changed value, and the corresponding time range. If the database parameter value was changed multiple times within the time range, then multiple change history records are created for the same parameter.
Note that this API only returns information on change history details for one database parameter.
To get a list of all the database parameters whose values were changed during a specified time range, use the following API endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters
'
operationId: SummarizeAwrDbParameterChanges
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/EntityNameQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbNameChangeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of AWR database parameter change history for the given database parameter was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbParameterChangeCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarize the AWR database parameter change history.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbParameterHistoryCollection\n snapshotIdGreaterThanOrEqualTo=5&snapshotIdLessThanOrEqualTo=10&name=_datapump_inherit_svcname\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n\n{\n \"name\": \"AWRDB_DB_PARAMETER_CHANGE\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"prevValue\": \"v1\", \"value\": \"v2\", \"snapshotId\": 5, \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\"\n },\n {\n \"prevValue\": \"v2\", \"value\": \"v3\", \"snapshotId\": 6, \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameters:
get:
description: 'Summarizes the database parameter history for the specified database in AWR. This includes the list of database
parameters, with information on whether the parameter values were modified within the query time range. Note that
each database parameter is only listed once. Depending on the optional query parameters, the returned summary gets all the database parameters, which include:
- Each parameter whose value was changed during the time range: (valueChanged ="Y")
- Each parameter whose value was unchanged during the time range: (valueChanged ="N")
- Each parameter whose value was changed at the system level during the time range: (valueChanged ="Y" and valueModified = "SYSTEM_MOD")
- Each parameter whose value was unchanged during the time range, however, the value is not the default value: (valueChanged ="N" and valueDefault = "FALSE")
Note that this API does not return information on the number of times each database parameter has been changed within the time range. To get the database parameter value change history for a specific parameter, use the following API endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbParameterChanges
'
operationId: SummarizeAwrDbParameters
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/EntityNamesOptionalQueryParam'
- $ref: '#/components/parameters/EntityNameContainsFilterOptionalQueryParam'
- $ref: '#/components/parameters/AwrDbParameterValueOptionalQueryParam'
- $ref: '#/components/parameters/AwrDbParameterDefaultOptionalQueryParam'
- $ref: '#/components/parameters/AwrDbParameterModifiedOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbNameChangeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of AWR database parameters was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbParameterCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarize AWR datbase parameter history information.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbParameters\n snapshotIdGreaterThanOrEqualTo=5&snapshotIdLessThanOrEqualTo=10&name=_datapump_inherit_svcname\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_PARAMETER_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"_datapump_inherit_svcname\", \"beginValue\": \"v1\", \"endValue\": \"v2\", \"isChanged\": true\n },\n {\n \"name\":\"parameter2\", \"beginValue\": \"v1\", \"endValue\": null, \"isChanged\": false\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport:
get:
description: 'Gets the AWR report for the specified database.
'
operationId: GetAwrDbReport
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumbersOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrDbReportTypeQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/ReportFormatQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The AWR report was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the AWR database report.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbReport?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_REPORT\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"content\": \"...\",\n \"format\":\"HTML\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots:
get:
description: 'Lists AWR snapshots for the specified database in the AWR.
'
operationId: ListAwrDbSnapshots
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/AwrDbSnapSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of AWR snapshots was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbSnapshotCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List the AWR snapshots for one database.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/awrDbs/<awrDbId>/awrDbSnapshots\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SNAPSHOT_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"dbId\": 1586624637,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"snapshotId\": 216,\n \"errorCount\": 0,\n \"timeBegin\": \"2020-12-03T18:00:41Z\",\n \"timeEnd\": \"2020-12-03T19:00:50Z\"\n },\n {\n \"dbId\": 1586624637,\n \"instanceNumber\": 1,\n \"timeDbStartup\": \"2020-11-24T18:53:46Z\",\n \"snapshotId\": 217,\n \"errorCount\": 0,\n \"timeBegin\": \"2020-12-03T19:00:53Z\",\n \"timeEnd\": \"2020-12-03T20:00:55Z\"\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSqlReport:
get:
description: 'Gets the SQL health check report for one SQL of the specified database.
'
operationId: GetAwrDbSqlReport
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/SqlIdQueryParam'
- $ref: '#/components/parameters/ReportFormatQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The AWR report for the SQL statement was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbSqlReport'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the SQL health check report for the SQL statement specified by the SQL ID.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbSqlReport?\n snapshotIdGreaterThanOrEqualTo=5&snapshotIdLessThanOrEqualTo=10&sqlId=g6gu1n3x0h1h4\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_DB_SQL_REPORT\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"content\": \"...\",\n \"format\":\"HTML\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSysstats:
get:
description: 'Summarizes the AWR SYSSTAT sample data for the specified database in AWR. The statistical data is summarized based on the Time dimension for each statistic.
'
operationId: SummarizeAwrDbSysstats
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/EntityNamesQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbNameSampledBeginTimeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of the AWR SYSSTAT sample data was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbSysstatCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes AWR Sysstat sample data for one database.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrSysstats?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=user calls\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_SYSSTAT_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\", \"avgValue\": .66, \"currentValue\": 0.5\n },\n {\n \"name\":\"user logouts cumulative\", \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\", \"avgValue\": .6, \"currentValue\": 0.4\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbTopWaitEvents:
get:
description: 'Summarizes the AWR top wait events.
'
operationId: SummarizeAwrDbTopWaitEvents
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/SessionTypeQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/AwrDbTopNQueryParam'
- $ref: '#/components/parameters/AwrDbTopEventSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of AWR top wait events was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbTopWaitEventCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes AWR top N wait events.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbTopWaitEvents?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_TOP_EVENT_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"avgWaitTimePerSec\": .66, \"waitsPerSec\": 0.5\n },\n {\n \"name\":\"event 2\", \"avgWaitTimePerSec\": .6, \"waitsPerSec\": 0.4\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEventBuckets:
get:
description: 'Summarizes AWR wait event data into value buckets and frequency, for the specified database in the AWR.
'
operationId: SummarizeAwrDbWaitEventBuckets
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/EntityNameQueryParam'
- $ref: '#/components/parameters/AwrNumBucketOptionalQueryParam'
- $ref: '#/components/parameters/AwrMinValueOptionalQueryParam'
- $ref: '#/components/parameters/AwrMaxValueOptionalQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbCategoryPercSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of AWR wait event data in value buckets was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbWaitEventBucketCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarize AWR event data into value buckets and frequencies for one database.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/awrDbs/<awrDbId>/awrDbWaitEventBuckets\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_EVENT_HISTOGRAM_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"categroy\":\" < 2um\", \"percentage\": 0.2\n },\n {\n \"categroy\":\" < 3um\", \"percentage\": 0.\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbWaitEvents:
get:
description: 'Summarizes the AWR wait event sample data for the specified database in the AWR. The event data is summarized based on the Time dimension for each event.
'
operationId: SummarizeAwrDbWaitEvents
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/AwrDbIdPathParam'
- $ref: '#/components/parameters/InstNumberOptionalQueryParam'
- $ref: '#/components/parameters/BeginSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/EndSnapshotOptionalQueryParam'
- $ref: '#/components/parameters/AwrBeginTimeOptionalQueryParam'
- $ref: '#/components/parameters/AwrEndTimeOptionalQueryParam'
- $ref: '#/components/parameters/EntityNamesOptionalQueryParam'
- $ref: '#/components/parameters/SessionTypeQueryParam'
- $ref: '#/components/parameters/ContainerIdOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLargeLimitQueryParam'
- $ref: '#/components/parameters/AwrDbNameSampledBeginTimeSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The summary of the AWR wait event sample data was retrieved successfully.
headers:
opc-next-page:
description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,
then a partial list might have been returned. Include this value as the `page` parameter for the
subsequent GET request to get the next batch of items.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AwrDbWaitEventCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Summarizes AWR wait event sample data.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>awrDbs/<awrDbId>/awrDbWaitEvents?\n timeGreaterThanOrEqualTo=2021-03-01T22:00:00.00Z&timeLessThanOrEqualTo=2021-03-04T22:00:00.00Z&name=db filenbsp;sequentialnbsp;read\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"AWRDB_EVENT_SET\",\n \"version\": \"1.0\",\n \"queryKey\": \"Q-123\",\n \"dbQueryTimeInSecs\": 1.2,\n \"items\": [\n {\n \"name\":\"user logouts cumulative\", \"snapshotId\": 5, \"timeBegin\": \"2020-12-04T14:01:00Z\", \"timeEnd\": \"2020-12-04T14:02:00Z\", \"avgWaitTimePerSec\": .66, \"waitsPerSec\": 0.5\n },\n {\n \"name\":\"user logouts cumulative\", \"snapshotId\": 6, \"timeBegin\": \"2020-12-04T14:02:00Z\", \"timeEnd\": \"2020-12-04T14:03:00Z\", \"avgWaitTimePerSec\": .6, \"waitsPerSec\": 0.4\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/clusterCacheMetrics:
get:
description: 'Gets the metrics related to cluster cache for the Oracle
Real Application Clusters (Oracle RAC) database specified
by managedDatabaseId.
'
operationId: GetClusterCacheMetric
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
responses:
200:
description: 'The cluster cache metrics for a specific Oracle Real Application Clusters (Oracle RAC) database.
'
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/ClusterCacheMetric'
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'
summary: 'Gets a detailed summary of various cluster cache metrics.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/clusterCacheMetrics?startTime=<startTime>
&endTime=<endTime>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ClusterCacheMetric'
/managedDatabases/{managedDatabaseId}/cursorCacheStatements:
get:
description: 'Lists the SQL statements from shared SQL area, also called the cursor cache.
'
operationId: ListCursorCacheStatements
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/SqlTextOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SqlStatementSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of SQL statements from cursor cache were 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/CursorCacheStatementCollection'
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'
summary: Lists the SQL statements from shared SQL area, also called the cursor cache.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/cursorCacheStatements\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"sqlId\": \"798sjnwans009\",\n \"schema\": \"SYSMAN\",\n \"sqlText\": \"SELECT AVAIL_ENABLED FROM MGMT_GENSVC_AVAIL_CONFIG WHERE TARGET_GUID = :B1\"\n },\n {\n \"sqlId\": \"bgxygds5y800p\",\n \"schema\": \"SYSMAN\",\n \"sqlText\": \"SELECT JOB_NAME FROM EM_LOADERJOB_QUEUE_PAYLOAD WHERE PAYLOAD_ID = :B1\"\n },\n {\n \"sqlId\": \"4qd95s5fg0002\",\n \"schema\": \"DBSNMP\",\n \"sqlText\": \"select count(*) from sys.seg$ s where s.ts# = :p3 and ( s.extsize * :p2) > (1024 * :p1)\"\n },\n {\n \"sqlId\": \"94qn6y14kw01g\",\n \"schema\": \"SYS\",\n \"sqlText\": \"SELECT NVL(TO_NUMBER(EXTRACT(XMLTYPE(:B2 ), :B1 )), 0) FROM DUAL\"\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/databaseParameters:
get:
description: 'Gets the list of database parameters for the specified Managed Database. The parameters are listed in alphabetical order, along with their current values.
'
operationId: ListDatabaseParameters
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ParameterSourceQueryParam'
- $ref: '#/components/parameters/ParameterNameQueryParam'
- $ref: '#/components/parameters/IsAllowedValuesIncludedQueryParam'
- $ref: '#/components/parameters/ParametersSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of database parameters was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseParametersCollection'
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'
summary: 'Lists database parameters.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/databaseParameters
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/dataguardPerformanceMetrics:
get:
description: "Gets a historical summary of the Database Guard performance metrics for Managed Databases.\nIf the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. \nIf the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.\n"
operationId: GetDataguardPerformanceMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/PeerDatabaseCompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The historical summary of the Data Guard performance metrics was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DataguardPerformanceMetrics'
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'
summary: Gets a summary of the Data Guard performance metrics like ApplyLag, TransportLag and RedoApplyRate metrics for the Managed Databases.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/dataguardPerformanceMetrics?startTime=<startTime>
&endTime=<endTime>&compartmentId=<compartmentId>
&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/DataguardPerformanceMetrics'
/managedDatabases/{managedDatabaseId}/haBackupDetails:
get:
description: 'Gets HA and backup details with metrics and backup history for a single database.
'
operationId: GetDatabaseHaBackupDetails
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: 'The HA and backup details with metrics and backup history for a single database were retrieved successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseHaBackupDetails'
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'
summary: 'Gets HA and backup details with metrics and backup history for a single database.
'
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/haBackupDetails
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/DatabaseHaBackupDetails'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions:
get:
description: 'Lists the details of the Optimizer Statistics Advisor task executions, such as their duration, and the number of findings, if any.
Optionally, you can specify a date-time range (of seven days) to obtain the list of executions that fall within the specified time range.
If the date-time range is not specified, then the executions in the last seven days are listed.
'
operationId: ListOptimizerStatisticsAdvisorExecutions
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/EndTimeLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The details of the Optimizer Statistics Advisor task executions were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizerStatisticsAdvisorExecutionsCollection'
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'
summary: Lists the optimizer advisor task executions scan details and their findings count.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsAdvisorExecutions
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}:
get:
description: 'Gets a comprehensive report of the Optimizer Statistics Advisor execution, which includes details of the
Managed Database, findings, recommendations, rationale, and examples.
'
operationId: GetOptimizerStatisticsAdvisorExecution
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ExecutionNamePathParam'
- $ref: '#/components/parameters/TaskNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The comprehensive report of the Optimizer Statistics Advisor execution was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizerStatisticsAdvisorExecution'
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'
summary: Gets the optimizer statistics advisor task execution detailed report.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsAdvisorExecutions/<executionName>?taskName=value
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
? /managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/actions/implementRecommendations
: post:
description: Asynchronously implements the findings and recommendations of the Optimizer Statistics Advisor execution.
operationId: ImplementOptimizerStatisticsAdvisorRecommendations
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ExecutionNamePathParam'
- $ref: '#/components/parameters/ImplementOptimizerStatisticsAdvisorRecommendationsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: The newly created job details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
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'
summary: Implements the Optimizer Statistics Advisor task recommendations asynchronously.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsAdvisorExecutions/<executionName>/actions/implementRecommendations\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"taskName\": \"AUTO_STATS_ADVISOR_TASK\",\n \"jobDetails\": {\n \"compartmentId\": \"ocid1.tenancy.oc1..<unique_ID>\",\n \"name\": \"TestJob\",\n \"description\": \"The job created to implement the recommendations of the Optimizer Statistics Advisor.\",\n \"resultLocation\": {\n \"type\": \"OBJECT_STORAGE\",\n \"namespaceName\": \"TestNamespace\",\n \"bucketName\": \"resultBucket\"\n },\n \"credentials\": {\n \"credentialType\": \"PASSWORD\",\n \"username\": \"TestUser\",\n \"password\": \"testPwd\",\n \"role\": \"NORMAL\"\n }\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsAdvisorExecutions/{executionName}/script:
get:
description: Gets the Oracle system-generated script for the specified Optimizer Statistics Advisor execution.
operationId: GetOptimizerStatisticsAdvisorExecutionScript
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ExecutionNamePathParam'
- $ref: '#/components/parameters/TaskNameQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The Oracle system-generated script for the specified Optimizer Statistics Advisor execution was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizerStatisticsAdvisorExecutionScript'
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'
summary: Gets the optimizer statistics advisor execution script for the provided task and execution name.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsAdvisorExecutions/<executionName>/script?taskName=value
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionAggregations:
get:
description: 'Gets a list of the optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.
You must specify a value for GroupByQueryParam to determine whether the data should be grouped by task status or task object status.
Optionally, you can specify a date-time range (of seven days) to obtain collection aggregations within the specified time range.
If the date-time range is not specified, then the operations in the last seven days are listed.
You can further filter the results by providing the optional type of TaskTypeQueryParam.
If the task type not provided, then both Auto and Manual tasks are considered for aggregation.
'
operationId: ListOptimizerStatisticsCollectionAggregations
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/EndTimeLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TaskTypeQueryParam'
- $ref: '#/components/parameters/GroupByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: 'The list of the optimizer statistics collection operations per hour, grouped by task or object status
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/OptimizerStatisticsCollectionAggregationsCollection'
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'
summary: Lists the number of optimizer statistics collection operations per hour, grouped by task or object status for the specified Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsCollectionAggregations?groupBy=TASK_STATUS
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations:
get:
description: 'Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database.
The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on.
Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range.
If the date-time range is not specified, then the operations in the last seven days are listed.
This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page.
If you use the same header value in a consecutive request, the next page records are returned.
To obtain the required results, you can apply the different types of filters supported by this API.
'
operationId: ListOptimizerStatisticsCollectionOperations
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeGreaterThanOrEqualToQueryParam'
- $ref: '#/components/parameters/EndTimeLessThanOrEqualToQueryParam'
- $ref: '#/components/parameters/TaskTypeQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/OptimizerStatisticsFilterByQueryParam'
- $ref: '#/components/parameters/OptimizerStatsOperationsSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The Optimizer Statistics Collection operation summary 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/OptimizerStatisticsCollectionOperationsCollection'
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'
summary: This API returns a detailed summary of optimizer statistics collection operations.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsCollectionOperations
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/optimizerStatisticsCollectionOperations/{optimizerStatisticsCollectionOperationId}:
get:
description: Gets a detailed report of the Optimizer Statistics Collection operation for the specified Managed Database.
operationId: GetOptimizerStatisticsCollectionOperation
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/OperationIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The detailed report of the Optimizer Statistics Collection operation was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizerStatisticsCollectionOperation'
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'
summary: The API gets the optimizer statistics collection operation detailed report for the provided managed database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/optimizerStatisticsCollectionOperations/<optimizerStatisticsCollectionOperationId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/pdbMetrics:
get:
description: 'Gets a summary of the resource usage metrics such as CPU, User I/O, and Storage for each
PDB within a specific CDB. If comparmentId is specified, then the metrics for
each PDB (within the CDB) in the specified compartment are retrieved.
If compartmentId is not specified, then the metrics for all the PDBs within the CDB are retrieved.
'
operationId: GetPdbMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CompareTypeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The summary of resource usage metrics for PDBs within a specific CDB was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PdbMetrics'
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'
summary: Gets a summary of the resource usage metrics like DB Time, CPU, User I/O, Wait, Storage, and Memory metrics for Pdb's under the container database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/pdbMetrics?startTime=<startTime>
&endTime=<endTime>&compartmentId=<compartmentId>
&compareType=<compareType>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PdbMetrics'
/managedDatabases/{managedDatabaseId}/peerDatabaseMetrics:
get:
description: "Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.\nIf the peerDatabaseCompartmentId is specified, then the metrics are only retrieved from the specified compartment. \nIf the peerDatabaseCompartmentId is not specified, then the metrics are retrieved from the compartment of the Managed Database specified by the ManagedDatabaseId.\n"
operationId: GetPeerDatabaseMetrics
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/StartTimeQueryParam'
- $ref: '#/components/parameters/EndTimeQueryParam'
- $ref: '#/components/parameters/PeerDatabaseCompartmentIdOptionalQueryParam'
- $ref: '#/components/parameters/CompareTypeQueryParam'
- $ref: '#/components/parameters/MetricNameFilterParam'
responses:
200:
description: The comparative summary of the baseline and target values of the Data Guard performance metrics was retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PeerDatabaseMetrics'
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'
summary: Gets a comparative summary of the baseline and target values of the Data Guard performance metrics for Managed Databases.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/peerDatabaseMetrics?startTime=<startTime>
&endTime=<endTime>&peerDatabaseCompartmentId=<peerDatabaseCompartmentId>
&compareType=<compareType>&filterByMetricNames=<filterByMetricNames>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PeerDatabaseMetrics'
/managedDatabases/{managedDatabaseId}/preferredCredentials:
get:
description: 'Gets the list of preferred credentials for a given Managed Database.
'
operationId: ListPreferredCredentials
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
responses:
200:
description: The preferred credentials were 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/PreferredCredentialCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the list of preferred credentials for the given Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/preferredCredentials
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PreferredCredential'
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}:
delete:
description: 'Deletes the preferred credential based on the credentialName.
'
operationId: DeletePreferredCredential
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/CredentialNamePathParam'
responses:
204:
description: The preferred credential was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Delete the preferred credential.
tags:
- dbManagement
x-example: 'DELETE /20201101/managedDatabases/<managedDatabaseId>/preferredCredentials/<credentialName>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PreferredCredential'
get:
description: 'Gets the preferred credential details for a Managed Database based on credentialName.
'
operationId: GetPreferredCredential
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/CredentialNamePathParam'
responses:
200:
description: The preferred credential details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PreferredCredential'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Gets the preferred credential based on credentialName path attribute.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/preferredCredentials/<credentialName>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PreferredCredential'
put:
description: 'Updates the preferred credential based on the credentialName.
'
operationId: UpdatePreferredCredential
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/CredentialNamePathParam'
- $ref: '#/components/parameters/UpdatePreferredCredentialBodyParam'
responses:
200:
description: The preferred credential was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/PreferredCredential'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Update the details of preferred credential.
tags:
- dbManagement
x-example: 'PUT /20201101/managedDatabases/<managedDatabaseId>/preferredCredentials/<credentialName>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PreferredCredential'
/managedDatabases/{managedDatabaseId}/preferredCredentials/{credentialName}/actions/test:
post:
description: 'Tests the preferred credential.
'
operationId: TestPreferredCredential
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/CredentialNamePathParam'
- $ref: '#/components/parameters/TestPreferredCredentialBodyParam'
responses:
200:
description: The preferred credential was tested successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TestPreferredCredentialStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Status of the test preferred credential.
tags:
- dbManagement
x-example: 'POST /20201101/managedDatabases/<managedDatabaseId>/preferredCredentials/<credentialName>/actions/test
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/PreferredCredential'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineConfiguration:
get:
description: 'Gets the configuration details of SQL plan baselines for the specified
Managed Database. The details include the settings for the capture and use of
SQL plan baselines, SPM Evolve Advisor task, and SQL Management Base.
'
operationId: GetSqlPlanBaselineConfiguration
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The SQL plan baseline configuration details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SqlPlanBaselineConfiguration'
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'
summary: Gets SQL plan baseline configuration details.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselineConfiguration\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"isAutomaticInitialPlanCaptureEnabled\": false,\n \"isSqlPlanBaselinesUsageEnabled\": true,\n \"isAutoSpmEvolveTaskEnabled\": false,\n \"isHighFrequencyAutoSpmEvolveTaskEnabled\": false,\n \"planRetentionWeeks\": 53,\n \"spaceBudgetPercent\": 10.0,\n \"autoCaptureFilters\": [\n {\n \"name\": \"AUTO_CAPTURE_PARSING_SCHEMA_NAME\",\n \"valuesToInclude\": [\n \"HR\"\n ],\n \"timeLastModified\": \"2021-11-17T09:30:22.384Z\",\n \"modifiedBy\": \"SYS\"\n },\n {\n \"name\": \"AUTO_CAPTURE_MODULE\",\n \"valuesToExclude\": [\n \"LOGGER\"\n ],\n \"timeLastModified\": \"2021-11-17T09:30:22.384Z\",\n \"modifiedBy\": \"SYS\"\n },\n {\n \"name\": \"AUTO_CAPTURE_ACTION\",\n \"valuesToInclude\": [\n \"R%\"\n ],\n \"timeLastModified\": \"2021-11-17T09:30:22.384Z\",\n \"modifiedBy\": \"SYS\"\n },\n {\n \"name\": \"AUTO_CAPTURE_SQL_TEXT\",\n \"valuesToInclude\": [\n \"SELECT a%\"\n ],\n \"timeLastModified\": \"2021-11-17T09:30:22.384Z\",\n \"modifiedBy\": \"SYS\"\n }\n ],\n \"autoSpmEvolveTaskParameters\": [\n {\n \"alternatePlanSources\": [\n \"CURSOR_CACHE\",\n \"AUTOMATIC_WORKLOAD_REPOSITORY\"\n ],\n \"arePlansAutoAccepted\": true\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineExecutionStats:
get:
description: 'Gets the number of SQL plan baselines aggregated by the age of their last execution in weeks.
'
operationId: SummarizeSqlPlanBaselinesByLastExecution
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The number of SQL plan baselines aggregated by the age of their last execution 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/SqlPlanBaselineAggregationCollection'
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'
summary: Get counts of SQL plan baselines aggregated by the age of their last execution in weeks.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselineExecutionStats\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"0\"\n },\n \"count\": 1709\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"1\"\n },\n \"count\": 12\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"2\"\n },\n \"count\": 2\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"3\"\n },\n \"count\": 11\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"4\"\n },\n \"count\": 2\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"5\"\n },\n \"count\": 2\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"6\"\n },\n \"count\": 4\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"7\"\n },\n \"count\": 9\n },\n {\n \"dimensions\": {\n \"attributeName\": \"lastExecutedTimeInWeeks\",\n \"attributeValue\": \"\"\n },\n \"count\": 152\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineJobs:
get:
description: 'Lists the database jobs used for loading SQL plan baselines in the specified Managed Database.
'
operationId: ListSqlPlanBaselineJobs
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/SqlPlanBaselineJobNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of database jobs related to SQL plan baselines 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/SqlPlanBaselineJobCollection'
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'
summary: Lists the database jobs used for loading SQL plan baselines.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselineJobs
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselineStats:
get:
description: 'Gets the number of SQL plan baselines aggregated by their attributes.
'
operationId: SummarizeSqlPlanBaselines
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The number of SQL plan baselines aggregated by attributes 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/SqlPlanBaselineAggregationCollection'
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'
summary: Get counts of SQL plan baselines aggregated by their attributes.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselineStats\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"dimensions\": {\n \"attributeName\": \"accepted\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 1920\n },\n {\n \"dimensions\": {\n \"attributeName\": \"enabled\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 2235\n },\n {\n \"dimensions\": {\n \"attributeName\": \"fixed\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 4\n },\n {\n \"dimensions\": {\n \"attributeName\": \"autopurge\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 2239\n },\n {\n \"dimensions\": {\n \"attributeName\": \"reproduced\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 2222\n },\n {\n \"dimensions\": {\n \"attributeName\": \"adaptive\",\n \"attributeValue\": \"yes\"\n },\n \"count\": 192\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines:
get:
description: 'Lists the SQL plan baselines for the specified Managed Database.
'
operationId: ListSqlPlanBaselines
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/SqlPlanNameOptionalQueryParam'
- $ref: '#/components/parameters/SqlHandleOptionalQueryParam'
- $ref: '#/components/parameters/SqlTextOptionalQueryParam'
- $ref: '#/components/parameters/IsSqlPlanEnabledQueryParam'
- $ref: '#/components/parameters/IsSqlPlanAcceptedQueryParam'
- $ref: '#/components/parameters/IsSqlPlanReproducedQueryParam'
- $ref: '#/components/parameters/IsSqlPlanFixedQueryParam'
- $ref: '#/components/parameters/IsSqlPlanAdaptiveQueryParam'
- $ref: '#/components/parameters/SqlPlanOriginOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SqlPlanSortByQueryParam'
- $ref: '#/components/parameters/SortOrderDescQueryParam'
- $ref: '#/components/parameters/IsSqlPlanAutoPurgedQueryParam'
- $ref: '#/components/parameters/TimeLastExecutedGreaterThanQueryParam'
- $ref: '#/components/parameters/TimeLastExecutedLessThanQueryParam'
- $ref: '#/components/parameters/IsNeverExecutedQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The SQL plan baseline 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/SqlPlanBaselineCollection'
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'
summary: Lists the SQL plan baselines.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n {\n \"planName\": \"SQL_PLAN_gxv1wnjcffd7z8dd47f8f\",\n \"sqlHandle\": \"SQL_feec3ca458e734ff\",\n \"sqlText\": \"SELECT DBID FROM V$DATABASE\",\n \"origin\": \"AUTO_CAPTURE\",\n \"timeCreated\": \"2021-11-01T12:49:01.543Z\",\n \"timeLastModified\": \"2021-11-01T12:49:01.543Z\",\n \"enabled\": \"YES\",\n \"accepted\": \"YES\",\n \"fixed\": \"NO\",\n \"reproduced\": \"YES\",\n \"autoPurge\": \"YES\",\n \"adaptive\": \"NO\"\n }\n ]\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changePlanRetention:
post:
description: 'Changes the retention period of unused plans. The period can range
between 5 and 523 weeks.
The database purges plans that have not been used for longer than
the plan retention period.
'
operationId: ChangePlanRetention
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ChangePlanRetentionDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The plan retention period was changed successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the retention period of unused plans.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/changePlanRetention\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"retentionWeeks\": 106\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSpaceBudget:
post:
description: 'Changes the disk space limit for the SQL Management Base. The allowable
range for this limit is between 1% and 50%.
'
operationId: ChangeSpaceBudget
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ChangeSpaceBudgetDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The disk space limit for the SQL Management Base was changed successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes the disk space limit for the SQL Management Base.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/changeSpaceBudget\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"spaceBudgetPercent\": 30\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/changeSqlPlanBaselinesAttributes:
post:
description: 'Changes one or more attributes of a single plan or all plans associated with a SQL statement.
'
operationId: ChangeSqlPlanBaselinesAttributes
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ChangeSqlPlanBaselinesAttributesDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The attributes of SQL plans were changed successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Changes one or more attributes of a single plan or all plans associated with a SQL statement.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/changeSqlPlanBaselinesAttributes\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"sqlHandle\": \"SQL_feec3ca458e734ff\",\n \"planName\": \"SQL_PLAN_gxv1wnjcffd7z8dd47f8f\",\n \"isEnabled\": true,\n \"isFixed\": true,\n \"isAutoPurged\": true\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticCaptureFilters:
post:
description: 'Configures automatic capture filters to capture only those statements
that match the filter criteria.
'
operationId: ConfigureAutomaticCaptureFilters
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ConfigureAutomaticCaptureFiltersDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The automatic capture filters were configured successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Configures automatic capture filters.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/configureAutomaticCaptureFilters\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"autoCaptureFilters\": [\n {\n \"name\": \"AUTO_CAPTURE_PARSING_SCHEMA_NAME\",\n \"valuesToInclude\": [\n \"HR\"\n ]\n }\n ]\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/configureAutomaticSpmEvolveAdvisorTask:
post:
description: 'Configures the Automatic SPM Evolve Advisor task `SYS_AUTO_SPM_EVOLVE_TASK`
by specifying task parameters. As the task is owned by `SYS`, only `SYS` can
set task parameters.
'
operationId: ConfigureAutomaticSpmEvolveAdvisorTask
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/ConfigureAutomaticSpmEvolveAdvisorTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Automatic SPM Evolve Advisor task was configured successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Configures the Automatic SPM Evolve Advisor task.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/configureAutomaticSpmEvolveAdvisorTask\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"taskParameters\": {\n \"alternatePlanSources\": [\n \"AUTOMATIC_WORKLOAD_REPOSITORY\",\n \"CURSOR_CACHE\"\n ],\n \"alternatePlanBaselines\": [\n \"EXISTING\",\n \"NEW\"\n ],\n \"arePlansAutoAccepted\": true,\n \"allowedTimeLimit\": 1800\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticInitialPlanCapture:
post:
description: 'Disables automatic initial plan capture.
'
operationId: DisableAutomaticInitialPlanCapture
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableAutomaticInitialPlanCaptureDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The automatic initial plan capture was disabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables automatic initial plan capture.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/disableAutomaticInitialPlanCapture\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableAutomaticSpmEvolveAdvisorTask:
post:
description: 'Disables the Automatic SPM Evolve Advisor task.
One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor.
Thus, the same task enables or disables both.
'
operationId: DisableAutomaticSpmEvolveAdvisorTask
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableAutomaticSpmEvolveAdvisorTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Automatic SPM Evolve Advisor task was disabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables the Automatic SPM Evolve Advisor task.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/disableAutomaticSpmEvolveAdvisorTask\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableHighFrequencyAutomaticSpmEvolveAdvisorTask:
post:
description: 'Disables the high-frequency Automatic SPM Evolve Advisor task.
It is available only on Oracle Exadata Database Machine, Oracle Database Exadata
Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).
'
operationId: DisableHighFrequencyAutomaticSpmEvolveAdvisorTask
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The high-frequency Automatic SPM Evolve Advisor task was disabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables the high-frequency Automatic SPM Evolve Advisor task.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/disableHighFrequencyAutomaticSpmEvolveAdvisorTask\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/disableSqlPlanBaselinesUsage:
post:
description: 'Disables the use of SQL plan baselines stored in SQL Management Base.
When disabled, the optimizer does not use any SQL plan baselines.
'
operationId: DisableSqlPlanBaselinesUsage
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/DisableSqlPlanBaselinesUsageDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The use of SQL plan baselines was disabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables the use of SQL plan baselines stored in SQL Management Base.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/disableSqlPlanBaselinesUsage\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/dropSqlPlanBaselines:
post:
description: 'Drops a single plan or all plans associated with a SQL statement.
'
operationId: DropSqlPlanBaselines
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/DropSqlPlanBaselinesDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The SQL plans were dropped successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Drops a single plan or all plans associated with a SQL statement.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/dropSqlPlanBaselines\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"sqlHandle\": \"SQL_feec3ca458e734ff\",\n \"planName\": \"SQL_PLAN_gxv1wnjcffd7z8dd47f8f\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticInitialPlanCapture:
post:
description: 'Enables automatic initial plan capture. When enabled, the database checks whether
executed SQL statements are eligible for automatic capture. It creates initial
plan baselines for eligible statements.
By default, the database creates a SQL plan baseline for every eligible repeatable
statement, including all recursive SQL and monitoring SQL. Thus, automatic capture
may result in the creation of an extremely large number of plan baselines. To limit
the statements that are eligible for plan baselines, configure filters.
'
operationId: EnableAutomaticInitialPlanCapture
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableAutomaticInitialPlanCaptureDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The automatic initial plan capture was enabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables automatic initial plan capture.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/enableAutomaticInitialPlanCapture\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableAutomaticSpmEvolveAdvisorTask:
post:
description: 'Enables the Automatic SPM Evolve Advisor task. By default, the automatic task
`SYS_AUTO_SPM_EVOLVE_TASK` runs every day in the scheduled maintenance window.
The SPM Evolve Advisor performs the following tasks:
- Checks AWR for top SQL
- Looks for alternative plans in all available sources
- Adds unaccepted plans to the plan history
- Tests the execution of as many plans as possible during the maintenance window
- Adds the alternative plan to the baseline if it performs better than the current plan
One client controls both Automatic SQL Tuning Advisor and Automatic SPM Evolve Advisor.
Thus, the same task enables or disables both.
'
operationId: EnableAutomaticSpmEvolveAdvisorTask
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableAutomaticSpmEvolveAdvisorTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The Automatic SPM Evolve Advisor task was enabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables the Automatic SPM Evolve Advisor task.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/enableAutomaticSpmEvolveAdvisorTask\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableHighFrequencyAutomaticSpmEvolveAdvisorTask:
post:
description: 'Enables the high-frequency Automatic SPM Evolve Advisor task. The high-frequency
task runs every hour and runs for no longer than 30 minutes. These settings
are not configurable.
The high-frequency task complements the standard Automatic SPM Evolve Advisor task.
They are independent and are scheduled through two different frameworks.
It is available only on Oracle Exadata Database Machine, Oracle Database Exadata
Cloud Service (ExaCS) and Oracle Database Exadata Cloud@Customer (ExaCC).
'
operationId: EnableHighFrequencyAutomaticSpmEvolveAdvisorTask
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The high-frequency Automatic SPM Evolve Advisor task was enabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables the high-frequency Automatic SPM Evolve Advisor task.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/enableHighFrequencyAutomaticSpmEvolveAdvisorTask\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/enableSqlPlanBaselinesUsage:
post:
description: 'Enables the use of SQL plan baselines stored in SQL Management Base.
When enabled, the optimizer uses SQL plan baselines to select plans
to avoid potential performance regressions.
'
operationId: EnableSqlPlanBaselinesUsage
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/EnableSqlPlanBaselinesUsageDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The use of SQL plan baselines was enabled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables the use of SQL plan baselines stored in SQL Management Base.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/enableSqlPlanBaselinesUsage\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n }\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromAwr:
post:
description: 'Loads plans from Automatic Workload Repository (AWR) snapshots. You must
specify the beginning and ending of the snapshot range. Optionally, you
can apply a filter to load only plans that meet specified criteria. By
default, the optimizer uses the loaded plans the next time that the database
executes the SQL statements.
'
operationId: LoadSqlPlanBaselinesFromAwr
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/LoadSqlPlanBaselinesFromAwrDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The database job to load SQL plan baselines from AWR was scheduled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SqlPlanBaselineJob'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Loads plans from Automatic Workload Repository (AWR) snapshots.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromAwr\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"jobName\": \"LoadBaselinesFromAWRTestJob\",\n \"jobDescription\": \"Load SQL plan baselines from AWR snapshots 30-50\",\n \"beginSnapshot\": 30,\n \"endSnapshot\": 50,\n \"sqlTextFilter\": \"sql_text like 'SELECT /*LOAD_STS*/%'\",\n \"isFixed\": false\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromCursorCache:
post:
description: 'Loads plans for statements directly from the shared SQL area, also called
the cursor cache. By applying a filter on the module name, the schema, or
the SQL ID you identify the SQL statement or set of SQL statements to load.
'
operationId: LoadSqlPlanBaselinesFromCursorCache
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/LoadSqlPlanBaselinesFromCursorCacheDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The database job to load SQL plan baselines from cursor cache was scheduled successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SqlPlanBaselineJob'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Loads plans for statements directly from the shared SQL area, also called the cursor cache.
tags:
- dbManagement
x-example: "POST /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/actions/loadSqlPlanBaselinesFromCursorCache\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentials\": {\n \"credentialType\": \"SECRET\",\n \"username\": \"TestUser\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"jobName\": \"LoadBaselinesFromCCTestJob\",\n \"jobDescription\": \"Load SQL plan baselines from cursor cache\",\n \"sqlId\": \"27m0sdw9snw59\"\n}\n"
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/sqlPlanBaselines/{planName}:
get:
description: 'Gets the SQL plan baseline details for the specified planName.
'
operationId: GetSqlPlanBaseline
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/SqlPlanNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The SQL plan baseline details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/SqlPlanBaseline'
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'
summary: Gets SQL plan baseline details.
tags:
- dbManagement
x-example: "GET /20201101/managedDatabases/<managedDatabaseId>/sqlPlanBaselines/<planName>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"planName\": \"SQL_PLAN_gxv1wnjcffd7z8dd47f8f\",\n \"sqlHandle\": \"SQL_feec3ca458e734ff\",\n \"sqlText\": \"SELECT DBID FROM V$DATABASE\",\n \"origin\": \"AUTO_CAPTURE\",\n \"timeCreated\": \"2021-11-01T12:49:01.543Z\",\n \"timeLastModified\": \"2021-11-01T12:49:01.543Z\",\n \"enabled\": \"YES\",\n \"accepted\": \"YES\",\n \"fixed\": \"NO\",\n \"reproduced\": \"YES\",\n \"autoPurge\": \"YES\",\n \"adaptive\": \"NO\",\n \"module\": \"JDBC Thin Client\",\n \"action\": \"UserAudit\",\n \"executionPlan\": \"\"\n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/tableStatistics:
get:
description: 'Lists the database table statistics grouped by different statuses such as Not Stale Stats, Stale Stats, and No Stats.
This also includes the percentage of each status.
'
operationId: ListTableStatistics
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The database table statistics grouped by statuses were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TableStatisticsCollection'
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'
summary: Gets the number of table statistics categorized by statistics status.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/tableStatistics
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/tablespaces:
get:
description: Gets the list of tablespaces for the specified managedDatabaseId.
operationId: ListTablespaces
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of tablespaces 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/TablespaceCollection'
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'
summary: Gets a list of tablespaces for a Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/tablespaces
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/Tablespace'
post:
description: 'Creates a tablespace within the Managed Database specified by managedDatabaseId.
'
operationId: CreateTablespace
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/CreateTablespaceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The details of the created tablespace.
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/Tablespace'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a tablespace.
tags:
- dbManagement
x-example: "POST /20210908/managedDatabases/<managedDatabaseId>/tablespaces\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"name\": \"TestTablespace\",\n \"type\": \"permanent\",\n \"isBigfile\": false,\n \"dataFiles\": [\n \"/ade/b/1455669240/oracle/dbs/test1.f\",\n \"/ade/b/1455669240/oracle/dbs/test2.f\",\n \"/ade/b/1455669240/oracle/dbs/test3.f\"\n ]\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}:
get:
description: 'Gets the details of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
'
operationId: GetTablespace
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The details of the tablespace.
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/Tablespace'
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'
summary: Gets the details of the tablespace.
tags:
- dbManagement
x-example: 'GET /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
put:
description: 'Updates the attributes of the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
'
operationId: UpdateTablespace
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UpdateTablespaceDetailsBodyParam'
responses:
200:
description: The details of the updated tablespace.
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/Tablespace'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates tablespace attributes.
tags:
- dbManagement
x-example: "PUT /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>\nHost: dbmgmt.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"name\": \"TestTablespaceNewName\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/addDataFiles:
post:
description: 'Adds data files or temp files to the tablespace.
'
operationId: AddDataFiles
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/AddDataFilesDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The operation to add the data files or temp files to the tablespace was completed successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TablespaceAdminStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Adds data files or temp files to the tablespace.
tags:
- dbManagement
x-example: "POST /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>/actions/addDataFiles\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"fileType\": \"DATAFILE\",\n \"dataFiles\": [\n \"/ade/b/1455669240/oracle/dbs/newTestDirectory/test1.f\",\n \"/ade/b/1455669240/oracle/dbs/newTestDirectory/test2.f\",\n \"/ade/b/1455669240/oracle/dbs/newTestDirectory/test3.f\"\n ]\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/dropTablespace:
post:
description: 'Drops the tablespace specified by tablespaceName within the Managed Database specified by managedDatabaseId.
'
operationId: DropTablespace
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/DropTablespaceDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The operation to drop the tablespace was completed successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TablespaceAdminStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Drops the tablespace.
tags:
- dbManagement
x-example: "POST /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>/actions/dropTablespace\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"isIncludingContents\": \"true\",\n \"isDroppingDataFiles\": \"true\",\n \"isCascadeConstraints\": \"false\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/removeDataFile:
post:
description: 'Removes a data file or temp file from the tablespace.
'
operationId: RemoveDataFile
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/RemoveDataFileDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The operation to drop the data file or temp file from the tablespace was completed successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TablespaceAdminStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Removes a data file or temp file from the tablespace.
tags:
- dbManagement
x-example: "POST /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>/actions/removeDataFile\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"fileType\": \"DATAFILE\",\n \"dataFile\": \"/ade/b/1455669240/oracle/dbs/newTestDirectory/test1.f\"\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/tablespaces/{tablespaceName}/actions/resizeDataFile:
post:
description: 'Resizes a data file or temp file within the tablespace.
'
operationId: ResizeDataFile
parameters:
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/TablespaceNamePathParam'
- $ref: '#/components/parameters/ResizeDataFileDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: 'The operation to resize the data file within the tablespace was completed successfully.
'
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TablespaceAdminStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Resizes a data file or temp file within the tablespace.
tags:
- dbManagement
x-example: "POST /20210908/managedDatabases/<managedDatabaseId>/tablespaces/<tablespaceName>/actions/resizeDataFile\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"credentialDetails\": {\n \"username\": \"TestUser\",\n \"tablespaceAdminCredentialType\": \"SECRET\",\n \"role\": \"NORMAL\",\n \"passwordSecretId\": \"ocid1.secret.oc1..\"\n },\n \"fileType\": \"DATAFILE\",\n \"dataFile\": \"/ade/b/1455669240/oracle/dbs/newTestDirectory/test1.f\",\n \"fileSize\": {\n \"size\": 100,\n \"unit\": \"MEGABYTES\"\n }\n}\n"
x-obmcs-client-retries-enabled: false
x-related-resource: '#/definitions/Tablespace'
/managedDatabases/{managedDatabaseId}/users:
get:
description: Gets the list of users for the specified managedDatabaseId.
operationId: ListUsers
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of users 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/UserCollection'
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'
summary: Gets a list of users for a Managed Database.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}:
get:
description: 'Gets the details of the user specified by managedDatabaseId and userName.
'
operationId: GetUser
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The user details were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/User'
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'
summary: Gets the details of a specific user.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/consumerGroupPrivileges:
get:
description: Gets the list of consumer group privileges granted to a specific user.
operationId: ListConsumerGroupPrivileges
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of consumer group privileges 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/ConsumerGroupPrivilegeCollection'
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'
summary: Gets a list of Consumer Group Privileges granted to a user.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/consumerGroupPrivileges
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/dataAccessContainers:
get:
description: Gets the list of containers for a specific user. This is only applicable if ALL_CONTAINERS !='Y'.
operationId: ListDataAccessContainers
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of containers 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/DataAccessContainerCollection'
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'
summary: Gets a list of Containers.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/dataAccessContainers
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/objectPrivileges:
get:
description: Gets the list of object privileges granted to a specific user.
operationId: ListObjectPrivileges
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of object privileges 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/ObjectPrivilegeCollection'
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'
summary: Gets a list of Object Privileges granted a user.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/objectPrivileges
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/proxiedForUsers:
get:
description: Gets the list of users on whose behalf the current user acts as proxy.
operationId: ListProxiedForUsers
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of users on whose behalf the current user acts as proxy 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/ProxiedForUserCollection'
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'
summary: Gets a list of proxied users.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/proxiedForUsers
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/proxyUsers:
get:
description: Gets the list of proxy users for the current user.
operationId: ListProxyUsers
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of proxy users 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/ProxyUserCollection'
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'
summary: Gets a list of proxy Users.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/proxyUsers
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/roles:
get:
description: Gets the list of roles granted to a specific user.
operationId: ListRoles
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of roles 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/RoleCollection'
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'
summary: Gets a list of roles granted to a user.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/roles
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/managedDatabases/{managedDatabaseId}/users/{userName}/systemPrivileges:
get:
description: Gets the list of system privileges granted to a specific user.
operationId: ListSystemPrivileges
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/ManagedDatabaseIdPathParam'
- $ref: '#/components/parameters/UserNamePathParam'
- $ref: '#/components/parameters/NameQueryParam'
- $ref: '#/components/parameters/UserSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/NamedCredentialIdHeader'
responses:
200:
description: The list of system privileges 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/SystemPrivilegeCollection'
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'
summary: Gets a list of System Privileges granted to a user.
tags:
- dbManagement
x-example: 'GET /20201101/managedDatabases/<managedDatabaseId>/users/<userName>/systemPrivileges
Host: dbmgmt.us-phoenix-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/ManagedDatabase'
/namedCredentials:
get:
description: 'Gets a single named credential specified by the name or all the named credentials in a specific compartment.
'
operationId: ListNamedCredentials
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/AssociatedResourceOptionalQueryParam'
- $ref: '#/components/parameters/TypeOptionalQueryParam'
- $ref: '#/components/parameters/ScopeOptionalQueryParam'
- $ref: '#/components/parameters/NamedCredentialNameOptionalQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of named credentials 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/NamedCredentialCollection'
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'
summary: 'Lists Named Credential.
'
tags:
- dbManagement
x-example: 'GET /20201101/namedCredential?compartmentId=<compartmentId>&limit=10
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/NamedCredential'
post:
description: 'Creates a named credential.
'
operationId: CreateNamedCredential
parameters:
- $ref: '#/components/parameters/CreateNamedCredentialDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
responses:
200:
description: The named credential was created successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: Location of the resource.
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NamedCredential'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates a Named Credential.
tags:
- dbManagement
x-example: "POST /20201101/namedCredential\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"TestNamedCredential\",\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"description\" : \"Oracle DB named credential\",\n \"scope\": \"RESOURCE\",\n \"type\":\"ORACLE_DB\",\n \"associatedResource\" : \"ocid1.externalpluggabledatabase.oc1.<unique_ID>\",\n \"content\" : {\n \"credentialType\" : \"BASIC\",\n \"userName\" : \"dbuser\",\n \"role\" : \"NORMAL\",\n \"passwordSecretId\" : \"ocid1.vaultsecret.oc1.<unique_ID>\",\n \"accessMode\" : \"SERVICE_PRINCIPAL\"\n }\n}\n"
x-related-resource: '#/definitions/NamedCredential'
/namedCredentials/{namedCredentialId}:
delete:
description: 'Deletes the named credential specified by namedCredentialId.
'
operationId: DeleteNamedCredential
parameters:
- $ref: '#/components/parameters/NamedCredentialIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
204:
description: The named credential was deleted successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Deletes a Named Credential.
tags:
- dbManagement
x-example: 'DELETE /20201101/namedCredential/<namedCredentialId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/NamedCredential'
get:
description: 'Gets the details for the named credential specified by namedCredentialId.
'
operationId: GetNamedCredential
parameters:
- $ref: '#/components/parameters/NamedCredentialIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The named credential details were retrieved successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NamedCredential'
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'
summary: Gets Named Credential details.
tags:
- dbManagement
x-example: 'GET /20201101/namedCredential/<namedCredentialId>
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/NamedCredential'
put:
description: 'Updates the named credential specified by namedCredentialId.
'
operationId: UpdateNamedCredential
parameters:
- $ref: '#/components/parameters/NamedCredentialIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/UpdateNamedCredentialDetailsBodyParam'
responses:
200:
description: The named credential was updated successfully.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/NamedCredential'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Updates a Named Credential.
tags:
- dbManagement
x-example: "PUT /20201101/namedCredential/<namedCredentialId>\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"description\" : \"Oracle DB named credential\",\n \"scope\": \"RESOURCE\",\n \"associatedResource\" : \"ocid1.externalpluggabledatabase.oc1.<unique_ID>\",\n \"content\" : {\n \"credentialType\" : \"BASIC\",\n \"userName\" : \"dbuser\",\n \"role\" : \"NORMAL\",\n \"passwordSecretId\" : \"ocid1.vaultsecret.oc1.<unique_ID>\",\n \"accessMode\" : \"SERVICE_PRINCIPAL\"\n }\n}\n"
x-related-resource: '#/definitions/NamedCredential'
/namedCredentials/{namedCredentialId}/actions/changeCompartment:
post:
description: 'Moves a named credential to a different compartment.
The destination compartment must not have a named credential
with the same name.
'
operationId: ChangeNamedCredentialCompartment
parameters:
- $ref: '#/components/parameters/NamedCredentialIdPathParam'
- $ref: '#/components/parameters/ChangeNamedCredentialCompartmentDetailsBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
204:
description: The named credential was moved to the destination compartment successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Moves a Named Credential.
tags:
- dbManagement
x-example: "POST /20201101/namedCredential/<namedCredentialId>/actions/changeCompartment\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n"
x-related-resource: '#/definitions/NamedCredential'
/namedCredentials/{namedCredentialId}/actions/test:
post:
description: 'Tests the named credential.
'
operationId: TestNamedCredential
parameters:
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/NamedCredentialIdPathParam'
- $ref: '#/components/parameters/TestNamedCredentialBodyParam'
responses:
200:
description: The named credential was tested successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/TestNamedCredentialStatus'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Status of the test named credential.
tags:
- dbManagement
x-example: 'POST /20201101/namedCredentials/<namedCredentialId>/actions/test
Host: dbmgmt.us-phoenix-1.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/NamedCredential'
/pluggabledatabases/{pluggableDatabaseId}/actions/disableDatabaseManagement:
post:
description: 'Disables a Database Management feature for the specified Oracle cloud pluggable database.
'
operationId: DisablePluggableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/PluggableDatabaseIdPathParam'
- $ref: '#/components/parameters/DisablePluggableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being disabled for the cloud pluggable database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Disables Database Management feature for a database.
tags:
- dbManagement
x-example: "POST /20201101/pluggabledatabases/<pluggableDatabaseId>/actions/disableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\"\n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: DISABLE
identifier: PLUGGABLE_DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/pluggabledatabases/{pluggableDatabaseId}/actions/enableDatabaseManagement:
post:
description: 'Enables a Database Management feature for the specified Oracle cloud pluggable database.
'
operationId: EnablePluggableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/PluggableDatabaseIdPathParam'
- $ref: '#/components/parameters/EnablePluggableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being enabled for the cloud pluggable database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Enables Database Management feature for the cloud pluggable Database.
tags:
- dbManagement
x-example: "POST /20201101/pluggabledatabases/<pluggableDatabaseId>/actions/enableDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": {\n \"connectionString\" : {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\" : {\n \"credentialType\" : \"DETAILS\",\n \"userName\" : \"dbsnmp\",\n \"passwordSecretId\" : \"ocid1.vaultsecret....\",\n \"role\" : \"NORMAL\"\n }\n },\n \"connectorDetails\" : {\n \"connectorType\" : \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\",\n }\n } \n}\n"
x-obmcs-client-retries-enabled: true
x-obmcs-terraform:
actionType: ENABLE
identifier: PLUGGABLE_DATABASE_DBM_FEATURE
x-related-resource: '#/definitions/ManagedDatabase'
/pluggabledatabases/{pluggableDatabaseId}/actions/modifyDatabaseManagement:
post:
description: 'Modifies the Database Management feature for the specified Oracle cloud pluggable database.
'
operationId: ModifyPluggableDatabaseManagementFeature
parameters:
- $ref: '#/components/parameters/PluggableDatabaseIdPathParam'
- $ref: '#/components/parameters/ModifyPluggableDatabaseManagementFeatureBodyParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
responses:
202:
description: The request was successfully received and the Database Management feature is being modified for the cloud pluggable database.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
'
schema:
type: string
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Modifies Database Management feature for the cloud pluggable Database.
tags:
- dbManagement
x-example: "POST /20201101/pluggabledatabases/<pluggableDatabaseId>/actions/modifyDatabaseManagement\nHost: dbmgmt.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"featureDetails\": {\n \"feature\": \"DIAGNOSTICS_AND_MANAGEMENT\",\n \"databaseConnectionDetails\": {\n \"connectionString\" : {\n \"port\": 1521,\n \"service\": \"EXAMPLE-service\",\n \"protocol\": \"TCP\"\n },\n \"connectionCredentials\" : {\n \"credentialType\" : \"DETAILS\",\n \"userName\" : \"dbsnmp\",\n \"passwordSecretId\" : \"ocid1.vaultsecret....\",\n \"role\" : \"NORMAL\"\n }\n },\n \"connectorDetails\" : {\n \"connectorType\" : \"PE\",\n \"privateEndPointId\": \"ocid1...privateendpoint....\",\n }\n } \n}\n"
x-obmcs-client-retries-enabled: true
x-related-resource: '#/definitions/ManagedDatabase'
/workRequests:
get:
description: 'Lists the work requests in a specific compartment.
'
operationId: ListWorkRequests
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/ResourceIdentifierQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/WorkRequestIdQueryParam'
- $ref: '#/components/parameters/WorkRequestStatusQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
responses:
200:
description: The 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/WorkRequestCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: List Work Requests
tags:
- dbManagement
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}:
get:
description: Gets the status of the work request with the given Work Request ID.
operationId: GetWorkRequest
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: The details of the work request were retrieved successfully.
headers:
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
retry-after:
description: A decimal number representing the number of seconds the client should wait before polling this work request again
schema:
type: number
format: float
content:
application/json:
schema:
$ref: '#/components/schemas/WorkRequest'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Get Work Request Status
tags:
- dbManagement
x-related-resource: '#/definitions/WorkRequest'
/workRequests/{workRequestId}/errors:
get:
description: 'Returns a paginated list of errors for a given work request.
'
operationId: ListWorkRequestErrors
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of work request errors 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/WorkRequestErrorCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request errors
tags:
- dbManagement
x-related-resource: '#/definitions/WorkRequestError'
/workRequests/{workRequestId}/logs:
get:
description: 'Returns a paginated list of logs for a given work request.
'
operationId: ListWorkRequestLogs
parameters:
- $ref: '#/components/parameters/WorkRequestIdPathParam'
- $ref: '#/components/parameters/RequestIdHeader'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/WorkRequestSortByQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
responses:
200:
description: The list of work request 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/WorkRequestLogEntryCollection'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Lists work request logs
tags:
- dbManagement
x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
parameters:
SqlPlanOriginOptionalQueryParam:
description: A filter to return all the SQL plan baselines that match the origin.
in: query
name: origin
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/SqlPlanBaselineOrigin'
schema:
type: string
enum:
- ADDM_SQLTUNE
- AUTO_CAPTURE
- AUTO_SQLTUNE
- EVOLVE_AUTO_INDEX_LOAD
- EVOLVE_CREATE_FROM_ADAPTIVE
- EVOLVE_LOAD_FROM_STS
- EVOLVE_LOAD_FROM_AWR
- EVOLVE_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD
- MANUAL_LOAD_FROM_AWR
- MANUAL_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD_FROM_STS
- MANUAL_SQLTUNE
- STORED_OUTLINE
- UNKNOWN
NameQueryParam:
description: A filter to return only resources that match the entire name.
in: query
name: name
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
EndTimeQueryParam:
description: 'The end time of the time range to retrieve the health metrics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: endTime
required: true
schema:
type: string
AwrDbIdPathParam:
description: 'The parameter to filter the database by internal ID.
Note that the internal ID of the database can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs
'
in: path
name: awrDbId
required: true
schema:
type: string
EnableDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an Oracle cloud database.
in: body
name: EnableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnableDatabaseManagementFeatureDetails'
IfMatchHeader:
description: 'For optimistic concurrency control. In the PUT or DELETE call
for a resource, set the `if-match` parameter to the value of the
etag from a previous GET or POST response for that resource.
The resource will be updated or deleted only if the etag you
provide matches the resource''s current etag value.
'
in: header
name: if-match
required: false
schema:
type: string
DisableExternalPluggableDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an external pluggable database.
in: body
name: DisableExternalPluggableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisableExternalPluggableDatabaseManagementFeatureDetails'
CloudDbNodeIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database node.
in: path
name: cloudDbNodeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
AwrBeginTimeOptionalQueryParam:
description: The optional greater than or equal to query parameter to filter the timestamp.
in: query
name: timeGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
FilterByFreeformTagExistsQueryParam:
description: 'A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned.
The key for each tag is "{tagName}.true". All inputs are case-insensitive.
Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
Multiple values for different tag names are interpreted as "AND".
'
in: query
name: freeformTagExists
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 106
type: string
DisableExternalNonContainerDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an external non-container database.
in: body
name: DisableExternalNonContainerDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisableExternalNonContainerDatabaseManagementFeatureDetails'
AwrEndTimeOptionalQueryParam:
description: The optional less than or equal to query parameter to filter the timestamp.
in: query
name: timeLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
OptimizerStatsOperationsSortByQueryParam:
description: Sorts the list of optimizer statistics operations based on a specific attribute.
in: query
name: sortBy
schema:
type: string
enum:
- START_TIME
- END_TIME
- STATUS
default: START_TIME
CloudAsmInstanceIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance.
in: path
name: cloudAsmInstanceId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DisableDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an Oracle cloud database.
in: body
name: DisableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisableDatabaseManagementFeatureDetails'
ModifyPluggableDatabaseManagementFeatureBodyParam:
description: The details required to modify a Database Management feature for an Oracle cloud pluggable database.
in: body
name: ModifyPluggableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/ModifyPluggableDatabaseManagementFeatureDetails'
NamedCredentialIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential.
in: path
name: namedCredentialId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PatchExternalDbSystemDiscoveryDetailsBodyParam:
description: The details required to update an external DB system discovery.
in: body
name: PatchExternalDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/PatchExternalDbSystemDiscoveryDetails'
LifecycleStateQueryParam:
description: The lifecycle state of a resource.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
schema:
type: string
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
AwrDbParameterDefaultOptionalQueryParam:
description: The optional query parameter to filter the database parameters that had the default value in the last snapshot.
in: query
name: valueDefault
required: false
x-default-description: 'null'
schema:
type: string
enum:
- 'TRUE'
- 'FALSE'
ParameterSourceQueryParam:
description: 'The source used to list database parameters. `CURRENT` is used to get the
database parameters that are currently in effect for the database
instance. `SPFILE` is used to list parameters from the server parameter
file. Default is `CURRENT`.
'
in: query
name: source
required: false
schema:
type: string
enum:
- CURRENT
- SPFILE
default: CURRENT
SqlPlanSortByQueryParam:
description: The option to sort the SQL plan baseline summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- timeCreated
- timeLastModified
- timeLastExecuted
default: timeCreated
CloudExadataInfrastructureIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
in: query
name: cloudExadataInfrastructureId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalExadataStorageGridDetailsBodyParam:
description: The details required to update an external Exadata storage grid.
in: body
name: UpdateExternalExadataStorageGridDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalExadataStorageGridDetails'
NamedCredentialNameOptionalQueryParam:
description: The name of the named credential.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
AwrDbSortByQueryParam:
description: The option to sort the AWR summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- END_INTERVAL_TIME
- NAME
default: END_INTERVAL_TIME
DbManagementPrivateEndpointIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint.
in: path
name: dbManagementPrivateEndpointId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateCloudExadataStorageConnectorDetailsBodyParam:
description: The details required to update connections to the Exadata storage servers.
in: body
name: UpdateCloudExadataStorageConnectorDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudExadataStorageConnectorDetails'
EnableCloudDbSystemStackMonitoringDetailsBodyParam:
description: The details required to enable Stack Monitoring for a cloud DB system.
in: body
name: EnableCloudDbSystemStackMonitoringDetails
required: true
schema:
$ref: '#/components/schemas/EnableCloudDbSystemStackMonitoringDetails'
DisplayNameOptionalQueryParam:
description: The optional single value query filter parameter on the entity display name.
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
EntityNamesOptionalQueryParam:
description: The optional multiple value query parameter to filter the entity name.
in: query
name: name
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
type: string
ResizeDataFileDetailsBodyParam:
description: 'The details required to resize a data file or temp file within the tablespace.
'
in: body
name: ResizeDataFileDetails
required: true
schema:
$ref: '#/components/schemas/ResizeDataFileDetails'
IsSqlPlanAdaptiveQueryParam:
description: 'A filter to return only SQL plan baselines that are either adaptive or not adaptive.
By default, all SQL plan baselines are returned.
'
in: query
name: isAdaptive
required: false
x-default-description: 'null'
schema:
type: boolean
TimeLastExecutedGreaterThanQueryParam:
description: 'A filter to return only SQL plan baselines whose last execution time is
after the specified value. By default, all SQL plan baselines are returned.
'
in: query
name: timeLastExecutedGreaterThan
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
HAFleetSortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The
default sort order for `DATABASENAME` is ascending and it is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- DATABASENAME
default: DATABASENAME
CloudDbSystemIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
in: path
name: cloudDbSystemId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalDbSystemConnectorDetailsBodyParam:
description: The details required to update an external connector.
in: body
name: UpdateExternalDbSystemConnectorDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalDbSystemConnectorDetails'
CreateExternalExadataStorageConnectorBodyParam:
description: The details required to add connections to the Exadata storage servers.
in: body
name: CreateExternalExadataStorageConnectorDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalExadataStorageConnectorDetails'
UpdateCloudExadataInfrastructureDetailsBodyParam:
description: The details required to update the managed Exadata infrastructure resources.
in: body
name: UpdateCloudExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudExadataInfrastructureDetails'
ScopeOptionalQueryParam:
description: The scope of named credential.
in: query
name: scope
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/NamedCredentialScope'
schema:
type: string
enum:
- RESOURCE
- GLOBAL
CreateExternalDbSystemDetailsBodyParam:
description: The details required to create an external DB system.
in: body
name: CreateExternalDbSystemDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalDbSystemDetails'
UpdateCloudDbSystemConnectorDetailsBodyParam:
description: The details required to update a cloud connector.
in: body
name: UpdateCloudDbSystemConnectorDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudDbSystemConnectorDetails'
ImplementOptimizerStatisticsAdvisorRecommendationsBodyParam:
description: The Optimizer Statistics Advisor recommendations implementation request.
in: body
name: ImplementOptimizerStatisticsAdvisorRecommendationsDetails
required: true
schema:
$ref: '#/components/schemas/ImplementOptimizerStatisticsAdvisorRecommendationsDetails'
ExternalNonContainerDatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external non-container database.
in: path
name: externalNonContainerDatabaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
OptimizerStatisticsFilterByQueryParam:
description: 'The parameter used to filter the optimizer statistics operations.
Any property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition.
The allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid.
Example: jobName= AND status=
'
in: query
name: filterBy
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 1024
minLength: 1
MetricNameFilterParam:
description: The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
in: query
name: filterByMetricNames
required: false
x-default-description: 'null'
schema:
type: string
EnableCloudDbSystemDatabaseManagementDetailsBodyParam:
description: The details required to enable Stack Monitoring for a cloud DB system.
in: body
name: EnableCloudDbSystemDatabaseManagementDetails
required: true
schema:
$ref: '#/components/schemas/EnableCloudDbSystemDatabaseManagementDetails'
FilterByExadataInfrastructureLifecycleStateParam:
description: 'The filter used to filter the Exadata infrastructure in the fleet by its lifecycle state.
If the parameter is not provided, Exdata infrastructures in any state are returned.
'
in: query
name: filterByExadataInfrastructureLifecycleState
required: false
x-default-description: All lifecycle states
x-obmcs-enumref: '#/definitions/ExadataInfrastructureLifecycleStateValues/state'
schema:
type: string
ConfigureAutomaticCaptureFiltersDetailsBodyParam:
description: The details required to configure automatic capture filters.
in: body
name: ConfigureAutomaticCaptureFiltersDetails
required: true
schema:
$ref: '#/components/schemas/ConfigureAutomaticCaptureFiltersDetails'
UpdateExternalDbSystemDetailsBodyParam:
description: The details required to update an external DB system.
in: body
name: UpdateExternalDbSystemDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalDbSystemDetails'
AwrDbNameSampledBeginTimeSortByQueryParam:
description: The option to sort the data within a time period.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIME_BEGIN
- NAME
default: TIME_BEGIN
DbaasParentInfrastructureIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the dbaas parent infrastructure of the cloud DB system.
in: query
name: dbaasParentInfrastructureId
required: false
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestSortByQueryParam:
description: 'The field to sort by. Only one sort order may be provided and the default order for timeAccepted is descending.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeAccepted
default: timeAccepted
AwrDbTopEventSortByQueryParam:
description: The option to sort the AWR top event summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- WAITS_PERSEC
- AVG_WAIT_TIME_PERSEC
default: WAITS_PERSEC
JobExecutionIdPathParam:
description: The identifier of the job execution.
in: path
name: jobExecutionId
required: true
schema:
type: string
CreateCloudExadataStorageConnectorBodyParam:
description: The details required to add connections to the Exadata storage servers.
in: body
name: CreateCloudExadataStorageConnectorDetails
required: true
schema:
$ref: '#/components/schemas/CreateCloudExadataStorageConnectorDetails'
ChangeSqlPlanBaselinesAttributesDetailsBodyParam:
description: The details required to change SQL plan baseline attributes.
in: body
name: ChangeSqlPlanBaselinesAttributesDetails
required: true
schema:
$ref: '#/components/schemas/ChangeSqlPlanBaselinesAttributesDetails'
ExternalDatabaseIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database.
in: query
name: externalDatabaseId
required: false
schema:
type: string
maxLength: 255
minLength: 1
CloudExadataStorageGridIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid.
in: path
name: cloudExadataStorageGridId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DbSystemMetricsStartTimeQueryParam:
description: 'The beginning of the time range set to retrieve metric data for the DB system
and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
in: query
name: startTime
required: true
schema:
type: string
EndTimeLessThanOrEqualToQueryParam:
description: 'The end time of the time range to retrieve the optimizer statistics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: endTimeLessThanOrEqualTo
required: false
schema:
type: string
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
ExternalDbSystemIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
in: query
name: externalDbSystemId
required: false
schema:
type: string
maxLength: 255
minLength: 1
CloudClusterInstanceIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster instance.
in: path
name: cloudClusterInstanceId
required: true
schema:
type: string
maxLength: 255
minLength: 1
CloudExadataStorageServerIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
in: path
name: cloudExadataStorageServerId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ManagedDatabaseGroupIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group.
in: path
name: managedDatabaseGroupId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalListenerDetailsBodyParam:
description: The details required to update an external listener.
in: body
name: UpdateExternalListenerDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalListenerDetails'
EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetailsBodyParam:
description: The details required to enable high frequency Automatic SPM Evolve Advisor task.
in: body
name: EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails
required: true
schema:
$ref: '#/components/schemas/EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails'
UpdateExternalDbSystemDiscoveryDetailsBodyParam:
description: The details required to update an external DB system discovery.
in: body
name: UpdateExternalDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalDbSystemDiscoveryDetails'
DisableAutomaticSpmEvolveAdvisorTaskDetailsBodyParam:
description: The details required to disable Automatic SPM Evolve Advisor task.
in: body
name: DisableAutomaticSpmEvolveAdvisorTaskDetails
required: true
schema:
$ref: '#/components/schemas/DisableAutomaticSpmEvolveAdvisorTaskDetails'
DropSqlPlanBaselinesDetailsBodyParam:
description: The details required to drop SQL plan baselines.
in: body
name: DropSqlPlanBaselinesDetails
required: true
schema:
$ref: '#/components/schemas/DropSqlPlanBaselinesDetails'
ChangePlanRetentionDetailsBodyParam:
description: The details required to change the plan retention period.
in: body
name: ChangePlanRetentionDetails
required: true
schema:
$ref: '#/components/schemas/ChangePlanRetentionDetails'
UpdateCloudDbSystemDiscoveryDetailsBodyParam:
description: The details required to update a cloud DB system discovery.
in: body
name: UpdateCloudDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudDbSystemDiscoveryDetails'
UserSortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The default sort order
for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- NAME
default: NAME
ReportFormatQueryParam:
description: The format of the AWR report.
in: query
name: reportFormat
required: false
schema:
type: string
enum:
- HTML
- TEXT
default: HTML
DiscoverCloudExadataInfrastructureDetailsBodyParam:
description: The details required to discover and monitor the Exadata infrastructure.
in: body
name: DiscoverCloudExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/DiscoverCloudExadataInfrastructureDetails'
EntityNameOptionalQueryParam:
description: The optional single value query parameter to filter the entity name.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
DropTablespaceDetailsBodyParam:
description: The details required to drop a tablespace.
in: body
name: DropTablespaceDetails
required: true
schema:
$ref: '#/components/schemas/DropTablespaceDetails'
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
AssociatedResourceOptionalQueryParam:
description: The resource associated to the named credential.
in: query
name: associatedResource
required: false
x-default-description: 'null'
schema:
type: string
CloudDbSystemDeploymentTypeQueryParam:
description: A filter to return cloud DB systems of the specified deployment type.
in: query
name: deploymentType
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
schema:
type: string
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
PeerDatabaseCompartmentIdOptionalQueryParam:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment for which peer database metrics are required.
This is not a mandatory parameter and in its absence, all the peer database metrics are returned.
'
in: query
name: peerDatabaseCompartmentId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
SqlPlanBaselineJobNameOptionalQueryParam:
description: A filter to return the SQL plan baseline jobs that match the name.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
UpdateCloudDbSystemDetailsBodyParam:
description: The details required to update a cloud DB system.
in: body
name: UpdateCloudDbSystemDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudDbSystemDetails'
DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetailsBodyParam:
description: The details required to disable high frequency Automatic SPM Evolve Advisor task.
in: body
name: DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails
required: true
schema:
$ref: '#/components/schemas/DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails'
AwrDbReportTypeQueryParam:
description: The query parameter to filter the AWR report types.
in: query
name: reportType
required: false
schema:
type: string
enum:
- AWR
- ASH
default: AWR
ExternalExadataInfrastructureIdOptionalQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
in: query
name: externalExadataInfrastructureId
required: false
schema:
type: string
maxLength: 255
minLength: 1
AwrMaxValueOptionalQueryParam:
description: The maximum value of the histogram.
in: query
name: maxValue
required: false
x-default-description: 'null'
schema:
type: number
format: double
CloudAsmIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
in: query
name: cloudAsmId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ManagedDatabaseIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
in: query
name: managedDatabaseId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
CloudDbSystemIdMandatoryQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
in: query
name: cloudDbSystemId
required: true
schema:
type: string
maxLength: 255
minLength: 1
JobRunIdPathParam:
description: The identifier of the job run.
in: path
name: jobRunId
required: true
schema:
type: string
OptionalRequestIdAddm:
description: 'Unique identifier for the request.
'
in: header
name: opc-request-id
required: false
x-default-description: 'null'
schema:
type: string
ResourceIdentifierQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
in: query
name: resourceId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
AwrDbCategoryPercSortByQueryParam:
description: The option to sort distribution data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- CATEGORY
- PERCENTAGE
default: CATEGORY
AssociatedDatabaseSortByQueryParam:
description: 'The option to sort databases using a specific Database Management private endpoint.
'
in: query
name: sortBy
schema:
type: string
enum:
- timeRegistered
default: timeRegistered
WorkRequestStatusQueryParam:
description: A filter that returns the resources whose status matches the given WorkRequestStatus.
in: query
name: status
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
schema:
type: string
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
EndTimeJobQueryParam:
description: 'The end time of the time range to retrieve the status summary of job executions
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: endTime
required: true
schema:
type: string
AutonomousDatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous Database.
in: path
name: autonomousDatabaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
in: path
name: workRequestId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UserNamePathParam:
description: The name of the user whose details are to be viewed.
in: path
name: userName
required: true
schema:
type: string
CloudExadataStorageConnectorIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server.
in: path
name: cloudExadataStorageConnectorId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ChangeExternalExadataInfrastructureCompartmentDetailsBodyParam:
description: The details required to move the Exadata infrastructure from one compartment to another.
in: body
name: ChangeExternalExadataInfrastructureCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeExternalExadataInfrastructureCompartmentDetails'
UpdateExternalAsmInstanceDetailsBodyParam:
description: The details required to update an external ASM instance.
in: body
name: UpdateExternalAsmInstanceDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalAsmInstanceDetails'
CloudClusterIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster.
in: path
name: cloudClusterId
required: true
schema:
type: string
maxLength: 255
minLength: 1
CloudDbHomeIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database home.
in: path
name: cloudDbHomeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
TypeOptionalQueryParam:
description: The type of database that is associated to the named credential.
in: query
name: type
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ResourceType'
schema:
type: string
enum:
- ORACLE_DB
ExternalAsmIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
in: path
name: externalAsmId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExternalExadataInfrastructureIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
in: query
name: externalExadataInfrastructureId
required: true
schema:
type: string
maxLength: 255
minLength: 1
StartTimeJobQueryParam:
description: 'The start time of the time range to retrieve the status summary of job executions
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: startTime
required: true
schema:
type: string
JobExecutionStatusQueryParam:
description: The status of the job execution.
in: query
name: status
required: false
x-default-description: 'null'
schema:
type: string
ChangeExternalDbSystemCompartmentDetailsBodyParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the external DB system should be moved.
in: body
name: ChangeExternalDbSystemCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeExternalDbSystemCompartmentDetails'
JobIdPathParam:
description: The identifier of the job.
in: path
name: jobId
required: true
schema:
type: string
ListAddmEndTimeQueryParam:
description: The end of the time range to search for ADDM tasks as defined by date-time RFC3339 format.
in: query
name: timeEnd
required: true
x-default-description: 'null'
schema:
type: string
format: date-time
ExternalExadataStorageConnectorIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the connector to the Exadata storage server.
in: path
name: externalExadataStorageConnectorId
required: true
schema:
type: string
maxLength: 255
minLength: 1
WorkRequestIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
in: query
name: workRequestId
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalExadataStorageServerDetailsBodyParam:
description: The details required to update an external Exadata storage server.
in: body
name: UpdateExternalExadataStorageServerDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalExadataStorageServerDetails'
DisablePluggableDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an Oracle cloud pluggable database.
in: body
name: DisablePluggableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisablePluggableDatabaseManagementFeatureDetails'
TestPreferredCredentialBodyParam:
description: The details required to test preferred credential.
in: body
name: TestPreferredCredentialDetails
required: false
schema:
$ref: '#/components/schemas/TestPreferredCredentialDetails'
AwrDbParameterValueOptionalQueryParam:
description: The optional query parameter to filter database parameters whose values were changed.
in: query
name: valueChanged
schema:
type: string
enum:
- Y
- N
default: Y
ExternalDbNodeIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database node.
in: path
name: externalDbNodeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExternalContainerDatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external container database.
in: path
name: externalContainerDatabaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExternalDbSystemIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
in: path
name: externalDbSystemId
required: true
schema:
type: string
maxLength: 255
minLength: 1
CloudDbSystemLifecycleStateQueryParam:
description: The lifecycle state of a resource.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
schema:
type: string
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- INACTIVE
default: ACTIVE
CreateExternalExadataInfrastructureDetailsBodyParam:
description: The details required to create the managed Exadata infrastructure resources.
in: body
name: CreateExternalExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalExadataInfrastructureDetails'
ExternalAsmIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
in: query
name: externalAsmId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ModifyAutonomousDatabaseManagementFeatureBodyParam:
description: The details required to modify a Database Management feature for an Autonomous Database.
in: body
name: ModifyAutonomousDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/ModifyAutonomousDatabaseManagementFeatureDetails'
CompartmentIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: true
schema:
type: string
maxLength: 255
minLength: 1
CreateCloudDbSystemDetailsBodyParam:
description: The details required to create a cloud DB system.
in: body
name: CreateCloudDbSystemDetails
required: true
schema:
$ref: '#/components/schemas/CreateCloudDbSystemDetails'
JobIdQueryParam:
description: The identifier of the job.
in: query
name: jobId
required: false
x-default-description: 'null'
schema:
type: string
UpdateTablespaceDetailsBodyParam:
description: The details required to update a tablespace.
in: body
name: UpdateTablespaceDetails
required: true
schema:
$ref: '#/components/schemas/UpdateTablespaceDetails'
ExternalDbSystemDiscoveryIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery.
in: path
name: externalDbSystemDiscoveryId
required: true
schema:
type: string
maxLength: 255
minLength: 1
TaskTypeQueryParam:
description: The filter types of the optimizer statistics tasks.
in: query
name: taskType
required: false
x-default-description: ALL
x-obmcs-top-level-enum: '#/definitions/OptimizerStatisticsTaskFilterTypes'
schema:
type: string
enum:
- ALL
- MANUAL
- AUTO
PatchCloudDbSystemDiscoveryDetailsBodyParam:
description: The details required to update a cloud DB system discovery.
in: body
name: PatchCloudDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/PatchCloudDbSystemDiscoveryDetails'
AwrDbTopNQueryParam:
description: The optional query parameter to filter the number of top categories to be returned.
in: query
name: topN
schema:
type: integer
default: 10
maximum: 20
minimum: 1
CreateCloudDbSystemDiscoveryDetailsBodyParam:
description: The details required to create a cloud DB system discovery.
in: body
name: CreateCloudDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/CreateCloudDbSystemDiscoveryDetails'
TaskNameQueryParam:
description: The name of the optimizer statistics collection execution task.
in: query
name: taskName
required: true
schema:
type: string
UpdateCloudListenerDetailsBodyParam:
description: The details required to update a cloud listener.
in: body
name: UpdateCloudListenerDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudListenerDetails'
ExternalClusterIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster.
in: path
name: externalClusterId
required: true
schema:
type: string
maxLength: 255
minLength: 1
EnableExternalDbSystemStackMonitoringDetailsBodyParam:
description: The details required to enable Stack Monitoring for an external DB system.
in: body
name: EnableExternalDbSystemStackMonitoringDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalDbSystemStackMonitoringDetails'
ExternalDbHomeIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database home.
in: path
name: externalDbHomeId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalMySqlDatabaseDetails:
description: The details required to update an external MySQL database resource.
in: body
name: UpdateExternalMySqlDatabaseDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalMySqlDatabaseDetails'
x-default-description: 'null'
AwrDbParameterModifiedOptionalQueryParam:
description: The optional query parameter to filter the database parameters that had a modified value in the last snapshot.
in: query
name: valueModified
required: false
x-default-description: 'null'
schema:
type: string
enum:
- MODIFIED
- SYSTEM_MOD
- 'FALSE'
SortByNameQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The
default sort order for `NAME` is ascending and it is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- NAME
default: NAME
FilterByFreeformTagEqualsQueryParam:
description: 'A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned.
The key for each tag is "{tagName}.{value}". All inputs are case-insensitive.
Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".
'
in: query
name: freeformTagEquals
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 357
type: string
CloudListenerIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener.
in: path
name: cloudListenerId
required: true
schema:
type: string
maxLength: 255
minLength: 1
AwrDbSnapSortByQueryParam:
description: The option to sort the AWR snapshot summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIME_BEGIN
- SNAPSHOT_ID
default: TIME_BEGIN
ListAddmSortByQueryParam:
description: The option to sort the list of ADDM tasks.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TASK_NAME
- TASK_ID
- DESCRIPTION
- DB_USER
- STATUS
- TIME_CREATED
- BEGIN_TIME
- END_TIME
default: END_TIME
FilterByDatabaseVersionParam:
description: The filter used to filter the databases in the fleet by a specific Oracle Database version.
in: query
name: filterByDatabaseVersion
required: false
x-default-description: 'null'
schema:
type: string
UpdateCloudDbNodeDetailsBodyParam:
description: The details required to update a cloud DB node.
in: body
name: UpdateCloudDbNodeDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudDbNodeDetails'
CreateExternalMySqlDatabaseConnectorDetails:
description: The details required to create an external MySQL database connector resource.
in: body
name: CreateExternalMySqlDatabaseConnectorDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalMySqlDatabaseConnectorDetails'
x-default-description: 'null'
EnableExternalExadataInfrastructureManagementDetailsBodyParam:
description: The details required to enable management for the Exadata infrastructure.
in: body
name: EnableExternalExadataInfrastructureManagementDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalExadataInfrastructureManagementDetails'
ChangeNamedCredentialCompartmentDetailsBodyParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the named credential should be moved.
in: body
name: ChangeNamedCredentialCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeNamedCredentialCompartmentDetails'
ManagedDatabaseGroupIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group.
in: query
name: managedDatabaseGroupId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
AwrDbNameChangeSortByQueryParam:
description: The option to sort the AWR database parameter change history data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- IS_CHANGED
- NAME
default: IS_CHANGED
ChangeManagedDatabaseGroupCompartmentDetailsBodyParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the Managed Database Group to.
in: body
name: ChangeManagedDatabaseGroupCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeManagedDatabaseGroupCompartmentDetails'
CloudExadataInfrastructureIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
in: path
name: cloudExadataInfrastructureId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ExternalMySqlDatabaseIdPathParam:
description: The OCID of the External MySQL Database.
in: path
name: externalMySqlDatabaseId
required: true
x-default-description: 'null'
schema:
type: string
CloudClusterIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster.
in: query
name: cloudClusterId
required: false
schema:
type: string
maxLength: 255
minLength: 1
ExternalClusterInstanceIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster instance.
in: path
name: externalClusterInstanceId
required: true
schema:
type: string
maxLength: 255
minLength: 1
InstNumberOptionalQueryParam:
description: The optional single value query parameter to filter the database instance number.
in: query
name: instNum
required: false
x-default-description: 'null'
schema:
type: string
UpdateCloudExadataStorageServerDetailsBodyParam:
description: The details required to update an Exadata storage server.
in: body
name: UpdateCloudExadataStorageServerDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudExadataStorageServerDetails'
ExecutionNamePathParam:
description: The name of the Optimizer Statistics Advisor execution.
in: path
name: executionName
required: true
schema:
type: string
ParameterNameQueryParam:
description: 'A filter to return all parameters that have the text given in their names.
'
in: query
name: name
required: false
schema:
type: string
maxLength: 80
minLength: 1
UpdateExternalDbHomeDetailsBodyParam:
description: The details required to update an external DB home.
in: body
name: UpdateExternalDbHomeDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalDbHomeDetails'
CreateTablespaceDetailsBodyParam:
description: The details required to create a tablespace.
in: body
name: CreateTablespaceDetails
required: true
schema:
$ref: '#/components/schemas/CreateTablespaceDetails'
ListAddmStartTimeQueryParam:
description: The beginning of the time range to search for ADDM tasks as defined by date-time RFC3339 format.
in: query
name: timeStart
required: true
x-default-description: 'null'
schema:
type: string
format: date-time
CompartmentIdOptionalQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
in: query
name: compartmentId
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ExternalClusterIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster.
in: query
name: externalClusterId
required: false
schema:
type: string
maxLength: 255
minLength: 1
RemoveDataFileDetailsBodyParam:
description: 'The details required to remove a data file or temp file from the tablespace.
'
in: body
name: RemoveDataFileDetails
required: true
schema:
$ref: '#/components/schemas/RemoveDataFileDetails'
TablespaceNamePathParam:
description: The name of the tablespace.
in: path
name: tablespaceName
required: true
schema:
type: string
AwrNumBucketOptionalQueryParam:
description: The number of buckets within the histogram.
in: query
name: numBucket
required: false
schema:
type: integer
default: 10
maximum: 50
minimum: 5
UpdateCloudExadataStorageGridDetailsBodyParam:
description: The details required to update an Exadata storage grid.
in: body
name: UpdateCloudExadataStorageGridDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudExadataStorageGridDetails'
EnableExternalContainerDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an external container database.
in: body
name: EnableExternalContainerDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalContainerDatabaseManagementFeatureDetails'
ExternalListenerIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener.
in: path
name: externalListenerId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DisableSqlPlanBaselinesUsageDetailsBodyParam:
description: The details required to disable SQL plan baseline usage.
in: body
name: DisableSqlPlanBaselinesUsageDetails
required: true
schema:
$ref: '#/components/schemas/DisableSqlPlanBaselinesUsageDetails'
UpdateNamedCredentialDetailsBodyParam:
description: The details required to update a named credential.
in: body
name: UpdateNamedCredentialDetails
required: true
schema:
$ref: '#/components/schemas/UpdateNamedCredentialDetails'
SqlStatementSortByQueryParam:
description: The option to sort the SQL statement summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- sqlId
- schema
default: sqlId
AddManagedDatabaseToManagedDatabaseGroupDetailsBodyParam:
description: The Managed Database details required to add the Managed Database to a Managed Database Group.
in: body
name: AddManagedDatabaseToManagedDatabaseGroupDetails
required: true
schema:
$ref: '#/components/schemas/AddManagedDatabaseToManagedDatabaseGroupDetails'
IsTestConnectionParam:
description: Parameter indicating whether database connection needs to be tested.
in: query
name: isTestConnectionParam
required: true
x-default-description: 'null'
schema:
type: boolean
UpdateExternalClusterDetailsBodyParam:
description: The details required to update an external cluster.
in: body
name: UpdateExternalClusterDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalClusterDetails'
CreateJobDetailsBodyParam:
description: The details required to create a job.
in: body
name: CreateJobDetails
required: true
schema:
$ref: '#/components/schemas/CreateJobDetails'
UpdateCloudAsmDetailsBodyParam:
description: The details required to update a cloud ASM.
in: body
name: UpdateCloudAsmDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudAsmDetails'
FilterByExadataInfrastructureDeploymentTypeParam:
description: The filter used to filter the Exadata infrastructures in the fleet by a specific deployment type.
in: query
name: filterByExadataInfrastructureDeploymentType
required: false
x-default-description: All deployment types
x-obmcs-top-level-enum: '#/definitions/ExadataInfrastructureDeploymentType'
schema:
type: string
enum:
- ONPREMISE
- EXADATA
- EXADATA_CC
IdOptionalQueryParam:
description: The identifier of the resource.
in: query
name: id
required: false
x-default-description: 'null'
schema:
type: string
ResetDatabaseParametersDetailsBodyParam:
description: The details required to reset database parameters.
in: body
name: ResetDatabaseParametersDetails
required: true
schema:
$ref: '#/components/schemas/ResetDatabaseParametersDetails'
EnableAutomaticInitialPlanCaptureDetailsBodyParam:
description: The details required to enable automatic initial plan capture.
in: body
name: EnableAutomaticInitialPlanCaptureDetails
required: true
schema:
$ref: '#/components/schemas/EnableAutomaticInitialPlanCaptureDetails'
CompareBaselineTimeQueryParam:
description: The baseline time for metrics comparison.
in: query
name: compareBaselineTime
required: true
schema:
type: string
SqlPlanNameOptionalQueryParam:
description: A filter to return only SQL plan baselines that match the plan name.
in: query
name: planName
required: false
x-default-description: 'null'
schema:
type: string
UpdateManagedDatabaseGroupDetailsBodyParam:
description: The details required to update a Managed Database Group.
in: body
name: UpdateManagedDatabaseGroupDetails
required: true
schema:
$ref: '#/components/schemas/UpdateManagedDatabaseGroupDetails'
EnableSqlPlanBaselinesUsageDetailsBodyParam:
description: The details required to enable SQL plan baseline usage.
in: body
name: EnableSqlPlanBaselinesUsageDetails
required: true
schema:
$ref: '#/components/schemas/EnableSqlPlanBaselinesUsageDetails'
IsSqlPlanFixedQueryParam:
description: 'A filter to return only SQL plan baselines that are either fixed or not fixed.
By default, all SQL plan baselines are returned.
'
in: query
name: isFixed
required: false
x-default-description: 'null'
schema:
type: boolean
RemoveManagedDatabaseFromManagedDatabaseGroupDetailsBodyParam:
description: The Managed Database details required to remove the Managed Database from a Managed Database Group.
in: body
name: RemoveManagedDatabaseFromManagedDatabaseGroupDetails
required: true
schema:
$ref: '#/components/schemas/RemoveManagedDatabaseFromManagedDatabaseGroupDetails'
DatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database.
in: path
name: databaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalExadataInfrastructureDetailsBodyParam:
description: The details required to update the managed Exadata infrastructure resources.
in: body
name: UpdateExternalExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalExadataInfrastructureDetails'
GroupByQueryParam:
description: The optimizer statistics tasks grouped by type.
in: query
name: groupType
required: true
x-obmcs-top-level-enum: '#/definitions/OptimizerStatisticsGroupByTypes'
schema:
type: string
enum:
- TASK_STATUS
- TASK_OBJECTS_STATUS
IsNeverExecutedQueryParam:
description: 'A filter to return only SQL plan baselines that are not executed till now.
By default, all SQL plan baselines are returned.
'
in: query
name: isNeverExecuted
required: false
schema:
type: boolean
default: false
ChangeCloudExadataInfrastructureCompartmentDetailsBodyParam:
description: The details required to move the Exadata infrastructure from one compartment to another.
in: body
name: ChangeCloudExadataInfrastructureCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeCloudExadataInfrastructureCompartmentDetails'
ComponentTypesFilterQueryParam:
description: The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types.
in: query
name: filterByComponentTypes
required: false
x-default-description: 'null'
schema:
type: string
FilterByDatbaseSubTypeParam:
description: The filter used to filter the databases in the fleet by a specific Oracle Database subtype.
in: query
name: filterByDatabaseSubType
required: false
x-default-description: 'null'
schema:
type: string
UpdateExternalExadataStorageConnectorDetailsBodyParam:
description: The details required to update connections to the Exadata storage servers.
in: body
name: UpdateExternalExadataStorageConnectorDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalExadataStorageConnectorDetails'
FilterByDatabaseTypeParam:
description: The filter used to filter the databases in the fleet by a specific Oracle Database type.
in: query
name: filterByDatabaseType
required: false
x-default-description: 'null'
schema:
type: string
StartTimeGreaterThanOrEqualToQueryParam:
description: 'The start time of the time range to retrieve the optimizer statistics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: startTimeGreaterThanOrEqualTo
required: false
schema:
type: string
AwrMinValueOptionalQueryParam:
description: The minimum value of the histogram.
in: query
name: minValue
required: false
schema:
type: number
format: double
default: 0
ExternalMySqlDatabaseConnectorIdPathParam:
description: The OCID of the External MySQL Database Connector.
in: path
name: externalMySqlDatabaseConnectorId
required: true
x-default-description: 'null'
schema:
type: string
ModifyDatabaseManagementFeatureBodyParam:
description: The details required to modify a Database Management feature for an Oracle cloud database.
in: body
name: ModifyDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/ModifyDatabaseManagementFeatureDetails'
SqlTextOptionalQueryParam:
description: 'A filter to return all the SQL plan baselines that match the SQL text. By default, the search
is case insensitive. To run an exact or case-sensitive search, double-quote the search string.
You may also use the ''%'' symbol as a wildcard.
'
in: query
name: sqlText
required: false
x-default-description: 'null'
schema:
type: string
UpdatePreferredCredentialBodyParam:
description: The details required to update preferred credential.
in: body
name: UpdatePreferredCredentialDetails
required: true
schema:
$ref: '#/components/schemas/UpdatePreferredCredentialDetails'
DbSystemMetricsEndTimeQueryParam:
description: 'The end of the time range set to retrieve metric data for the DB system
and its members. Expressed in UTC in ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
in: query
name: endTime
required: true
schema:
type: string
NamedCredentialIdHeader:
description: The OCID of the Named Credential.
in: header
name: opc-named-credential-id
required: false
x-default-description: 'null'
schema:
type: string
ExternalAsmInstanceIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance.
in: path
name: externalAsmInstanceId
required: true
schema:
type: string
maxLength: 255
minLength: 1
PluggableDatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle cloud pluggable database.
in: path
name: pluggableDatabaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
IsAllowedValuesIncludedQueryParam:
description: 'When true, results include a list of valid values for parameters (if applicable).
'
in: query
name: isAllowedValuesIncluded
required: false
schema:
type: boolean
default: false
CloudAsmIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
in: path
name: cloudAsmId
required: true
schema:
type: string
maxLength: 255
minLength: 1
TestNamedCredentialBodyParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database against which the credential is to be tested.
in: body
name: TestNamedCredentialDetails
required: true
schema:
$ref: '#/components/schemas/TestNamedCredentialDetails'
CreateExternalMySqlDatabaseDetails:
description: The details required to create an external MySQL database resource.
in: body
name: CreateExternalMySqlDatabaseDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalMySqlDatabaseDetails'
x-default-description: 'null'
DeploymentTypeQueryParam:
description: A filter to return Managed Databases of the specified deployment type.
in: query
name: deploymentType
required: false
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
schema:
type: string
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
ExternalExadataInfrastructureIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
in: path
name: externalExadataInfrastructureId
required: true
schema:
type: string
maxLength: 255
minLength: 1
AddDataFilesDetailsBodyParam:
description: 'The details required to add data files or temp files to the tablespace.
'
in: body
name: AddDataFilesDetails
required: true
schema:
$ref: '#/components/schemas/AddDataFilesDetails'
AwrDbNameSampledTimeSortByQueryParam:
description: The option to sort the AWR time series summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIMESTAMP
- NAME
default: TIMESTAMP
CloudDbSystemConnectorIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
in: path
name: cloudDbSystemConnectorId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DatabaseHostedInQueryParam:
description: Indicates whether the database is a cloud database or an external database.
in: query
name: databaseHostedIn
required: true
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/DatabaseHostedIn'
schema:
type: string
enum:
- CLOUD
- EXTERNAL
CloudDbSystemIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
in: query
name: cloudDbSystemId
required: false
schema:
type: string
maxLength: 255
minLength: 1
EnableAutonomousDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an Autonomous Database.
in: body
name: EnableAutonomousDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnableAutonomousDatabaseManagementFeatureDetails'
ChangeDatabaseParametersDetailsBodyParam:
description: The details required to change database parameter values.
in: body
name: ChangeDatabaseParametersDetails
required: true
schema:
$ref: '#/components/schemas/ChangeDatabaseParametersDetails'
IsSqlPlanEnabledQueryParam:
description: 'A filter to return only SQL plan baselines that are either enabled or not enabled.
By default, all SQL plan baselines are returned.
'
in: query
name: isEnabled
required: false
x-default-description: 'null'
schema:
type: boolean
EnableExternalDbSystemDatabaseManagementDetailsBodyParam:
description: The details required to enable Database Management for an external DB system.
in: body
name: EnableExternalDbSystemDatabaseManagementDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalDbSystemDatabaseManagementDetails'
CompareTypeQueryParam:
description: The time window used for metrics comparison.
in: query
name: compareType
required: false
x-default-description: HOUR
x-obmcs-top-level-enum: '#/definitions/CompareType'
schema:
type: string
enum:
- HOUR
- DAY
- WEEK
JobRunStatusQueryParam:
description: The status of the job run.
in: query
name: runStatus
required: false
x-default-description: 'null'
schema:
type: string
JobRunIdQueryParam:
description: The identifier of the job run.
in: query
name: jobRunId
required: false
x-default-description: 'null'
schema:
type: string
FilterByDefinedTagExistsQueryParam:
description: 'A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned.
Each item in the list has the format "{namespace}.{tagName}.true" (for checking existence of a defined tag)
or "{namespace}.true". All inputs are case-insensitive.
Currently, only existence ("true" at the end) is supported. Absence ("false" at the end) is not supported.
Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
'
in: query
name: definedTagExists
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 207
type: string
IsClusterDbManagementPrivateEndpointQueryParam:
description: 'The option to filter Database Management private endpoints that can used for Oracle Databases in a cluster. This should be used along with the vcnId query parameter.
'
in: query
name: isCluster
schema:
type: boolean
default: false
EntityNameContainsFilterOptionalQueryParam:
description: The optional contains query parameter to filter the entity name by any part of the name.
in: query
name: nameContains
required: false
x-default-description: 'null'
schema:
type: string
ParametersSortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The
default sort order for `NAME` is ascending and it is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- NAME
default: NAME
EntityNameQueryParam:
description: The required single value query parameter to filter the entity name.
in: query
name: name
required: true
schema:
type: string
ExternalExadataStorageServerIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
in: path
name: externalExadataStorageServerId
required: true
schema:
type: string
maxLength: 255
minLength: 1
DisableExternalContainerDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an external container database.
in: body
name: DisableExternalContainerDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisableExternalContainerDatabaseManagementFeatureDetails'
FleetPaginationLimitQueryParam:
description: The maximum number of records returned in the paginated response.
in: query
name: limit
schema:
type: integer
default: 10
maximum: 2000
minimum: 1
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
ExternalExadataStorageGridIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage grid.
in: path
name: externalExadataStorageGridId
required: true
schema:
type: string
maxLength: 255
minLength: 1
UpdateExternalAsmDetailsBodyParam:
description: The details required to update an external ASM.
in: body
name: UpdateExternalAsmDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalAsmDetails'
EntityNamesQueryParam:
description: The required multiple value query parameter to filter the entity name.
in: query
name: name
required: true
style: form
explode: true
schema:
type: array
items:
type: string
SessionTypeQueryParam:
description: The optional query parameter to filter ASH activities by FOREGROUND or BACKGROUND.
in: query
name: sessionType
required: false
schema:
type: string
enum:
- FOREGROUND
- BACKGROUND
- ALL
default: FOREGROUND
OperationIdPathParam:
description: The ID of the Optimizer Statistics Collection operation.
in: path
name: optimizerStatisticsCollectionOperationId
required: true
schema:
type: number
format: integer
CreateManagedDatabaseGroupDetailsBodyParam:
description: The details required to create a Managed Database Group.
in: body
name: CreateManagedDatabaseGroupDetails
required: true
schema:
$ref: '#/components/schemas/CreateManagedDatabaseGroupDetails'
FilterByNameParam:
description: The parameter to filter by MySQL Database System type.
in: query
name: name
required: false
x-default-description: 'null'
schema:
type: string
SortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The default sort order
for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending.
The ‘NAME’ sort order is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- TIMECREATED
- NAME
default: TIMECREATED
AwrDbCpuSortByQueryParam:
description: The option to sort the AWR CPU usage summary data.
in: query
name: sortBy
required: false
schema:
type: string
enum:
- TIME_SAMPLED
- AVG_VALUE
default: TIME_SAMPLED
CreateCloudDbSystemConnectorDetailsBodyParam:
description: The details required to create a cloud connector.
in: body
name: CreateCloudDbSystemConnectorDetails
required: true
schema:
$ref: '#/components/schemas/CreateCloudDbSystemConnectorDetails'
UpdateCloudClusterDetailsBodyParam:
description: The details required to update a cloud cluster.
in: body
name: UpdateCloudClusterDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudClusterDetails'
IsSqlPlanAutoPurgedQueryParam:
description: 'A filter to return only SQL plan baselines that are either auto-purged or not auto-purged.
By default, all SQL plan baselines are returned.
'
in: query
name: isAutoPurged
required: false
x-default-description: 'null'
schema:
type: boolean
VcnIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN.
in: query
name: vcnId
required: false
schema:
type: string
maxLength: 255
minLength: 1
SortOrderDescQueryParam:
description: The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order.
in: query
name: sortOrder
x-obmcs-top-level-enum: '#/definitions/SortOrders'
schema:
type: string
enum:
- ASC
- DESC
default: DESC
CreateNamedCredentialDetailsBodyParam:
description: The details required to create a named credential.
in: body
name: CreateNamedCredentialDetails
required: true
schema:
$ref: '#/components/schemas/CreateNamedCredentialDetails'
StartTimeQueryParam:
description: 'The start time of the time range to retrieve the health metrics of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
in: query
name: startTime
required: true
schema:
type: string
SqlIdQueryParam:
description: 'The parameter to filter SQL by ID. Note that the SQL ID is generated internally by Oracle for each SQL statement and can be retrieved from AWR Report API (/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbReport) or Performance Hub API (/internal/managedDatabases/{managedDatabaseId}/actions/retrievePerformanceData)
'
in: query
name: sqlId
required: true
schema:
type: string
IsSqlPlanReproducedQueryParam:
description: 'A filter to return only SQL plan baselines that were either reproduced or
not reproduced by the optimizer. By default, all SQL plan baselines are returned.
'
in: query
name: isReproduced
required: false
x-default-description: 'null'
schema:
type: boolean
CreateCloudExadataInfrastructureDetailsBodyParam:
description: The details required to create the managed Exadata infrastructure resources.
in: body
name: CreateCloudExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/CreateCloudExadataInfrastructureDetails'
ManagementOptionQueryParam:
description: A filter to return Managed Databases with the specified management option.
in: query
name: managementOption
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/ManagementOption'
schema:
type: string
enum:
- BASIC
- ADVANCED
FilterByDatabaseDeploymentTypeParam:
description: The filter used to filter the databases in the fleet by a specific Oracle Database deployment type.
in: query
name: filterByDatabaseDeploymentType
required: false
x-default-description: 'null'
schema:
type: string
EnableExternalDatabaseManagementDetails:
description: The details required to enable an external MySQL database resource.
in: body
name: EnableExternalDatabaseManagementDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalDatabaseManagementDetails'
x-default-description: 'null'
DisplayNameQueryParam:
description: A filter to only return the resources that match the entire display name.
in: query
name: displayName
required: false
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
ManagedDatabaseIdRequiredQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
in: query
name: managedDatabaseId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
EnableAutomaticSpmEvolveAdvisorTaskDetailsBodyParam:
description: The details required to enable Automatic SPM Evolve Advisor task.
in: body
name: EnableAutomaticSpmEvolveAdvisorTaskDetails
required: true
schema:
$ref: '#/components/schemas/EnableAutomaticSpmEvolveAdvisorTaskDetails'
CreateExternalDbSystemDiscoveryDetailsBodyParam:
description: The details required to create an external DB system discovery.
in: body
name: CreateExternalDbSystemDiscoveryDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalDbSystemDiscoveryDetails'
CloudDbSystemDiscoveryIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery.
in: path
name: cloudDbSystemDiscoveryId
required: true
schema:
type: string
maxLength: 255
minLength: 1
JobLifecycleStateQueryParam:
description: The lifecycle state of the job.
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/Job/lifecycleState'
schema:
type: string
EnablePluggableDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an Oracle cloud pluggable database.
in: body
name: EnablePluggableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnablePluggableDatabaseManagementFeatureDetails'
EndSnapshotOptionalQueryParam:
description: The optional less than or equal to query parameter to filter the snapshot ID.
in: query
name: endSnIdLessThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: integer
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
UpdateExternalClusterInstanceDetailsBodyParam:
description: The details required to update an external cluster instance.
in: body
name: UpdateExternalClusterInstanceDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalClusterInstanceDetails'
ChangeSpaceBudgetDetailsBodyParam:
description: The details required to change the disk space limit for the SQL Management Base.
in: body
name: ChangeSpaceBudgetDetails
required: true
schema:
$ref: '#/components/schemas/ChangeSpaceBudgetDetails'
EnableExternalPluggableDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an external pluggable database.
in: body
name: EnableExternalPluggableDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalPluggableDatabaseManagementFeatureDetails'
ExternalDbSystemConnectorIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
in: path
name: externalDbSystemConnectorId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ContainerIdOptionalQueryParam:
description: 'The optional query parameter to filter the database container by an exact ID value.
Note that the database container ID can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
'
in: query
name: containerId
required: false
x-default-description: 'null'
schema:
type: integer
SqlHandleOptionalQueryParam:
description: A filter to return all the SQL plan baselines for the specified SQL handle.
in: query
name: sqlHandle
required: false
x-default-description: 'null'
schema:
type: string
UpdateJobDetailsBodyParam:
description: The details required to update a job.
in: body
name: UpdateJobDetails
required: true
schema:
$ref: '#/components/schemas/UpdateJobDetails'
EnableExternalNonContainerDatabaseManagementFeatureBodyParam:
description: The details required to enable a Database Management feature for an external non-container database.
in: body
name: EnableExternalNonContainerDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/EnableExternalNonContainerDatabaseManagementFeatureDetails'
ConfigureAutomaticSpmEvolveAdvisorTaskDetailsBodyParam:
description: The configuration details of the Automatic SPM Evolve Advisor task.
in: body
name: ConfigureAutomaticSpmEvolveAdvisorTaskDetails
required: true
schema:
$ref: '#/components/schemas/ConfigureAutomaticSpmEvolveAdvisorTaskDetails'
PaginationLargeLimitQueryParam:
description: The maximum number of records returned in large paginated response.
in: query
name: limit
schema:
type: integer
default: 1000
maximum: 100000
minimum: 1
IsSqlPlanAcceptedQueryParam:
description: 'A filter to return only SQL plan baselines that are either accepted or not accepted.
By default, all SQL plan baselines are returned.
'
in: query
name: isAccepted
required: false
x-default-description: 'null'
schema:
type: boolean
RetryTokenHeader:
description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations. For example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
might be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
CompareTargetTimeQueryParam:
description: The target time for metrics comparison.
in: query
name: compareTargetTime
required: true
schema:
type: string
ExternalPluggableDatabaseIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external pluggable database.
in: path
name: externalPluggableDatabaseId
required: true
schema:
type: string
maxLength: 255
minLength: 1
ChangeJobCompartmentDetailsBodyParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the job to.
in: body
name: ChangeJobCompartmentDetails
required: true
schema:
$ref: '#/components/schemas/ChangeJobCompartmentDetails'
LoadSqlPlanBaselinesFromAwrDetailsBodyParam:
description: The details required to load plans from Automatic Workload Repository (AWR).
in: body
name: LoadSqlPlanBaselinesFromAwrDetails
required: true
schema:
$ref: '#/components/schemas/LoadSqlPlanBaselinesFromAwrDetails'
DisableAutonomousDatabaseManagementFeatureBodyParam:
description: The details required to disable a Database Management feature for an Autonomous Database.
in: body
name: DisableAutonomousDatabaseManagementFeatureDetails
required: true
schema:
$ref: '#/components/schemas/DisableAutonomousDatabaseManagementFeatureDetails'
CredentialNamePathParam:
description: "The name of the preferred credential. There are 3 built-in preferred credentials with display names and names as below: \n Basic Monitoring(MONITORING)\n Advanced diagnostics(PC_READ)\n Administrator(PC_WRITE)\n"
in: path
name: credentialName
required: true
schema:
type: string
TimeLastExecutedLessThanQueryParam:
description: 'A filter to return only SQL plan baselines whose last execution time is
before the specified value. By default, all SQL plan baselines are returned.
'
in: query
name: timeLastExecutedLessThan
required: false
x-default-description: 'null'
schema:
type: string
format: date-time
CreateExternalDbSystemConnectorDetailsBodyParam:
description: The details required to create an external connector.
in: body
name: CreateExternalDbSystemConnectorDetails
required: true
schema:
$ref: '#/components/schemas/CreateExternalDbSystemConnectorDetails'
DiscoverExternalExadataInfrastructureDetailsBodyParam:
description: The details required to discover and monitor the Exadata infrastructure.
in: body
name: DiscoverExternalExadataInfrastructureDetails
required: true
schema:
$ref: '#/components/schemas/DiscoverExternalExadataInfrastructureDetails'
InstNumbersOptionalQueryParam:
description: The optional multiple value query parameter to filter the database instance numbers.
in: query
name: instNums
required: false
x-default-description: 'null'
style: form
explode: false
schema:
type: array
items:
type: integer
UpdateExternalMySqlDatabaseConnectorDetails:
description: The details required to update MySQL database connector resource.
in: body
name: UpdateExternalMySqlDatabaseConnectorDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalMySqlDatabaseConnectorDetails'
x-default-description: 'null'
UpdateExternalDbNodeDetailsBodyParam:
description: The details required to update an external DB node.
in: body
name: UpdateExternalDbNodeDetails
required: true
schema:
$ref: '#/components/schemas/UpdateExternalDbNodeDetails'
FilterByDefinedTagEqualsQueryParam:
description: 'A list of tag filters to apply. Only resources with a defined tag matching the value will be returned.
Each item in the list has the format "{namespace}.{tagName}.{value}". All inputs are case-insensitive.
Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR".
Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND".
'
in: query
name: definedTagEquals
required: false
x-default-description: 'null'
style: form
explode: true
schema:
type: array
items:
maxLength: 458
type: string
SqlPlanNamePathParam:
description: The plan name of the SQL plan baseline.
in: path
name: planName
required: true
schema:
type: string
UpdateManagedDatabaseDetailsBodyParam:
description: The details required to update a Managed Database.
in: body
name: UpdateManagedDatabaseDetails
required: true
schema:
$ref: '#/components/schemas/UpdateManagedDatabaseDetails'
IsDnsResolutionEnabledPrivateEndpointQueryParam:
description: 'The option to filter Database Management private endpoints which are endbled with DNS proxy server. This should be used along with the vcnId query parameter.
Only one of this parameter and IsClusterDbManagementPrivateEndpointQueryParam should be set to true at one time.
'
in: query
name: isDnsResolutionEnabled
schema:
type: boolean
default: false
DisableAutomaticInitialPlanCaptureDetailsBodyParam:
description: The details required to disable automatic initial plan capture.
in: body
name: DisableAutomaticInitialPlanCaptureDetails
required: true
schema:
$ref: '#/components/schemas/DisableAutomaticInitialPlanCaptureDetails'
DbSystemSortByQueryParam:
description: 'The field to sort information by. Only one sortOrder can be used. The default sort order
for `TIMECREATED` is descending and the default sort order for `DISPLAYNAME` is ascending.
The `DISPLAYNAME` sort order is case-sensitive.
'
in: query
name: sortBy
schema:
type: string
enum:
- TIMECREATED
- DISPLAYNAME
default: TIMECREATED
UpdateCloudAsmInstanceDetailsBodyParam:
description: The details required to update a cloud ASM instance.
in: body
name: UpdateCloudAsmInstanceDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudAsmInstanceDetails'
UpdateCloudDbHomeDetailsBodyParam:
description: The details required to update a cloud DB home.
in: body
name: UpdateCloudDbHomeDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudDbHomeDetails'
EnableCloudExadataInfrastructureManagementDetailsBodyParam:
description: The details required to enable management for the Exadata infrastructure.
in: body
name: EnableCloudExadataInfrastructureManagementDetails
required: true
schema:
$ref: '#/components/schemas/EnableCloudExadataInfrastructureManagementDetails'
LoadSqlPlanBaselinesFromCursorCacheDetailsBodyParam:
description: The details of SQL statements and plans to be loaded from cursor cache.
in: body
name: LoadSqlPlanBaselinesFromCursorCacheDetails
required: true
schema:
$ref: '#/components/schemas/LoadSqlPlanBaselinesFromCursorCacheDetails'
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
UpdateCloudClusterInstanceDetailsBodyParam:
description: The details required to update a cloud cluster instance.
in: body
name: UpdateCloudClusterInstanceDetails
required: true
schema:
$ref: '#/components/schemas/UpdateCloudClusterInstanceDetails'
BeginSnapshotOptionalQueryParam:
description: The optional greater than or equal to filter on the snapshot ID.
in: query
name: beginSnIdGreaterThanOrEqualTo
required: false
x-default-description: 'null'
schema:
type: integer
schemas:
CloudCluster:
description: The details of a cloud cluster.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the cloud cluster defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud cluster.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud cluster. The name does not have to be unique.
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
gridHome:
description: The directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster.
type: string
isFlexCluster:
description: Indicates whether the cluster is Oracle Flex Cluster or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud cluster.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
networkConfigurations:
description: The list of network address configurations of the cloud cluster.
items:
$ref: '#/components/schemas/CloudClusterNetworkConfiguration'
maxItems: 10
type: array
ocrFileLocation:
description: The location of the Oracle Cluster Registry (OCR).
type: string
scanConfigurations:
description: The list of Single Client Access Name (SCAN) configurations of the cloud cluster.
items:
$ref: '#/components/schemas/CloudClusterScanListenerConfiguration'
maxItems: 10
type: array
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
timeCreated:
description: The date and time the cloud cluster was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud cluster was last updated.
format: date-time
type: string
version:
description: The cluster version.
type: string
vipConfigurations:
description: The list of Virtual IP (VIP) configurations of the cloud cluster.
items:
$ref: '#/components/schemas/CloudClusterVipConfiguration'
maxItems: 10
type: array
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
JobExecutionsStatusSummaryCollection:
description: A collection of job execution status summary objects.
properties:
items:
description: A list of JobExecutionsSummary objects.
items:
$ref: '#/components/schemas/JobExecutionsStatusSummary'
type: array
required:
- items
type: object
AwrDbSysstatCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_SYSSTAT_SET
properties:
items:
description: A list of AWR SYSSTAT summary data.
items:
$ref: '#/components/schemas/AwrDbSysstatSummary'
type: array
description: The AWR SYSSTAT time series summary data.
type: object
ExternalAsmUserSummary:
description: The summary of an ASM user.
properties:
asmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
type: string
name:
description: The name of the ASM user.
type: string
privileges:
description: The list of privileges of the ASM user.
items:
type: string
type: array
uniqueItems: true
required:
- name
- privileges
type: object
CursorCacheStatementSummary:
description: The summary of a SQL statement in the cursor cache.
properties:
schema:
description: The name of the parsing schema.
maxLength: 128
type: string
sqlId:
description: The SQL statement identifier. Identifies a SQL statement in the cursor cache.
maxLength: 13
type: string
sqlText:
description: The first thousand characters of the SQL text.
maxLength: 1000
type: string
required:
- sqlId
- schema
- sqlText
type: object
AwrDbWaitEventSummary:
description: The summary of the AWR wait event time series data for one event.
properties:
avgWaitTimePerSec:
description: The average wait time per second.
format: double
type: number
avgWaitTimePerWait:
description: The average wait time in milliseconds per wait.
format: double
type: number
name:
description: The name of the event.
type: string
snapshotId:
description: 'The ID of the snapshot. The snapshot ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
'
type: integer
timeBegin:
description: The begin time of the wait event.
format: date-time
type: string
timeEnd:
description: The end time of the wait event.
format: date-time
type: string
waitsPerSec:
description: The wait count per second.
format: double
type: number
required:
- name
type: object
ExternalAsmInstanceParameters:
description: The initialization parameters for an ASM instance.
properties:
asmInstanceDisplayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
type: string
asmInstanceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance.
type: string
autoMountDiskGroups:
description: 'The list of disk group names that an ASM instance mounts at startup or when the `ALTER DISKGROUP ALL MOUNT` statement is issued.
'
items:
type: string
type: array
diskDiscoveryPath:
description: 'An operating system-dependent value used to limit the set of disks considered for discovery.
'
type: string
preferredReadFailureGroups:
description: The list of failure groups that contain preferred read disks.
items:
type: string
type: array
rebalancePower:
description: 'The maximum power on an ASM instance for disk rebalancing.
'
maximum: 1024
minimum: 0
type: integer
required:
- asmInstanceId
- asmInstanceDisplayName
- diskDiscoveryPath
- autoMountDiskGroups
- rebalancePower
- preferredReadFailureGroups
type: object
EnableExternalExadataInfrastructureManagementDetails:
description: The details required to enable Database Management on the Exadata infrastructure.
properties:
licenseModel:
description: 'The Oracle license model.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
required:
- licenseModel
type: object
ExadataInfrastructureUsageMetrics:
description: The list of aggregated metrics for Exadata infrastructures in the fleet.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Exadata infrastructure resides.
type: string
deploymentType:
description: The Exadata infrastructure deployment type.
enum:
- ONPREMISE
- EXADATA
- EXADATA_CC
type: string
x-obmcs-top-level-enum: '#/definitions/ExadataInfrastructureDeploymentType'
infrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
type: string
infrastructureName:
description: The display name of the Exadata infrastructure.
type: string
metrics:
description: A list of the health metrics like CPU, Storage, and Memory.
items:
$ref: '#/components/schemas/ExadataFleetMetricDefinition'
type: array
numberOfDbSystems:
description: The number of Database Systems created on the Exadata infrastructure.
type: integer
rackSize:
description: The size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
- OTHER
type: string
state:
description: The lifecycle state of the Exadata infrastructure.
type: string
x-obmcs-enumref: '#/definitions/ExadataInfrastructureLifecycleStateValues/state'
storageServerCount:
description: The number of storage server for the Exadata infrastructure.
type: integer
type: object
JobExecution:
description: The details of a job execution.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the parent job resides.
type: string
databaseSubType:
description: The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
deploymentType:
description: A list of the supported infrastructure that can be used to deploy the database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
errorMessage:
description: 'The error message that is returned if the job execution fails. Null is returned if the job is
still running or if the job execution is successful.
'
type: string
id:
description: The identifier of the job execution.
type: string
inBinds:
$ref: '#/components/schemas/JobInBindsDetails'
isCluster:
description: Indicates whether the Oracle Database is part of a cluster.
type: boolean
jobId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent job.
type: string
jobName:
description: The name of the parent job.
type: string
jobRunId:
description: The identifier of the associated job run.
type: string
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the parent job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database associated with the job execution.
type: string
managedDatabaseName:
description: The name of the Managed Database associated with the job execution.
type: string
name:
description: The name of the job execution.
type: string
outBinds:
$ref: '#/components/schemas/JobOutBindsDetails'
resultDetails:
$ref: '#/components/schemas/JobExecutionResultDetails'
scheduleDetails:
$ref: '#/components/schemas/JobScheduleDetails'
sqlText:
description: The SQL text executed as part of the job.
type: string
status:
description: The status of the job execution.
enum:
- SUCCEEDED
- FAILED
- IN_PROGRESS
type: string
timeCompleted:
description: The date and time when the job execution completed.
format: date-time
type: string
timeCreated:
description: The date and time when the job execution was created.
format: date-time
type: string
userName:
description: The database user name used to execute the SQL job.
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- id
- name
- compartmentId
- managedDatabaseId
- managedDatabaseName
- jobId
- jobName
- jobRunId
- status
- timeCreated
ExternalClusterScanListenerConfiguration:
description: The details of a SCAN listener in an external cluster.
properties:
networkNumber:
description: The network number from which SCAN VIPs are obtained.
type: integer
scanName:
description: The name of the SCAN listener.
type: string
scanPort:
description: The port number of the SCAN listener.
maximum: 65535
minimum: 1
type: integer
scanProtocol:
description: The protocol of the SCAN listener.
enum:
- TCP
- TCPS
type: string
type: object
UpdateCloudListenerDetails:
description: The details required to update a cloud listener.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
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
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
type: object
PeerDatabaseMetrics:
description: The summary of resource usage metrics for the peer database.
properties:
peerDbMetrics:
description: A list of resource usage metrics for the peer database.
items:
$ref: '#/components/schemas/DatabaseUsageMetrics'
type: array
required:
- peerDbMetrics
type: object
FleetMetricSummaryDefinition:
description: A summary of the fleet metrics, which provides the metric aggregated value of the databases in the fleet.
properties:
baselineValue:
description: The metric aggregated value at the baseline date and time.
format: double
type: number
dimensions:
description: The unique dimension key and values of the baseline metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
percentageChange:
description: The percentage change in the metric aggregated value compared to the baseline value.
format: double
type: number
targetValue:
description: The metric aggregated value at the target date and time.
format: double
type: number
unit:
description: The unit of the value.
type: string
type: object
ExternalDbSystemConnectorCollection:
description: A collection of external DB system connectors.
properties:
items:
description: An array of external DB system connectors.
items:
$ref: '#/components/schemas/ExternalDbSystemConnectorSummary'
type: array
required:
- items
type: object
ChangeDbManagementPrivateEndpointCompartmentDetails:
description: The details used to move the Database Management private endpoint to another compartment.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to which the Database Management private endpoint needs to be moved.
maxLength: 255
minLength: 1
type: string
DatabaseHomeMetricDefinition:
description: The response containing the CPU, Storage, Wait, DB Time, and Memory metrics for a specific Managed Database.
properties:
activityTimeSeriesMetrics:
description: A list of the active session metrics for CPU and Wait time for a specific Managed Database.
items:
$ref: '#/components/schemas/ActivityTimeSeriesMetrics'
type: array
cpuUtilizationAggregateMetrics:
$ref: '#/components/schemas/CpuUtilizationAggregateMetrics'
dbStorageAggregateMetrics:
$ref: '#/components/schemas/DatabaseStorageAggregateMetrics'
dbTimeAggregateMetrics:
$ref: '#/components/schemas/DatabaseTimeAggregateMetrics'
failedConnectionsAggregateMetrics:
$ref: '#/components/schemas/FailedConnectionsAggregateMetrics'
ioAggregateMetrics:
$ref: '#/components/schemas/DatabaseIOAggregateMetrics'
memoryAggregateMetrics:
$ref: '#/components/schemas/MemoryAggregateMetrics'
statementsAggregateMetrics:
$ref: '#/components/schemas/StatementsAggregateMetrics'
required:
- activityTimeSeriesMetrics
- dbTimeAggregateMetrics
- ioAggregateMetrics
- memoryAggregateMetrics
- dbStorageAggregateMetrics
type: object
CloudDatabaseCollection:
description: A collection of cloud databases.
properties:
items:
description: An array of cloud databases.
items:
$ref: '#/components/schemas/CloudDatabaseSummary'
type: array
required:
- items
type: object
ExternalAsmDiskGroupSummary:
description: The summary of an external ASM disk group.
properties:
databases:
description: The unique names of the databases using the disk group.
items:
type: string
type: array
dismountingInstanceCount:
description: The number of ASM instances that have the disk group in dismounted state.
format: int32
type: integer
isSparse:
description: Indicates whether the disk group is a sparse disk group or not.
type: boolean
mountingInstanceCount:
description: The number of ASM instances that have the disk group in mounted state.
format: int32
type: integer
name:
description: The name of the ASM disk group.
type: string
redundancyType:
description: The redundancy type of the disk group.
enum:
- EXTEND
- EXTERN
- FLEX
- HIGH
- NORMAL
type: string
totalSizeInMBs:
description: The total capacity of the disk group (in megabytes).
format: int64
type: integer
usedPercent:
description: The percentage of used space in the disk group.
format: float
type: number
usedSizeInMBs:
description: The used capacity of the disk group (in megabytes).
format: int64
type: integer
required:
- name
type: object
ExternalExadataDatabaseSystemSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: DATABASE_SYSTEM_SUMMARY
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
description: The DB systems of the Exadata infrastructure.
type: object
AwrDbSnapshotRangeCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_SNAPSHOT_RANGE_SET
properties:
items:
description: A list of AWR snapshot range summary data.
items:
$ref: '#/components/schemas/AwrDbSnapshotRangeSummary'
type: array
description: The AWR snapshot range list.
type: object
ObjectPrivilegeCollection:
description: A collection of object privileges granted to the current user.
properties:
items:
description: An array of object privileges.
items:
$ref: '#/components/schemas/ObjectPrivilegeSummary'
type: array
required:
- items
type: object
ExternalPluggableDatabaseFeatureDetails:
description: The details required to enable the specified Database Management feature.
discriminator:
propertyName: feature
properties:
connectorDetails:
$ref: '#/components/schemas/ConnectorDetails'
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
- connectorDetails
type: object
DisableAutonomousDatabaseManagementFeatureDetails:
description: The details required to disable a Database Management feature for an Autonomous Database.
properties:
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
ExternalExadataStorageConnectorCollection:
description: The Exadata storage server connector list.
properties:
items:
description: A list of Exadata storage server connectors.
items:
$ref: '#/components/schemas/ExternalExadataStorageConnectorSummary'
type: array
required:
- items
type: object
CreateCloudExadataInfrastructureDetails:
description: The details required to create the Exadata infrastructure.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
discoveryKey:
description: The unique key of the discovery request.
maxLength: 255
minLength: 1
type: string
displayName:
description: The name of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerNames:
description: The list of all the Exadata storage server names to be included for monitoring purposes. If not specified, all the Exadata storage servers associated with the VM Clusters are included.
items:
maxLength: 255
minLength: 1
type: string
type: array
vmClusterIds:
description: The list of VM Clusters in the Exadata infrastructure.
items:
maxLength: 255
minLength: 1
type: string
type: array
required:
- compartmentId
- vmClusterIds
type: object
ChangeSqlPlanBaselinesAttributesDetails:
description: 'The details required to change SQL plan baseline attributes.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
isAutoPurged:
description: Indicates whether the plan is purged if it is not used for a time period.
type: boolean
isEnabled:
description: Indicates whether the plan is available for use by the optimizer.
type: boolean
isFixed:
description: Indicates whether the plan baseline is fixed. A fixed plan takes precedence over a non-fixed plan.
type: boolean
planName:
description: 'Then plan name. It identifies a specific plan. If `null'' then all plans associated
with a SQL statement identified by `sqlHandle'' are considered for attribute changes.
'
type: string
sqlHandle:
description: 'The SQL statement handle. It identifies plans associated with a SQL statement
for attribute changes. If `null` then `planName` must be specified.
'
type: string
type: object
UpdateExternalExadataStorageGridDetails:
description: The details required to update an Exadata storage server grid.
properties:
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
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
type: object
UpdateCloudDbNodeDetails:
description: The details required to update a cloud DB node.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
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
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
type: object
CloudAsm:
description: The details of a cloud ASM.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the cloud ASM defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the ASM is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud ASM.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud ASM. The name does not have to be unique.
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
gridHome:
description: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
type: string
isCluster:
description: Indicates whether the ASM is a cluster ASM or not.
type: boolean
isFlexEnabled:
description: Indicates whether Oracle Flex ASM is enabled or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud ASM.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
servicedDatabases:
description: The list of databases that are serviced by the ASM.
items:
$ref: '#/components/schemas/CloudAsmServicedDatabase'
maxItems: 100
type: array
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
timeCreated:
description: The date and time the cloud ASM was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud ASM was last updated.
format: date-time
type: string
version:
description: The ASM version.
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
CloudDbHomeSummary:
description: The summary of a cloud database home.
properties:
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the DB home is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud DB home.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home in DBaas service.
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
displayName:
description: The user-friendly name for the cloud DB home. The name does not have to be unique.
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
homeDirectory:
description: The location of the DB home.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB home.
type: string
x-obmcs-enumref: '#/definitions/CloudDbHome/lifecycleState'
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
timeCreated:
description: The date and time the cloud DB home was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB home was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
PatchCloudDbSystemDiscoveryDetails:
description: The details required to update a cloud DB system discovery resource.
properties:
items:
description: A sequence of instructions to apply to the resource.
items:
$ref: '#/components/schemas/PatchInstruction'
maxItems: 100
type: array
type: object
CloudClusterSummary:
description: The summary of a cloud cluster.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud cluster.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud cluster. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud cluster.
type: string
x-obmcs-enumref: '#/definitions/CloudCluster/lifecycleState'
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
timeCreated:
description: The date and time the cloud cluster was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud cluster was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalExadataStorageGrid:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_GRID
properties:
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
serverCount:
description: The number of Exadata storage servers in the Exadata infrastructure.
format: integer
type: number
storageServers:
description: A list of monitored Exadata storage servers.
items:
$ref: '#/components/schemas/ExternalExadataStorageServerSummary'
type: array
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
description: The details of the Exadata storage server grid.
type: object
ObjectPrivilegeSummary:
description: A summary of object privileges.
properties:
common:
description: 'Indicates how the object privilege was granted. Possible values:
YES if the role is granted commonly (CONTAINER=ALL is used)
NO if the role is granted locally (CONTAINER=ALL is not used)
'
enum:
- 'YES'
- 'NO'
type: string
grantOption:
description: Indicates whether the privilege is granted with the GRANT OPTION (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
grantor:
description: The name of the user who granted the object privilege.
type: string
hierarchy:
description: Indicates whether the privilege is granted with the HIERARCHY OPTION (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
inherited:
description: Indicates whether the granted privilege is inherited from another container (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
name:
description: The name of the privilege on the object.
type: string
object:
description: The name of the object. The object can be any object, including tables, packages, indexes, sequences, and so on.
type: string
owner:
description: The owner of the object.
type: string
schemaType:
description: The type of object.
type: string
type: object
ExternalDbSystemDiscovery:
description: The details of an external DB system discovery.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the external DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
discoveredComponents:
description: The list of DB system components that were found in the DB system discovery.
items:
$ref: '#/components/schemas/DiscoveredExternalDbSystemComponent'
type: array
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
gridHome:
description: The directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system discovery resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
resourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing OCI resource matching the discovered DB system.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external DB system discovery was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system discovery was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- agentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
UpdateCloudExadataInfrastructureDetails:
description: The details required to update the Exadata infrastructure.
properties:
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
discoveryKey:
description: The unique key of the discovery request.
type: string
displayName:
description: The name of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerNames:
description: The list of the names of Exadata storage servers to be monitored. If not specified, it includes all Exadata storage servers associated with the monitored VM Clusters.
items:
maxLength: 255
minLength: 1
type: string
type: array
vmClusterIds:
description: The list of all the VM Cluster OCIDs.
items:
maxLength: 255
minLength: 1
type: string
type: array
type: object
PreferredCredential:
description: The details of the preferred credential.
discriminator:
propertyName: type
properties:
credentialName:
description: The name of the preferred credential.
type: string
isAccessible:
description: Indicates whether the preferred credential is accessible.
type: boolean
status:
description: The status of the preferred credential.
enum:
- SET
- NOT_SET
type: string
x-obmcs-top-level-enum: '#/definitions/PreferredCredentialStatus'
type:
description: The type of preferred credential. Only 'BASIC' is supported currently.
enum:
- BASIC
- NAMED_CREDENTIAL
type: string
x-obmcs-top-level-enum: '#/definitions/PreferredCredentialType'
type: object
ProxyUserCollection:
description: A collection of proxy users for the current user.
properties:
items:
description: An array of user resources.
items:
$ref: '#/components/schemas/ProxyUserSummary'
type: array
required:
- items
type: object
CloudAsmSummary:
description: The summary of a cloud ASM.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the ASM is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud ASM.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud ASM. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud ASM.
type: string
x-obmcs-enumref: '#/definitions/CloudAsm/lifecycleState'
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
timeCreated:
description: The date and time the cloud ASM was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud ASM was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalExadataInfrastructureDiscovery:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: INFRASTRUCTURE_DISCOVER
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
dbSystems:
description: The list of DB systems in the Exadata infrastructure.
items:
$ref: '#/components/schemas/ExternalDatabaseSystemDiscoverySummary'
type: array
discoveryKey:
description: The unique key of the discovery request.
type: string
gridHomePath:
description: The Oracle home path of the Exadata infrastructure.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
rackSize:
description: The size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
- UNKNOWN
type: string
storageGrid:
$ref: '#/components/schemas/ExternalStorageGridDiscoverySummary'
storageServers:
description: The list of storage servers in the Exadata infrastructure.
items:
$ref: '#/components/schemas/ExternalStorageServerDiscoverySummary'
type: array
required:
- discoveryKey
description: The result of the Exadata infrastructure discovery.
type: object
DatabaseFleetHealthMetrics:
description: The details of the fleet health metrics.
properties:
compareBaselineTime:
description: 'The baseline date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
This is the date and time against which percentage change is calculated.
'
type: string
compareTargetTime:
description: 'The target date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
All the metrics are returned for the target date and time and the percentage change
is calculated against the baseline date and time.
'
type: string
compareType:
description: The time window used for metrics comparison.
enum:
- HOUR
- DAY
- WEEK
type: string
x-obmcs-top-level-enum: '#/definitions/CompareType'
fleetDatabases:
description: A list of the databases present in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/DatabaseUsageMetrics'
type: array
fleetSummary:
$ref: '#/components/schemas/FleetSummary'
required:
- compareBaselineTime
- compareTargetTime
- fleetDatabases
type: object
DisableExternalPluggableDatabaseManagementFeatureDetails:
description: The details required to disable a Database Management feature for an external pluggable database.
properties:
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
DatabaseConnectionDetails:
description: The connection details required to connect to the database.
properties:
connectionCredentials:
$ref: '#/components/schemas/DatabaseConnectionCredentials'
connectionString:
$ref: '#/components/schemas/DatabaseConnectionStringDetails'
required:
- connectionString
- connectionCredentials
type: object
TestNamedCredentialStatus:
description: The status of the named credential test. The status is 'SUCCEEDED' if the named credential is working or else the status is 'FAILED'.
properties:
errorCode:
description: 'An error code that defines the failure of the named credential test. The response is ''null'' if the named credential test was successful.
'
type: string
errorMessage:
description: 'The error message that indicates the reason for the failure of the named credential test. The response is ''null'' if the named credential test was successful.
'
type: string
status:
description: The status of the named credential test. The status is 'SUCCEEDED' if the named credential is working or else the status is 'FAILED'.
enum:
- SUCCEEDED
- FAILED
type: string
required:
- status
type: object
UpdateExternalListenerDetails:
description: The details required to update an external listener.
properties:
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
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
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
type: object
PreferredCredentialCollection:
description: A collection of preferred credential attributes.
properties:
items:
description: The attributes of the preferred credential.
items:
$ref: '#/components/schemas/PreferredCredentialSummary'
type: array
required:
- items
type: object
DatabaseBackupSummary:
description: The summary of the High Availability (HA) and backup for a database.
properties:
backupDestination:
description: The backup destination of the database.
enum:
- DISK
- TAPE
- NFS
- LOCAL
- DBRS
- OBJECT_STORE
- RECOVERY_APPLIANCE
type: string
backupDurationInSeconds:
description: The backup duration of the database in seconds.
type: integer
backupSizeInGBs:
description: The backup size of the database.
format: float
type: number
backupStatus:
description: The backup status of the database.
type: string
backupType:
description: The backup type of the database (FULL/INCREMENTAL).
type: string
timeBackupCompleted:
description: The database backup completion date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
required:
- backupStatus
- timeBackupCompleted
- backupDurationInSeconds
- backupType
- backupDestination
- backupSizeInGBs
UpdateJobDetails:
description: The details required to update a job.
discriminator:
propertyName: jobType
properties:
description:
description: The description of the job.
maxLength: 400
type: string
jobType:
description: The type of job.
enum:
- SQL
type: string
x-obmcs-top-level-enum: '#/definitions/JobTypes'
resultLocation:
$ref: '#/components/schemas/JobExecutionResultLocation'
scheduleDetails:
$ref: '#/components/schemas/JobScheduleDetails'
timeout:
description: The job timeout duration, which is expressed like "1h 10m 15s".
type: string
type: object
CloudAsmCollection:
description: A collection of cloud ASMs.
properties:
items:
description: An array of cloud ASMs.
items:
$ref: '#/components/schemas/CloudAsmSummary'
type: array
required:
- items
type: object
DataAccessContainerSummary:
description: A summary of the ContainerDataAccess user.
properties:
name:
description: The name of the container included in the attribute.
type: string
type: object
MetricDimensionDefinition:
description: The metric dimension details.
properties:
dimensionName:
description: The name of the dimension.
type: string
dimensionValue:
description: The value of the dimension.
type: string
type: object
CloudClusterInstance:
description: The details of a cloud cluster instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
type: string
cloudClusterId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster that the cluster instance belongs to.
type: string
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster instance is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud cluster instance.
type: string
crsBaseDirectory:
description: The Oracle base location of Cluster Ready Services (CRS).
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cluster instance. The name does not have to be unique.
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
hostName:
description: The name of the host on which the cluster instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud cluster instance.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
nodeRole:
description: The role of the cluster node.
enum:
- HUB
- LEAF
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud cluster instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud cluster instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudClusterId
- cloudDbSystemId
- lifecycleState
type: object
DbmResource:
description: The base Exadata resource.
discriminator:
propertyName: resourceType
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the resource defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
displayName:
description: The name of the Exadata resource. English letters, numbers, "-", "_" and "." only.
maxLength: 255
minLength: 1
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata resource.
type: string
internalId:
description: The internal ID of the Exadata resource.
type: string
lifecycleDetails:
description: The details of the lifecycle state of the Exadata resource.
type: string
lifecycleState:
description: The current lifecycle state of the database resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
resourceType:
description: The type of Exadata resource.
enum:
- INFRASTRUCTURE_SUMMARY
- INFRASTRUCTURE
- STORAGE_SERVER_SUMMARY
- STORAGE_SERVER
- STORAGE_GRID_SUMMARY
- STORAGE_GRID
- STORAGE_CONNECTOR_SUMMARY
- STORAGE_CONNECTOR
- DATABASE_SYSTEM_SUMMARY
- DATABASE_SUMMARY
- VM_CLUSTER_SUMMARY
- CLOUD_INFRASTRUCTURE_SUMMARY
- CLOUD_INFRASTRUCTURE
- CLOUD_STORAGE_SERVER_SUMMARY
- CLOUD_STORAGE_SERVER
- CLOUD_STORAGE_GRID_SUMMARY
- CLOUD_STORAGE_GRID
- CLOUD_STORAGE_CONNECTOR_SUMMARY
- CLOUD_STORAGE_CONNECTOR
- MANAGED_DATABASE_SUMMARY
type: string
status:
description: The status of the Exadata resource.
type: string
timeCreated:
description: The timestamp of the creation of the Exadata resource.
format: date-time
type: string
timeUpdated:
description: The timestamp of the last update of the Exadata resource.
format: date-time
type: string
version:
description: The version of the Exadata resource.
type: string
required:
- id
- displayName
- resourceType
type: object
DatabaseConnectionStringDetails:
description: 'The details of the Oracle Database connection string.
'
discriminator:
propertyName: connectionType
properties:
connectionType:
default: BASIC
description: "The list of supported connection types:\n - BASIC: Basic connection details\n"
enum:
- BASIC
type: string
required:
- connectionType
DisableAutomaticInitialPlanCaptureDetails:
description: 'The details required to disable automatic initial plan capture.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
PdbMetrics:
description: The summary of Pluggable Databases (PDBs) and their resource usage metrics, within a specific Container Database (CDB).
properties:
databaseUsageMetrics:
description: A summary of PDBs and their resource usage metrics such as CPU, User I/O, and Storage, within a specific CDB.
items:
$ref: '#/components/schemas/DatabaseUsageMetrics'
type: array
required:
- databaseUsageMetrics
type: object
HaMetricDefinition:
description: The metric definition for HA and backup metrics.
properties:
dimensions:
additionalProperties:
maxLength: 255
minLength: 1
type: string
description: 'The dimension qualifiers provided in the definition of the returned metric.
Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.
Example: `{"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}`
'
type: object
metadata:
additionalProperties:
maxLength: 255
minLength: 1
type: string
description: 'The metadata qualifiers provided in the definition of the returned metric.
Available metadata vary by metric.
'
type: object
metricName:
description: The name of the metric.
type: string
timestamp:
description: The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
value:
description: The target value of the metric.
format: double
type: number
required:
- metricName
- metadata
- dimensions
- timestamp
- value
type: object
JobRunCollection:
description: A collection of job run objects.
properties:
items:
description: A list of JobRunSummary objects.
items:
$ref: '#/components/schemas/JobRunSummary'
type: array
required:
- items
type: object
ExternalDbSystem:
description: The details of an external DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/ExternalDbSystemDatabaseManagementConfigDetails'
dbSystemDiscoveryId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system discovery.
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
discoveryAgentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent used during the discovery of the DB system.
type: string
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/ExternalExadataInfraBasicInfo'
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
homeDirectory:
description: 'The Oracle Grid home directory in case of cluster-based DB system and
Oracle home directory in case of single instance-based DB system.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
type: string
isCluster:
description: Indicates whether the DB system is a cluster DB system or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- INACTIVE
type: string
stackMonitoringConfig:
$ref: '#/components/schemas/ExternalDbSystemStackMonitoringConfigDetails'
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
timeCreated:
description: The date and time the external DB system was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalAsm:
description: The details of an external ASM.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the external ASM defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external ASM.
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
displayName:
description: The user-friendly name for the external ASM. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the ASM is a part of.
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
gridHome:
description: The directory in which ASM is installed. This is the same directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
type: string
isCluster:
description: Indicates whether the ASM is a cluster ASM or not.
type: boolean
isFlexEnabled:
description: Indicates whether Oracle Flex ASM is enabled or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external ASM.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
servicedDatabases:
description: The list of databases that are serviced by the ASM.
items:
$ref: '#/components/schemas/ExternalAsmServicedDatabase'
type: array
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
timeCreated:
description: The date and time the external ASM was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external ASM was last updated.
format: date-time
type: string
version:
description: The ASM version.
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
AddDataFilesDetails:
description: 'The details required to add data files or temp files to the tablespace.
lease provide either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
autoExtendMaxSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The maximum disk space allowed for automatic extension of the data files or temp files.
'
autoExtendNextSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of the next increment of disk space to be allocated automatically when more extents are required.
'
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
dataFiles:
description: 'The list of data files or temp files added to the tablespace.
'
items:
type: string
type: array
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
fileCount:
description: 'The number of data files or temp files to be added for the tablespace. This is for Oracle Managed Files only.
'
type: integer
fileSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of each data file or temp file.
'
fileType:
description: 'Specifies whether the file is a data file or temp file.
'
enum:
- DATAFILE
- TEMPFILE
type: string
isAutoExtensible:
description: 'Specifies whether the data file or temp file can be extended automatically.
'
type: boolean
isMaxSizeUnlimited:
description: 'Specifies whether the disk space of the data file or temp file can be limited.
'
type: boolean
isReusable:
description: 'Specifies whether Oracle can reuse the data file or temp file. Reuse is only allowed when the file name is provided.
'
type: boolean
required:
- fileType
type: object
ExadataInfrastructureFleetSummary:
description: 'A summary of the inventory count grouped by Exadata infrastructure deployment type, and the metrics that
describe the aggregated usage of CPU, storage, and so on of all Exadata infrastructures in the fleet.
'
properties:
aggregatedMetrics:
description: A list of Exadata infrastructures present in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/ExadataFleetMetricSummaryDefinition'
type: array
inventory:
description: 'A list of the Exadata infrastructures in the fleet.
'
items:
$ref: '#/components/schemas/ExadataInfrastructureFleetStatusByCategory'
type: array
type: object
AutomaticCaptureFilterDetails:
description: 'The details of a capture filter used to include or exclude SQL statements
in the initial automatic plan capture.
'
properties:
name:
description: 'The name of the automatic capture filter.
- AUTO_CAPTURE_SQL_TEXT: Search pattern to apply to SQL text.
- AUTO_CAPTURE_PARSING_SCHEMA_NAME: Parsing schema to include or exclude for SQL plan management auto capture.
- AUTO_CAPTURE_MODULE: Module to include or exclude for SQL plan management auto capture.
- AUTO_CAPTURE_ACTION: Action to include or exclude for SQL plan management automatic capture.
'
enum:
- AUTO_CAPTURE_SQL_TEXT
- AUTO_CAPTURE_PARSING_SCHEMA_NAME
- AUTO_CAPTURE_MODULE
- AUTO_CAPTURE_ACTION
type: string
valuesToExclude:
description: A list of filter values to exclude.
items:
type: string
type: array
valuesToInclude:
description: A list of filter values to include.
items:
type: string
type: array
required:
- name
type: object
SchemaDefinition:
description: The schema object details.
properties:
name:
description: The name of the schema.
type: string
objects:
description: The names of schema objects.
items:
type: string
type: array
required:
- name
type: object
AwrDbTopWaitEventCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_TOP_EVENT_SET
properties:
items:
description: A list of AWR top event summary data.
items:
$ref: '#/components/schemas/AwrDbTopWaitEventSummary'
type: array
description: The AWR top wait event data.
type: object
UpdateCloudAsmInstanceDetails:
description: The details required to update a cloud ASM instance.
properties:
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
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
type: object
ConfigureAutomaticSpmEvolveAdvisorTaskDetails:
description: 'The configuration details of the Automatic SPM Evolve Advisor task.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
taskParameters:
$ref: '#/components/schemas/SpmEvolveTaskParameters'
required:
- taskParameters
type: object
UpdateExternalExadataStorageServerDetails:
description: The details required to update an Exadata storage server.
properties:
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
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
type: object
MetricsAggregationRange:
description: The set of aggregated data returned for a metric.
properties:
header:
$ref: '#/components/schemas/DbManagementAnalyticsMetric'
metrics:
description: 'The list of metrics returned for the specified request. Each of the metrics
has a `metricName` and additional properties like `metadata`, `dimensions`.
If a property is not set, then use the value from `header`.
Suppose `m` be an item in the `metrics` array:
- If `m.metricName` is not set, use `header.metricName` instead
- If `m.durationInSeconds` is not set, use `header.durationInSeconds` instead
- If `m.dimensions` is not set, use `header.dimensions` instead
- If `m.metadata` is not set, use `header.metadata` instead
'
items:
$ref: '#/components/schemas/DbManagementAnalyticsMetric'
type: array
rangeEndTimeInEpochSeconds:
description: The end of the time range (exclusive) of the returned metric data.
format: int64
type: integer
rangeStartTimeInEpochSeconds:
description: The beginning of the time range (inclusive) of the returned metric data.
format: int64
type: integer
type: object
ProxiedForUserSummary:
allOf:
- $ref: '#/components/schemas/ProxyUserSummary'
description: A summary of users on whose behalf the current user acts as proxy.
DataguardPerformanceMetrics:
description: A summary of Data Guard performance metrics for Managed Databases.
properties:
metricsData:
description: A summary of Data Guard performance metrics such as ApplyLag, TransportLag and RedoApplyRate, for Managed Databases.
items:
$ref: '#/components/schemas/PerformanceMetricsData'
type: array
required:
- metricsData
type: object
JobRunSummary:
description: A summary of a specific job run.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the parent job resides.
type: string
id:
description: The identifier of the job run.
type: string
jobId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent job.
type: string
jobName:
description: The name of the parent job.
type: string
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the parent job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database where the parent job has to be executed.
type: string
name:
description: The name of the job run.
type: string
runStatus:
description: The status of the job run.
type: string
x-obmcs-enumref: '#/definitions/JobRun/runStatus'
timeSubmitted:
description: The date and time when the job run was submitted.
format: date-time
type: string
timeUpdated:
description: The date and time when the job run was last updated.
format: date-time
type: string
required:
- id
- name
- compartmentId
- jobId
- jobName
- runStatus
- timeSubmitted
- timeUpdated
ExternalExadataStorageConnectorSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_CONNECTOR_SUMMARY
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
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
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The connector of the Exadata storage server.
type: object
SqlCpuActivity:
description: The SQL CPU activity from the Exadata storage server.
properties:
cpuActivity:
description: The CPU activity percentage.
format: float
type: number
databaseName:
description: The database name.
type: string
sqlId:
description: The SQL ID.
type: string
type: object
EnableAutonomousDatabaseManagementFeatureDetails:
description: The details required to enable a Database Management feature for an Autonomous Database.
properties:
featureDetails:
$ref: '#/components/schemas/AutonomousDatabaseFeatureDetails'
required:
- featureDetails
type: object
ConnectorDetails:
description: The connector details required to connect to an Oracle cloud database.
discriminator:
propertyName: connectorType
properties:
connectorType:
description: "The list of supported connection types:\n - PE: Private endpoint\n - MACS: Management agent\n - EXTERNAL: External database connector\n\n - DIRECT: Direct connection\n"
enum:
- PE
- MACS
- EXTERNAL
- DIRECT
type: string
required:
- connectorType
type: object
PdbStatusDetails:
description: The number and status of PDBs in a Container Database.
properties:
count:
description: The number of PDBs with this status.
type: integer
status:
description: The status of the PDBs with this count.
enum:
- UP
- DOWN
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseStatus'
type: object
CloudDbSystemDiscovery:
description: The details of a cloud DB system discovery.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the cloud DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
dbaasParentInfrastructureId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems ,
it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
'
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
deploymentType:
description: The deployment type of cloud DB system.
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
discoveredComponents:
description: The list of DB system components that were found in the DB system discovery.
items:
$ref: '#/components/schemas/DiscoveredCloudDbSystemComponent'
maxItems: 500
type: array
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
gridHome:
description: The directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system discovery resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
resourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing OCI resource matching the discovered DB system.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud DB system discovery was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system discovery was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- agentId
- dbaasParentInfrastructureId
- deploymentType
- lifecycleState
- timeCreated
- timeUpdated
type: object
EnableCloudDbSystemDatabaseManagementDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The details required to enable Database Management for a cloud DB system.
ExternalDatabaseInstance:
description: The details of an external database instance.
properties:
hostName:
description: The name of the host machine.
type: string
instanceName:
description: The name of the database instance.
type: string
instanceNumber:
description: The instance number of the database instance.
type: integer
required:
- instanceNumber
- instanceName
- hostName
type: object
DataPoints:
description: The aggregated datapoints of the metric.
properties:
timestamp:
description: The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
value:
description: The value of the metric.
format: double
type: number
type: object
ClusterCacheMetric:
description: 'The response containing the cluster cache metrics for the
Oracle Real Application Clusters (Oracle RAC) database.
'
properties:
clusterCacheMetrics:
description: A list of cluster cache metrics for a specific Managed Database.
items:
$ref: '#/components/schemas/TimeSeriesMetricDefinition'
type: array
required:
- clusterCacheMetrics
type: object
CloudExadataStorageGrid:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_GRID
properties:
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
serverCount:
description: The number of Exadata storage servers in the Exadata infrastructure.
format: integer
type: number
storageServers:
description: A list of monitored Exadata storage servers.
items:
$ref: '#/components/schemas/CloudExadataStorageServerSummary'
type: array
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
description: The details of the Exadata storage server grid.
type: object
CreateExternalDbSystemConnectorDetails:
description: The details required to create an external DB system connector.
discriminator:
propertyName: connectorType
properties:
connectorType:
description: The type of connector.
enum:
- MACS
type: string
displayName:
description: The user-friendly name for the external connector. The name does not have to be unique.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
type: string
required:
- connectorType
- externalDbSystemId
type: object
ManagedDatabaseGroupCollection:
description: A collection of Managed Database Group resources.
properties:
items:
description: An array of ManagedDatabaseGroupSummary resources.
items:
$ref: '#/components/schemas/ManagedDatabaseGroupSummary'
type: array
required:
- items
type: object
DataAccessContainerCollection:
description: A collection of specific containers for the current user. This is only applicable if ALL_CONTAINERS !='Y'.
properties:
items:
description: An array of container resources.
items:
$ref: '#/components/schemas/DataAccessContainerSummary'
type: array
required:
- items
type: object
EnableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails:
description: 'The details required to enable high frequency Automatic SPM Evolve Advisor task.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
ExadataVmClusterSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: VM_CLUSTER_SUMMARY
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
deploymentType:
description: The infrastructure deployment type.
enum:
- EXADATA
- EXADATA_CC
type: string
x-obmcs-top-level-enum: '#/definitions/CloudExadataInfrastructureDeploymentType'
homeDirectory:
description: The Oracle home directory.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
description: The VM Clusters of the Exadata infrastructure.
type: object
AutomaticCaptureFilter:
description: 'An automatic capture filter that enables you to capture only those SQL statements
that you want, and exclude noncritical statements.
'
properties:
modifiedBy:
description: The database user who last updated the filter value.
type: string
name:
description: 'The name of the automatic capture filter.
- AUTO_CAPTURE_SQL_TEXT: Search pattern to apply to SQL text.
- AUTO_CAPTURE_PARSING_SCHEMA_NAME: Parsing schema to include or exclude for SQL plan management auto capture.
- AUTO_CAPTURE_MODULE: Module to include or exclude for SQL plan management auto capture.
- AUTO_CAPTURE_ACTION: Action to include or exclude for SQL plan management automatic capture.
'
enum:
- AUTO_CAPTURE_SQL_TEXT
- AUTO_CAPTURE_PARSING_SCHEMA_NAME
- AUTO_CAPTURE_MODULE
- AUTO_CAPTURE_ACTION
type: string
timeLastModified:
description: The time the filter value was last updated.
format: date-time
type: string
valuesToExclude:
description: A list of filter values to exclude.
items:
type: string
type: array
valuesToInclude:
description: A list of filter values to include.
items:
type: string
type: array
type: object
AwrDbParameterCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_DB_PARAMETER_SET
properties:
items:
description: A list of AWR database parameter summary data.
items:
$ref: '#/components/schemas/AwrDbParameterSummary'
type: array
description: The AWR database parameter data.
type: object
ExternalExadataStorageConnectorStatus:
description: The status of an Exadata storage server connector.
properties:
errorMessage:
description: The error message indicating the reason for failure or `null` if the connection was successful.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server connector.
type: string
status:
description: The connection status of the connector.
enum:
- SUCCEEDED
- FAILED
type: string
required:
- status
type: object
ExternalDbSystemConnectorSummary:
description: The summary of an external DB system connector.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the external DB system connector.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
connectorType:
description: The type of connector.
enum:
- MACS
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
displayName:
description: The user-friendly name for the external connector. The name does not have to be unique.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the connector is a part of.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system connector.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system connector.
type: string
x-obmcs-enumref: '#/definitions/ExternalDbSystemConnector/lifecycleState'
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
timeCreated:
description: The date and time the external DB system connector was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system connector was last updated.
format: date-time
type: string
required:
- id
- displayName
- connectorType
- compartmentId
- externalDbSystemId
- agentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
LoadSqlPlanBaselinesFromCursorCacheDetails:
description: 'The details of SQL statements and plans to be loaded from cursor cache. You can specify
the plans to load using SQL ID, plan identifier, or filterName and filterValue pair.
You can also control the SQL plan baseline into which the plans are loaded using either
SQL text or SQL handle.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
filterName:
description: 'The name of the filter.
- SQL_TEXT: Search pattern to apply to SQL text.
- PARSING_SCHEMA_NAME: Name of the parsing schema.
- MODULE: Name of the module.
- ACTION: Name of the action.
'
enum:
- SQL_TEXT
- PARSING_SCHEMA_NAME
- MODULE
- ACTION
type: string
filterValue:
description: 'The filter value. It is upper-cased except when it is enclosed in
double quotes or filter name is `SQL_TEXT`.
'
type: string
isEnabled:
description: 'Indicates whether the loaded plans are enabled (`true`) or not (`false`).
By default, they are enabled.
'
type: boolean
isFixed:
description: 'Indicates whether the plans are loaded as fixed plans (`true`) or non-fixed plans (`false`).
By default, they are loaded as non-fixed plans.
'
type: boolean
jobDescription:
description: The description of the job.
type: string
jobName:
description: The name of the database job used for loading SQL plan baselines.
type: string
planHash:
description: 'The plan identifier. By default, all plans present in the cursor cache
for the SQL statement identified by `sqlId` are captured.
'
format: integer
type: number
sqlHandle:
description: 'The SQL handle to use in identifying the SQL plan baseline into which
the plans are loaded.
'
type: string
sqlId:
description: The SQL statement identifier. Identifies a SQL statement in the cursor cache.
type: string
sqlText:
description: 'The SQL text to use in identifying the SQL plan baseline into which the plans
are loaded. If the SQL plan baseline does not exist, it is created.
'
type: string
required:
- jobName
type: object
DatabaseBackupMetrics:
allOf:
- $ref: '#/components/schemas/DatabaseHaMetrics'
- properties:
isAutomaticBackupEnabled:
description: Indicates whether automatic backup is enabled or not. This is only applicable for cloud databases.
type: boolean
retentionPeriodInDays:
description: The retention period of the database.
type: string
timeSeriesMetrics:
description: The array of metric values for different timestamps.
items:
$ref: '#/components/schemas/MetricsAggregationRange'
type: array
required:
- retentionPeriodInDays
- isAutomaticBackupEnabled
- timeSeriesMetrics
type: object
description: The details of the backup metrics for a single database.
RestCredential:
description: The user credential information.
properties:
password:
description: The password of the user.
format: password
maxLength: 255
type: string
sslTrustStoreLocation:
description: The full path of the SSL truststore location in the agent.
maxLength: 1024
minLength: 1
type: string
sslTrustStorePassword:
description: The password of the SSL truststore location in the agent.
format: password
maxLength: 255
type: string
sslTrustStoreType:
default: JKS
description: The SSL truststore type.
enum:
- JKS
- BCFKS
type: string
username:
description: The name of the user.
maxLength: 255
type: string
required:
- username
- password
type: object
CreateJobDetails:
description: The details required to create a job.
discriminator:
propertyName: jobType
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the job resides.
type: string
databaseSubType:
description: The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
description:
description: The description of the job.
maxLength: 400
type: string
jobType:
description: The type of job.
enum:
- SQL
type: string
x-obmcs-top-level-enum: '#/definitions/JobTypes'
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database where the job has to be executed.
type: string
name:
description: 'The name of the job. Valid characters are uppercase or lowercase letters,
numbers, and "_". The name of the job cannot be modified. It must be unique
in the compartment and must begin with an alphabetic character.
'
maxLength: 255
minLength: 1
type: string
resultLocation:
$ref: '#/components/schemas/JobExecutionResultLocation'
scheduleDetails:
$ref: '#/components/schemas/JobScheduleDetails'
scheduleType:
description: The schedule type of the job.
type: string
x-obmcs-enumref: '#/definitions/Job/scheduleType'
timeout:
description: The job timeout duration, which is expressed like "1h 10m 15s".
type: string
required:
- name
- compartmentId
- jobType
- scheduleType
type: object
Job:
description: The details of the job.
discriminator:
propertyName: jobType
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the job resides.
type: string
databaseSubType:
description: The subtype of the Oracle Database where the job has to be executed. Applicable only when managedDatabaseGroupId is provided.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
description:
description: The description of the job.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the job.
type: string
jobType:
description: The type of job.
enum:
- SQL
type: string
x-obmcs-top-level-enum: '#/definitions/JobTypes'
lifecycleState:
description: The lifecycle state of the job.
enum:
- ACTIVE
- INACTIVE
type: string
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database where the job has to be executed.
type: string
managedDatabasesDetails:
description: The details of the Managed Databases where the job has to be executed.
items:
$ref: '#/components/schemas/JobDatabase'
type: array
name:
description: The display name of the job.
type: string
resultLocation:
$ref: '#/components/schemas/JobExecutionResultLocation'
scheduleDetails:
$ref: '#/components/schemas/JobScheduleDetails'
scheduleType:
description: The schedule type of the job.
enum:
- IMMEDIATE
- LATER
type: string
submissionErrorMessage:
description: The error message that is returned if the job submission fails. Null is returned in all other scenarios.
type: string
timeCreated:
description: The date and time when the job was created.
format: date-time
type: string
timeUpdated:
description: The date and time when the job was last updated.
format: date-time
type: string
timeout:
description: The job timeout duration, which is expressed like "1h 10m 15s".
type: string
required:
- id
- compartmentId
- name
- scheduleType
- jobType
- lifecycleState
- timeCreated
- timeUpdated
type: object
CloudDatabaseInstance:
description: The details of a cloud database instance.
properties:
hostName:
description: The name of the host machine.
type: string
instanceName:
description: The name of the database instance.
type: string
instanceNumber:
description: The instance number of the database instance.
type: integer
required:
- instanceNumber
- instanceName
- hostName
type: object
ExternalExadataStorageConnector:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_CONNECTOR
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The details of the Exadata storage server connector.
type: object
ExadataInfrastructureFleetStatusByCategory:
description: The number of Exadata infrastructures in the fleet, grouped by deployment type and rack-size.
properties:
deploymentType:
description: The infrastructure deployment type.
enum:
- ONPREMISE
- EXADATA
- EXADATA_CC
type: string
x-obmcs-top-level-enum: '#/definitions/ExadataInfrastructureDeploymentType'
inventoryCount:
description: The number of Exadata infrastructures in the fleet.
type: integer
rackSize:
description: The size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
- OTHER
type: string
type: object
CursorCacheStatementCollection:
description: The list of SQL statements in the cursor cache.
properties:
items:
description: A list of SQL statements in the cursor cache.
items:
$ref: '#/components/schemas/CursorCacheStatementSummary'
type: array
uniqueItems: true
required:
- items
type: object
AddmTaskSummary:
description: The object containing the ADDM task metadata.
properties:
beginSnapshotId:
description: 'The ID number of the beginning AWR snapshot.
'
format: int64
type: integer
dbUser:
description: The database user who owns the ADDM task.
type: string
description:
description: The description of the ADDM task.
type: string
endSnapshotId:
description: 'The ID number of the ending AWR snapshot.
'
format: int64
type: integer
endSnapshotTime:
description: 'The timestamp of the ending AWR snapshot used in the ADDM task as defined by date-time RFC3339 format.
'
format: date-time
type: string
findings:
description: The number of ADDM findings.
format: int64
type: integer
howCreated:
description: A description of how the task was created.
enum:
- AUTO
- MANUAL
type: string
startSnapshotTime:
description: 'The timestamp of the beginning AWR snapshot used in the ADDM task as defined by date-time RFC3339 format.
'
format: date-time
type: string
status:
description: The status of the ADDM task.
enum:
- INITIAL
- EXECUTING
- INTERRUPTED
- COMPLETED
- ERROR
type: string
taskId:
description: The ID number of the ADDM task.
format: int64
type: integer
taskName:
description: The name of the ADDM task.
type: string
timeCreated:
description: The creation date of the ADDM task.
format: date-time
type: string
required:
- timeCreated
- taskId
type: object
ChangeDatabaseParameterDetails:
description: The value of a database parameter to change.
properties:
name:
description: The parameter name.
maxLength: 80
minLength: 1
type: string
updateComment:
description: 'A comment string to associate with the change in parameter value.
It cannot contain control characters or a line break.
'
type: string
value:
description: The parameter value.
type: string
required:
- name
- value
type: object
CloudExadataStorageServer:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_SERVER
properties:
connector:
$ref: '#/components/schemas/CloudExadataStorageConnectorSummary'
cpuCount:
description: The CPU count of the Exadata storage server.
format: integer
type: number
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
maxFlashDiskIOPS:
description: The maximum flash disk IO operations per second of the Exadata storage server.
type: integer
maxFlashDiskThroughput:
description: The maximum flash disk IO throughput in MB/s of the Exadata storage server.
type: integer
maxHardDiskIOPS:
description: The maximum hard disk IO operations per second of the Exadata storage server.
type: integer
maxHardDiskThroughput:
description: The maximum hard disk IO throughput in MB/s of the Exadata storage server.
type: integer
memoryGB:
description: The Exadata storage server memory size in GB.
format: double
type: number
storageGridId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server grid.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The details of the Exadata storage server.
type: object
SnapshotDetails:
description: The details of the newly generated AWR snapshot.
properties:
snapshotId:
description: The ID of the beginning AWR snapshot.
format: int64
type: integer
required:
- snapshotId
type: object
AwrDbSnapshotSummary:
description: The AWR snapshot summary of one snapshot.
properties:
awrDbId:
description: 'Internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs
'
type: string
errorCount:
description: The total number of errors.
format: int64
type: integer
instanceNumber:
description: The database instance number.
type: integer
snapshotId:
description: 'The ID of the snapshot. The snapshot ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
'
type: integer
timeBegin:
description: The start time of the snapshot.
format: date-time
type: string
timeDbStartup:
description: The timestamp of the database startup.
format: date-time
type: string
timeEnd:
description: The end time of the snapshot.
format: date-time
type: string
required:
- awrDbId
- snapshotId
type: object
CloudClusterNetworkConfiguration:
description: The details of a network address configuration in a cloud cluster.
properties:
networkNumber:
description: The network number.
type: integer
networkType:
description: The network type.
enum:
- AUTOCONFIG
- DHCP
- STATIC
- MIXED
type: string
subnet:
description: The subnet for the network.
type: string
type: object
AssociatedCloudComponent:
description: The details of the associated component.
properties:
associationType:
description: The association type.
enum:
- CONTAINS
- USES
type: string
componentId:
description: The identifier of the associated component.
type: string
componentType:
description: The type of associated component.
enum:
- ASM
- ASM_INSTANCE
- CLUSTER
- CLUSTER_INSTANCE
- DATABASE
- DATABASE_INSTANCE
- DATABASE_HOME
- DATABASE_NODE
- DBSYSTEM
- LISTENER
- PLUGGABLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemComponentType'
required:
- componentId
- associationType
type: object
ChildDatabase:
description: The child Managed Database of a Managed Database Group.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides.
type: string
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
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
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
name:
description: The name of the Managed Database.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeAdded:
description: The date and time the Managed Database was added to the group.
format: date-time
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- name
- id
- compartmentId
- timeAdded
JobExecutionResultDetails:
description: The job execution result details.
discriminator:
propertyName: type
properties:
type:
description: The type of job execution result.
enum:
- OBJECT_STORAGE
type: string
required:
- type
type: object
CreateExternalMySqlDatabaseConnectorDetails:
description: Details for creating an external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: OCID of compartment for the External MySQL Database.
maxLength: 255
type: string
connectorDetails:
$ref: '#/components/schemas/CreateMySqlDatabaseConnectorDetails'
required:
- compartmentId
- connectorDetails
type: object
UpdateExternalMySqlDatabaseConnectorDetails:
description: Details required for updating an external MySQL database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: OCID of compartment for the External MySQL Database.
type: string
connectorDetails:
$ref: '#/components/schemas/UpdateMySqlDatabaseConnectorDetails'
required:
- connectorDetails
DatabaseFleetBackupMetrics:
description: The details of the backup metrics for the fleet of databases.
properties:
backupMetrics:
description: A list of backup metrics for the databases present in the fleet.
items:
$ref: '#/components/schemas/DatabaseBackupMetrics'
type: array
uniqueItems: true
required:
- backupMetrics
ExternalDbSystemConnector:
description: The details of an external DB system connector.
discriminator:
propertyName: connectorType
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
connectionFailureMessage:
description: 'The error message indicating the reason for connection failure or `null` if
the connection was successful.
'
type: string
connectionStatus:
description: The status of connectivity to the external DB system component.
type: string
connectorType:
description: The type of connector.
enum:
- MACS
type: string
displayName:
description: The user-friendly name for the external connector. The name does not have to be unique.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the connector is a part of.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system connector.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system connector.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
timeConnectionStatusLastUpdated:
description: The date and time the connectionStatus of the external DB system connector was last updated.
format: date-time
type: string
timeCreated:
description: The date and time the external DB system connector was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system connector was last updated.
format: date-time
type: string
required:
- connectorType
- id
- displayName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
User:
description: The summary of a specific user resource.
properties:
allShared:
description: In a sharded database, indicates whether the user is created with shard DDL enabled (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
authentication:
description: The authentication mechanism for the user.
enum:
- NONE
- EXTERNAL
- GLOBAL
- PASSWORD
type: string
common:
description: Indicates whether a given user is common(Y) or local(N).
enum:
- 'YES'
- 'NO'
type: string
consumerGroup:
description: The initial resource consumer group for the User.
type: string
defaultCollation:
description: The default collation for the user schema.
type: string
defaultTablespace:
description: The default tablespace for data.
type: string
editionsEnabled:
description: Indicates whether editions have been enabled for the corresponding user (Y) or not (N).
enum:
- 'YES'
- 'NO'
type: string
externalName:
description: The external name of the user.
type: string
externalShared:
description: In a federated sharded database, indicates whether the user is an external shard user (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
implicit:
description: Indicates whether the user is a common user created by an implicit application (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
inherited:
description: Indicates whether the user definition is inherited from another container (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
localTempTablespace:
description: The default local temporary tablespace for the user.
type: string
name:
description: The name of the User.
type: string
oracleMaintained:
description: Indicates whether the user was created and is maintained by Oracle-supplied scripts (such as catalog.sql or catproc.sql).
enum:
- 'YES'
- 'NO'
type: string
passwordVersions:
description: The list of existing versions of the password hashes (also known as "verifiers") for the account.
type: string
profile:
description: The profile name of the user.
type: string
proxyConnect:
description: 'Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges
for this account (that is, by users who have been granted the "connect through" privilege for this account).
'
enum:
- 'YES'
- 'NO'
type: string
status:
description: The status of the user account.
enum:
- OPEN
- EXPIRED
- EXPIRED_GRACE
- LOCKED
- LOCKED_TIMED
- EXPIRED_AND_LOCKED
- EXPIRED_GRACE_AND_LOCKED
- EXPIRED_AND_LOCKED_TIMED
- EXPIRED_GRACE_AND_LOCKED_TIMED
- OPEN_AND_IN_ROLLOVER
- EXPIRED_AND_IN_ROLLOVER
- LOCKED_AND_IN_ROLLOVER
- EXPIRED_AND_LOCKED_AND_IN_ROLLOVER
- LOCKED_TIMED_AND_IN_ROLLOVER
- EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL
type: string
tempTablespace:
description: The name of the default tablespace for temporary tables or the name of a tablespace group.
type: string
timeCreated:
description: The date and time the user was created.
format: date-time
type: string
timeExpiring:
description: The date and time of the expiration of the user account.
format: date-time
type: string
timeLastLogin:
description: 'The date and time of the last user login.
This column is not populated when a user connects to the database with administrative privileges, that is, AS { SYSASM | SYSBACKUP | SYSDBA | SYSDG | SYSOPER | SYSRAC | SYSKM }.
'
format: date-time
type: string
timeLocked:
description: The date the account was locked, if the status of the account is LOCKED.
format: date-time
type: string
timePasswordChanged:
description: 'The date and time when the user password was last set.
This column is populated only when the value of the AUTHENTICATION_TYPE column is PASSWORD. Otherwise, this column is null.
'
format: date-time
type: string
required:
- name
- status
- defaultTablespace
- tempTablespace
- timeCreated
- profile
type: object
AwrDbSysstatSummary:
description: The summary of the AWR SYSSTAT data.
properties:
avgValue:
description: The average value of the SYSSTAT.
format: double
type: number
category:
description: The name of the SYSSTAT category.
type: string
currentValue:
description: The last value of the SYSSTAT.
format: double
type: number
name:
description: The name of the SYSSTAT.
type: string
timeBegin:
description: The start time of the SYSSTAT.
format: date-time
type: string
timeEnd:
description: The end time of the SYSSTAT.
format: date-time
type: string
required:
- name
type: object
EnablePluggableDatabaseManagementFeatureDetails:
description: The details required to enable a Database Management feature for an Oracle cloud pluggable database.
properties:
featureDetails:
$ref: '#/components/schemas/DatabaseFeatureDetails'
required:
- featureDetails
type: object
DisablePluggableDatabaseManagementFeatureDetails:
description: The details required to disable a Database Management feature for an Oracle cloud pluggable database.
properties:
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
ExternalDbNodeCollection:
description: A collection of external database nodes.
properties:
items:
description: An array of external DB nodes.
items:
$ref: '#/components/schemas/ExternalDbNodeSummary'
type: array
required:
- items
type: object
UpdateDbManagementPrivateEndpointDetails:
description: The details used to update a Database Management private endpoint.
properties:
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
description:
description: The description of the private endpoint.
maxLength: 1024
minLength: 1
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
name:
description: The display name of the private endpoint.
maxLength: 255
minLength: 1
type: string
nsgIds:
description: 'The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".
'
type: object
description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`
'
type: object
description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
type: object
CloudExadataStorageConnectorSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_CONNECTOR_SUMMARY
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
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
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The connector of the Exadata storage server.
type: object
ManagedDatabaseSummary:
description: A summary of the Managed Database.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databasePlatformName:
description: The operating system of database.
maxLength: 255
type: string
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle Database version.
type: string
dbSystemId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system that this Managed Database is part of.
'
type: string
dbmgmtFeatureConfigs:
description: The list of feature configurations
items:
$ref: '#/components/schemas/DatabaseFeatureConfiguration'
maxItems: 3
type: array
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
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
isCluster:
description: Indicates whether the Oracle Database is part of a cluster.
type: boolean
managementOption:
description: The management option used when enabling Database Management.
enum:
- BASIC
- ADVANCED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementOption'
name:
description: The name of the Managed Database.
type: string
parentContainerId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent Container Database
if the Managed Database is a Pluggable Database.
'
type: string
storageSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the storage DB system.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the Managed Database was created.
format: date-time
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- id
- compartmentId
- name
- databaseType
- databaseSubType
- isCluster
- timeCreated
type: object
StatementsAggregateMetrics:
description: The queued and running statement metrics for Autonomous Databases.
properties:
queuedStatements:
$ref: '#/components/schemas/MetricDataPoint'
runningStatements:
$ref: '#/components/schemas/MetricDataPoint'
type: object
ExternalDbSystemDatabaseManagementConfigDetails:
description: The details required to enable Database Management for an external DB system.
properties:
licenseModel:
description: 'The Oracle license model that applies to the external database.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
required:
- licenseModel
type: object
PerformanceMetrics:
description: The Data Guard performance metric details.
properties:
datapoints:
description: The aggregated datapoints of the metric.
items:
$ref: '#/components/schemas/DataPoints'
type: array
dimensions:
description: The dimensions of the Data Guard performance metrics, such as primary database ID, primary database unique name.
type: object
metadata:
description: The metadata of the metric, such as Unit.
type: object
name:
description: The name of the metric.
type: string
type: object
CloudClusterCollection:
description: A collection of cloud clusters.
properties:
items:
description: An array of cloud clusters.
items:
$ref: '#/components/schemas/CloudClusterSummary'
type: array
required:
- items
type: object
LoadSqlPlanBaselinesFromAwrDetails:
description: 'The details required to load plans from Automatic Workload Repository (AWR).
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
beginSnapshot:
description: The begin snapshot.
type: integer
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
endSnapshot:
description: The end snapshot.
type: integer
isEnabled:
description: 'Indicates whether the loaded plans are enabled (`true`) or not (`false`).
By default, they are enabled.
'
type: boolean
isFixed:
description: 'Indicates whether the plans are loaded as fixed plans (`true`) or non-fixed plans (`false`).
By default, they are loaded as non-fixed plans.
'
type: boolean
jobDescription:
description: The description of the job.
type: string
jobName:
description: The name of the database job used for loading SQL plan baselines.
type: string
sqlTextFilter:
description: 'A filter applied to AWR to select only qualifying plans to be loaded.
By default all plans in AWR are selected. The filter can take the form of
any `WHERE` clause predicate that can be specified against the column
`DBA_HIST_SQLTEXT.SQL_TEXT`. An example is `sql_text like ''SELECT %''`.
'
type: string
required:
- jobName
- beginSnapshot
- endSnapshot
type: object
JobSummary:
description: A summary of the job.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the job resides.
type: string
databaseSubType:
description: The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
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
description:
description: The description of the job.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the job.
type: string
jobType:
description: The type of job.
enum:
- SQL
type: string
x-obmcs-top-level-enum: '#/definitions/JobTypes'
lifecycleState:
description: The lifecycle state of the job.
type: string
x-obmcs-enumref: '#/definitions/Job/lifecycleState'
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database where the job has to be executed.
type: string
name:
description: The display name of the job.
type: string
scheduleDetails:
$ref: '#/components/schemas/JobScheduleDetails'
scheduleType:
description: The schedule type of the job.
type: string
x-obmcs-enumref: '#/definitions/Job/scheduleType'
submissionErrorMessage:
description: The error message that is returned if the job submission fails. Null is returned in all other scenarios.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time when the job was created.
format: date-time
type: string
timeUpdated:
description: The date and time when the job was last updated.
format: date-time
type: string
timeout:
description: The job timeout duration, which is expressed like "1h 10m 15s".
type: string
required:
- id
- compartmentId
- name
- scheduleType
- jobType
- lifecycleState
- timeCreated
- timeUpdated
type: object
OpenAlertHistory:
description: The existing open alerts in the Exadata storage server.
properties:
alerts:
description: A list of open alerts.
items:
$ref: '#/components/schemas/OpenAlertSummary'
type: array
required:
- alerts
type: object
UpdateExternalDbSystemConnectorDetails:
description: The details required to update an external DB system connector.
discriminator:
propertyName: connectorType
properties:
connectorType:
description: The type of connector.
enum:
- MACS
type: string
required:
- connectorType
type: object
PreferredCredentialSummary:
description: The summary of preferred credentials.
properties:
credentialName:
description: The name of the preferred credential.
type: string
isAccessible:
description: Indicates whether the preferred credential is accessible.
type: boolean
namedCredentialId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Named Credential that contains the database user password metadata.
type: string
passwordSecretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Vault service secret that contains the database user password.
type: string
role:
description: The role of the database user.
enum:
- NORMAL
- SYSDBA
- SYSDG
type: string
x-obmcs-top-level-enum: '#/definitions/Role'
status:
description: The status of the preferred credential.
enum:
- SET
- NOT_SET
type: string
x-obmcs-top-level-enum: '#/definitions/PreferredCredentialStatus'
userName:
description: The user name used to connect to the database.
type: string
required:
- credentialName
- status
- isAccessible
type: object
ExternalAsmInstance:
description: The details of an external ASM instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external ASM instance.
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
displayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
type: string
externalAsmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM that the ASM instance belongs to.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node on which the ASM instance is running.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the ASM instance is a part of.
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
hostName:
description: The name of the host on which the ASM instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external ASM instance.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external ASM instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external ASM instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalAsmId
- externalDbSystemId
- lifecycleState
type: object
WorkRequestSummary:
description: A Summary of the work request.
properties:
compartmentId:
description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects.
If the work request affects multiple resources that are not in the same compartment then the system picks the primary resource whose compartment should be used.
'
maxLength: 255
minLength: 1
type: string
id:
description: The ID of the work request.
maxLength: 255
minLength: 1
type: string
operationType:
description: The type of work request.
enum:
- CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT
- DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT
- CREATE_DB_SYSTEM_DISCOVERY
- CREATE_DB_SYSTEM
- UPDATE_DB_SYSTEM
- DB_SYSTEM_ENABLE_DBMGMT
- DB_SYSTEM_DISABLE_DBMGMT
- DELETE_DB_SYSTEM
- UPDATE_EXTERNAL_DB_SYSTEM_CONNECTOR
- CHANGE_EXTERNAL_DB_SYSTEM_COMPARTMENT
- UPDATE_CLOUD_DB_SYSTEM_CONNECTOR
- CHANGE_CLOUD_DB_SYSTEM_COMPARTMENT
- DISABLE_EXADATA_INFRASTURCTURE
- ENABLE_EXADATA_INFRASTRUCTURE
- DELETE_EXADATA_INFRASTRUCTURE
- CHANGE_EXADATA_COMPARTMENT
- ENABLE_SQL_WATCH
- DISABLE_SQL_WATCH
- MODIFY_SQL_WATCH
- ENABLE_DBLM
- DISABLE_DBLM
- MODIFY_DBLM
- ENABLE_DBMGMT
- DISABLE_DBMGMT
- MODIFY_DBMGMT
- CHECK_EXTERNAL_MYSQL_CONNECTION
- UPDATE_EXTERNAL_MYSQL_CREDENTIAL
- CREATE_EXTERNAL_MYSQL_CONNECTOR
- DELETE_EXTERNAL_MYSQL_CONNECTOR
- DELETE_EXTERNAL_MYSQL_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType'
percentComplete:
description: The completed percentage of the operation tracked by the work request.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: The status of the current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
timeAccepted:
description: 'The date and time the work request was accepted, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339).
The precision for this time object is in milliseconds.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
The precision for this time object is in milliseconds.
'
format: date-time
type: string
timeStarted:
description: 'The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). The precision for this time object is in milliseconds.
'
format: date-time
type: string
required:
- operationType
- status
- id
- compartmentId
- percentComplete
- timeAccepted
- resources
SqlPlanBaseline:
description: The details of a SQL plan baseline.
properties:
accepted:
description: Indicates whether the plan baseline is accepted (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
action:
description: The application action.
type: string
adaptive:
description: 'Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.
When a new adaptive plan is found for a SQL statement that has an existing SQL plan baseline, that new plan
will be added to the SQL plan baseline as an unaccepted plan, and the `ADAPTIVE` property will be marked `YES`.
When this new plan is verified (either manually or via the auto evolve task), the plan will be test executed
and the final plan determined at execution will become an accepted plan if its performance is better than
the existing plan baseline. At this point, the value of the `ADAPTIVE` property is set to `NO` since the plan
is no longer adaptive, but resolved.
'
enum:
- 'YES'
- 'NO'
type: string
autoPurge:
description: Indicates whether the plan baseline is auto-purged (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
enabled:
description: Indicates whether the plan baseline is enabled (`YES`) or disabled (`NO`).
enum:
- 'YES'
- 'NO'
type: string
executionPlan:
description: The execution plan for the SQL statement.
type: string
fixed:
description: Indicates whether the plan baseline is fixed (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
module:
description: The application module name.
type: string
origin:
description: The origin of the SQL plan baseline.
enum:
- ADDM_SQLTUNE
- AUTO_CAPTURE
- AUTO_SQLTUNE
- EVOLVE_AUTO_INDEX_LOAD
- EVOLVE_CREATE_FROM_ADAPTIVE
- EVOLVE_LOAD_FROM_STS
- EVOLVE_LOAD_FROM_AWR
- EVOLVE_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD
- MANUAL_LOAD_FROM_AWR
- MANUAL_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD_FROM_STS
- MANUAL_SQLTUNE
- STORED_OUTLINE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/SqlPlanBaselineOrigin'
planName:
description: The unique plan identifier.
type: string
reproduced:
description: 'Indicates whether the optimizer was able to reproduce the plan (`YES`) or not (`NO`).
The value is set to `YES` when a plan is initially added to the plan baseline.
'
enum:
- 'YES'
- 'NO'
type: string
sqlHandle:
description: The unique SQL identifier.
type: string
sqlText:
description: The SQL text.
type: string
timeCreated:
description: The date and time when the plan baseline was created.
format: date-time
type: string
timeLastExecuted:
description: 'The date and time when the plan baseline was last executed.
**Note:** For performance reasons, database does not update this value
immediately after each execution of the plan baseline. Therefore, the plan
baseline may have been executed more recently than this value indicates.
'
format: date-time
type: string
timeLastModified:
description: The date and time when the plan baseline was last modified.
format: date-time
type: string
required:
- planName
- sqlHandle
- sqlText
- timeCreated
- executionPlan
type: object
DatabaseCredentialDetails:
description: The credential to connect to the database to perform tablespace administration tasks.
discriminator:
propertyName: credentialType
properties:
credentialType:
description: The type of the credential for tablespace administration tasks.
enum:
- SECRET
- PASSWORD
- NAMED_CREDENTIAL
type: string
required:
- credentialType
type: object
ManagedDatabase:
description: The details of a Managed Database.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details specific to a type of database defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databasePlatformName:
description: The operating system of database.
maxLength: 255
type: string
databaseStatus:
description: 'The status of the Oracle Database. Indicates whether the status of the database
is UP, DOWN, or UNKNOWN at the current time.
'
enum:
- UP
- DOWN
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseStatus'
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle Database version.
type: string
dbSystemId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system that this Managed Database is part of.
'
type: string
dbmgmtFeatureConfigs:
description: The list of feature configurations
items:
$ref: '#/components/schemas/DatabaseFeatureConfiguration'
maxItems: 3
type: array
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
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
instanceCount:
description: The number of Oracle Real Application Clusters (Oracle RAC) database instances.
type: integer
instanceDetails:
description: The details of the Oracle Real Application Clusters (Oracle RAC) database instances.
items:
$ref: '#/components/schemas/InstanceDetails'
type: array
isCluster:
description: Indicates whether the Oracle Database is part of a cluster.
type: boolean
managedDatabaseGroups:
description: A list of Managed Database Groups that the Managed Database belongs to.
items:
$ref: '#/components/schemas/ParentGroup'
type: array
managementOption:
description: The management option used when enabling Database Management.
enum:
- BASIC
- ADVANCED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementOption'
name:
description: The name of the Managed Database.
type: string
parentContainerCompartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
in which the parent Container Database resides, if the Managed Database
is a Pluggable Database (PDB).
'
type: string
parentContainerId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent Container Database
if Managed Database is a Pluggable Database.
'
type: string
parentContainerName:
description: The name of the parent Container Database.
type: string
pdbCount:
description: The number of PDBs in the Container Database.
type: integer
pdbStatus:
description: The status of the PDB in the Container Database.
items:
$ref: '#/components/schemas/PdbStatusDetails'
type: array
storageSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the storage DB system.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the Managed Database was created.
format: date-time
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- id
- compartmentId
- name
- databaseType
- databaseSubType
- isCluster
- timeCreated
type: object
MySqlConnectorCollection:
description: The collection of external MySQL Database connectors. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The list of external MySQL Database connector records.
items:
$ref: '#/components/schemas/MySqlDatabaseConnectorSummary'
type: array
required:
- items
type: object
UpdateExternalMySqlDatabaseDetails:
description: Details for updating an external MySQL database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
dbName:
description: Display Name of the External MySQL Database.
maxLength: 255
type: string
required:
- dbName
CreateCloudExadataStorageConnectorDetails:
description: The details required to create the connector to the Exadata storage server.
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
maxLength: 255
minLength: 1
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
maxLength: 1024
minLength: 1
type: string
credentialInfo:
$ref: '#/components/schemas/RestCredential'
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
displayName:
description: The name of the Exadata storage server connector.
maxLength: 255
minLength: 1
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
maxLength: 255
minLength: 1
type: string
required:
- storageServerId
- agentId
- connectionUri
- credentialInfo
type: object
ExternalStorageGridDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: STORAGE_GRID_DISCOVER_SUMMARY
properties:
countOfStorageServersDiscovered:
description: The total number of Exadata storage servers discovered.
type: integer
description: The summary of the Exadata storage server grid discovery.
type: object
UpdateCloudClusterInstanceDetails:
description: The details required to update a cloud cluster instance.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
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
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
type: object
NamedCredentialContent:
description: The details of the named credential.
discriminator:
propertyName: credentialType
properties:
credentialType:
description: The type of named credential. Only 'BASIC' is supported currently.
enum:
- BASIC
type: string
x-obmcs-top-level-enum: '#/definitions/NamedCredentialContentType'
required:
- credentialType
type: object
ExadataMetricDimensionDefinition:
description: The metric dimension details.
properties:
dimensionName:
description: The name of the dimension.
type: string
dimensionValue:
description: The value of the dimension.
type: string
type: object
OptimizerStatisticsAdvisorExecutionSummary:
description: The summary of the Optimizer Statistics Advisor execution.
properties:
errorMessage:
description: The errors in the Optimizer Statistics Advisor execution, if any.
type: string
executionName:
description: The name of the Optimizer Statistics Advisor execution.
type: string
findings:
description: The number of findings generated by the Optimizer Statistics Advisor execution.
type: integer
status:
description: The status of the Optimizer Statistics Advisor execution.
enum:
- EXECUTING
- COMPLETED
- INTERRUPTED
- CANCELLED
- FATAL_ERROR
type: string
statusMessage:
description: The Optimizer Statistics Advisor execution status message, if any.
type: string
taskName:
description: The name of the Optimizer Statistics Advisor task.
type: string
timeEnd:
description: 'The end time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
format: date-time
type: string
timeStart:
description: 'The start time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database
in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
'
format: date-time
type: string
required:
- taskName
- executionName
- timeStart
- timeEnd
- status
type: object
MySqlDatabaseConnectorSummary:
description: Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
associatedServices:
description: OCI Services associated with this connector.
maxLength: 255
type: string
compartmentId:
description: OCID of compartment for the External MySQL connector.
maxLength: 255
type: string
connectionStatus:
description: Connection Status.
maxLength: 255
type: string
connectorType:
description: Connector Type.
enum:
- MACS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlConnectorType'
credentialType:
description: Credential type used to connect to database.
enum:
- MYSQL_EXTERNAL_NON_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SOCKET_CREDENTIALS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlCredType'
hostName:
description: Host name for Connector.
maxLength: 255
minLength: 1
type: string
id:
description: OCID of MySQL Database Connector.
maxLength: 255
type: string
lifecycleState:
description: Indicates lifecycle state of the resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
macsAgentId:
description: Agent Id of the MACS agent.
maxLength: 255
type: string
name:
description: External MySQL Database Connector Name
maxLength: 255
type: string
networkProtocol:
description: Network Protocol.
enum:
- TCP
- TCPS
- SOCKETS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlNetworkProtocolType'
port:
description: Connector port.
maximum: 65535
minimum: 1
type: integer
sourceDatabase:
description: Name of MySQL Database.
maxLength: 255
type: string
sourceDatabaseType:
description: Type of MySQL Database.
enum:
- EXTERNAL
- MDS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlType'
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
timeConnectionStatusUpdated:
description: Time when connection status was last updated.
format: date-time
type: string
timeCreated:
description: Connector creation time.
format: date-time
type: string
timeUpdated:
description: Connector update time.
format: date-time
type: string
required:
- id
UpdateCloudDbSystemDetails:
description: The details required to update a cloud DB system.
properties:
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
type: object
UpdateExternalDbSystemDetails:
description: The details required to update an external DB system.
properties:
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
type: object
AssociatedComponent:
description: The details of the associated component.
properties:
associationType:
description: The association type.
enum:
- CONTAINS
- USES
type: string
componentId:
description: The identifier of the associated component.
type: string
componentType:
description: The type of associated component.
enum:
- ASM
- ASM_INSTANCE
- CLUSTER
- CLUSTER_INSTANCE
- DATABASE
- DATABASE_INSTANCE
- DATABASE_HOME
- DATABASE_NODE
- DBSYSTEM
- LISTENER
- PLUGGABLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/ExternalDbSystemComponentType'
required:
- componentId
- associationType
type: object
SqlPlanBaselineDimensions:
description: The details of the SQL plan baseline dimensions.
properties:
attributeName:
description: The name of the SQL plan baseline attribute.
maxLength: 20
type: string
attributeValue:
description: The value of the attribute.
maxLength: 10
type: string
required:
- attributeName
- attributeValue
type: object
ExternalDatabaseSystemDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: DATABASE_SYSTEM_DISCOVER_SUMMARY
properties:
asmConnectorName:
description: The display name of the ASM connector.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
oracleHome:
description: The Oracle home path.
type: string
description: The summary of the DB system discovery.
type: object
ExternalDatabaseCollection:
description: A collection of external databases.
properties:
items:
description: An array of external databases.
items:
$ref: '#/components/schemas/ExternalDatabaseSummary'
type: array
required:
- items
type: object
UpdateNamedCredentialDetails:
description: The details required to update a named credential.
properties:
associatedResource:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource that \nis associated to the named credential.\n"
type: string
content:
$ref: '#/components/schemas/NamedCredentialContent'
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
description:
description: The information specified by the user about the named credential.
maxLength: 400
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
scope:
description: The scope of the named credential.
enum:
- RESOURCE
- GLOBAL
type: string
x-obmcs-top-level-enum: '#/definitions/NamedCredentialScope'
type: object
DatabaseCredentials:
description: 'The database credentials used to perform management activity.
Provide one of the following attribute set.
(userName, password, role) OR (userName, secretId, role) OR (namedCredentialId)
'
properties:
password:
description: 'The password for the database user name.
'
format: password
type: string
role:
description: The role of the database user. Indicates whether the database user is a normal user or sysdba.
enum:
- NORMAL
- SYSDBA
type: string
secretId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the secret containing the user password.
type: string
userName:
description: 'The database user name used to perform management activity.
'
type: string
type: object
ManagedDatabaseCredential:
description: The credential used to connect to the Managed Database and obtain the details of the optimizer statistics tasks.
discriminator:
propertyName: credentialType
properties:
credentialType:
description: Indicates the type of credential required to retrieve the details of the optimizer statistics tasks.
enum:
- SECRET
- PASSWORD
type: string
role:
description: The role of the database user.
enum:
- NORMAL
- SYSDBA
type: string
username:
description: The user name used to connect to the database.
maxLength: 128
minLength: 1
type: string
required:
- credentialType
- username
- role
type: object
CloudListenerEndpoint:
description: The protocol address that a cloud listener is configured to listen on.
discriminator:
propertyName: protocol
properties:
protocol:
description: The listener protocol.
enum:
- IPC
- TCP
- TCPS
type: string
services:
description: The list of services registered with the listener.
items:
type: string
maxItems: 500
type: array
required:
- protocol
type: object
CloudListenerServiceSummary:
description: The summary of a service registered with a cloud listener.
properties:
listenerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
name:
description: The name of the service.
type: string
required:
- name
type: object
EnableAutomaticSpmEvolveAdvisorTaskDetails:
description: 'The details required to enable Automatic SPM Evolve Advisor task.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
ExternalDatabaseFeatureDetails:
description: The details required to enable the specified Database Management feature.
discriminator:
propertyName: feature
properties:
connectorDetails:
$ref: '#/components/schemas/ConnectorDetails'
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
- connectorDetails
type: object
ExternalListenerCollection:
description: A collection of external listeners.
properties:
items:
description: An array of external listeners.
items:
$ref: '#/components/schemas/ExternalListenerSummary'
type: array
required:
- items
type: object
AddManagedDatabaseToManagedDatabaseGroupDetails:
description: The Managed Database details required to add it to a Managed Database Group.
properties:
managedDatabaseId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
'
maxLength: 255
minLength: 1
type: string
required:
- managedDatabaseId
type: object
AllowedParameterValue:
description: A valid value for a database parameter.
properties:
isDefault:
description: Indicates whether the given ordinal value is the default value for the parameter.
type: boolean
ordinal:
description: The ordinal number in the list (1-based).
format: integer
type: number
value:
description: The parameter value at ordinal.
type: string
type: object
CreateManagedDatabaseGroupDetails:
description: The details required to create a Managed Database Group.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
in which the Managed Database Group resides.
'
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
description:
description: The information specified by the user about the Managed Database Group.
maxLength: 400
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
name:
description: 'The name of the Managed Database Group. Valid characters are uppercase or
lowercase letters, numbers, and "_". The name of the Managed Database Group
cannot be modified. It must be unique in the compartment and must begin with
an alphabetic character.
'
maxLength: 255
minLength: 1
type: string
required:
- name
- compartmentId
type: object
DiscoveredCloudDbSystemComponent:
description: The details of a cloud DB system component.
discriminator:
propertyName: componentType
properties:
associatedComponents:
description: The list of associated components.
items:
$ref: '#/components/schemas/AssociatedCloudComponent'
maxItems: 100
type: array
componentId:
description: The identifier of the discovered DB system component.
type: string
componentName:
description: The name of the discovered DB system component.
type: string
componentType:
description: The cloud DB system component type.
enum:
- ASM
- ASM_INSTANCE
- CLUSTER
- CLUSTER_INSTANCE
- DATABASE
- DATABASE_INSTANCE
- DATABASE_HOME
- DATABASE_NODE
- DBSYSTEM
- LISTENER
- PLUGGABLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemComponentType'
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing DBaas OCI resource matching the discovered DB system component.
type: string
displayName:
description: The user-friendly name for the discovered DB system component. The name does not have to be unique.
type: string
isSelectedForMonitoring:
description: Indicates whether the DB system component should be provisioned as an OCI resource or not.
type: boolean
resourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing OCI resource matching the discovered DB system component.
type: string
status:
description: The state of the discovered DB system component.
enum:
- NEW
- EXISTING
- EXISTING_BASIC
- EXISTING_PE
- EXISTING_BASIC_PE
- MARKED_FOR_UPGRADE
- MARKED_FOR_MIGRATION
- MARKED_FOR_UPGRADE_MIGRATION
- MARKED_FOR_DELETION
- UNKNOWN
type: string
required:
- componentId
- displayName
- componentName
- componentType
type: object
UpdateDatabaseParametersResult:
description: The results of database parameter update.
properties:
status:
additionalProperties:
$ref: '#/components/schemas/DatabaseParameterUpdateStatus'
description: 'A map with the parameter name as key and its update status as value.
'
type: object
required:
- status
type: object
ModifyDatabaseManagementFeatureDetails:
description: The details required to modify a Database Management feature for an Oracle cloud database.
properties:
featureDetails:
$ref: '#/components/schemas/DatabaseFeatureDetails'
required:
- featureDetails
type: object
UpdateCloudExadataStorageGridDetails:
description: The details required to update an Exadata storage server grid.
properties:
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
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
type: object
NamedCredential:
description: The details of a named credential.
properties:
associatedResource:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource that \nis associated to the named credential.\n"
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
content:
$ref: '#/components/schemas/NamedCredentialContent'
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
description:
description: The information specified by the user about the named credential.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential.
type: string
lifecycleDetails:
description: The details of the lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the named credential.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
name:
description: The name of the named credential.
type: string
scope:
description: The scope of the named credential.
enum:
- RESOURCE
- GLOBAL
type: string
x-obmcs-top-level-enum: '#/definitions/NamedCredentialScope'
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
timeCreated:
description: The date and time the named credential was created.
format: date-time
type: string
timeUpdated:
description: The date and time the named credential was last updated.
format: date-time
type: string
type:
description: The type of resource associated with the named credential.
enum:
- ORACLE_DB
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceType'
required:
- name
- id
- compartmentId
- lifecycleState
- timeCreated
type: object
DisableExternalContainerDatabaseManagementFeatureDetails:
description: The details required to disable a Database Management feature for an external container database.
properties:
canDisableAllPdbs:
description: Indicates whether Diagnostics & Management should be disabled for the pluggable databases before disabling it for the container database.
type: boolean
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
CreateCloudDbSystemDiscoveryDetails:
description: The details required to create a cloud DB system discovery resource.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the cloud DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud DB system resides.
type: string
dbaasParentInfrastructureId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems,
it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
'
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
deploymentType:
description: The deployment type of cloud DB system.
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
required:
- agentId
- compartmentId
- dbaasParentInfrastructureId
- deploymentType
type: object
WorkRequestLogEntry:
description: A log message from the execution of a work request.
properties:
id:
description: The identifier of the work request log.
type: integer
message:
description: A human-readable log message.
type: string
timestamp:
description: 'The date and time the log message was written, described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). The precision for the time object is in milliseconds.
'
format: date-time
type: string
workRequestId:
description: The OCID of the work request.
maxLength: 255
minLength: 1
type: string
required:
- id
- workRequestId
- message
- timestamp
DatabaseConnectionCredentials:
description: 'The credentials used to connect to the database. Currently only the `DETAILS` type
is supported for creating MACS connector credentials.
'
discriminator:
propertyName: credentialType
properties:
credentialType:
default: DETAILS
description: The type of credential used to connect to the database.
enum:
- NAME_REFERENCE
- DETAILS
- SSL_DETAILS
- NAMED_CREDENTIALS
type: string
OptimizerStatisticsCollectionOperationsCollection:
description: The details of each statistics collection operation.
properties:
items:
description: The details of the Optimizer Statistics Collection operation.
items:
$ref: '#/components/schemas/OptimizerStatisticsCollectionOperationSummary'
type: array
required:
- items
type: object
AssociatedServiceDetails:
description: The details of the associated service that will be enabled or disabled for an external DB System.
properties:
isEnabled:
description: The status of the associated service.
type: boolean
metadata:
description: The associated service-specific inputs in JSON string format, which Database Management can identify.
type: string
required:
- isEnabled
type: object
CloudExadataStorageConnector:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_CONNECTOR
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The details of the Exadata storage server connector.
type: object
WorkRequest:
description: A description of the work request status.
properties:
compartmentId:
description: 'The OCID of the compartment that contains the work request. Work requests should be scoped to
the same compartment as the resource the work request affects. If the work request affects multiple resources that are not in the same compartment,
then the system picks the primary resource whose compartment should be used.
'
maxLength: 255
minLength: 1
type: string
id:
description: The ID of the work request.
maxLength: 255
minLength: 1
type: string
operationType:
description: The type of work request.
enum:
- CREATE_DB_MANAGEMENT_PRIVATE_ENDPOINT
- DELETE_DB_MANAGEMENT_PRIVATE_ENDPOINT
- CREATE_DB_SYSTEM_DISCOVERY
- CREATE_DB_SYSTEM
- UPDATE_DB_SYSTEM
- DB_SYSTEM_ENABLE_DBMGMT
- DB_SYSTEM_DISABLE_DBMGMT
- DELETE_DB_SYSTEM
- UPDATE_EXTERNAL_DB_SYSTEM_CONNECTOR
- CHANGE_EXTERNAL_DB_SYSTEM_COMPARTMENT
- UPDATE_CLOUD_DB_SYSTEM_CONNECTOR
- CHANGE_CLOUD_DB_SYSTEM_COMPARTMENT
- DISABLE_EXADATA_INFRASTURCTURE
- ENABLE_EXADATA_INFRASTRUCTURE
- DELETE_EXADATA_INFRASTRUCTURE
- CHANGE_EXADATA_COMPARTMENT
- ENABLE_SQL_WATCH
- DISABLE_SQL_WATCH
- MODIFY_SQL_WATCH
- ENABLE_DBLM
- DISABLE_DBLM
- MODIFY_DBLM
- ENABLE_DBMGMT
- DISABLE_DBMGMT
- MODIFY_DBMGMT
- CHECK_EXTERNAL_MYSQL_CONNECTION
- UPDATE_EXTERNAL_MYSQL_CREDENTIAL
- CREATE_EXTERNAL_MYSQL_CONNECTOR
- DELETE_EXTERNAL_MYSQL_CONNECTOR
- DELETE_EXTERNAL_MYSQL_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType'
percentComplete:
description: The completed percentage of the operation tracked by the work request.
format: float
type: number
resources:
description: The resources affected by this work request.
items:
$ref: '#/components/schemas/WorkRequestResource'
type: array
status:
description: The status of the current work request.
enum:
- ACCEPTED
- IN_PROGRESS
- FAILED
- SUCCEEDED
- CANCELING
- CANCELED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus'
timeAccepted:
description: 'The date and time the work request was accepted, as described in
[RFC 3339](https://tools.ietf.org/rfc/rfc3339).
The precision for this time object in milliseconds.
'
format: date-time
type: string
timeFinished:
description: 'The date and time the work request reached a terminal state, either FAILED or SUCCEEDED, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
The precision for this time object is in milliseconds.
'
format: date-time
type: string
timeStarted:
description: 'The date and time the work request transitioned from ACCEPTED to IN_PROGRESS, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
The precision for this time object is in milliseconds.
'
format: date-time
type: string
required:
- id
- compartmentId
- operationType
- status
- percentComplete
- timeAccepted
- resources
ConsumerGroupPrivilegeSummary:
description: A summary of consumer group privileges.
properties:
grantOption:
description: Indicates whether the privilege is granted with the GRANT option (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
initialGroup:
description: Indicates whether the consumer group is designated as the default for this user or role (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
name:
description: The name of the granted consumer group privilege.
type: string
type: object
SqlPlanBaselineSummary:
description: The summary of a SQL plan baseline.
properties:
accepted:
description: Indicates whether the plan baseline is accepted (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
adaptive:
description: 'Indicates whether a plan that is automatically captured by SQL plan management is marked adaptive or not.
When a new adaptive plan is found for a SQL statement that has an existing SQL plan baseline, that new plan
will be added to the SQL plan baseline as an unaccepted plan, and the `ADAPTIVE` property will be marked `YES`.
When this new plan is verified (either manually or via the auto evolve task), the plan will be test executed
and the final plan determined at execution will become an accepted plan if its performance is better than
the existing plan baseline. At this point, the value of the `ADAPTIVE` property is set to `NO` since the plan
is no longer adaptive, but resolved.
'
enum:
- 'YES'
- 'NO'
type: string
autoPurge:
description: Indicates whether the plan baseline is auto-purged (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
enabled:
description: Indicates whether the plan baseline is enabled (`YES`) or disabled (`NO`).
enum:
- 'YES'
- 'NO'
type: string
fixed:
description: Indicates whether the plan baseline is fixed (`YES`) or not (`NO`).
enum:
- 'YES'
- 'NO'
type: string
origin:
description: The origin of the SQL plan baseline.
enum:
- ADDM_SQLTUNE
- AUTO_CAPTURE
- AUTO_SQLTUNE
- EVOLVE_AUTO_INDEX_LOAD
- EVOLVE_CREATE_FROM_ADAPTIVE
- EVOLVE_LOAD_FROM_STS
- EVOLVE_LOAD_FROM_AWR
- EVOLVE_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD
- MANUAL_LOAD_FROM_AWR
- MANUAL_LOAD_FROM_CURSOR_CACHE
- MANUAL_LOAD_FROM_STS
- MANUAL_SQLTUNE
- STORED_OUTLINE
- UNKNOWN
type: string
x-obmcs-top-level-enum: '#/definitions/SqlPlanBaselineOrigin'
planName:
description: The unique plan identifier.
type: string
reproduced:
description: 'Indicates whether the optimizer was able to reproduce the plan (`YES`) or not (`NO`).
The value is set to `YES` when a plan is initially added to the plan baseline.
'
enum:
- 'YES'
- 'NO'
type: string
sqlHandle:
description: The unique SQL identifier.
type: string
sqlText:
description: The SQL text (truncated to the first 50 characters).
maxLength: 50
type: string
timeCreated:
description: The date and time when the plan baseline was created.
format: date-time
type: string
timeLastExecuted:
description: 'The date and time when the plan baseline was last executed.
**Note:** For performance reasons, database does not update this value
immediately after each execution of the plan baseline. Therefore, the plan
baseline may have been executed more recently than this value indicates.
'
format: date-time
type: string
timeLastModified:
description: The date and time when the plan baseline was last modified.
format: date-time
type: string
required:
- planName
- sqlHandle
- sqlText
- timeCreated
type: object
SqlPlanBaselineJobSummary:
description: A summary of the database job used for loading and evolving SQL plan baselines.
properties:
name:
description: The name of the job.
type: string
status:
description: The status of the job.
enum:
- SUCCEEDED
- SCHEDULED
- FAILED
type: string
timeCreated:
description: The date and time the job was created.
format: date-time
type: string
type:
description: The type of the job.
enum:
- LOAD
type: string
required:
- name
- type
- status
type: object
DiscoverCloudExadataInfrastructureDetails:
description: The connection details and the discovery options for the Exadata discovery.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
discoveryType:
default: NEW
description: The type of discovery.
enum:
- NEW
- OVERRIDE
type: string
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. This is applicable for rediscovery only.
maxLength: 255
minLength: 1
type: string
vmClusterIds:
description: The list of VM Clusters in the Exadata infrastructure.
items:
maxLength: 255
minLength: 1
type: string
type: array
required:
- discoveryType
- compartmentId
- vmClusterIds
type: object
CloudDbNodeCollection:
description: A collection of cloud DB nodes.
properties:
items:
description: An array of cloud DB nodes.
items:
$ref: '#/components/schemas/CloudDbNodeSummary'
type: array
required:
- items
type: object
ExadataInfrastructureFleetHealthMetrics:
description: The details of the fleet health metrics.
properties:
compareBaselineTime:
description: 'The baseline date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
This is the date and time against which percentage change is calculated.
'
type: string
compareTargetTime:
description: 'The target date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd''T''hh:mm:ss.sss''Z''".
All the metrics are returned for the target date and time and the percentage change
is calculated against the baseline date and time.
'
type: string
compareType:
description: The time window used for metrics comparison.
enum:
- HOUR
- DAY
- WEEK
type: string
x-obmcs-top-level-enum: '#/definitions/CompareType'
exadataInfrastructureFleetSummary:
$ref: '#/components/schemas/ExadataInfrastructureFleetSummary'
fleetExadataInfrastructures:
description: A list of the Exadata infrastructures present in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/ExadataInfrastructureUsageMetrics'
type: array
required:
- compareBaselineTime
- compareTargetTime
- fleetExadataInfrastructures
type: object
CloudDbSystemConnectorCollection:
description: A collection of cloud DB system connectors.
properties:
items:
description: An array of cloud DB system connectors.
items:
$ref: '#/components/schemas/CloudDbSystemConnectorSummary'
type: array
required:
- items
type: object
CloudDbNode:
description: The details of a cloud DB node.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the cloud DB node defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the DB node is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud DB node.
type: string
cpuCoreCount:
description: The number of CPU cores available on the DB node.
format: float
type: number
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node in DBaas service.
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
displayName:
description: The user-friendly name for the cloud DB node. The name does not have to be unique.
type: string
domainName:
description: The name of the domain.
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
hostName:
description: The host name for the DB node.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB node.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
memorySizeInGBs:
description: The total memory in gigabytes (GB) on the DB node.
format: float
type: number
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud DB node was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB node was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
TestPreferredCredentialStatus:
description: The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'.
properties:
errorCode:
description: 'An error code that defines the failure of the preferred credential test. The response is ''null'' if the preferred credential test was successful.
'
type: string
errorMessage:
description: 'The error message that indicates the reason for the failure of the preferred credential test. The response is ''null'' if the preferred credential test was successful.
'
type: string
status:
description: The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'.
enum:
- SUCCEEDED
- FAILED
type: string
type: object
ExternalStorageServerDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: STORAGE_SERVER_DISCOVER_SUMMARY
properties:
connectorName:
description: The name of the Exadata storage server connector in case of rediscovery.
type: string
cpuCount:
description: The CPU count of the Exadata storage server.
type: integer
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
memoryGB:
description: The memory size in GB of the Exadata storage server.
format: double
type: number
description: The summary of the Exadata storage server discovery.
type: object
UpdateCloudAsmDetails:
description: The details required to update a cloud ASM.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
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
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
type: object
TablespaceSummary:
description: The summary of a tablespace.
properties:
allocatedSizeKB:
description: The allocated tablespace size in KB.
format: integer
type: number
allocationType:
description: The type of extent allocation in effect for the tablespace.
enum:
- SYSTEM
- UNIFORM
- USER
type: string
blockSizeBytes:
description: The tablespace block size.
format: integer
type: number
compressFor:
description: The operation type for which default compression is enabled.
enum:
- BASIC
- ADVANCED
- QUERY_LOW
- QUERY_HIGH
- ARCHIVE_LOW
- ARCHIVE_HIGH
- DIRECT_LOAD_ONLY
- FOR_ALL_OPERATIONS
type: string
datafiles:
description: A list of the data files associated with the tablespace.
items:
$ref: '#/components/schemas/Datafile'
type: array
defaultCellMemory:
description: This specifies the default value for the CELLMEMORY attribute that tables created in the tablespace will inherit unless the behavior is overridden explicitly. This column is intended for use with Oracle Exadata.
type: string
defaultInMemory:
description: Indicates whether the In-Memory Column Store (IM column store) is by default enabled or disabled for tables in the tablespace.
enum:
- ENABLED
- DISABLED
type: string
defaultInMemoryCompression:
description: Indicates the default compression level for the IM column store for the tablespace.
enum:
- NO_MEMCOMPRESS
- FOR_DML
- FOR_QUERY_LOW
- FOR_QUERY_HIGH
- FOR_CAPACITY_LOW
- FOR_CAPACITY_HIGH
type: string
defaultInMemoryDistribute:
description: Indicates how the IM column store is distributed by default for the tablespace in an Oracle Real Application Clusters (Oracle RAC) environment.
enum:
- AUTO
- BY_ROWID_RANGE
- BY_PARTITION
- BY_SUBPARTITION
type: string
defaultInMemoryDuplicate:
description: Indicates the duplicate setting for the IM column store in an Oracle RAC environment.
enum:
- NO_DUPLICATE
- DUPLICATE
- DUPLICATE_ALL
type: string
defaultInMemoryPriority:
description: Indicates the default priority for In-Memory Column Store (IM column store) population for the tablespace.
enum:
- LOW
- MEDIUM
- HIGH
- CRITICAL
- NONE
type: string
defaultInMemoryService:
description: Indicates how the IM column store is populated on various instances by default for the tablespace.
enum:
- DEFAULT
- NONE
- ALL
- USER_DEFINED
type: string
defaultInMemoryServiceName:
description: Indicates the service name for the service on which the IM column store should be populated by default for the tablespace. This column has a value only when the corresponding DEF_INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null.
type: string
defaultIndexCompression:
description: Indicates whether default index compression is enabled or disabled.
enum:
- ENABLED
- DISABLED
type: string
defaultTableCompression:
description: Indicates whether default table compression is enabled or disabled.
enum:
- ENABLED
- DISABLED
type: string
extentManagement:
description: Indicates whether the extents in the tablespace are Locally managed or Dictionary managed.
enum:
- LOCAL
- DICTIONARY
type: string
freeSpaceKB:
description: The free space available in the tablespace in KB.
format: integer
type: number
indexCompressFor:
description: The operation type for which default index compression is enabled.
enum:
- ADVANCED_LOW
- ADVANCED_HIGH
- NONE
type: string
isBigfile:
description: Indicates whether the tablespace is a Bigfile tablespace or a Smallfile tablespace.
type: boolean
isChunkTablespace:
description: Indicates whether this is a chunk tablespace.
type: boolean
isDefault:
description: Indicates whether this is the default tablespace.
type: boolean
isEncrypted:
description: Indicates whether the tablespace is encrypted.
type: boolean
isForceLogging:
description: Indicates whether the tablespace is under Force Logging mode.
type: boolean
isPluggedIn:
description: Indicates whether the tablespace is plugged in.
type: boolean
logging:
description: The default logging attribute.
enum:
- LOGGING
- NOLOGGING
type: string
lostWriteProtect:
description: The lost write protection setting for the tablespace.
enum:
- ENABLED
- PROTECT_OFF
- SUSPEND
type: string
maxSizeKB:
description: The maximum tablespace size in KB. If the tablespace contains any data files with Autoextend enabled, then this column displays the amount of underlying free storage space for the tablespace. For example, if the current tablespace size is 1 GB, the combined maximum size of all its data files is 32 GB, and its underlying storage (for example, ASM or file system storage) has 20 GB of free space, then this column will have a value of approximately 20 GB. If the tablespace contains only data files with autoextend disabled, then this column displays the allocated space for the entire tablespace, that is, the combined size of all data files in the tablespace.
format: integer
type: number
name:
description: The name of the tablespace.
type: string
predicateEvaluation:
description: Indicates whether predicates are evaluated by Host or by Storage.
enum:
- HOST
- STORAGE
type: string
retention:
description: Indicates whether undo retention guarantee is enabled for the tablespace.
enum:
- GUARANTEE
- NOGUARANTEE
- NOT_APPLY
type: string
segmentSpaceManagement:
description: Indicates whether the free and used segment space in the tablespace is managed using free lists (MANUAL) or bitmaps (AUTO).
enum:
- MANUAL
- AUTO
type: string
shared:
description: Indicates whether the tablespace is for shared tablespace, or for local temporary tablespace for leaf (read-only) instances, or for local temporary tablespace for all instance types.
enum:
- SHARED
- LOCAL_ON_LEAF
- LOCAL_ON_ALL
type: string
status:
description: The status of the tablespace.
enum:
- ONLINE
- OFFLINE
- READ_ONLY
type: string
tempGroup:
description: The temporary tablespace group.
type: string
type:
description: The type of tablespace.
enum:
- UNDO
- LOST_WRITE_PROTECTION
- PERMANENT
- TEMPORARY
type: string
usedPercentAllocated:
description: The percentage of used space out of the total allocated space in the tablespace.
format: double
type: number
usedPercentAvailable:
description: The percentage of used space out of the maximum available space in the tablespace.
format: double
type: number
usedSpaceKB:
description: The total space used by the tablespace in KB.
format: integer
type: number
userSizeKB:
description: The size of the tablespace available for user data in KB. The difference between tablespace size and user data size is used for storing metadata.
format: integer
type: number
required:
- name
- type
type: object
CloudAsmDiskGroupSummary:
description: The summary of a cloud ASM disk group.
properties:
databases:
description: The unique names of the databases using the disk group.
items:
type: string
maxItems: 100
type: array
dismountingInstanceCount:
description: The number of ASM instances that have the disk group in dismounted state.
format: int32
type: integer
isSparse:
description: Indicates whether the disk group is a sparse disk group or not.
type: boolean
mountingInstanceCount:
description: The number of ASM instances that have the disk group in mounted state.
format: int32
type: integer
name:
description: The name of the ASM disk group.
type: string
redundancyType:
description: The redundancy type of the disk group.
enum:
- EXTEND
- EXTERN
- FLEX
- HIGH
- NORMAL
type: string
totalSizeInMBs:
description: The total capacity of the disk group (in megabytes).
format: int64
type: integer
usedPercent:
description: The percentage of used space in the disk group.
format: float
type: number
usedSizeInMBs:
description: The used capacity of the disk group (in megabytes).
format: int64
type: integer
required:
- name
type: object
DbManagementPrivateEndpointCollection:
description: A collection of Database Management private endpoint objects.
properties:
items:
description: A list of DbManagementPrivateEndpointSummary objects.
items:
$ref: '#/components/schemas/DbManagementPrivateEndpointSummary'
type: array
required:
- items
type: object
WorkRequestResource:
description: The resource that is created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
- FAILED
- ACCEPTED
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceActionType'
entityDependencies:
description: 'The dependent resources of this work request resource, these can only be provisioned
when primary resource successfully completes.
'
items:
$ref: '#/components/schemas/WorkRequestSubResource'
type: array
entityName:
description: The name of the WorkRequest resource entity.
type: string
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that is used in a GET request to access the resource metadata.
type: string
identifier:
description: The OCID or other unique identifier of the resource the work request affects.
maxLength: 255
minLength: 1
type: string
required:
- actionType
- entityType
- identifier
ExternalDbSystemDiscoverySummary:
description: The summary of an external DB system.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the external DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system discovery.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system discovery resource.
type: string
x-obmcs-enumref: '#/definitions/ExternalDbSystemDiscovery/lifecycleState'
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
timeCreated:
description: The date and time the external DB system discovery was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system discovery was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- agentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
UserCollection:
description: A collection of users for a specific Managed Database.
properties:
items:
description: An array of User resources.
items:
$ref: '#/components/schemas/UserSummary'
type: array
required:
- items
type: object
TableStatisticSummary:
description: 'The summary of table statistics statuses, which includes status categories such as Stale, Not Stale, and No Stats,
the number of table statistics grouped by status category, and the percentage of objects with a particular status.
'
properties:
count:
description: The number of objects aggregated by status category.
type: integer
percentage:
description: The percentage of objects with a particular status.
format: double
type: number
type:
description: The valid status categories of table statistics.
enum:
- NO_STATS
- STALE
- NOT_STALE
type: string
x-obmcs-top-level-enum: '#/definitions/TableStatisticsStatusCategory'
required:
- type
- count
- percentage
type: object
SqlPlanBaselineAggregationCollection:
description: A collection of SQL plan baseline aggregations.
properties:
items:
description: A list of SQL plan baseline aggregations.
items:
$ref: '#/components/schemas/SqlPlanBaselineAggregation'
type: array
required:
- items
type: object
ExternalCluster:
description: The details of an external cluster.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the external cluster defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external cluster.
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
displayName:
description: The user-friendly name for the external cluster. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster is a part of.
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
gridHome:
description: The directory in which Oracle Grid Infrastructure is installed.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster.
type: string
isFlexCluster:
description: Indicates whether the cluster is Oracle Flex Cluster or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external cluster.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
networkConfigurations:
description: The list of network address configurations of the external cluster.
items:
$ref: '#/components/schemas/ExternalClusterNetworkConfiguration'
type: array
ocrFileLocation:
description: The location of the Oracle Cluster Registry (OCR).
type: string
scanConfigurations:
description: The list of Single Client Access Name (SCAN) configurations of the external cluster.
items:
$ref: '#/components/schemas/ExternalClusterScanListenerConfiguration'
type: array
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
timeCreated:
description: The date and time the external cluster was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external cluster was last updated.
format: date-time
type: string
version:
description: The cluster version.
type: string
vipConfigurations:
description: The list of Virtual IP (VIP) configurations of the external cluster.
items:
$ref: '#/components/schemas/ExternalClusterVipConfiguration'
type: array
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalListenerServiceSummary:
description: The summary of a service registered with an external listener.
properties:
listenerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
name:
description: The name of the service.
type: string
required:
- name
type: object
ProxyUserSummary:
description: A summary of the proxy user.
properties:
authentication:
description: Indicates whether the proxy is required to supply the client credentials (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
flags:
description: The flags associated with the proxy/client pair.
enum:
- PROXY_MAY_ACTIVATE_ALL_CLIENT_ROLES
- NO_CLIENT_ROLES_MAY_BE_ACTIVATED
- PROXY_MAY_ACTIVATE_ROLE
- PROXY_MAY_NOT_ACTIVATE_ROLE
type: string
name:
description: The name of a proxy user or the name of the client user.
type: string
type: object
CloudClusterInstanceSummary:
description: The summary of a cloud cluster instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
type: string
cloudClusterId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster that the cluster instance belongs to.
type: string
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the cluster instance is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud cluster instance.
type: string
crsBaseDirectory:
description: The Oracle base location of Cluster Ready Services (CRS).
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cluster instance. The name does not have to be unique.
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
hostName:
description: The name of the host on which the cluster instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud cluster instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud cluster instance.
type: string
x-obmcs-enumref: '#/definitions/CloudClusterInstance/lifecycleState'
nodeRole:
description: The role of the cluster node.
type: string
x-obmcs-enumref: '#/definitions/CloudClusterInstance/nodeRole'
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
timeCreated:
description: The date and time the cloud cluster instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud cluster instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudClusterId
- cloudDbSystemId
- lifecycleState
type: object
ExternalListenerSummary:
description: The summary of an external listener.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external listener.
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
displayName:
description: The user-friendly name for the external listener. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node on which the listener is running.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the listener is a member of.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external listener.
type: string
x-obmcs-enumref: '#/definitions/ExternalListener/lifecycleState'
listenerType:
description: The type of listener.
type: string
x-obmcs-enumref: '#/definitions/ExternalListener/listenerType'
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
timeCreated:
description: The date and time the external listener was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external listener was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
DatabaseStorageAggregateMetrics:
description: The database storage metric values.
properties:
storageAllocated:
$ref: '#/components/schemas/MetricDataPoint'
storageUsed:
$ref: '#/components/schemas/MetricDataPoint'
storageUsedByTableSpace:
description: A list of the storage metrics grouped by TableSpace for a specific Managed Database.
items:
$ref: '#/components/schemas/MetricDataPoint'
type: array
type: object
CloudDbHomeCollection:
description: A collection of cloud database homes.
properties:
items:
description: An array of cloud DB homes.
items:
$ref: '#/components/schemas/CloudDbHomeSummary'
type: array
required:
- items
type: object
WorkRequestError:
description: An error encountered while executing a work request.
properties:
code:
description: 'A machine-usable code for the error that occurred. Error codes are listed on
(https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
'
type: string
id:
description: The identifier of the work request error.
maxLength: 255
minLength: 1
type: string
isRetryable:
description: Determines if the work request error can be reproduced and tried again.
type: boolean
message:
description: A human-readable description of the issue that occurred.
type: string
timestamp:
description: 'The date and time the error occurred as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). The precision for the time object is in milliseconds.
'
format: date-time
type: string
workRequestId:
description: The OCID of the work request.
maxLength: 255
minLength: 1
type: string
required:
- id
- workRequestId
- code
- message
- timestamp
ExternalDbNodeSummary:
description: The summary of an external database node.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external DB node.
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
displayName:
description: The user-friendly name for the external DB node. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the DB node is a part of.
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
hostName:
description: The host name for the DB node.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB node.
type: string
x-obmcs-enumref: '#/definitions/ExternalDbNode/lifecycleState'
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
timeCreated:
description: The date and time the external DB node was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB node was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ParentGroup:
description: The parent Managed Database Group of a Managed Database.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database Group resides.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group.
type: string
name:
description: The name of the Managed Database Group.
type: string
required:
- name
- id
- compartmentId
Tablespace:
allOf:
- $ref: '#/components/schemas/TablespaceSummary'
description: The details of a tablespace.
ExternalExadataInfrastructureCollection:
description: A list of the Exadata infrastructure resources.
properties:
items:
description: A list of Exadata infrastructures.
items:
$ref: '#/components/schemas/ExternalExadataInfrastructureSummary'
type: array
required:
- items
type: object
ExternalExadataInfrastructure:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: INFRASTRUCTURE
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseCompartments:
description: The list of [OCIDs] (/Content/General/Concepts/identifiers.htm) of the compartments.
items:
type: string
type: array
databaseSystems:
description: A list of DB systems.
items:
$ref: '#/components/schemas/ExternalExadataDatabaseSystemSummary'
type: array
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
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
rackSize:
description: The rack size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
type: string
storageGrid:
$ref: '#/components/schemas/ExternalExadataStorageGridSummary'
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
description: The details of the Exadata infrastructure.
type: object
CloudAsmUserSummary:
description: The summary of an ASM user.
properties:
asmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
type: string
name:
description: The name of the ASM user.
type: string
privileges:
description: The list of privileges of the ASM user.
items:
type: string
maxItems: 25
type: array
uniqueItems: true
required:
- name
- privileges
type: object
ExternalDbSystemDiscoveryCollection:
description: A collection of external DB system discovery summaries.
properties:
items:
description: An array of external DB system discoveries.
items:
$ref: '#/components/schemas/ExternalDbSystemDiscoverySummary'
type: array
required:
- items
type: object
CloudAsmServicedDatabase:
allOf:
- $ref: '#/components/schemas/CloudServicedDatabase'
- properties:
diskGroups:
description: The list of ASM disk groups used by the database.
items:
type: string
maxItems: 600
type: array
type: object
description: The details of a database serviced by a cloud ASM.
NamedCredentialSummary:
description: A summary of the named credential.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
in which the named credential resides.
'
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
description:
description: The information specified by the user about the named credential.
maxLength: 400
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the named credential.
type: string
lifecycleDetails:
description: The details of the lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the named credential.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
name:
description: 'The name of the named credential. Valid characters are uppercase or
lowercase letters, numbers, and "_". The name of the named credential
cannot be modified. It must be unique in the compartment and must begin with
an alphabetic character.
'
maxLength: 255
minLength: 1
type: string
scope:
description: The scope of the named credential.
enum:
- RESOURCE
- GLOBAL
type: string
x-obmcs-top-level-enum: '#/definitions/NamedCredentialScope'
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
timeCreated:
description: The date and time the named credential was created.
format: date-time
type: string
timeUpdated:
description: The date and time the named credential was last updated.
format: date-time
type: string
type:
description: The type of resource associated with the named credential.
enum:
- ORACLE_DB
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceType'
required:
- name
- id
- compartmentId
- lifecycleState
- lifecycleDetails
- type
- scope
- description
- timeCreated
- timeUpdated
type: object
TableStatisticsCollection:
description: A collection of table statistics, which are grouped by status.
properties:
items:
description: The list of table statistics statuses.
items:
$ref: '#/components/schemas/TableStatisticSummary'
type: array
required:
- items
type: object
EnableExternalPluggableDatabaseManagementFeatureDetails:
description: The details required to enable a Database Management feature for an external pluggable database.
properties:
featureDetails:
$ref: '#/components/schemas/ExternalPluggableDatabaseFeatureDetails'
required:
- featureDetails
type: object
EntityDiscovered:
description: The details of the base entity discovery.
discriminator:
propertyName: entityType
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent used for monitoring.
type: string
connectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the associated connector.
type: string
discoverErrorCode:
description: The error code of the discovery.
type: string
discoverErrorMsg:
description: The error message of the discovery.
type: string
discoverStatus:
default: NEW_DISCOVERED
description: The status of the entity discovery.
enum:
- PREV_DISCOVERED
- NEW_DISCOVERED
- NOT_FOUND
- DISCOVERING
type: string
displayName:
description: The name of the entity.
type: string
entityType:
description: The type of discovered entities.
enum:
- STORAGE_SERVER_DISCOVER_SUMMARY
- STORAGE_GRID_DISCOVER_SUMMARY
- DATABASE_SYSTEM_DISCOVER_SUMMARY
- INFRASTRUCTURE_DISCOVER_SUMMARY
- INFRASTRUCTURE_DISCOVER
- MANAGED_STORAGE_SERVER_DISCOVER_SUMMARY
- MANAGED_STORAGE_GRID_DISCOVER_SUMMARY
- VM_CLUSTER_DISCOVER_SUMMARY
- MANAGED_INFRASTRUCTURE_DISCOVER_SUMMARY
- CLOUD_INFRASTRUCTURE_DISCOVER
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the entity discovered.
type: string
internalId:
description: The internal identifier of the entity.
type: string
status:
description: The status of the entity.
type: string
version:
description: The version of the entity.
type: string
required:
- displayName
- entityType
type: object
EnableDatabaseManagementFeatureDetails:
description: The details required to enable Database Management features for an Oracle cloud database.
properties:
featureDetails:
$ref: '#/components/schemas/DatabaseFeatureDetails'
required:
- featureDetails
type: object
UpdateExternalClusterInstanceDetails:
description: The details required to update an external cluster instance.
properties:
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
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
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
type: object
ExternalListenerServiceCollection:
description: A collection of external listener services.
properties:
items:
description: An array of external listener services.
items:
$ref: '#/components/schemas/ExternalListenerServiceSummary'
type: array
required:
- items
type: object
OptimizerDatabase:
description: The subset information of the Managed Database resource, which is used by Optimizer Statistics.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides.
type: string
dbDeploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
dbSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
dbType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
dbVersion:
description: The version of the Oracle Database.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
name:
description: The name of the Managed Database.
type: string
required:
- id
- name
- dbType
- dbSubType
- dbDeploymentType
- dbVersion
- compartmentId
type: object
CloudDbSystemSummary:
description: The summary of a cloud DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/CloudDbSystemDatabaseManagementConfigDetails'
dbaasParentInfrastructureId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems ,
it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
'
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
deploymentType:
description: The deployment type of cloud DB system.
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/CloudExadataInfraBasicInfo'
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
homeDirectory:
description: 'The Oracle Grid home directory in case of cluster-based DB system and
Oracle home directory in case of single instance-based DB system.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system resource.
type: string
x-obmcs-enumref: '#/definitions/CloudDbSystem/lifecycleState'
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
timeCreated:
description: The date and time the cloud DB system was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system was last updated.
format: date-time
type: string
required:
- id
- dbaasParentInfrastructureId
- deploymentType
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalDbHome:
description: The details of an external database home.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the DB home defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external DB home.
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
displayName:
description: The user-friendly name for the external DB home. The name does not have to be unique.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the DB home is a part of.
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
homeDirectory:
description: The location of the DB home.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB home.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB home.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external DB home was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB home was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
UpdateExternalExadataStorageConnectorDetails:
description: The connector details of the Exadata storage server to be updated.
properties:
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
maxLength: 1024
minLength: 1
type: string
connectorName:
description: The name of the Exadata storage server connector.
maxLength: 255
minLength: 1
type: string
credentialInfo:
$ref: '#/components/schemas/RestCredential'
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
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
type: object
CloudAsmUserCollection:
description: A collection of cloud ASM users.
properties:
items:
description: An array of cloud ASM users.
items:
$ref: '#/components/schemas/CloudAsmUserSummary'
type: array
required:
- items
type: object
AwrDbReport:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_DB_REPORT
properties:
content:
description: The content of the report.
type: string
format:
description: The format of the report.
enum:
- HTML
- TEXT
- XML
type: string
description: The result of the AWR report.
type: object
MetricsAggregationRangeCollection:
description: The collection of metrics.
properties:
endTime:
description: 'The end of the metric data query time range. Expressed in UTC in
ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
type: string
items:
description: The metric data.
items:
$ref: '#/components/schemas/MetricsAggregationRange'
type: array
startTime:
description: 'The beginning of the metric data query time range. Expressed in UTC in
ISO-8601 format, which is `yyyy-MM-dd''T''hh:mm:ss.sss''Z''`.
'
type: string
required:
- items
type: object
ExternalDbSystemStackMonitoringConfigDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The configuration details of Stack Monitoring for an external DB system.
DataguardMetrics:
allOf:
- $ref: '#/components/schemas/BaseDatabaseHaDetails'
- properties:
fastStartFailOver:
description: The Fast-Start Failover status of the primary database.
type: string
metrics:
description: A list of primary or standby database metrics.
items:
$ref: '#/components/schemas/HaMetricDefinition'
type: array
protectionMode:
description: The protection mode of the primary Database.
type: string
standByDatabases:
description: A list of standby databases and their metrics
items:
$ref: '#/components/schemas/StandByDatabaseDataguardMetrics'
type: array
uniqueItems: true
required:
- fastStartFailOver
- protectionMode
- metrics
- standByDatabases
type: object
description: The Data Guard usage metrics for a single database.
WorkRequestSubResource:
description: The resource that is created or operated on by a work request.
properties:
actionType:
description: 'The way in which this resource is affected by the work tracked in the work request.
A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
work is complete for that resource at which point it will transition to CREATED, UPDATED,
or DELETED, respectively.
'
enum:
- CREATED
- UPDATED
- DELETED
- IN_PROGRESS
- RELATED
- FAILED
- ACCEPTED
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceActionType'
description:
description: Description of the entity
type: string
entityName:
description: The name of the subresource entity.
type: string
entityType:
description: The resource type the work request affects.
type: string
entityUri:
description: The URI path that is used in a GET request to access the resource metadata.
type: string
identifier:
description: The OCID or other unique identifier of the resource the work request affects.
maxLength: 255
minLength: 1
type: string
required:
- actionType
- entityType
- entityName
UpdateCloudExadataStorageServerDetails:
description: The details required to update an Exadata storage server.
properties:
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
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
type: object
OptimizerStatisticsCollectionAggregationSummary:
description: The summary of the Optimizer Statistics Collection, which includes the aggregated number of tasks grouped by status.
properties:
completed:
description: The number of tasks or objects for which statistics gathering is completed.
type: integer
failed:
description: The number of tasks or objects for which statistics gathering failed.
type: integer
groupBy:
description: The optimizer statistics tasks grouped by type.
enum:
- TASK_STATUS
- TASK_OBJECTS_STATUS
type: string
x-obmcs-top-level-enum: '#/definitions/OptimizerStatisticsGroupByTypes'
inProgress:
description: The number of tasks or objects for which statistics gathering is in progress.
type: integer
pending:
description: The number of tasks or objects for which statistics are yet to be gathered.
type: integer
skipped:
description: The number of tasks or objects for which statistics gathering was skipped.
type: integer
timeEnd:
description: Indicates the end of the hour as the statistics are aggregated per hour.
format: date-time
type: string
timeStart:
description: Indicates the start of the hour as the statistics are aggregated per hour.
format: date-time
type: string
timedOut:
description: The number of tasks or objects for which statistics gathering timed out.
type: integer
total:
description: 'The total number of tasks or objects for which statistics collection is finished. This number is the
sum of all the tasks or objects with various statuses: pending, inProgress, completed, failed, skipped,
timedOut, and unknown.
'
type: integer
unknown:
description: The number of tasks or objects for which the status of statistics gathering is unknown.
type: integer
required:
- timeStart
type: object
IormPlan:
description: The IORM plan from an Exadata storage server.
properties:
dbPlan:
$ref: '#/components/schemas/DatabasePlan'
planObjective:
description: The objective of the IORM plan.
enum:
- AUTO
- HIGH_THROUGHPUT
- LOW_LATENCY
- BALANCED
- BASIC
- OTHER
type: string
x-obmcs-top-level-enum: '#/definitions/IormPlanObjectiveEnum'
planStatus:
description: The status of the IORM plan.
enum:
- ACTIVE
- INACTIVE
- OTHER
type: string
x-obmcs-top-level-enum: '#/definitions/IormPlanStatusEnum'
required:
- planStatus
- planObjective
type: object
ChangeSpaceBudgetDetails:
description: 'The details required to change the disk space limit for the SQL Management Base.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
spaceBudgetPercent:
description: 'The maximum percent of `SYSAUX` space that the SQL Management Base can use.
'
format: double
maximum: 50
minimum: 1
type: number
required:
- spaceBudgetPercent
type: object
RecommendationRationale:
description: The details of the rationale for the recommendation.
properties:
message:
description: The message of the rationale.
type: string
required:
- message
type: object
AwrQueryResult:
description: The AWR query result.
discriminator:
propertyName: awrResultType
properties:
awrResultType:
description: The result type of AWR query.
enum:
- AWRDB_SET
- AWRDB_SNAPSHOT_RANGE_SET
- AWRDB_SNAPSHOT_SET
- AWRDB_METRICS_SET
- AWRDB_SYSSTAT_SET
- AWRDB_TOP_EVENT_SET
- AWRDB_EVENT_SET
- AWRDB_EVENT_HISTOGRAM
- AWRDB_DB_PARAMETER_SET
- AWRDB_DB_PARAMETER_CHANGE
- AWRDB_ASH_CPU_USAGE_SET
- AWRDB_DB_REPORT
- AWRDB_SQL_REPORT
type: string
dbQueryTimeInSecs:
description: The time taken to query the database tier (in seconds).
format: double
type: number
name:
description: The name of the query result.
type: string
queryKey:
description: The ID assigned to the query instance.
type: string
version:
description: The version of the query result.
type: string
required:
- name
- awrResultType
type: object
AwrDbParameterSummary:
description: The summary of the AWR change history data for a single database parameter.
properties:
beginValue:
description: The parameter value when the period began.
type: string
endValue:
description: The parameter value when the period ended.
type: string
instanceNumber:
description: The database instance number.
type: integer
isChanged:
description: Indicates whether the parameter value changed within the period.
type: boolean
isDefault:
description: Indicates whether the parameter value in the end snapshot is the default.
type: boolean
name:
description: The name of the parameter.
type: string
valueModified:
description: "Indicates whether the parameter has been modified after instance startup:\n - MODIFIED - Parameter has been modified with ALTER SESSION\n - SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM (which causes all the currently logged in sessions’ values to be modified)\n - FALSE - Parameter has not been modified after instance startup\n"
type: string
required:
- name
type: object
DatabaseFleetDataguardMetrics:
description: The list of Oracle Data Guard-enabled databases in the fleet.
properties:
dataguardMetrics:
description: The Data Guard usage metrics for the Oracle Data Guard-enabled databases.
items:
$ref: '#/components/schemas/DataguardMetrics'
type: array
uniqueItems: true
required:
- dataguardMetrics
type: object
ExternalDbHomeCollection:
description: A collection of external database homes.
properties:
items:
description: An array of external DB homes.
items:
$ref: '#/components/schemas/ExternalDbHomeSummary'
type: array
required:
- items
type: object
ExternalDbSystemCollection:
description: A collection of external DB systems.
properties:
items:
description: An array of external DB systems.
items:
$ref: '#/components/schemas/ExternalDbSystemSummary'
type: array
required:
- items
type: object
DisableExternalNonContainerDatabaseManagementFeatureDetails:
description: The details required to disable a Database Management feature for an external non-container database.
properties:
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
CloudDbSystemDatabaseManagementConfigDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The configuration details of Database Management for a cloud DB system.
RoleSummary:
description: A summary of each role.
properties:
adminOption:
description: Indicates whether the role is granted with the ADMIN OPTION (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
common:
description: 'Indicates how the role was granted. Possible values:
YES if the role is granted commonly (CONTAINER=ALL is used)
NO if the role is granted locally (CONTAINER=ALL is not used)
'
enum:
- 'YES'
- 'NO'
type: string
defaultRole:
description: Indicates whether the role is designated as a DEFAULT ROLE for the user (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
delegateOption:
description: Indicates whether the role is granted with the DELEGATE OPTION (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
inherited:
description: Indicates whether the granted role is inherited from another container (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
name:
description: The name of the role granted to the user.
type: string
type: object
ManagedDatabaseGroup:
description: The details of a Managed Database Group.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
description:
description: The information specified by the user about the Managed Database Group.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group.
type: string
lifecycleState:
description: The current lifecycle state of the Managed Database Group.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
managedDatabases:
description: A list of Managed Databases in the Managed Database Group.
items:
$ref: '#/components/schemas/ChildDatabase'
type: array
name:
description: The name of the Managed Database Group.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the Managed Database Group was created.
format: date-time
type: string
timeUpdated:
description: The date and time the Managed Database Group was last updated.
format: date-time
type: string
required:
- name
- id
- compartmentId
- managedDatabases
- lifecycleState
- timeCreated
type: object
ExadataFleetMetricDefinition:
description: The Exadata infrastructure metric details.
properties:
baselineValue:
description: The baseline value of the metric.
format: double
type: number
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/ExadataMetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
percentageChange:
description: The percentage change in the metric aggregated value compared to the baseline value.
format: double
type: number
targetValue:
description: The target value of the metric.
format: double
type: number
timestamp:
description: The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
unit:
description: The unit of the value.
type: string
type: object
ChangeJobCompartmentDetails:
description: The details required to change the compartment of a job.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to which the job should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
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
DatabaseHomeMetrics:
description: The response containing the metric collection for a specific Managed Database.
properties:
databaseHomeMetrics:
$ref: '#/components/schemas/DatabaseHomeMetricDefinition'
databaseInstanceHomeMetrics:
description: The metrics for the RAC database instances.
items:
$ref: '#/components/schemas/DatabaseInstanceHomeMetricsDefinition'
type: array
required:
- databaseHomeMetrics
type: object
ExternalDatabaseSummary:
description: The summary of an external database.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databasePlatformName:
description: The operating system of database.
maxLength: 255
type: string
databaseSubType:
description: 'The subtype of Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, or Non-container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle database version.
maxLength: 512
type: string
dbManagementConfig:
$ref: '#/components/schemas/DatabaseManagementConfig'
dbSystemInfo:
$ref: '#/components/schemas/ExternalDbSystemBasicInfo'
dbUniqueName:
description: The `DB_UNIQUE_NAME` of the external database.
type: string
dbmgmtFeatureConfigs:
description: The list of feature configurations
items:
$ref: '#/components/schemas/DatabaseFeatureConfiguration'
maxItems: 5
type: array
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
displayName:
description: The user-friendly name for the database. The name does not have to be unique.
type: string
externalContainerDatabaseId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent Container Database (CDB)
if this is a Pluggable Database (PDB).
'
type: string
externalDbHomeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB home.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
type: string
instanceDetails:
description: The list of database instances if the database is a RAC database.
items:
$ref: '#/components/schemas/ExternalDatabaseInstance'
type: array
lifecycleState:
description: The current lifecycle state of the external database resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external DB system was created.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
type: object
FleetSummary:
description: 'A summary of the inventory count grouped by database type and subtype, and the metrics that
describe the aggregated usage of CPU, storage, and so on of all the databases in the fleet.
'
properties:
aggregatedMetrics:
description: A list of databases present in the fleet and their usage metrics.
items:
$ref: '#/components/schemas/FleetMetricSummaryDefinition'
type: array
inventory:
description: A list of the databases in the fleet, grouped by database type and subtype.
items:
$ref: '#/components/schemas/FleetStatusByCategory'
type: array
type: object
ChangeDatabaseParametersDetails:
description: 'The details required to change database parameter values.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/DatabaseCredentials'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
parameters:
description: A list of database parameters and their values.
items:
$ref: '#/components/schemas/ChangeDatabaseParameterDetails'
type: array
scope:
description: 'The clause used to specify when the parameter change takes effect.
Use `MEMORY` to make the change in memory and affect it immediately.
Use `SPFILE` to make the change in the server parameter file. The
change takes effect when the database is next shut down and started
up again. Use `BOTH` to make the change in memory and in the server
parameter file. The change takes effect immediately and persists
after the database is shut down and started up again.
'
enum:
- MEMORY
- SPFILE
- BOTH
type: string
x-obmcs-top-level-enum: '#/definitions/ParameterScope'
required:
- scope
- parameters
type: object
ExternalMySqlDatabase:
description: External database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: OCID of compartment for the External MySQL Database.
maxLength: 255
type: string
dbName:
description: Display Name of the External MySQL Database.
maxLength: 255
type: string
externalDatabaseId:
description: OCID of External MySQL Database.
maxLength: 255
type: string
managementState:
description: Indicates database management state.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementState'
required:
- compartmentId
- dbName
AsmPropertySummary:
description: The summary of ASM properties.
properties:
diskGroup:
description: The name of the disk group.
type: string
required:
- diskGroup
type: object
CloudExadataStorageGridSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_GRID_SUMMARY
properties:
serverCount:
description: The number of Exadata storage servers in the Exadata infrastructure.
type: integer
description: The Exadata storage server grid of the Exadata infrastructure.
type: object
BaseDatabaseHaDetails:
description: The common database details used by all HA metrics.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Managed Database resides.
type: string
databaseId:
description: The database ID of the Managed Database. Every database had its own ID and that value is captured here.
type: string
databaseName:
description: The display name of the Managed Database.
type: string
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle Database version.
type: string
dbId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
dbRole:
description: The database role of the Managed Database.
enum:
- SNAPSHOT_STANDBY
- LOGICAL_STANDBY
- PHYSICAL_STANDBY
- PRIMARY
- FAR_SYNC
type: string
x-obmcs-top-level-enum: '#/definitions/DbRole'
dbUniqueName:
description: The database unique name of the Managed Database.
type: string
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- dbId
- compartmentId
- databaseType
- databaseSubType
- deploymentType
- databaseName
- dbRole
type: object
JobOutBind:
description: The details of the job out-bind variable.
properties:
dataType:
description: The datatype of the out-bind variable.
enum:
- NUMBER
- STRING
- CLOB
type: string
position:
description: The position of the out-bind variable.
format: int32
maximum: 200
minimum: 1
type: integer
required:
- position
- dataType
type: object
JobExecutionCollection:
description: A collection of job execution objects.
properties:
items:
description: A list of JobExecutionSummary objects.
items:
$ref: '#/components/schemas/JobExecutionSummary'
type: array
required:
- items
type: object
ExternalClusterNetworkConfiguration:
description: The details of a network address configuration in an external cluster.
properties:
networkNumber:
description: The network number.
type: integer
networkType:
description: The network type.
enum:
- AUTOCONFIG
- DHCP
- STATIC
- MIXED
type: string
subnet:
description: The subnet for the network.
type: string
type: object
DropTablespaceDetails:
description: 'The details required to drop a tablespace.
It takes either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
isCascadeConstraints:
description: 'Specifies whether all the constraints on the tablespace being dropped should be dropped.
'
type: boolean
isDroppingDataFiles:
description: 'Specifies whether all the associated data files of the tablespace being dropped should be dropped.
'
type: boolean
isIncludingContents:
description: 'Specifies whether all the contents of the tablespace being dropped should be dropped.
'
type: boolean
type: object
AwrDbWaitEventBucketSummary:
description: A summary of the AWR wait event bucket and waits percentage.
properties:
category:
description: The name of the wait event frequency category. Normally, it is the upper range of the waits within the AWR wait event bucket.
type: string
percentage:
description: The percentage of waits in a wait event bucket over the total waits of the database.
format: double
type: number
required:
- category
- percentage
type: object
TablespaceAdminStatus:
description: The status of a tablespace admin action.
properties:
errorCode:
description: 'The error code that denotes failure if the tablespace admin action is not successful. The error code is "null" if the admin action is successful.
'
type: integer
errorMessage:
description: 'The error message that indicates the reason for failure if the tablespace admin action is not successful. The error message is "null" if the admin action is successful.
'
type: string
status:
description: 'The status of a tablespace admin action.
'
enum:
- SUCCEEDED
- FAILED
type: string
required:
- status
type: object
CloudDbSystemConnector:
description: The details of a cloud DB system connector.
discriminator:
propertyName: connectorType
properties:
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the connector is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
connectionFailureMessage:
description: 'The error message indicating the reason for connection failure or `null` if
the connection was successful.
'
type: string
connectionStatus:
description: The status of connectivity to the cloud DB system component.
type: string
connectorType:
description: The type of connector.
enum:
- MACS
type: string
displayName:
description: The user-friendly name for the cloud connector. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system connector.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system connector.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
timeConnectionStatusLastUpdated:
description: The date and time the connectionStatus of the cloud DB system connector was last updated.
format: date-time
type: string
timeCreated:
description: The date and time the cloud DB system connector was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system connector was last updated.
format: date-time
type: string
required:
- connectorType
- id
- displayName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
CloudDbHome:
description: The details of a cloud database home.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the DB home defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the DB home is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud DB home.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home in DBaas service.
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
displayName:
description: The user-friendly name for the cloud DB home. The name does not have to be unique.
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
homeDirectory:
description: The location of the DB home.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB home.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud DB home was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB home was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
JobInBind:
description: The details of the job in-bind variable.
properties:
arrayTypeName:
description: The Oracle schema object name for the predefined type of array.
type: string
dataType:
description: The datatype of the in-bind variable.
enum:
- NUMBER
- STRING
- CLOB
type: string
position:
description: The position of the in-bind variable.
format: int32
maximum: 200
minimum: 1
type: integer
values:
description: The values for the in-bind variable.
items:
type: string
type: array
required:
- position
- dataType
- values
type: object
Recommendation:
description: The details of the Optimizer Statistics Advisor findings and recommendations.
properties:
example:
$ref: '#/components/schemas/RecommendationExample'
message:
description: An overview of the Optimizer Statistics Advisor recommendation.
type: string
rationales:
description: The rationale of the recommendation.
items:
$ref: '#/components/schemas/RecommendationRationale'
type: array
required:
- message
type: object
TablespaceAdminCredentialDetails:
description: The credential to connect to the database to perform tablespace administration tasks.
discriminator:
propertyName: tablespaceAdminCredentialType
properties:
role:
description: The role of the database user.
enum:
- NORMAL
- SYSDBA
type: string
tablespaceAdminCredentialType:
description: The type of the credential for tablespace administration tasks.
enum:
- SECRET
- PASSWORD
type: string
username:
description: The user to connect to the database.
type: string
required:
- tablespaceAdminCredentialType
- username
- role
type: object
SqlPlanBaselineConfiguration:
description: 'The configuration details of SQL plan baselines. The details include:
- whether automatic initial plan capture is enabled or disabled
- whether use of SQL plan baselines is enabled or disabled
- whether Automatic SPM Evolve Advisor task is enabled or disabled
- whether high-frequency Automatic SPM Evolve Advisor task is enabled or disabled
- filters for the automatic initial plan capture
- parameters for the Automatic SPM Evolve Advisor task
- plan retention and allocated space for the plan baselines
'
properties:
autoCaptureFilters:
description: The capture filters used in automatic initial plan capture.
items:
$ref: '#/components/schemas/AutomaticCaptureFilter'
type: array
autoSpmEvolveTaskParameters:
$ref: '#/components/schemas/SpmEvolveTaskParameters'
isAutoSpmEvolveTaskEnabled:
description: Indicates whether the Automatic SPM Evolve Advisor task is enabled (`true`) or not (`false`).
type: boolean
isAutomaticInitialPlanCaptureEnabled:
description: Indicates whether the automatic capture of SQL plan baselines is enabled (`true`) or not (`false`).
type: boolean
isHighFrequencyAutoSpmEvolveTaskEnabled:
description: Indicates whether the high frequency Automatic SPM Evolve Advisor task is enabled (`true`) or not (`false`).
type: boolean
isSqlPlanBaselinesUsageEnabled:
description: Indicates whether the database uses SQL plan baselines (`true`) or not (`false`).
type: boolean
planRetentionWeeks:
description: The number of weeks to retain unused plans before they are purged.
type: integer
spaceBudgetMB:
description: The maximum `SYSAUX` space that can be used for SQL Management Base in MB.
format: float
type: number
spaceBudgetPercent:
description: The maximum percent of `SYSAUX` space that can be used for SQL Management Base.
format: float
type: number
spaceUsedMB:
description: The space used by SQL Management Base in MB.
format: float
type: number
required:
- isAutomaticInitialPlanCaptureEnabled
- isSqlPlanBaselinesUsageEnabled
- isAutoSpmEvolveTaskEnabled
- isHighFrequencyAutoSpmEvolveTaskEnabled
- planRetentionWeeks
- spaceBudgetPercent
type: object
UpdateCloudExadataStorageConnectorDetails:
description: The connector details of the Exadata storage server to be updated.
properties:
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
maxLength: 1024
minLength: 1
type: string
credentialInfo:
$ref: '#/components/schemas/RestCredential'
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
displayName:
description: The name of the Exadata storage server connector.
maxLength: 255
minLength: 1
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
type: object
ManagedDatabaseGroupSummary:
description: A group of Managed Databases that will be managed together.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
description:
description: The information specified by the user about the Managed Database Group.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group.
type: string
lifecycleState:
description: The current lifecycle state of the Managed Database Group.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
managedDatabaseCount:
description: The number of Managed Databases in the Managed Database Group.
type: integer
name:
description: The name of the Managed Database Group.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the Managed Database Group was created.
format: date-time
type: string
required:
- name
- id
- compartmentId
- managedDatabaseCount
- lifecycleState
- timeCreated
type: object
UserSummary:
description: The summary of a specific User.
properties:
defaultTablespace:
description: The default tablespace for data.
type: string
name:
description: The name of the User.
type: string
profile:
description: The profile name of the user.
type: string
status:
description: The status of the user account.
enum:
- OPEN
- EXPIRED
- EXPIRED_GRACE
- LOCKED
- LOCKED_TIMED
- EXPIRED_AND_LOCKED
- EXPIRED_GRACE_AND_LOCKED
- EXPIRED_AND_LOCKED_TIMED
- EXPIRED_GRACE_AND_LOCKED_TIMED
- OPEN_AND_IN_ROLLOVER
- EXPIRED_AND_IN_ROLLOVER
- LOCKED_AND_IN_ROLLOVER
- EXPIRED_AND_LOCKED_AND_IN_ROLLOVER
- LOCKED_TIMED_AND_IN_ROLLOVER
- EXPIRED_AND_LOCKED_TIMED_AND_IN_ROL
type: string
tempTablespace:
description: The name of the default tablespace for temporary tables or the name of a tablespace group.
type: string
timeCreated:
description: The date and time the user was created.
format: date-time
type: string
timeExpiring:
description: The date and time of the expiration of the user account.
format: date-time
type: string
timeLocked:
description: The date the account was locked, if the status of the account is LOCKED.
format: date-time
type: string
required:
- name
- status
- defaultTablespace
- tempTablespace
- timeCreated
- profile
type: object
CloudListener:
description: The details of a cloud listener.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the cloud listener defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
adrHomeDirectory:
description: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
type: string
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbHomeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the listener is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud listener.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud listener. The name does not have to be unique.
type: string
endpoints:
description: The list of protocol addresses the listener is configured to listen on.
items:
$ref: '#/components/schemas/CloudListenerEndpoint'
maxItems: 25
type: array
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
hostName:
description: The name of the host on which the cloud listener is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud listener.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
listenerAlias:
description: The listener alias.
type: string
listenerOraLocation:
description: The location of the listener configuration file listener.ora.
type: string
listenerType:
description: The type of listener.
enum:
- ASM
- LOCAL
- SCAN
type: string
logDirectory:
description: The destination directory of the listener log file.
type: string
oracleHome:
description: The Oracle home location of the listener.
type: string
servicedAsms:
description: The list of ASMs that are serviced by the listener.
items:
$ref: '#/components/schemas/CloudServicedAsm'
maxItems: 4
type: array
servicedDatabases:
description: The list of databases that are serviced by the listener.
items:
$ref: '#/components/schemas/CloudListenerServicedDatabase'
maxItems: 100
type: array
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
timeCreated:
description: The date and time the cloud listener was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud listener was last updated.
format: date-time
type: string
traceDirectory:
description: The destination directory of the listener trace file.
type: string
version:
description: The listener version.
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
DropSqlPlanBaselinesDetails:
description: 'The details required to drop SQL plan baselines.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
planName:
description: 'The plan name. It identifies a specific plan. If `null'' then all plans
associated with the SQL statement identified by `sqlHandle'' are dropped.
'
type: string
sqlHandle:
description: 'The SQL statement handle. It identifies plans associated with a SQL statement
that are to be dropped. If `null` then `planName` must be specified.
'
type: string
type: object
CpuUtilizationAggregateMetrics:
description: The CPU utilization metrics for Autonomous Databases.
properties:
cpuStatistics:
$ref: '#/components/schemas/MetricStatisticsDefinition'
cpuUtilization:
$ref: '#/components/schemas/MetricDataPoint'
type: object
AddmTasksCollection:
description: The list of ADDM task metadata.
properties:
items:
description: The list of ADDM task metadata.
items:
$ref: '#/components/schemas/AddmTaskSummary'
type: array
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
required:
- items
- managedDatabaseId
type: object
CreateExternalDbSystemDetails:
description: The details required to create an external DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the external DB system resides.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/ExternalDbSystemDatabaseManagementConfigDetails'
dbSystemDiscoveryId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system discovery.
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
stackMonitoringConfig:
$ref: '#/components/schemas/AssociatedServiceDetails'
required:
- compartmentId
- dbSystemDiscoveryId
type: object
StorageServerDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: MANAGED_STORAGE_SERVER_DISCOVER_SUMMARY
properties:
connectorName:
description: The name of the Exadata storage server connector in case of rediscovery.
type: string
cpuCount:
description: The CPU count of the Exadata storage server.
type: integer
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
memoryGB:
description: The memory size in GB of the Exadata storage server.
format: double
type: number
description: The summary of the Exadata storage server discovery.
type: object
JobDatabase:
description: The Managed Database on which the job is executed.
properties:
databaseSubType:
description: The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
deploymentType:
description: A list of the supported infrastructure that can be used to deploy the database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
isCluster:
description: Indicates whether the Oracle Database is part of a cluster.
type: boolean
name:
description: The name of the Managed Database.
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- name
- id
CloudListenerCollection:
description: A collection of cloud listeners.
properties:
items:
description: An array of cloud listeners.
items:
$ref: '#/components/schemas/CloudListenerSummary'
type: array
required:
- items
type: object
CloudDatabaseSummary:
description: The summary of a cloud database.
properties:
cloudDbHomeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB home.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databasePlatformName:
description: The operating system of database.
maxLength: 255
type: string
databaseSubType:
description: 'The subtype of Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, or Non-container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle database version.
maxLength: 512
type: string
dbManagementConfig:
$ref: '#/components/schemas/CloudDbSystemDatabaseManagementConfigDetails'
dbSystemInfo:
$ref: '#/components/schemas/CloudDbSystemBasicInfo'
dbUniqueName:
description: The `DB_UNIQUE_NAME` of the cloud database.
type: string
dbmgmtFeatureConfigs:
description: The list of feature configurations
items:
$ref: '#/components/schemas/DatabaseFeatureConfiguration'
maxItems: 5
type: array
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
displayName:
description: The user-friendly name for the database. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
type: string
instanceDetails:
description: The list of database instances if the database is a RAC database.
items:
$ref: '#/components/schemas/CloudDatabaseInstance'
maxItems: 10
type: array
lifecycleState:
description: The current lifecycle state of the cloud database resource.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
parentContainerDatabaseId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent Container Database (CDB)
if this is a Pluggable Database (PDB).
'
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud DB system was created.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
type: object
AwrDbMetricSummary:
description: The summary of the AWR metric data for a particular metric at a specific time.
properties:
avgValue:
description: The average value of the sampling period.
format: double
type: number
maxValue:
description: The maximum value of the sampling period.
format: double
type: number
minValue:
description: The minimum value of the sampling period.
format: double
type: number
name:
description: The name of the metric.
type: string
timestamp:
description: The time of the sampling.
format: date-time
type: string
required:
- name
type: object
ExternalServicedAsm:
description: The details of ASM serviced by an external listener.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the external ASM resides.
type: string
displayName:
description: The user-friendly name for the external ASM. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
type: string
required:
- id
- displayName
type: object
UpdateManagedDatabaseGroupDetails:
description: The details required to update a Managed Database Group.
properties:
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
description:
description: The information specified by the user about the Managed Database Group.
maxLength: 400
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
type: object
DiscoveredExternalDbSystemComponent:
description: The details of an external DB system component.
discriminator:
propertyName: componentType
properties:
associatedComponents:
description: The list of associated components.
items:
$ref: '#/components/schemas/AssociatedComponent'
type: array
componentId:
description: The identifier of the discovered DB system component.
type: string
componentName:
description: The name of the discovered DB system component.
type: string
componentType:
description: The external DB system component type.
enum:
- ASM
- ASM_INSTANCE
- CLUSTER
- CLUSTER_INSTANCE
- DATABASE
- DATABASE_INSTANCE
- DATABASE_HOME
- DATABASE_NODE
- DBSYSTEM
- LISTENER
- PLUGGABLE_DATABASE
type: string
x-obmcs-top-level-enum: '#/definitions/ExternalDbSystemComponentType'
displayName:
description: The user-friendly name for the discovered DB system component. The name does not have to be unique.
type: string
isSelectedForMonitoring:
description: Indicates whether the DB system component should be provisioned as an OCI resource or not.
type: boolean
resourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing OCI resource matching the discovered DB system component.
type: string
status:
description: The state of the discovered DB system component.
enum:
- NEW
- EXISTING
- MARKED_FOR_DELETION
- UNKNOWN
type: string
required:
- componentId
- displayName
- componentName
- componentType
type: object
ExternalListenerEndpoint:
description: The protocol address that an external listener is configured to listen on.
discriminator:
propertyName: protocol
properties:
protocol:
description: The listener protocol.
enum:
- IPC
- TCP
- TCPS
type: string
services:
description: The list of services registered with the listener.
items:
type: string
type: array
required:
- protocol
type: object
DisableSqlPlanBaselinesUsageDetails:
description: 'The details required to disable SQL plan baseline usage.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
ExternalAsmDiskGroupCollection:
description: A collection of external ASM disk groups.
properties:
items:
description: An array of external ASM disk groups.
items:
$ref: '#/components/schemas/ExternalAsmDiskGroupSummary'
type: array
required:
- items
type: object
NamedCredentialCollection:
description: A collection of named credential summary.
properties:
items:
description: An array of named credential resources.
items:
$ref: '#/components/schemas/NamedCredentialSummary'
type: array
required:
- items
type: object
DatabasePlanDirective:
description: 'Manages resource allocation among databases. Besides the name, at least one other property must be available.
'
properties:
allocation:
description: 'The resource allocation as a percentage (0-100) within the level.
'
maximum: 100
minimum: 1
type: integer
asmCluster:
description: 'Starting with Oracle Exadata System Software release 19.1.0, you can use the asmcluster attribute to
distinguish between databases with the same name running in different Oracle ASM clusters.
'
type: string
flashCacheLimit:
description: 'Defines a soft limit for space usage in Exadata Smart Flash Cache.
If the cache is not full, the limit can be exceeded.
You specify the value for flashcachelimit in bytes. You can also use the suffixes M (megabytes),
G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T.
The value for flashcachelimit must be at least 4 MB.
The flashcachelimit and flashcachesize attributes cannot be specified in the same directive.
The value for flashcachelimit cannot be smaller than flashcachemin, if it is specified.
'
type: string
flashCacheMin:
description: 'Specifies a minimum guaranteed space allocation in Exadata Smart Flash Cache.
You specify the value for flashcachemin in bytes. You can also use the suffixes
M (megabytes), G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T.
The value for flashcachemin must be at least 4 MB.
In any plan, the sum of all flashcachemin values cannot exceed the size of Exadata Smart Flash Cache.
If flashcachelimit is specified, then the value for flashcachemin cannot exceed flashcachelimit.
If flashcachesize is specified, then the value for flashcachemin cannot exceed flashcachesize.
'
type: string
flashCacheSize:
description: 'Defines a hard limit for space usage in Exadata Smart Flash Cache.
The limit cannot be exceeded, even if the cache is not full.
In an IORM plan, if the size of Exadata Smart Flash Cache can accommodate all of the flashcachemin
and flashcachesize allocations, then each flashcachesize definition represents a guaranteed space allocation.
However, starting with Oracle Exadata System Software release 19.2.0 you can use the flashcachesize
attribute to over-provision space in Exadata Smart Flash Cache. Consequently,
if the size of Exadata Smart Flash Cache cannot accommodate all of the flashcachemin and flashcachesize
allocations, then only flashcachemin is guaranteed.
'
type: string
isFlashCacheOn:
description: 'Controls use of Exadata Smart Flash Cache by a database.
This ensures that cache space is reserved for mission-critical databases.
flashcache=off is invalid in a directive that contains the flashcachemin, flashcachelimit, or flashcachesize attributes.
'
type: boolean
isFlashLogOn:
description: 'Controls use of Exadata Smart Flash Log by a database.
This ensures that Exadata Smart Flash Log is reserved for mission-critical databases.
'
type: boolean
isPmemCacheOn:
description: 'Controls use of the persistent memory (PMEM) cache by a database. This ensures that cache space
is reserved for mission-critical databases.
pmemcache=off is invalid in a directive that contains the pmemcachemin, pmemcachelimit, or pmemcachesize attributes.
'
type: boolean
isPmemLogOn:
description: 'Controls use of persistent memory logging (PMEM log) by a database.
This ensures that PMEM log is reserved for mission-critical databases.
'
type: boolean
level:
description: 'The allocation level. Valid values are from 1 to 8. Resources are allocated to level 1 first,
and then remaining resources are allocated to level 2, and so on.
'
maximum: 8
minimum: 1
type: integer
limit:
description: The maximum I/O utilization limit as a percentage of the available resources.
maximum: 100
minimum: 1
type: integer
name:
description: The name of a database or a profile.
type: string
pmemCacheLimit:
description: 'Defines a soft limit for space usage in the persistent memory (PMEM) cache.
If the cache is not full, the limit can be exceeded.
You specify the value for pmemcachelimit in bytes. You can also use the suffixes M (megabytes),
G (gigabytes), or T (terabytes) to specify larger values. For example, 300M, 150G, or 1T.
The value for pmemcachelimit must be at least 4 MB.
The pmemcachelimit and pmemcachesize attributes cannot be specified in the same directive.
The value for pmemcachelimit cannot be smaller than pmemcachemin, if it is specified.
'
type: string
pmemCacheMin:
description: 'Specifies a minimum guaranteed space allocation in the persistent memory (PMEM) cache.
'
type: string
pmemCacheSize:
description: 'Defines a hard limit for space usage in the persistent memory (PMEM) cache.
The limit cannot be exceeded, even if the cache is not full.
In an IORM plan, if the size of the PMEM cache can accommodate all of the pmemcachemin and
pmemcachesize allocations, then each pmemcachesize definition represents a guaranteed space allocation.
However, you can use the pmemcachesize attribute to over-provision space in the PMEM cache.
Consequently, if the PMEM cache size cannot accommodate all of the pmemcachemin and pmemcachesize
allocations, then only pmemcachemin is guaranteed.
'
type: string
role:
description: 'Enables you to specify different plan directives based on the Oracle Data Guard database role.
'
enum:
- PRIMARY
- STANDBY
- NONE
type: string
x-obmcs-top-level-enum: '#/definitions/DatabasePlanRoleEnum'
share:
description: 'The relative priority of a database in the database plan. A higher share value implies
higher priority and more access to the I/O resources.
Use either share or (level, allocation). All plan directives in a database plan
should use the same setting.
Share-based resource allocation is the recommended method for a database plan.
'
maximum: 32
minimum: 1
type: integer
type:
description: "Enables you to create a profile or template, to ease management and configuration of resource plans\nin environments with many databases.\n\n- type=database: Specifies a directive that applies to a specific database.\nIf type in not specified, then the directive defaults to the database type.\n- type=profile: Specifies a directive that applies to a profile rather than a specific database.\n\n To associate a database with an IORM profile, you must set the database initialization\n parameter db_performance_profile to the value of the profile name. Databases that map to a profile inherit the settings specified in the profile.\n"
enum:
- DATABASE
- PROFILE
- OTHER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabasePlanTypeEnum'
required:
- name
type: object
ConsumerGroupPrivilegeCollection:
description: A collection of consumer group privileges granted to the current user.
properties:
items:
description: An array of consumer group privileges.
items:
$ref: '#/components/schemas/ConsumerGroupPrivilegeSummary'
type: array
required:
- items
type: object
CloudListenerServiceCollection:
description: A collection of cloud listener services.
properties:
items:
description: An array of cloud listener services.
items:
$ref: '#/components/schemas/CloudListenerServiceSummary'
type: array
required:
- items
type: object
OptimizerStatisticsCollectionAggregationsCollection:
description: 'The number of times optimizer statistics are collected each hour, grouped by task status.
'
properties:
items:
description: The list of Optimizer Statistics Collection details.
items:
$ref: '#/components/schemas/OptimizerStatisticsCollectionAggregationSummary'
type: array
required:
- items
type: object
CloudDbSystemStackMonitoringConfigDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The configuration details of Stack Monitoring for a cloud DB system.
RecommendationExample:
description: An example of the recommendation.
properties:
lines:
description: The list of examples for the recommendation.
items:
$ref: '#/components/schemas/RecommendationExampleLine'
type: array
type: object
MetricStatisticsDefinition:
description: The metric statistics values with dimension details.
properties:
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
lowerQuartile:
description: The first quartile value of the metric.
format: double
type: number
max:
description: The maximum value of the metric.
format: double
type: number
median:
description: The median value of the metric.
format: double
type: number
min:
description: The minimum value of the metric.
format: double
type: number
unit:
description: The unit of the metric value.
type: string
upperQuartile:
description: The third quartile value of the metric.
format: double
type: number
type: object
DatabaseFeatureDetails:
description: The details required to enable the specified Database Management feature.
discriminator:
propertyName: feature
properties:
connectorDetails:
$ref: '#/components/schemas/ConnectorDetails'
databaseConnectionDetails:
$ref: '#/components/schemas/DatabaseConnectionDetails'
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
- databaseConnectionDetails
- connectorDetails
type: object
JobInBindsDetails:
description: A collection of job in-bind variables.
properties:
items:
description: A list of JobInBind objects.
items:
$ref: '#/components/schemas/JobInBind'
type: array
required:
- items
type: object
CreateCloudDbSystemConnectorDetails:
description: The details required to create a cloud DB system connector.
discriminator:
propertyName: connectorType
properties:
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
type: string
connectorType:
description: The type of connector.
enum:
- MACS
type: string
displayName:
description: The user-friendly name for the cloud connector. The name does not have to be unique.
type: string
required:
- connectorType
- cloudDbSystemId
type: object
DatabaseParameterSummary:
description: A summary of the database parameter.
properties:
allowedValues:
description: A list of allowed values for this parameter.
items:
$ref: '#/components/schemas/AllowedParameterValue'
type: array
category:
description: The parameter category.
type: string
constraint:
description: 'Applicable in case of Oracle Real Application Clusters (Oracle RAC) databases.
A `UNIQUE` parameter is one which is unique to each Oracle Real Application
Clusters (Oracle RAC) instance. For example, the parameter `INSTANCE_NUMBER`
must have different values in each instance. An `IDENTICAL` parameter must
have the same value for every instance. For example, the parameter
`DB_BLOCK_SIZE` must have the same value in all instances.
'
enum:
- UNIQUE
- IDENTICAL
- NONE
type: string
containerId:
description: 'The ID of the database container to which the data pertains.
Possible values include:
- `0`: This value is used for data that pertain to the entire CDB. This value is also used for data in non-CDBs.
- `1`: This value is used for data that pertain to only the root container.
- `n`: Where n is the applicable container ID for the data.
'
format: integer
type: number
description:
description: The description of the parameter.
type: string
displayValue:
description: 'The parameter value in a user-friendly format. For example, if the `value` property shows the value 262144 for a big integer parameter, then the `displayValue` property will show the value 256K.
'
type: string
isAdjusted:
description: Indicates whether Oracle adjusted the input value to a more suitable value.
type: boolean
isBasic:
description: Indicates whether the parameter is a basic parameter (`TRUE`) or not (`FALSE`).
type: boolean
isDefault:
description: 'Indicates whether the parameter is set to the default value (`TRUE`) or the parameter value was specified in the parameter file (`FALSE`).
'
type: boolean
isDeprecated:
description: Indicates whether the parameter has been deprecated (`TRUE`) or not (`FALSE`).
type: boolean
isInstanceModifiable:
description: 'For parameters that can be changed with `ALTER SYSTEM`, indicates whether the value of the parameter can be different for every instance (`TRUE`) or whether the parameter must have the same value for all Real Application Clusters instances (`FALSE`). For other parameters, this is always `FALSE`.
'
type: boolean
isModified:
description: 'Indicates how the parameter was modified. If an `ALTER SYSTEM` was performed, the value will be `MODIFIED`.
'
enum:
- MODIFIED
- 'FALSE'
type: string
isPdbModifiable:
description: 'Indicates whether the parameter can be modified on a per-PDB basis (`TRUE`) or not (`FALSE`). In a non-CDB, the value of this property is `null`.
'
type: boolean
isSessionModifiable:
description: 'Indicates whether the parameter can be changed with `ALTER SESSION` (`TRUE`) or not (`FALSE`)
'
type: boolean
isSpecified:
description: 'Indicates whether the parameter was specified in the server parameter file (`TRUE`) or not (`FALSE`). Applicable only when the parameter source is `SPFILE`.
'
type: boolean
isSystemModifiable:
description: 'Indicates whether the parameter can be changed with `ALTER SYSTEM` and when the change takes effect:
- IMMEDIATE: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect immediately.
- DEFERRED: Parameter can be changed with `ALTER SYSTEM` regardless of the type of parameter file used to start the instance. The change takes effect in subsequent sessions.
- FALSE: Parameter cannot be changed with `ALTER SYSTEM` unless a server parameter file was used to start the instance. The change takes effect in subsequent instances.
'
enum:
- IMMEDIATE
- DEFERRED
- 'FALSE'
type: string
name:
description: The parameter name.
type: string
number:
description: The parameter number.
format: integer
type: number
ordinal:
description: 'The position (ordinal number) of the parameter value. Useful only for parameters whose values are lists of strings.
'
format: integer
type: number
sid:
description: The database instance SID for which the parameter is defined.
type: string
type:
description: The parameter type.
enum:
- BOOLEAN
- STRING
- INTEGER
- FILENAME
- BIG_INTEGER
- RESERVED
type: string
updateComment:
description: The comments associated with the most recent update.
type: string
value:
description: The parameter value.
type: string
required:
- name
- type
- value
- displayValue
type: object
InstanceDetails:
description: The details of the Oracle Real Application Clusters (Oracle RAC) database instance.
properties:
hostName:
description: The name of the host of the Oracle RAC database instance.
type: string
id:
description: The ID of the Oracle RAC database instance.
type: integer
name:
description: The name of the Oracle RAC database instance.
type: string
status:
description: The status of the Oracle RAC database instance.
enum:
- UP
- DOWN
- UNKNOWN
type: string
required:
- id
- name
- hostName
- status
type: object
EnableExternalDbSystemDatabaseManagementDetails:
description: The details required to enable Database Management for an external DB system.
properties:
licenseModel:
description: 'The Oracle license model that applies to the external database.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
required:
- licenseModel
type: object
DiscoverExternalExadataInfrastructureDetails:
description: The connection details and the discovery options for the Exadata discovery.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
dbSystemIds:
description: The list of the DB system identifiers.
items:
maxLength: 255
minLength: 1
type: string
type: array
discoveryType:
default: NEW
description: The type of discovery.
enum:
- NEW
- OVERRIDE
type: string
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure. This is applicable for rediscovery only.
maxLength: 255
minLength: 1
type: string
required:
- discoveryType
- compartmentId
- dbSystemIds
type: object
OptimizerStatisticsAdvisorExecutionScript:
description: The Oracle system-generated script for the Optimizer Statistics Advisor execution.
properties:
script:
description: The Optimizer Statistics Advisor execution script.
type: string
required:
- script
type: object
AdvisorRule:
description: The details of the Optimizer Statistics Advisor rule.
properties:
description:
description: The description of the rule.
type: string
findings:
description: The list of findings for the rule.
items:
$ref: '#/components/schemas/RuleFinding'
type: array
name:
description: The name of the rule.
type: string
required:
- name
- description
- findings
type: object
RoleCollection:
description: A collection of roles granted to the current User.
properties:
items:
description: An array of roles.
items:
$ref: '#/components/schemas/RoleSummary'
type: array
required:
- items
type: object
ChangeManagedDatabaseGroupCompartmentDetails:
description: The details required to change the compartment of a Managed Database Group.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to which the Managed Database Group should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
OptimizerStatisticsAdvisorExecutionReport:
description: 'A report that includes the rules, findings, recommendations, and actions discovered during the
execution of the Optimizer Statistics Advisor.
'
properties:
rules:
description: The list of rules that were not adhered to by the Optimizer Statistics Collection.
items:
$ref: '#/components/schemas/AdvisorRule'
type: array
summary:
description: A summary of the Optimizer Statistics Advisor execution.
type: string
required:
- summary
- rules
type: object
ExternalMySqlDatabaseSummary:
description: External database summary record. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: OCID of compartment for the External MySQL Database.
maxLength: 255
type: string
connectorId:
description: The OCID of the enabled MySQL Database Connector.
maxLength: 255
type: string
dbName:
description: Display name of the External MySQL Database.
maxLength: 255
type: string
deploymentType:
description: The deployment type of the Mysql Database.
enum:
- ONPREMISE
- MDS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlDeploymentType'
externalDatabaseId:
description: OCID of External MySQL Database.
maxLength: 255
type: string
lifecycleState:
description: Indicates lifecycle state of the resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
managementState:
description: Indicates database management state.
enum:
- ENABLED
- DISABLED
type: string
x-obmcs-top-level-enum: '#/definitions/ManagementState'
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
required:
- compartmentId
- dbName
TablespaceCollection:
description: A collection of tablespaces for a specific Managed Database.
properties:
items:
description: An array of TablespaceSummary resources.
items:
$ref: '#/components/schemas/TablespaceSummary'
type: array
required:
- items
type: object
DatabaseManagementConfig:
description: The configuration of the Database Management service.
properties:
connectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database connector.
type: string
databaseManagementStatus:
description: The status of the Database Management service.
enum:
- ENABLING
- ENABLED
- DISABLING
- NOT_ENABLED
- FAILED_ENABLING
- FAILED_DISABLING
type: string
licenseModel:
description: 'The Oracle license model that applies to the external database.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
required:
- databaseManagementStatus
- licenseModel
OptimizerStatisticsAdvisorExecutionsCollection:
description: The details of each Optimizer Statistics Advisor execution.
properties:
items:
description: The list of Optimizer Statistics Advisor executions.
items:
$ref: '#/components/schemas/OptimizerStatisticsAdvisorExecutionSummary'
type: array
required:
- items
type: object
AwrDbCpuUsageSummary:
description: A summary of the AWR CPU resource limits and metrics.
properties:
avgValue:
description: The average CPU usage per second.
format: double
type: number
timestamp:
description: The timestamp for the CPU summary data.
format: date-time
type: string
type: object
DatabaseInstanceHomeMetricsDefinition:
description: 'The response containing the CPU, Wait, DB Time, and Memory metrics
for a specific Oracle Real Application Clusters (Oracle RAC) database
instance.
'
properties:
activityTimeSeriesMetrics:
description: 'A list of the active session metrics for CPU and Wait time for
a specific Oracle Real Application Clusters (Oracle RAC)
database instance.
'
items:
$ref: '#/components/schemas/ActivityTimeSeriesMetrics'
type: array
cpuUtilizationAggregateMetrics:
$ref: '#/components/schemas/CpuUtilizationAggregateMetrics'
dbTimeAggregateMetrics:
$ref: '#/components/schemas/DatabaseTimeAggregateMetrics'
instanceName:
description: 'The name of the Oracle Real Application Clusters (Oracle RAC)
database instance to which the corresponding metrics belong.
'
type: string
instanceNumber:
description: 'The number of Oracle Real Application Clusters (Oracle RAC)
database instance to which the corresponding metrics belong.
'
type: integer
ioAggregateMetrics:
$ref: '#/components/schemas/DatabaseIOAggregateMetrics'
memoryAggregateMetrics:
$ref: '#/components/schemas/MemoryAggregateMetrics'
required:
- instanceName
- instanceNumber
- activityTimeSeriesMetrics
- dbTimeAggregateMetrics
- ioAggregateMetrics
- memoryAggregateMetrics
type: object
JobCollection:
description: A collection of job objects.
properties:
items:
description: A list of JobSummary objects.
items:
$ref: '#/components/schemas/JobSummary'
type: array
required:
- items
type: object
EnableSqlPlanBaselinesUsageDetails:
description: 'The details required to enable SQL plan baseline usage.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
ExternalDbSystemSummary:
description: The summary of an external DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/ExternalDbSystemDatabaseManagementConfigDetails'
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/ExternalExadataInfraBasicInfo'
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
homeDirectory:
description: 'The Oracle Grid home directory in case of cluster-based DB system and
Oracle home directory in case of single instance-based DB system.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB system resource.
type: string
x-obmcs-enumref: '#/definitions/ExternalDbSystem/lifecycleState'
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
timeCreated:
description: The date and time the external DB system was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB system was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
DisableHighFrequencyAutomaticSpmEvolveAdvisorTaskDetails:
description: 'The details required to disable high frequency Automatic SPM Evolve Advisor task.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
AwrDbCpuUsageCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_ASH_CPU_USAGE_SET
properties:
cpuCount:
description: The number of CPUs available for the database to use.
type: integer
items:
description: A list of AWR CPU usage summary data.
items:
$ref: '#/components/schemas/AwrDbCpuUsageSummary'
type: array
numCpuCores:
description: The number of available CPU cores, which include subcores of multicore and single-core CPUs.
type: integer
numCpus:
description: The number of available CPUs or processors.
format: double
type: number
description: The AWR CPU usage data.
type: object
CloudIormPlan:
description: The IORM plan from an Exadata storage server.
properties:
dbPlan:
$ref: '#/components/schemas/DatabasePlan'
planObjective:
description: The objective of the IORM plan.
enum:
- AUTO
- HIGH_THROUGHPUT
- LOW_LATENCY
- BALANCED
- BASIC
- OTHER
type: string
x-obmcs-top-level-enum: '#/definitions/IormPlanObjectiveEnum'
planStatus:
description: The status of the IORM plan.
enum:
- ACTIVE
- INACTIVE
- OTHER
type: string
x-obmcs-top-level-enum: '#/definitions/IormPlanStatusEnum'
required:
- planStatus
- planObjective
type: object
ExternalExadataInfraBasicInfo:
description: The basic information about an external Exadata Infrastructure.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
displayName:
description: The user-friendly name for the Exadata Infrastructure. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external Exadata Infrastructure.
type: string
required:
- id
- displayName
- compartmentId
ImplementOptimizerStatisticsAdvisorRecommendationsJob:
description: The job request details to implement the Optimizer Statistics Advisor task recommendations.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the job resides.
type: string
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
description:
description: The name of the execution.
type: string
name:
description: 'The name of the job. Valid characters are uppercase or lowercase letters,
numbers, and "_". The name of the job cannot be modified. It must be unique
in the compartment and must begin with an alphabetic character.
'
maxLength: 255
minLength: 1
type: string
resultLocation:
$ref: '#/components/schemas/JobExecutionResultLocation'
required:
- name
- compartmentId
- resultLocation
type: object
JobOutBindsDetails:
description: A collection of job out-bind variables.
properties:
items:
description: A list of JobOutBind objects.
items:
$ref: '#/components/schemas/JobOutBind'
type: array
required:
- items
type: object
OptimizerStatisticsOperationTask:
description: The details of the Optimizer Statistics Collection task.
properties:
status:
description: The status of the Optimizer Statistics Collection task.
enum:
- PENDING
- IN_PROGRESS
- SKIPPED
- TIMED_OUT
- COMPLETED
- FAILED
type: string
target:
description: The name of the target object for which statistics are gathered.
type: string
targetType:
description: The type of target object.
enum:
- TABLE
- GLOBAL_TABLE
- COORDINATOR_TABLE
- TABLE_PARTITION
- TABLE_SUBPARTITION
- INDEX
- INDEX_PARTITION
- INDEX_SUBPARTITION
type: string
timeEnd:
description: The end time of the Optimizer Statistics Collection task.
format: date-time
type: string
timeStart:
description: The start time of the Optimizer Statistics Collection task.
format: date-time
type: string
required:
- target
- targetType
- timeStart
- timeEnd
- status
type: object
DatabaseFeatureConfiguration:
description: The details of an external database feature configuration.
discriminator:
propertyName: feature
properties:
connectorDetails:
$ref: '#/components/schemas/ConnectorDetails'
databaseConnectionDetails:
$ref: '#/components/schemas/DatabaseConnectionDetails'
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
featureStatus:
description: 'The list of statuses for Database Management features.
'
enum:
- ENABLED
- NOT_ENABLED
- UNSUPPORTED
- FAILED_ENABLING
- FAILED_DISABLING
- FAILED
- ENABLED_WITH_WARNINGS
- PENDING_DISABLE
- ENABLING
- DISABLING
type: string
required:
- feature
- featureStatus
type: object
SqlPlanBaselineCollection:
description: The SQL plan baseline list.
properties:
items:
description: A list of SQL plan baselines.
items:
$ref: '#/components/schemas/SqlPlanBaselineSummary'
type: array
uniqueItems: true
required:
- items
type: object
CloudAsmInstanceCollection:
description: A collection of cloud ASM instances.
properties:
items:
description: An array of cloud ASM instances.
items:
$ref: '#/components/schemas/CloudAsmInstanceSummary'
type: array
required:
- items
type: object
UpdateTablespaceDetails:
description: 'The details required to update a tablespace.
It takes either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
autoExtendMaxSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The maximum disk space allowed for automatic extension of the data files or temp files.
'
autoExtendNextSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of the next increment of disk space to be allocated automatically when more extents are required.
'
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
fileSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of each data file or temp file.
'
isAutoExtensible:
description: 'Specifies whether the data file or temp file can be extended automatically.
'
type: boolean
isDefault:
description: 'Specifies whether the tablespace is the default tablespace.
'
type: boolean
isMaxSizeUnlimited:
description: 'Specifies whether the disk space of the data file or temp file can be limited.
'
type: boolean
name:
description: 'The name of the tablespace. It must be unique within a database.
'
maxLength: 255
minLength: 1
type: string
status:
description: 'The status of the tablespace.
'
enum:
- READ_ONLY
- READ_WRITE
type: string
type:
description: 'The type of tablespace.
'
enum:
- PERMANENT
- TEMPORARY
type: string
type: object
AwrDbTopWaitEventSummary:
description: A summary of the AWR top wait event data for one event.
properties:
avgWaitTimePerSec:
description: The average wait time per second.
format: double
type: number
name:
description: The name of the event.
type: string
waitsPerSec:
description: The wait count per second.
format: double
type: number
required:
- name
type: object
OptimizerStatisticsCollectionOperation:
allOf:
- $ref: '#/components/schemas/OptimizerStatisticsCollectionOperationSummary'
- required:
- database
- tasks
- properties:
database:
$ref: '#/components/schemas/OptimizerDatabase'
tasks:
description: An array of Optimizer Statistics Collection task details.
items:
$ref: '#/components/schemas/OptimizerStatisticsOperationTask'
type: array
description: The summary of the Optimizer Statistics Collection tasks, which includes details of the Managed Database and the execution.
CloudDbSystemCollection:
description: A collection of cloud DB systems.
properties:
items:
description: An array of cloud DB systems.
items:
$ref: '#/components/schemas/CloudDbSystemSummary'
type: array
required:
- items
type: object
JobExecutionResultLocation:
description: The location of the job execution result.
discriminator:
propertyName: type
properties:
type:
description: The type of the job execution result location.
enum:
- OBJECT_STORAGE
type: string
required:
- type
type: object
CloudExadataInfrastructureSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_INFRASTRUCTURE_SUMMARY
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
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
gridHomePath:
description: The Oracle grid home path.
type: string
infrastructureType:
description: The type of the Exadata infrastructure.
enum:
- EXADATA
- EXADATA_CC
type: string
x-obmcs-top-level-enum: '#/definitions/CloudExadataInfrastructureDeploymentType'
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
rackSize:
description: The rack size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
required:
- compartmentId
description: The Exadata infrastructure.
type: object
CloudDbSystem:
description: The details of a cloud DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/CloudDbSystemDatabaseManagementConfigDetails'
dbSystemDiscoveryId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system discovery.
type: string
dbaasParentInfrastructureId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems ,
it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
'
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
deploymentType:
description: The deployment type of cloud DB system.
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
discoveryAgentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent used during the discovery of the DB system.
type: string
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/CloudExadataInfraBasicInfo'
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
homeDirectory:
description: 'The Oracle Grid home directory in case of cluster-based DB system and
Oracle home directory in case of single instance-based DB system.
'
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
type: string
isCluster:
description: Indicates whether the DB system is a cluster DB system or not.
type: boolean
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system resource.
enum:
- CREATING
- ACTIVE
- UPDATING
- DELETING
- DELETED
- INACTIVE
type: string
stackMonitoringConfig:
$ref: '#/components/schemas/CloudDbSystemStackMonitoringConfigDetails'
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
timeCreated:
description: The date and time the cloud DB system was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system was last updated.
format: date-time
type: string
required:
- id
- dbaasParentInfrastructureId
- deploymentType
- displayName
- compartmentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
CreateDbManagementPrivateEndpointDetails:
description: The details used to create a new Database Management private endpoint.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
description:
description: The description of the private endpoint.
maxLength: 1024
minLength: 1
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
isCluster:
description: Specifies whether the Database Management private endpoint will be used for Oracle Databases in a cluster.
type: boolean
isDnsResolutionEnabled:
description: Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
type: boolean
name:
description: The display name of the Database Management private endpoint.
maxLength: 255
minLength: 1
type: string
nsgIds:
description: 'The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".
'
type: object
description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`
'
type: object
description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.
maxLength: 255
minLength: 1
type: string
required:
- name
- compartmentId
- subnetId
type: object
UpdatePreferredCredentialDetails:
description: The details required to update the preferred credential.
discriminator:
propertyName: type
properties:
type:
description: The type of preferred credential.
enum:
- BASIC
- NAMED_CREDENTIAL
type: string
x-obmcs-top-level-enum: '#/definitions/PreferredCredentialType'
required:
- type
type: object
RemoveDataFileDetails:
description: 'The details required to remove a data file or temp file from the tablespace.
It takes either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
dataFile:
description: 'Name of the data file or temp file to be removed from the tablespace.
'
type: string
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
fileType:
description: 'Specifies whether the file is a data file or temp file.
'
enum:
- DATAFILE
- TEMPFILE
type: string
required:
- fileType
- dataFile
type: object
MemoryAggregateMetrics:
description: The memory aggregate metric details.
properties:
memoryUsage:
description: The Memory Usage metrics grouped by memorypool for a specific Managed Database.
items:
$ref: '#/components/schemas/MetricDataPoint'
type: array
type: object
ExternalClusterInstanceCollection:
description: A collection of external cluster instances.
properties:
items:
description: An array of external cluster instances.
items:
$ref: '#/components/schemas/ExternalClusterInstanceSummary'
type: array
required:
- items
type: object
CreateMySqlDatabaseConnectorDetails:
description: Create Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
credentialType:
description: Type of the credential.
enum:
- MYSQL_EXTERNAL_NON_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SOCKET_CREDENTIALS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlCredType'
displayName:
description: External MySQL Database Connector Name.
maxLength: 255
type: string
externalDatabaseId:
description: OCID of MySQL Database resource.
maxLength: 255
type: string
hostName:
description: Host name for Connector.
maxLength: 255
minLength: 1
type: string
macsAgentId:
description: Agent Id of the MACS agent.
maxLength: 255
type: string
networkProtocol:
description: Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
enum:
- TCP
- TCPS
- SOCKETS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlNetworkProtocolType'
port:
description: Port number to connect to External MySQL Database.
maximum: 65535
minimum: 1
type: integer
sslSecretId:
description: If using existing SSL secret to connect, OCID for the secret resource.
maxLength: 255
type: string
required:
- hostName
- port
- macsAgentId
- displayName
- credentialType
- externalDatabaseId
- networkProtocol
- sslSecretId
CloudDbSystemDiscoveryCollection:
description: A collection of cloud DB system discovery summaries.
properties:
items:
description: An array of cloud DB system discoveries.
items:
$ref: '#/components/schemas/CloudDbSystemDiscoverySummary'
type: array
required:
- items
type: object
SystemPrivilegeCollection:
description: A collection of system privileges granted to the current user.
properties:
items:
description: An array of system privileges.
items:
$ref: '#/components/schemas/SystemPrivilegeSummary'
type: array
required:
- items
type: object
Datafile:
description: The details of a data file.
properties:
allocatedSizeKB:
description: The allocated file size in KB.
format: integer
type: number
freeSpaceKB:
description: The free space available in the data file in KB.
format: integer
type: number
incrementBy:
description: The number of blocks used as auto-extension increment.
format: integer
type: number
instanceId:
description: Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces.
format: integer
type: number
isAutoExtensible:
description: Indicates whether the data file is auto-extensible.
type: boolean
lostWriteProtect:
description: The lost write protection status of the file.
enum:
- ENABLED
- PROTECT_OFF
- SUSPEND
type: string
maxSizeKB:
description: The maximum file size in KB.
format: integer
type: number
name:
description: The filename (including the path) of the data file or temp file.
type: string
onlineStatus:
description: The online status of the file.
enum:
- SYSOFF
- SYSTEM
- OFFLINE
- ONLINE
- RECOVER
type: string
shared:
description: Type of tablespace this file belongs to. If it's for a shared tablespace, for a local temporary tablespace for RIM (read-only) instances, or for local temporary tablespace for all instance types.
enum:
- SHARED
- LOCAL_FOR_RIM
- LOCAL_FOR_ALL
type: string
status:
description: The status of the file. INVALID status is used when the file number is not in use, for example, a file in a tablespace that was removed.
enum:
- AVAILABLE
- INVALID
- OFFLINE
- ONLINE
- UNKNOWN
type: string
usedPercentAllocated:
description: The percentage of used space out of the total allocated space in the file.
format: double
type: number
usedPercentAvailable:
description: The percentage of used space out of the maximum available space in the file.
format: double
type: number
usedSpaceKB:
description: The total space used in the data file in KB.
format: integer
type: number
userSizeKB:
description: The size of the file available for user data in KB. The actual size of the file minus the USER_BYTES value is used to store file-related metadata.
format: integer
type: number
required:
- name
type: object
UpdateCloudDbSystemDiscoveryDetails:
description: The details required to update a cloud DB system discovery resource.
properties:
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
type: object
CloudListenerSummary:
description: The summary of a cloud listener.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node on which the listener is running.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the listener is a member of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud listener.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the cloud listener. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud listener.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud listener.
type: string
x-obmcs-enumref: '#/definitions/CloudListener/lifecycleState'
listenerType:
description: The type of listener.
type: string
x-obmcs-enumref: '#/definitions/CloudListener/listenerType'
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
timeCreated:
description: The date and time the cloud listener was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud listener was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
SqlPlanBaselineJob:
description: The details of the database job used for loading and evolving SQL plan baselines.
properties:
name:
description: The job name.
type: string
status:
description: The job status.
enum:
- SUCCEEDED
- SCHEDULED
- FAILED
type: string
timeCreated:
description: The date and time the job was created.
format: date-time
type: string
type:
description: The job type.
enum:
- LOAD
type: string
required:
- name
- type
- status
type: object
AssociatedDatabaseCollection:
description: A collection of databases using a Database Management private endpoint.
properties:
items:
description: A list of databases using a Database Management private endpoint.
items:
$ref: '#/components/schemas/AssociatedDatabaseSummary'
type: array
uniqueItems: true
required:
- items
type: object
CreateExternalExadataInfrastructureDetails:
description: The details required to create the external Exadata infrastructure.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
maxLength: 255
minLength: 1
type: string
dbSystemIds:
description: The list of DB systems in the Exadata infrastructure.
items:
maxLength: 255
minLength: 1
type: string
type: array
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
discoveryKey:
description: The unique key of the discovery request.
maxLength: 255
minLength: 1
type: string
displayName:
description: The name of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerNames:
description: The list of all the Exadata storage server names to be included for monitoring purposes. If not specified, all the Exadata storage servers associated with the DB systems are included.
items:
maxLength: 255
minLength: 1
type: string
type: array
required:
- compartmentId
- displayName
- dbSystemIds
type: object
CloudDbSystemConnectorSummary:
description: The summary of a cloud DB system connector.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the cloud DB system connector.
'
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the connector is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
connectorType:
description: The type of connector.
enum:
- MACS
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
displayName:
description: The user-friendly name for the cloud connector. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system connector.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system connector.
type: string
x-obmcs-enumref: '#/definitions/CloudDbSystemConnector/lifecycleState'
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
timeCreated:
description: The date and time the cloud DB system connector was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system connector was last updated.
format: date-time
type: string
required:
- id
- displayName
- connectorType
- compartmentId
- cloudDbSystemId
- agentId
- lifecycleState
- timeCreated
- timeUpdated
type: object
VMClusterDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: VM_CLUSTER_DISCOVER_SUMMARY
properties:
asmConnectorName:
description: The display name of the ASM connector.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
oracleHome:
description: The Oracle home path.
type: string
description: The summary of the VM Cluster discovery.
type: object
ExternalExadataStorageGridSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_GRID_SUMMARY
properties:
serverCount:
description: The number of Exadata storage servers in the Exadata infrastructure.
format: integer
type: number
description: The Exadata storage server grid of the Exadata infrastructure.
type: object
AsmPropertyCollection:
description: A collection of ASM properties for a specific Managed Database.
properties:
items:
description: An array of AsmPropertySummary resources.
items:
$ref: '#/components/schemas/AsmPropertySummary'
type: array
required:
- items
type: object
CloudOpenAlertHistory:
description: The existing open alerts in the Exadata storage server.
properties:
alerts:
description: A list of open alerts.
items:
$ref: '#/components/schemas/OpenAlertSummary'
type: array
required:
- alerts
type: object
ExternalMySqlDatabaseConnector:
description: Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
associatedServices:
description: OCI Services associated with this connector.
maxLength: 255
type: string
compartmentId:
description: OCID of compartment for the External MySQL connector.
maxLength: 255
type: string
connectionStatus:
description: Connection Status
maxLength: 255
type: string
connectorType:
description: Connector Type.
enum:
- MACS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlConnectorType'
credentialType:
description: Credential type used to connect to database.
enum:
- MYSQL_EXTERNAL_NON_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SOCKET_CREDENTIALS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlCredType'
externalDatabaseId:
description: OCID of MySQL Database resource
maxLength: 255
type: string
hostName:
description: Host name for Connector.
maxLength: 255
minLength: 1
type: string
id:
description: OCID of MySQL Database Connector.
maxLength: 255
type: string
lifecycleState:
description: Indicates lifecycle state of the resource.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
macsAgentId:
description: Agent Id of the MACS agent.
maxLength: 255
type: string
name:
description: External MySQL Database Connector Name.
maxLength: 255
type: string
networkProtocol:
description: Network Protocol.
enum:
- TCP
- TCPS
- SOCKETS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlNetworkProtocolType'
port:
description: Connector port.
maximum: 65535
minimum: 1
type: integer
sourceDatabase:
description: Name of MySQL Database.
maxLength: 255
type: string
sourceDatabaseType:
description: Type of MySQL Database.
enum:
- EXTERNAL
- MDS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlType'
sslSecretId:
description: OCID of the SSL secret, if TCPS with SSL is used to connect to database.
maxLength: 255
type: string
sslSecretName:
description: Name of the SSL secret, if TCPS with SSL is used to connect to database.
maxLength: 255
type: string
timeConnectionStatusUpdated:
description: Time when connection status was last updated.
format: date-time
type: string
timeCreated:
description: Connector creation time.
format: date-time
type: string
timeUpdated:
description: Connector update time.
format: date-time
type: string
required:
- id
AwrDbMetricCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_METRICS_SET
properties:
items:
description: A list of AWR metric summary data.
items:
$ref: '#/components/schemas/AwrDbMetricSummary'
type: array
description: The AWR metrics time series summary data.
type: object
OptimizerStatisticsCollectionOperationSummary:
description: The summary of the Optimizer Statistics Collection operation.
properties:
completedCount:
description: The number of objects for which statistics collection is completed.
type: integer
durationInSeconds:
description: The time it takes to complete the operation (in seconds).
format: integer
type: number
endTime:
description: The end time of the operation.
format: data-time
type: string
failedCount:
description: The number of objects for which statistics collection failed.
type: integer
id:
description: The ID of the operation.
type: integer
inProgressCount:
description: The number of objects for which statistics collection is in progress.
type: integer
jobName:
description: The name of the job.
type: string
operationName:
description: The name of the operation.
type: string
startTime:
description: The start time of the operation.
format: data-time
type: string
status:
description: The status of the operation such as Completed, and Failed.
enum:
- IN_PROGRESS
- COMPLETED
- FAILED
- TIMED_OUT
- UNKNOWN
type: string
target:
description: The target object type such as Table, Index, and Partition.
type: string
timedOutCount:
description: The number of objects for which statistics collection timed out.
type: integer
totalObjectsCount:
description: 'The total number of objects for which statistics is collected. This number is the sum of all the objects
with various statuses: completed, inProgress, failed, and timedOut.
'
type: integer
required:
- id
- operationName
- target
- jobName
- status
- startTime
- endTime
- durationInSeconds
type: object
ExternalListener:
description: The details of an external listener.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the external listener defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
adrHomeDirectory:
description: The directory that stores tracing and logging incidents when Automatic Diagnostic Repository (ADR) is enabled.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external listener.
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
displayName:
description: The user-friendly name for the external listener. The name does not have to be unique.
type: string
endpoints:
description: The list of protocol addresses the listener is configured to listen on.
items:
$ref: '#/components/schemas/ExternalListenerEndpoint'
type: array
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbHomeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB home.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the listener is a part of.
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
hostName:
description: The name of the host on which the external listener is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external listener.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external listener.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
listenerAlias:
description: The listener alias.
type: string
listenerOraLocation:
description: The location of the listener configuration file listener.ora.
type: string
listenerType:
description: The type of listener.
enum:
- ASM
- LOCAL
- SCAN
type: string
logDirectory:
description: The destination directory of the listener log file.
type: string
oracleHome:
description: The Oracle home location of the listener.
type: string
servicedAsms:
description: The list of ASMs that are serviced by the listener.
items:
$ref: '#/components/schemas/ExternalServicedAsm'
type: array
servicedDatabases:
description: The list of databases that are serviced by the listener.
items:
$ref: '#/components/schemas/ExternalListenerServicedDatabase'
type: array
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
timeCreated:
description: The date and time the external listener was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external listener was last updated.
format: date-time
type: string
traceDirectory:
description: The destination directory of the listener trace file.
type: string
version:
description: The listener version.
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
CloudAsmInstance:
description: The details of a cloud ASM instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
type: string
cloudAsmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM that the ASM instance belongs to.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node on which the ASM instance is running.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the ASM instance is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud ASM instance.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
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
hostName:
description: The name of the host on which the ASM instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud ASM instance.
enum:
- CREATING
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the cloud ASM instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud ASM instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudAsmId
- cloudDbSystemId
- lifecycleState
type: object
CloudAsmInstanceSummary:
description: The summary of a cloud ASM instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
type: string
cloudAsmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM that the ASM instance belongs to.
type: string
cloudDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node on which the ASM instance is running.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the ASM instance is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud ASM instance.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) in DBaas service.
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
displayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
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
hostName:
description: The name of the host on which the ASM instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud ASM instance.
type: string
x-obmcs-enumref: '#/definitions/CloudAsmInstance/lifecycleState'
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
timeCreated:
description: The date and time the cloud ASM instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud ASM instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudAsmId
- cloudDbSystemId
- lifecycleState
type: object
ChangeCloudExadataInfrastructureCompartmentDetails:
description: The details required to change the compartment of the Exadata infrastructure.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to move the Exadata infrastructure and related components to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
EnableCloudExadataInfrastructureManagementDetails:
description: The details required to enable Database Management on the Exadata infrastructure.
properties:
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
required:
- licenseModel
type: object
AssociatedDatabaseSummary:
description: The summary of a database currently using a Database Management private endpoint.
properties:
compartmentId:
description: The compartment [OCID](/Content/General/Concepts/identifiers.htm) of the database.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database.
type: string
name:
description: The name of the database.
type: string
timeRegistered:
description: The time when Database Management was enabled for the database.
format: date-time
type: string
required:
- id
- name
- compartmentId
- timeRegistered
type: object
WorkRequestLogEntryCollection:
description: 'The results of a work request log search. This contains WorkRequestLog items and other data.
'
properties:
items:
description: A collection of work request logs.
items:
$ref: '#/components/schemas/WorkRequestLogEntry'
type: array
required:
- items
type: object
ChangeNamedCredentialCompartmentDetails:
description: The details required to change the compartment of a named credential.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to which the named credential should be moved.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
JobScheduleDetails:
description: The details of the job schedule.
properties:
endTime:
description: The end time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: data-time
type: string
intervalType:
default: NEVER
description: The interval type for a recurring scheduled job. For a non-recurring (one time) job, NEVER must be specified as the interval type.
enum:
- DAILY
- HOURLY
- WEEKLY
- MONTHLY
- NEVER
type: string
intervalValue:
description: The value for the interval period for a recurring scheduled job.
maxLength: 9
minLength: 1
type: string
startTime:
description: The start time of the scheduled job in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: data-time
type: string
type: object
CloudExadataInfrastructureDiscovery:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: CLOUD_INFRASTRUCTURE_DISCOVER
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
discoveryKey:
description: The unique key of the discovery request.
type: string
gridHomePath:
description: The Oracle home path of the Exadata infrastructure.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
rackSize:
description: The size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
- UNKNOWN
type: string
storageGrid:
$ref: '#/components/schemas/StorageGridDiscoverySummary'
storageServers:
description: The list of storage servers in the Exadata infrastructure.
items:
$ref: '#/components/schemas/StorageServerDiscoverySummary'
type: array
vmClusters:
description: The list of VM Clusters in the Exadata infrastructure.
items:
$ref: '#/components/schemas/VMClusterDiscoverySummary'
type: array
required:
- discoveryKey
description: The result of the Exadata infrastructure discovery.
type: object
UpdateMySqlDatabaseConnectorDetails:
description: Update Details of external database connector. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
credentialType:
description: Type of the credential.
enum:
- MYSQL_EXTERNAL_NON_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SSL_CREDENTIALS
- MYSQL_EXTERNAL_SOCKET_CREDENTIALS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlCredType'
displayName:
description: External MySQL Database Connector Name.
maxLength: 255
type: string
externalDatabaseId:
description: OCID of MySQL Database resource.
maxLength: 255
type: string
hostName:
description: Host name for Connector.
maxLength: 255
minLength: 1
type: string
macsAgentId:
description: Agent Id of the MACS agent.
maxLength: 255
type: string
networkProtocol:
description: Protocol to be used to connect to External MySQL Database; TCP, TCP with SSL or Socket.
enum:
- TCP
- TCPS
- SOCKETS
type: string
x-obmcs-top-level-enum: '#/definitions/MySqlNetworkProtocolType'
port:
description: Port number to connect to External MySQL Database.
maximum: 65535
minimum: 1
type: integer
sslSecretId:
description: If using existing SSL secret to connect, OCID for the secret resource.
maxLength: 255
type: string
required:
- hostName
- port
- macsAgentId
- sslSecretId
- networkProtocol
ExternalServicedDatabase:
description: The details of a database serviced by an external DB system component such as a listener or ASM.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the external database resides.
type: string
databaseSubType:
description: 'The subtype of Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
dbUniqueName:
description: The unique name of the external database.
type: string
displayName:
description: The user-friendly name for the database. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external database.
type: string
isManaged:
description: Indicates whether the database is a Managed Database or not.
type: boolean
required:
- id
- displayName
type: object
DatabaseHaBackupDetails:
allOf:
- $ref: '#/components/schemas/BaseDatabaseHaDetails'
- properties:
backupHistory:
description: A list of database backups.
items:
$ref: '#/components/schemas/DatabaseBackupSummary'
type: array
uniqueItems: true
flashBackOn:
description: Indicates whether flashback is enabled for the database.
type: string
flashBackTime:
description: The oldest flashback date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
lastFullBackupSummary:
$ref: '#/components/schemas/DatabaseBackupSummary'
metrics:
description: A list of database backup metrics such as BackupSize and BackupDuration.
items:
$ref: '#/components/schemas/HaMetricDefinition'
type: array
recoveryWindowGoalInDays:
description: The configured number of days intended to recover a protected database from a backup.
type: integer
type: object
description: The database HA and backup details.
StorageGridDiscoverySummary:
allOf:
- $ref: '#/components/schemas/EntityDiscovered'
- discriminator:
propertyName: MANAGED_STORAGE_GRID_DISCOVER_SUMMARY
properties:
countOfStorageServersDiscovered:
description: The total number of Exadata storage servers discovered.
type: integer
description: The summary of the Exadata storage server grid discovery.
type: object
DbManagementAnalyticsMetric:
description: The metric details of a Database Management resource.
properties:
dimensions:
additionalProperties:
type: string
description: The qualifiers provided in the definition of the returned metric.
type: object
durationInSeconds:
description: The duration of the returned aggregated data in seconds.
format: int64
type: integer
mean:
description: The mean value of the metric.
format: double
type: number
metadata:
additionalProperties:
type: string
description: 'The additional information about the metric.
Example: `"unit": "bytes"`
'
type: object
metricName:
description: The name of the metric.
type: string
startTimestampInEpochSeconds:
description: The start time associated with the value of the metric.
format: int64
type: integer
type: object
DatabaseHaMetrics:
allOf:
- $ref: '#/components/schemas/BaseDatabaseHaDetails'
- properties:
isDataguardEnabled:
description: Indicates whether Data Guard is enabled for the database.
type: boolean
lastBackupSummary:
$ref: '#/components/schemas/DatabaseBackupSummary'
metrics:
description: A list of database health metrics such as BackupDuration and BackupSize.
items:
$ref: '#/components/schemas/HaMetricDefinition'
type: array
required:
- isDataguardEnabled
- lastBackupSummary
- metrics
type: object
description: The details of the HA metrics for a single database.
ResizeDataFileDetails:
description: 'The details required to resize a data file or temp file within the tablespace.
It takes either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
autoExtendMaxSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The maximum disk space allowed for automatic extension of the data files or temp files.
'
autoExtendNextSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of the next increment of disk space to be allocated automatically when more extents are required.
'
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
dataFile:
description: 'Name of the data file or temp file to be resized.
'
type: string
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
fileSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The new size of the data file or temp file.
'
fileType:
description: 'Specifies whether the file is a data file or temp file.
'
enum:
- DATAFILE
- TEMPFILE
type: string
isAutoExtensible:
description: 'Specifies whether the data file or temp file can be extended automatically.
'
type: boolean
isMaxSizeUnlimited:
description: 'Specifies whether the disk space of the data file or temp file can be limited.
'
type: boolean
required:
- fileType
- dataFile
type: object
CloudAsmInstanceParameters:
description: The initialization parameters for an ASM instance.
properties:
asmInstanceDisplayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
type: string
asmInstanceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM instance.
type: string
autoMountDiskGroups:
description: 'The list of disk group names that an ASM instance mounts at startup or when the `ALTER DISKGROUP ALL MOUNT` statement is issued.
'
items:
type: string
maxItems: 25
type: array
diskDiscoveryPath:
description: 'An operating system-dependent value used to limit the set of disks considered for discovery.
'
type: string
preferredReadFailureGroups:
description: The list of failure groups that contain preferred read disks.
items:
type: string
maxItems: 25
type: array
rebalancePower:
description: 'The maximum power on an ASM instance for disk rebalancing.
'
maximum: 1024
minimum: 0
type: integer
required:
- asmInstanceId
- asmInstanceDisplayName
- diskDiscoveryPath
- autoMountDiskGroups
- rebalancePower
- preferredReadFailureGroups
type: object
CloudDbNodeSummary:
description: The summary of a cloud DB node.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
type: string
cloudDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system that the DB node is a part of.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the cloud DB node.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node in DBaas service.
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
displayName:
description: The user-friendly name for the cloud DB node. The name does not have to be unique.
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
hostName:
description: The host name for the DB node.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB node.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB node.
type: string
x-obmcs-enumref: '#/definitions/CloudDbNode/lifecycleState'
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
timeCreated:
description: The date and time the cloud DB node was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB node was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- cloudDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalAsmUserCollection:
description: A collection of external ASM users.
properties:
items:
description: An array of external ASM users.
items:
$ref: '#/components/schemas/ExternalAsmUserSummary'
type: array
required:
- items
type: object
UpdateExternalDbNodeDetails:
description: The details required to update an external DB node.
properties:
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
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
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
type: object
AwrDbSnapshotRangeSummary:
allOf:
- $ref: '#/components/schemas/AwrDbSummary'
description: The summary data for a range of AWR snapshots.
type: object
CreateExternalDbSystemDiscoveryDetails:
description: The details required to create an external DB system discovery resource.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the external DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the external DB system resides.
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
required:
- agentId
- compartmentId
type: object
CreateTablespaceDetails:
description: 'The details required to create a tablespace.
It takes either credentialDetails or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
autoExtendMaxSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The maximum disk space allowed for automatic extension of the data files or temp files.
'
autoExtendNextSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of the next increment of disk space to be allocated automatically when more extents are required.
'
blockSizeInKilobytes:
description: 'Block size for the tablespace.
'
enum:
- BLOCK_SIZE_2KB
- BLOCK_SIZE_4KB
- BLOCK_SIZE_8KB
- BLOCK_SIZE_16KB
- BLOCK_SIZE_32KB
type: integer
credentialDetails:
$ref: '#/components/schemas/TablespaceAdminCredentialDetails'
dataFiles:
description: 'The list of data files or temp files created for the tablespace.
'
items:
type: string
type: array
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
defaultCompress:
description: 'The default compression of data for all tables created in the tablespace.
'
enum:
- NO_COMPRESS
- BASIC_COMPRESS
type: string
encryptionAlgorithm:
description: 'The name of the encryption algorithm to be used for tablespace encryption.
'
type: string
extentManagement:
description: 'Specifies how the extents of the tablespace should be managed.
'
enum:
- AUTOALLOCATE
- UNIFORM
type: string
extentUniformSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of the extent when the tablespace is managed with uniform extents of a specific size.
'
fileCount:
description: 'The number of data files or temp files created for the tablespace. This is for Oracle Managed Files only.
'
type: integer
fileSize:
$ref: '#/components/schemas/TablespaceStorageSize'
description: 'The size of each data file or temp file.
'
isAutoExtensible:
description: 'Specifies whether the data file or temp file can be extended automatically.
'
type: boolean
isBigfile:
description: 'Specifies whether the tablespace is a bigfile or smallfile tablespace.
A bigfile tablespace contains only one data file or temp file, which can contain up to approximately 4 billion (232) blocks.
A smallfile tablespace is a traditional Oracle tablespace, which can contain 1022 data files or temp files, each of which can contain up to approximately 4 million (222) blocks.
'
type: boolean
isDefault:
description: 'Specifies whether the tablespace is the default tablespace.
'
type: boolean
isEncrypted:
description: Indicates whether the tablespace is encrypted.
type: boolean
isMaxSizeUnlimited:
description: 'Specifies whether the disk space of the data file or temp file can be limited.
'
type: boolean
isReusable:
description: 'Specifies whether Oracle can reuse the data file or temp file. Reuse is only allowed when the file name is provided.
'
type: boolean
name:
description: 'The name of the tablespace. It must be unique within a database.
'
maxLength: 255
minLength: 1
type: string
segmentManagement:
description: 'Specifies whether tablespace segment management should be automatic or manual.
'
enum:
- AUTO
- MANUAL
type: string
status:
description: 'The status of the tablespace.
'
enum:
- READ_ONLY
- READ_WRITE
type: string
type:
description: 'The type of tablespace.
'
enum:
- PERMANENT
- TEMPORARY
type: string
required:
- name
type: object
FailedConnectionsAggregateMetrics:
description: The failed connection metrics for Autonomous Databases on Shared Exadata Infrastructure.
properties:
failedConnections:
$ref: '#/components/schemas/MetricDataPoint'
type: object
DatabaseParameterUpdateStatus:
description: The result of database parameter update.
properties:
errorCode:
description: 'An error code that defines the failure or `null` if the parameter
was updated successfully.
'
type: string
errorMessage:
description: 'The error message indicating the reason for failure or `null` if
the parameter was updated successfully.
'
type: string
status:
description: The status of the parameter update.
enum:
- SUCCEEDED
- FAILED
type: string
type: object
ResetDatabaseParametersDetails:
description: 'The details required to reset database parameter values.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/DatabaseCredentials'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
parameters:
description: A list of database parameter names.
items:
type: string
type: array
scope:
description: 'The clause used to specify when the parameter change takes effect.
Use `MEMORY` to make the change in memory and ensure that it takes
effect immediately. Use `SPFILE` to make the change in the server
parameter file. The change takes effect when the database is next
shut down and started up again. Use `BOTH` to make the change in
memory and in the server parameter file. The change takes effect
immediately and persists after the database is shut down and
started up again.
'
enum:
- MEMORY
- SPFILE
- BOTH
type: string
x-obmcs-top-level-enum: '#/definitions/ParameterScope'
required:
- scope
- parameters
type: object
ChangePlanRetentionDetails:
description: 'The details required to change the plan retention period.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
retentionWeeks:
description: 'The retention period in weeks. It can range between 5 and 523 weeks.
'
maximum: 523
minimum: 5
type: integer
required:
- retentionWeeks
type: object
EnableExternalContainerDatabaseManagementFeatureDetails:
description: The details required to enable a Database Management feature for an external container database.
properties:
featureDetails:
$ref: '#/components/schemas/ExternalDatabaseFeatureDetails'
required:
- featureDetails
type: object
RemoveManagedDatabaseFromManagedDatabaseGroupDetails:
description: The Managed Database details required to remove it from a Managed Database Group.
properties:
managedDatabaseId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
'
maxLength: 255
minLength: 1
type: string
required:
- managedDatabaseId
type: object
UpdateExternalAsmInstanceDetails:
description: The details required to update an external ASM instance.
properties:
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
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
type: object
TimeSeriesMetricDataPoint:
description: The metric values with dimension details.
properties:
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
timestamp:
description: The date and time the metric was created.
format: date-time
type: string
unit:
description: The unit of the metric value.
type: string
value:
description: The value of the metric.
format: double
type: number
required:
- timestamp
- value
- unit
type: object
RuleFinding:
description: The summary of the Optimizer Statistics Advisor findings and recommendations.
properties:
details:
description: The details of the schema or operation.
items:
$ref: '#/components/schemas/FindingSchemaOrOperation'
type: array
message:
description: A high-level overview of the findings of the Optimizer Statistics Advisor.
type: string
recommendations:
description: The list of recommendations.
items:
$ref: '#/components/schemas/Recommendation'
type: array
required:
- message
- details
- recommendations
type: object
UpdateExternalClusterDetails:
description: The details required to update an external cluster.
properties:
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
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
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
type: object
FleetStatusByCategory:
description: The number of databases in the fleet, grouped by database type and sub type.
properties:
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
inventoryCount:
description: The number of databases in the fleet.
type: integer
type: object
DatabasePlan:
description: 'The resource allocation directives must all use the share attribute, or they must all use the level and allocation attributes.
If you use the share attribute to allocate I/O resources, then the database plan can have a maximum of 1024 directives.
If you use the level and allocation attributes to allocate I/O resources, then the database plan can have
a maximum of 32 directives.
Only one directive is allowed for each database name and each profile name.
'
properties:
items:
description: A list of DatabasePlanDirectives.
items:
$ref: '#/components/schemas/DatabasePlanDirective'
type: array
required:
- items
type: object
CloudExadataInfrastructureCollection:
description: A list of the Exadata infrastructure resources.
properties:
items:
description: A list of Exadata infrastructures.
items:
$ref: '#/components/schemas/CloudExadataInfrastructureSummary'
type: array
required:
- items
type: object
ModifyPluggableDatabaseManagementFeatureDetails:
description: The details required to modify a Database Management feature for an Oracle cloud pluggable database.
properties:
featureDetails:
$ref: '#/components/schemas/DatabaseFeatureDetails'
required:
- featureDetails
type: object
CreateExternalExadataStorageConnectorDetails:
description: The details required to create the connector to the Exadata storage server.
properties:
agentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the agent for the Exadata storage server.
maxLength: 255
minLength: 1
type: string
connectionUri:
description: The unique string of the connection. For example, "https:///MS/RESTService/".
maxLength: 1024
minLength: 1
type: string
connectorName:
description: The name of the Exadata storage server connector.
maxLength: 255
minLength: 1
type: string
credentialInfo:
$ref: '#/components/schemas/RestCredential'
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
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
storageServerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server.
maxLength: 255
minLength: 1
type: string
required:
- storageServerId
- agentId
- connectorName
- connectionUri
- credentialInfo
type: object
FleetMetricDefinition:
description: The database metric details.
properties:
baselineValue:
description: The baseline value of the metric.
format: double
type: number
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
percentageChange:
description: The percentage change in the metric aggregated value compared to the baseline value.
format: double
type: number
targetValue:
description: The target value of the metric.
format: double
type: number
timestamp:
description: The data point date and time in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".
format: date-time
type: string
unit:
description: The unit of the value.
type: string
type: object
ExternalAsmCollection:
description: A collection of external ASMs.
properties:
items:
description: An array of external ASMs.
items:
$ref: '#/components/schemas/ExternalAsmSummary'
type: array
required:
- items
type: object
AwrDbParameterChangeCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_DB_PARAMETER_CHANGE
properties:
items:
description: A list of AWR database parameter change summary data.
items:
$ref: '#/components/schemas/AwrDbParameterChangeSummary'
type: array
description: The AWR database parameter change history.
type: object
CloudClusterInstanceCollection:
description: A collection of cloud cluster instances.
properties:
items:
description: An array of cloud cluster instances.
items:
$ref: '#/components/schemas/CloudClusterInstanceSummary'
type: array
required:
- items
type: object
ActivityTimeSeriesMetrics:
description: The response object representing activityMetric details for a specific Managed Database at a particular time.
properties:
cluster:
$ref: '#/components/schemas/MetricDataPoint'
cpuCount:
$ref: '#/components/schemas/MetricDataPoint'
cpuTime:
$ref: '#/components/schemas/MetricDataPoint'
timestamp:
description: The date and time the activity metric was created.
format: date-time
type: string
userIoTime:
$ref: '#/components/schemas/MetricDataPoint'
waitTime:
$ref: '#/components/schemas/MetricDataPoint'
type: object
HistoricAddmResult:
description: 'The details of the historic ADDM task.
'
properties:
beginSnapshotId:
description: 'The ID number of the beginning AWR snapshot.
'
format: int64
type: integer
dbUser:
description: The database user who owns the historic ADDM task.
type: string
description:
description: The description of the ADDM task.
type: string
endSnapshotId:
description: 'The ID number of the ending AWR snapshot.
'
format: int64
type: integer
endSnapshotTime:
description: 'The timestamp of the ending AWR snapshot used in the ADDM task as defined by date-time RFC3339 format.
'
format: date-time
type: string
findings:
description: The number of ADDM findings.
format: int64
type: integer
howCreated:
description: A description of how the task was created.
enum:
- AUTO
- MANUAL
type: string
isNewlyCreated:
description: Specifies whether the ADDM task returned had already existed or was newly created by the api call.
type: boolean
startSnapshotTime:
description: 'The timestamp of the beginning AWR snapshot used in the ADDM task as defined by date-time RFC3339 format.
'
format: date-time
type: string
status:
description: The status of the ADDM task.
enum:
- INITIAL
- EXECUTING
- INTERRUPTED
- COMPLETED
- ERROR
type: string
taskId:
description: The ID of the historic ADDM task.
format: int64
type: integer
taskName:
description: The name of the historic ADDM task.
type: string
timeCreated:
description: The creation date of the ADDM task.
format: date-time
type: string
required:
- timeCreated
- taskId
type: object
StandByDatabaseDataguardMetrics:
description: The standby database details.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Managed Database resides.
type: string
databaseId:
description: The database ID of the Managed Database. Every database had its own ID and that value is captured here.
type: string
databaseName:
description: The display name of the Managed Database.
type: string
dbId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
dbRole:
description: The database role of the Managed Database.
enum:
- SNAPSHOT_STANDBY
- LOGICAL_STANDBY
- PHYSICAL_STANDBY
- PRIMARY
- FAR_SYNC
type: string
x-obmcs-top-level-enum: '#/definitions/DbRole'
dbUniqueName:
description: The database unique name of the Managed Database.
type: string
metrics:
description: A list of standby databases with latest values for metrics such as ApplyLag, TransportLag, and RedoApplyRate.
items:
$ref: '#/components/schemas/HaMetricDefinition'
type: array
required:
- dbId
- compartmentId
- databaseName
- dbRole
- metrics
type: object
JobExecutionsStatusSummary:
description: A summary of the status of the job executions.
properties:
count:
description: The number of job executions of a particular status.
minimum: 0
type: integer
status:
description: The status of the job execution.
enum:
- SUCCEEDED
- FAILED
- IN_PROGRESS
type: string
required:
- status
- count
CloudExadataInfrastructure:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_INFRASTRUCTURE
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
databaseCompartments:
description: The list of [OCIDs] (/Content/General/Concepts/identifiers.htm) of the compartments.
items:
type: string
type: array
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
deploymentType:
description: The infrastructure deployment type.
enum:
- EXADATA
- EXADATA_CC
type: string
x-obmcs-top-level-enum: '#/definitions/CloudExadataInfrastructureDeploymentType'
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
rackSize:
description: The rack size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
type: string
storageGrid:
$ref: '#/components/schemas/CloudExadataStorageGridSummary'
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
vmClusters:
description: The list of VM Clusters in the Exadata infrastructure.
items:
$ref: '#/components/schemas/ExadataVmClusterSummary'
type: array
description: The details of the Exadata infrastructure.
type: object
UpdateExternalDbSystemDiscoveryDetails:
description: The details required to update an external DB system discovery resource.
properties:
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
type: object
CloudExadataStorageServerCollection:
description: The Exadata storage server list.
properties:
items:
description: A list of Exadata storage servers.
items:
$ref: '#/components/schemas/CloudExadataStorageServerSummary'
type: array
required:
- items
type: object
UpdateExternalAsmDetails:
description: The details required to update an external ASM.
properties:
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
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
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
type: object
DatabaseFleetHaOverviewMetrics:
description: The details of the HA metrics for the fleet of databases.
properties:
haMetrics:
description: A list of the databases present in the fleet and their HA usage metrics.
items:
$ref: '#/components/schemas/DatabaseHaMetrics'
type: array
uniqueItems: true
required:
- haMetrics
type: object
CloudExadataStorageConnectorCollection:
description: The Exadata storage server connector list.
properties:
items:
description: A list of Exadata storage server connectors.
items:
$ref: '#/components/schemas/CloudExadataStorageConnectorSummary'
type: array
required:
- items
type: object
ChangeExternalExadataInfrastructureCompartmentDetails:
description: The details required to change the compartment of the Exadata infrastructure.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to move the Exadata infrastructure and related components to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
ExternalExadataStorageServerSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_SERVER_SUMMARY
properties:
connectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the connector.
type: string
cpuCount:
description: The CPU count of the Exadata storage server.
format: integer
type: number
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
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
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
maxFlashDiskIOPS:
description: The maximum flash disk IO operations per second of the Exadata storage server.
type: integer
maxFlashDiskThroughput:
description: The maximum flash disk IO throughput in MB/s of the Exadata storage server.
type: integer
maxHardDiskIOPS:
description: The maximum hard disk IO operations per second of the Exadata storage server.
type: integer
maxHardDiskThroughput:
description: The maximum hard disk IO throughput in MB/s of the Exadata storage server.
type: integer
memoryGB:
description: The Exadata storage server memory size in GB.
format: double
type: number
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The Exadata storage server of the Exadata infrastructure.
type: object
ExternalAsmConfiguration:
description: The configuration details of an ASM.
properties:
initParameters:
description: An array of initialization parameters for the external ASM instances.
items:
$ref: '#/components/schemas/ExternalAsmInstanceParameters'
type: array
required:
- initParameters
type: object
PerformanceMetricsData:
description: The list of Data Guard performance metrics for Managed Databases.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the Managed Database resides.
type: string
databaseId:
description: The database ID of the Managed Database. Every database had its own ID and that value is captured here.
type: string
dbRole:
description: The database role of the Managed Database.
enum:
- SNAPSHOT_STANDBY
- LOGICAL_STANDBY
- PHYSICAL_STANDBY
- PRIMARY
- FAR_SYNC
type: string
x-obmcs-top-level-enum: '#/definitions/DbRole'
dbUniqueName:
description: The database unique name of the Managed Database.
type: string
deploymentType:
description: The deployment type of the Managed Database.
type: string
metrics:
description: The list of Data Guard performance metrics such as ApplyLag, TransportLag and RedoApplyRate for the Managed Databases.
items:
$ref: '#/components/schemas/PerformanceMetrics'
type: array
primaryDbId:
description: The ID of the primary database.
type: string
primaryDbUniqueName:
description: The primary database unique name of the Managed Database.
type: string
resourceId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
resourceName:
description: The resource name of the Managed Database.
type: string
type: object
ModifyAutonomousDatabaseManagementFeatureDetails:
description: The details required to modify a Database Management feature for an Autonomous Database.
properties:
featureDetails:
$ref: '#/components/schemas/AutonomousDatabaseFeatureDetails'
required:
- featureDetails
type: object
ExternalMySqlDatabaseCollection:
description: The collection of external MySQL Databases. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
items:
description: The list of external MySQL Database records.
items:
$ref: '#/components/schemas/ExternalMySqlDatabaseSummary'
type: array
required:
- items
type: object
UpdateCloudDbHomeDetails:
description: The details required to update a cloud DB home.
properties:
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
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
type: object
SpmEvolveTaskParameters:
description: The set of parameters used in an SPM evolve task.
properties:
allowedTimeLimit:
description: The global time limit in seconds. This is the total time allowed for the task.
type: integer
alternatePlanBaselines:
description: Determines which alternative plans should be loaded.
items:
enum:
- AUTO
- EXISTING
- NEW
type: string
type: array
alternatePlanLimit:
description: 'Specifies the maximum number of plans to load in total (that is, not
the limit for each SQL statement). A value of zero indicates `UNLIMITED`
number of plans.
'
type: integer
alternatePlanSources:
description: Determines which sources to search for additional plans.
items:
enum:
- AUTO
- AUTOMATIC_WORKLOAD_REPOSITORY
- CURSOR_CACHE
- SQL_TUNING_SET
type: string
type: array
arePlansAutoAccepted:
description: Specifies whether to accept recommended plans automatically.
type: boolean
type: object
CloudDbSystemDiscoverySummary:
description: The summary of a cloud DB system.
properties:
agentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the management agent
used for the cloud DB system discovery.
'
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
dbaasParentInfrastructureId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the parent cloud DB Infrastructure. For VM DB systems ,
it will be the DBSystem ID. For ExaCS and ExaCC, it will be the cloudVmClusterId and vmClusterId respectively.
'
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
deploymentType:
description: The deployment type of cloud DB system.
enum:
- VM
- EXADATA
- EXADATA_CC
- EXADATA_XS
type: string
x-obmcs-top-level-enum: '#/definitions/CloudDbSystemDeploymentType'
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system discovery.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the cloud DB system discovery resource.
type: string
x-obmcs-enumref: '#/definitions/CloudDbSystemDiscovery/lifecycleState'
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
timeCreated:
description: The date and time the cloud DB system discovery was created.
format: date-time
type: string
timeUpdated:
description: The date and time the cloud DB system discovery was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- agentId
- dbaasParentInfrastructureId
- deploymentType
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalExadataInfrastructureSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: INFRASTRUCTURE_SUMMARY
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
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
gridHomePath:
description: The Oracle grid home path.
type: string
licenseModel:
description: 'The Oracle license model that applies to the database management resources.
'
enum:
- LICENSE_INCLUDED
- BRING_YOUR_OWN_LICENSE
type: string
rackSize:
description: The rack size of the Exadata infrastructure.
enum:
- FULL
- HALF
- QUARTER
- EIGHTH
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
required:
- compartmentId
description: The Exadata infrastructure.
type: object
CloudListenerServicedDatabase:
allOf:
- $ref: '#/components/schemas/CloudServicedDatabase'
description: The details of a database serviced by a cloud listener.
DatabaseIOAggregateMetrics:
description: The database Input/Output metric details.
properties:
ioThroughput:
description: The IOThroughput metrics grouped by IOType for a specific Managed Database.
items:
$ref: '#/components/schemas/MetricDataPoint'
type: array
ioThroughputStatistics:
description: The IOThroughput metric statistics such as min, max, mean, lowerQuartile, and upperQuartile.
items:
$ref: '#/components/schemas/MetricStatisticsDefinition'
type: array
iops:
description: The Input/Output Operations Per Second metrics grouped by IOType for a specific Managed Database.
items:
$ref: '#/components/schemas/MetricDataPoint'
type: array
iopsStatistics:
description: The Input/Output metric statistics such as min, max, mean, lowerQuartile, and upperQuartile.
items:
$ref: '#/components/schemas/MetricStatisticsDefinition'
type: array
type: object
TestPreferredCredentialDetails:
description: The status of the preferred credential test. The status is 'SUCCEEDED' if the preferred credential is working else the status is 'FAILED'.
discriminator:
propertyName: type
properties:
type:
description: The type of preferred credential. Only 'BASIC' is supported currently.
enum:
- BASIC
- NAMED_CREDENTIAL
type: string
x-obmcs-top-level-enum: '#/definitions/PreferredCredentialType'
required:
- type
type: object
DatabaseTimeAggregateMetrics:
description: The database time metric details.
properties:
cluster:
$ref: '#/components/schemas/MetricDataPoint'
cpuCount:
$ref: '#/components/schemas/MetricDataPoint'
cpuTime:
$ref: '#/components/schemas/MetricDataPoint'
userIoTime:
$ref: '#/components/schemas/MetricDataPoint'
waitTime:
$ref: '#/components/schemas/MetricDataPoint'
type: object
DisableDatabaseManagementFeatureDetails:
description: The details required to disable Database Management features for an Oracle cloud database.
properties:
canDisableAllPdbs:
description: Indicates whether Diagnostics & Management should be disabled for the pluggable databases before disabling it for the container database.
type: boolean
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
type: object
UpdateCloudClusterDetails:
description: The details required to update a cloud cluster.
properties:
cloudConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud connector.
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
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
type: object
DbManagementPrivateEndpointSummary:
description: The summary of a Database Management private endpoint.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
description:
description: The description of the private endpoint.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint.
type: string
lifecycleState:
description: The current lifecycle state of the private endpoint.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
name:
description: The display name of the Database Management private endpoint.
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".
'
type: object
description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`
'
type: object
description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN.
type: string
required:
- id
- name
- compartmentId
- vcnId
- subnetId
type: object
ExternalExadataStorageServerCollection:
description: The Exadata storage server list.
properties:
items:
description: A list of Exadata storage servers.
items:
$ref: '#/components/schemas/ExternalExadataStorageServerSummary'
type: array
required:
- items
type: object
UpdateExternalExadataInfrastructureDetails:
description: The details required to update the external Exadata infrastructure.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
maxLength: 255
minLength: 1
type: string
dbSystemIds:
description: The list of all the DB systems OCIDs.
items:
maxLength: 255
minLength: 1
type: string
type: array
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
discoveryKey:
description: The unique key of the discovery request.
type: string
displayName:
description: The name of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
storageServerNames:
description: The list of the names of Exadata storage servers to be monitored. If not specified, it includes all Exadata storage servers associated with the monitored DB systems.
items:
maxLength: 255
minLength: 1
type: string
type: array
required:
- compartmentId
type: object
SqlPlanBaselineAggregation:
description: A summary of SQL plan baselines.
properties:
count:
description: The number of SQL plan baselines matching aggregation criteria.
type: integer
dimensions:
$ref: '#/components/schemas/SqlPlanBaselineDimensions'
required:
- dimensions
type: object
ExadataFleetMetricSummaryDefinition:
description: A summary of the fleet metrics, which provides the metric aggregated value of the Exadata infrastructures in the fleet.
properties:
baselineValue:
description: The metric aggregated value at the baseline date and time.
format: double
type: number
dimensions:
description: The unique dimension key and values of the baseline metric.
items:
$ref: '#/components/schemas/ExadataMetricDimensionDefinition'
type: array
metricName:
description: The name of the metric.
type: string
percentageChange:
description: The percentage change in the metric aggregated value compared to the baseline value.
format: double
type: number
targetValue:
description: The metric aggregated value at the target date and time.
format: double
type: number
unit:
description: The unit of the value.
type: string
type: object
AutonomousDatabaseFeatureDetails:
description: The details required to enable the specified Database Management feature for an Autonomous Database.
discriminator:
propertyName: feature
properties:
connectorDetails:
$ref: '#/components/schemas/ConnectorDetails'
databaseConnectionDetails:
$ref: '#/components/schemas/DatabaseConnectionDetails'
feature:
description: The name of the Database Management feature.
enum:
- DIAGNOSTICS_AND_MANAGEMENT
- DB_LIFECYCLE_MANAGEMENT
- SQLWATCH
type: string
x-obmcs-top-level-enum: '#/definitions/DbManagementFeature'
required:
- feature
- databaseConnectionDetails
type: object
JobExecutionSummary:
description: A summary of a job execution on a Managed Database.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the parent job resides.
type: string
databaseSubType:
description: The subtype of the Oracle Database. Indicates whether the database is a Container Database, Pluggable Database, or a Non-container Database.
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
deploymentType:
description: A list of the supported infrastructure that can be used to deploy the database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
id:
description: The identifier of the job execution.
type: string
isCluster:
description: Indicates whether the Oracle Database is part of a cluster.
type: boolean
jobId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent job.
type: string
jobName:
description: The name of the parent job.
type: string
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the parent job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of Managed Database associated with the job execution.
type: string
managedDatabaseName:
description: The name of the Managed Database associated with the job execution.
type: string
name:
description: The name of the job execution.
type: string
status:
description: The status of the job execution.
type: string
x-obmcs-enumref: '#/definitions/JobExecution/status'
timeCompleted:
description: The date and time when the job execution was completed.
format: date-time
type: string
timeCreated:
description: The date and time when the job execution was created.
format: date-time
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
required:
- id
- name
- compartmentId
- managedDatabaseId
- managedDatabaseName
- jobId
- jobName
- status
- timeCreated
DatabaseParametersCollection:
description: A collection of database parameters.
properties:
databaseName:
description: The name of the Managed Database.
type: string
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database
is a Container Database, Pluggable Database, or a Non-container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle Database version.
type: string
items:
description: An array of DatabaseParameterSummary objects.
items:
$ref: '#/components/schemas/DatabaseParameterSummary'
type: array
required:
- databaseName
- databaseType
- databaseSubType
- databaseVersion
- items
type: object
CloudExadataStorageConnectorStatus:
description: The status of an Exadata storage server connector.
properties:
errorMessage:
description: The error message indicating the reason for failure or `null` if the connection was successful.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server connector.
type: string
status:
description: The connection status of the connector.
enum:
- SUCCEEDED
- FAILED
type: string
required:
- status
type: object
WorkRequestCollection:
description: 'Lists all work requests in a specific compartment. This contains WorkRequestSummary items.
'
properties:
items:
description: A collection of work requests.
items:
$ref: '#/components/schemas/WorkRequestSummary'
type: array
required:
- items
type: object
DisableAutomaticSpmEvolveAdvisorTaskDetails:
description: 'The details required to disable Automatic SPM Evolve Advisor task.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
DatabaseUsageMetrics:
description: The list of aggregated metrics for Managed Databases in the fleet.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where the Managed Database resides.
type: string
databaseContainerId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent Container Database, in the case of a Pluggable Database.
type: string
databaseId:
description: The Database id of the Managed Database. Every database had its own id and that value is captured here.
type: string
databaseName:
description: The display name of the Managed Database.
type: string
databaseSubType:
description: 'The subtype of the Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
databaseVersion:
description: The Oracle Database version.
type: string
dbId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
dbRole:
description: The Database role of the Managed Database.
enum:
- SNAPSHOT_STANDBY
- LOGICAL_STANDBY
- PHYSICAL_STANDBY
- PRIMARY
- FAR_SYNC
type: string
x-obmcs-top-level-enum: '#/definitions/DbRole'
dbUniqueName:
description: The Database unique name of the Managed Database.
type: string
deploymentType:
description: The infrastructure used to deploy the Oracle Database.
enum:
- ONPREMISE
- BM
- VM
- EXADATA
- EXADATA_CC
- AUTONOMOUS
type: string
x-obmcs-top-level-enum: '#/definitions/DeploymentType'
metrics:
description: A list of the database health metrics like CPU, Storage, and Memory.
items:
$ref: '#/components/schemas/FleetMetricDefinition'
type: array
primaryDbId:
description: The Primary Database id of the Managed Database.
type: string
primaryDbUniqueName:
description: The Primary Database unique name of the Managed Database.
type: string
workloadType:
description: The workload type of the Autonomous Database.
enum:
- OLTP
- DW
- AJD
- APEX
type: string
x-obmcs-top-level-enum: '#/definitions/WorkloadType'
type: object
PatchExternalDbSystemDiscoveryDetails:
description: The details required to update an external DB system discovery resource.
properties:
items:
description: A sequence of instructions to apply to the resource.
items:
$ref: '#/components/schemas/PatchInstruction'
type: array
type: object
AwrDbSnapshotCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_SNAPSHOT_SET
properties:
items:
description: A list of AWR snapshot summary data.
items:
$ref: '#/components/schemas/AwrDbSnapshotSummary'
type: array
description: The list of AWR snapshots for one database.
type: object
UpdateCloudDbSystemConnectorDetails:
description: The details required to update a cloud DB system connector.
discriminator:
propertyName: connectorType
properties:
connectorType:
description: The type of connector.
enum:
- MACS
type: string
required:
- connectorType
type: object
SqlPlanBaselineJobCollection:
description: A collection of database jobs used for loading and evolving SQL plan baselines.
properties:
items:
description: A list of SQL plan baseline jobs.
items:
$ref: '#/components/schemas/SqlPlanBaselineJobSummary'
type: array
required:
- items
type: object
UpdateExternalDbHomeDetails:
description: The details required to update an external DB home.
properties:
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
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
type: object
ImplementOptimizerStatisticsAdvisorRecommendationsDetails:
description: The request details object to implement the Optimizer Statistics Advisor task recommendations.
properties:
jobDetails:
$ref: '#/components/schemas/ImplementOptimizerStatisticsAdvisorRecommendationsJob'
taskName:
description: The name of the task.
maxLength: 255
minLength: 1
type: string
required:
- taskName
- jobDetails
type: object
CreateExternalMySqlDatabaseDetails:
description: Details for creating an external database. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
compartmentId:
description: OCID of compartment for the External MySQL Database.
maxLength: 255
type: string
dbName:
description: Name of the External MySQL Database.
maxLength: 255
type: string
required:
- compartmentId
- dbName
UpdateManagedDatabaseDetails:
description: The details required to update a Managed Database.
properties:
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
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
type: object
CreateCloudDbSystemDetails:
description: The details required to create a cloud DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud DB system resides.
type: string
databaseManagementConfig:
$ref: '#/components/schemas/CloudDbSystemDatabaseManagementConfigDetails'
dbSystemDiscoveryId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB system discovery.
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
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
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
stackMonitoringConfig:
$ref: '#/components/schemas/CloudDbSystemStackMonitoringConfigDetails'
required:
- compartmentId
- dbSystemDiscoveryId
type: object
AwrDbWaitEventCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_EVENT_SET
properties:
items:
description: A list of AWR wait events.
items:
$ref: '#/components/schemas/AwrDbWaitEventSummary'
type: array
description: The AWR wait event data.
type: object
ExternalClusterInstanceSummary:
description: The summary of an external cluster instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external cluster instance.
type: string
crsBaseDirectory:
description: The Oracle base location of Cluster Ready Services (CRS).
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
displayName:
description: The user-friendly name for the cluster instance. The name does not have to be unique.
type: string
externalClusterId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster that the cluster instance belongs to.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster instance is a part of.
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
hostName:
description: The name of the host on which the cluster instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external cluster instance.
type: string
x-obmcs-enumref: '#/definitions/ExternalClusterInstance/lifecycleState'
nodeRole:
description: The role of the cluster node.
type: string
x-obmcs-enumref: '#/definitions/ExternalClusterInstance/nodeRole'
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
timeCreated:
description: The date and time the external cluster instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external cluster instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalClusterId
- externalDbSystemId
- lifecycleState
type: object
ExternalDbSystemBasicInfo:
description: The basic information about an external DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
displayName:
description: The user-friendly name for the DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/ExternalExadataInfraBasicInfo'
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system.
type: string
required:
- id
- displayName
- compartmentId
AwrDbSqlReport:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_SQL_REPORT
properties:
content:
description: The content of the report.
type: string
format:
description: The format of the report.
enum:
- HTML
- TEXT
type: string
description: The result of the AWR SQL report.
type: object
CreateNamedCredentialDetails:
description: The details required to create a named credential.
properties:
associatedResource:
description: "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource that \nis associated to the named credential.\n"
type: string
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment
in which the named credential resides.
'
type: string
content:
$ref: '#/components/schemas/NamedCredentialContent'
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
description:
description: The information specified by the user about the named credential.
maxLength: 400
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
name:
description: 'The name of the named credential. Valid characters are uppercase or
lowercase letters, numbers, and "_". The name of the named credential
cannot be modified. It must be unique in the compartment and must begin with
an alphabetic character.
'
maxLength: 255
minLength: 1
type: string
scope:
description: The scope of the named credential.
enum:
- RESOURCE
- GLOBAL
type: string
x-obmcs-top-level-enum: '#/definitions/NamedCredentialScope'
type:
description: The type of resource associated with the named credential.
enum:
- ORACLE_DB
type: string
x-obmcs-top-level-enum: '#/definitions/ResourceType'
required:
- name
- compartmentId
- type
- scope
- content
type: object
CloudDbSystemBasicInfo:
description: The basic information about a cloud DB system.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
displayName:
description: The user-friendly name for the cloud DB system. The name does not have to be unique.
type: string
exadataInfraInfo:
$ref: '#/components/schemas/CloudExadataInfraBasicInfo'
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud DB system.
type: string
required:
- id
- displayName
- compartmentId
ExternalAsmInstanceCollection:
description: A collection of external ASM instances.
properties:
items:
description: An array of external ASM instances.
items:
$ref: '#/components/schemas/ExternalAsmInstanceSummary'
type: array
required:
- items
type: object
CloudClusterScanListenerConfiguration:
description: The details of a SCAN listener in a cloud cluster.
properties:
networkNumber:
description: The network number from which SCAN VIPs are obtained.
type: integer
scanName:
description: The name of the SCAN listener.
type: string
scanPort:
description: The port number of the SCAN listener.
maximum: 65535
minimum: 1
type: integer
scanProtocol:
description: The protocol of the SCAN listener.
enum:
- TCP
- TCPS
type: string
type: object
ExternalExadataStorageServer:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: STORAGE_SERVER
properties:
connector:
$ref: '#/components/schemas/ExternalExadataStorageConnectorSummary'
cpuCount:
description: The CPU count of the Exadata storage server.
format: integer
type: number
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
exadataInfrastructureId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
maxLength: 255
minLength: 1
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
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
maxFlashDiskIOPS:
description: The maximum flash disk IO operations per second of the Exadata storage server.
type: integer
maxFlashDiskThroughput:
description: The maximum flash disk IO throughput in MB/s of the Exadata storage server.
type: integer
maxHardDiskIOPS:
description: The maximum hard disk IO operations per second of the Exadata storage server.
type: integer
maxHardDiskThroughput:
description: The maximum hard disk IO throughput in MB/s of the Exadata storage server.
type: integer
memoryGB:
description: The Exadata storage server memory size in GB.
format: double
type: number
storageGridId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata storage server grid.
maxLength: 255
minLength: 1
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The details of the Exadata storage server.
type: object
ProxiedForUserCollection:
description: A collection of users on whose behalf the current user acts as proxy.
properties:
items:
description: An array of user resources.
items:
$ref: '#/components/schemas/ProxiedForUserSummary'
type: array
required:
- items
type: object
CloudAsmConfiguration:
description: The configuration details of an ASM.
properties:
initParameters:
description: An array of initialization parameters for the cloud ASM instances.
items:
$ref: '#/components/schemas/CloudAsmInstanceParameters'
maxItems: 100
type: array
required:
- initParameters
type: object
CloudClusterVipConfiguration:
description: The details of the Virtual IP (VIP) address for a node in a cloud cluster.
properties:
address:
description: The VIP name or IP address.
type: string
networkNumber:
description: The network number from which VIPs are obtained.
type: integer
nodeName:
description: The name of the node with the VIP.
type: string
type: object
ExternalAsmServicedDatabase:
allOf:
- $ref: '#/components/schemas/ExternalServicedDatabase'
- properties:
diskGroups:
description: The list of ASM disk groups used by the database.
items:
type: string
type: array
type: object
description: The details of a database serviced by an external ASM.
AwrDbParameterChangeSummary:
description: A summary of the changes made to a single AWR database parameter.
properties:
instanceNumber:
description: The database instance number.
type: integer
isDefault:
description: Indicates whether the parameter value in the end snapshot is the default.
type: boolean
previousValue:
description: The previous value of the database parameter.
type: string
snapshotId:
description: 'The ID of the snapshot with the parameter value changed. The snapshot ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
'
type: integer
timeBegin:
description: The start time of the interval.
format: date-time
type: string
timeEnd:
description: The end time of the interval.
format: date-time
type: string
value:
description: The current value of the database parameter.
type: string
valueModified:
description: "Indicates whether the parameter has been modified after instance startup:\n - MODIFIED - Parameter has been modified with ALTER SESSION\n - SYSTEM_MOD - Parameter has been modified with ALTER SYSTEM (which causes all the currently logged in sessions’ values to be modified)\n - FALSE - Parameter has not been modified after instance startup\n"
type: string
required:
- snapshotId
type: object
FindingSchemaOrOperation:
description: The findings of the Optimizer Statistics Advisor.
properties:
operations:
description: The list of operation details.
items:
type: string
type: array
schemas:
description: The names of the impacted database schemas and their objects.
items:
$ref: '#/components/schemas/SchemaDefinition'
type: array
type: object
EnableExternalDbSystemStackMonitoringDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The details required to enable Stack Monitoring for an external DB system.
RunHistoricAddmDetails:
description: 'The details of the ADDM task, which include the beginning and ending AWR snapshot IDs.
'
properties:
endSnapshotId:
description: The ID of the ending AWR snapshot.
format: int64
type: integer
startSnapshotId:
description: The ID number of the beginning AWR snapshot.
format: int64
type: integer
required:
- startSnapshotId
- endSnapshotId
RecommendationExampleLine:
description: An example line of the recommendation
properties:
comment:
description: The comments about the operation.
type: string
operation:
description: The details of the example operation.
type: string
type: object
AwrDbCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_SET
properties:
items:
description: A list of AWR summary data.
items:
$ref: '#/components/schemas/AwrDbSummary'
type: array
description: The result of AWR query.
type: object
JobRun:
description: The details of a specific job run.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the parent job resides.
type: string
id:
description: The identifier of the job run.
type: string
jobId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the parent job.
type: string
jobName:
description: The name of the parent job.
type: string
managedDatabaseGroupId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database Group where the parent job has to be executed.
type: string
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of Managed Database where the parent job has to be executed.
type: string
name:
description: The name of the job run.
type: string
runStatus:
description: The status of the job run.
enum:
- COMPLETED
- FAILED
- IN_PROGRESS
type: string
timeSubmitted:
description: The date and time when the job run was submitted.
format: date-time
type: string
timeUpdated:
description: The date and time when the job run was last updated.
format: date-time
type: string
required:
- id
- name
- compartmentId
- jobId
- jobName
- runStatus
- timeSubmitted
- timeUpdated
DbManagementPrivateEndpoint:
description: A Database Management private endpoint allows Database Management to connect to databases in a Virtual Cloud Network (VCN).
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
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
description:
description: The description of the Database Management private endpoint.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Database Management private endpoint.
type: string
isCluster:
description: Specifies whether the Database Management private endpoint can be used for Oracle Databases in a cluster.
type: boolean
isDnsResolutionEnabled:
description: Specifies whether the Database Management private endpoint has DNS proxy server enabled to resolve private host name.
type: boolean
lifecycleState:
description: The current lifecycle state of the Database Management private endpoint.
enum:
- CREATING
- UPDATING
- ACTIVE
- DELETING
- DELETED
- FAILED
type: string
x-obmcs-top-level-enum: '#/definitions/LifecycleStates'
name:
description: The display name of the Database Management private endpoint.
type: string
nsgIds:
description: 'The OCIDs of the Network Security Groups to which the Database Management private endpoint belongs.
'
items:
maxLength: 255
minLength: 1
type: string
maxItems: 5
type: array
uniqueItems: true
privateIp:
description: 'The IP addresses assigned to the Database Management private endpoint.
'
maxLength: 46
minLength: 1
type: string
securityAttributes:
additionalProperties:
additionalProperties:
description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce".
'
type: object
description: 'Key-value pair representing a security attribute key and value, scoped to a namespace.
Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}`
'
type: object
description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
'
type: object
subnetId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the Database Managament private endpoint was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
format: date-time
type: string
vcnId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the VCN.
type: string
required:
- id
- name
- compartmentId
- vcnId
- subnetId
type: object
EnableExternalNonContainerDatabaseManagementFeatureDetails:
description: The details required to enable a Database Management feature for an external non-container database.
properties:
featureDetails:
$ref: '#/components/schemas/ExternalDatabaseFeatureDetails'
required:
- featureDetails
type: object
CloudExadataInfraBasicInfo:
description: The basic information about a Cloud Exadata Infrastructure.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
displayName:
description: The user-friendly name for the Exadata Infrastructure. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Cloud Exadata Infrastructure.
type: string
required:
- id
- displayName
- compartmentId
CloudExadataStorageServerSummary:
allOf:
- $ref: '#/components/schemas/DbmResource'
- discriminator:
propertyName: CLOUD_STORAGE_SERVER_SUMMARY
properties:
connectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the connector.
type: string
cpuCount:
description: The CPU count of the Exadata storage server.
type: integer
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
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
ipAddress:
description: The IP address of the Exadata storage server.
type: string
makeModel:
description: The make model of the Exadata storage server.
type: string
maxFlashDiskIOPS:
description: The maximum flash disk IO operations per second of the Exadata storage server.
type: integer
maxFlashDiskThroughput:
description: The maximum flash disk IO throughput in MB/s of the Exadata storage server.
type: integer
maxHardDiskIOPS:
description: The maximum hard disk IO operations per second of the Exadata storage server.
type: integer
maxHardDiskThroughput:
description: The maximum hard disk IO throughput in MB/s of the Exadata storage server.
type: integer
memoryGB:
description: The Exadata storage server memory size in GB.
format: double
type: number
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
description: The Exadata storage server of the Exadata infrastructure.
type: object
EnableAutomaticInitialPlanCaptureDetails:
description: 'The details required to enable automatic initial plan capture.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
type: object
ExternalDbNode:
description: The details of an external database node.
properties:
additionalDetails:
additionalProperties:
type: string
description: 'The additional details of the external DB node defined in `{"key": "value"}` format.
Example: `{"bar-key": "value"}`
'
type: object
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external DB node.
type: string
cpuCoreCount:
description: The number of CPU cores available on the DB node.
format: float
type: number
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
displayName:
description: The user-friendly name for the external DB node. The name does not have to be unique.
type: string
domainName:
description: Name of the domain.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the DB node is a part of.
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
hostName:
description: The host name for the DB node.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB node.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
memorySizeInGBs:
description: The total memory in gigabytes (GB) on the DB node.
format: float
type: number
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external DB node was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB node was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
ExternalClusterCollection:
description: A collection of external clusters.
properties:
items:
description: An array of external clusters.
items:
$ref: '#/components/schemas/ExternalClusterSummary'
type: array
required:
- items
type: object
CloudServicedAsm:
description: The details of ASM serviced by a cloud listener.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud ASM resides.
type: string
displayName:
description: The user-friendly name for the cloud ASM. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud ASM.
type: string
required:
- id
- displayName
type: object
EnableCloudDbSystemStackMonitoringDetails:
allOf:
- $ref: '#/components/schemas/AssociatedServiceDetails'
- type: object
description: The details required to enable Stack Monitoring for a cloud DB system.
SystemPrivilegeSummary:
description: A Summary of system privileges.
properties:
adminOption:
description: Indicates whether the system privilege is granted with the ADMIN option (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
common:
description: 'Indicates how the system privilege was granted. Possible values:
YES if the system privilege is granted commonly (CONTAINER=ALL is used)
NO if the system privilege is granted locally (CONTAINER=ALL is not used)
'
enum:
- 'YES'
- 'NO'
type: string
inherited:
description: Indicates whether the granted system privilege is inherited from another container (YES) or not (NO).
enum:
- 'YES'
- 'NO'
type: string
name:
description: The name of a system privilege.
type: string
type: object
ExternalClusterVipConfiguration:
description: The details of the Virtual IP (VIP) address for a node in an external cluster.
properties:
address:
description: The VIP name or IP address.
type: string
networkNumber:
description: The network number from which VIPs are obtained.
type: integer
nodeName:
description: The name of the node with the VIP.
type: string
type: object
ExternalClusterInstance:
description: The details of an external cluster instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the cluster instance.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external cluster instance.
type: string
crsBaseDirectory:
description: The Oracle base location of Cluster Ready Services (CRS).
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
displayName:
description: The user-friendly name for the cluster instance. The name does not have to be unique.
type: string
externalClusterId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster that the cluster instance belongs to.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster instance is a part of.
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
hostName:
description: The name of the host on which the cluster instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external cluster instance.
enum:
- CREATING
- NOT_CONNECTED
- ACTIVE
- INACTIVE
- UPDATING
- DELETING
- DELETED
- FAILED
type: string
nodeRole:
description: The role of the cluster node.
enum:
- HUB
- LEAF
type: string
systemTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only string, integer and boolean types are supported.
'
type: object
description: 'Key-value pair representing 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
timeCreated:
description: The date and time the external cluster instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external cluster instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalClusterId
- externalDbSystemId
- lifecycleState
type: object
AwrDbSummary:
description: The AWR summary for a database.
properties:
awrDbId:
description: 'The internal ID of the database. The internal ID of the database is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs
'
type: string
containerId:
description: 'ID of the database container. The database container ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbSnapshotRanges
'
type: integer
dbName:
description: The name of the database.
type: string
dbUniqueName:
description: The unique name of the database.
type: string
dbVersion:
description: The version of the database.
type: string
firstSnapshotId:
description: 'The ID of the earliest snapshot. The snapshot ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
'
type: integer
instanceList:
description: The database instance numbers.
items:
type: integer
type: array
latestSnapshotId:
description: 'The ID of the latest snapshot. The snapshot ID is not the [OCID](/Content/General/Concepts/identifiers.htm).
It can be retrieved from the following endpoint:
/managedDatabases/{managedDatabaseId}/awrDbs/{awrDbId}/awrDbSnapshots
'
type: integer
snapshotCount:
description: The total number of snapshots.
format: int64
type: integer
snapshotIntervalInMin:
description: The interval time between snapshots (in minutes).
type: integer
snapshotTimezone:
description: The time zone of the snapshot.
type: string
srcDbId:
description: The internal ID of the database where the AWR snapshot data was collected.
type: string
srcDbName:
description: The name of the database where the AWR snapshot data was collected.
type: string
timeDbStartup:
description: The timestamp of the database startup.
format: date-time
type: string
timeFirstSnapshotBegin:
description: The start time of the earliest snapshot.
format: date-time
type: string
timeLatestSnapshotEnd:
description: The end time of the latest snapshot.
format: date-time
type: string
required:
- awrDbId
- dbName
type: object
ChangeExternalDbSystemCompartmentDetails:
description: The details required to change the compartment of an external DB system.
properties:
compartmentId:
description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the
compartment to move the external DB system to.
'
maxLength: 255
minLength: 1
type: string
required:
- compartmentId
type: object
EnableExternalDatabaseManagementDetails:
description: Detail to enable or disable database management. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.
properties:
connectorId:
description: OCID of External MySQL Database connector.
maxLength: 255
type: string
required:
- connectorId
type: object
TablespaceStorageSize:
description: Storage size.
properties:
size:
description: 'Storage size number in bytes, kilobytes, megabytes, gigabytes, or terabytes.
'
format: integer
type: number
unit:
description: 'Storage size unit: bytes, kilobytes, megabytes, gigabytes, or terabytes.
'
enum:
- BYTES
- KILOBYTES
- MEGABYTES
- GIGABYTES
- TERABYTES
type: string
required:
- size
type: object
OptimizerStatisticsAdvisorExecution:
allOf:
- $ref: '#/components/schemas/OptimizerStatisticsAdvisorExecutionSummary'
- required:
- database
- report
- properties:
database:
$ref: '#/components/schemas/OptimizerDatabase'
report:
$ref: '#/components/schemas/OptimizerStatisticsAdvisorExecutionReport'
description: 'The summary of the Optimizer Statistics Advisor execution, which includes information about the Managed Database
and a comprehensive execution report.
'
AwrDbWaitEventBucketCollection:
allOf:
- $ref: '#/components/schemas/AwrQueryResult'
- discriminator:
propertyName: AWRDB_EVENT_HISTOGRAM_SET
properties:
items:
description: A list of AWR wait event buckets.
items:
$ref: '#/components/schemas/AwrDbWaitEventBucketSummary'
type: array
totalWaits:
description: The total waits of the database.
format: int64
type: integer
description: The percentage distribution of waits in the AWR wait event buckets.
type: object
ExternalAsmSummary:
description: The summary of an external ASM.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external ASM.
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
displayName:
description: The user-friendly name for the external ASM. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the ASM is a part of.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external ASM.
type: string
x-obmcs-enumref: '#/definitions/ExternalAsm/lifecycleState'
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
timeCreated:
description: The date and time the external ASM was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external ASM was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
PatchInstruction:
description: A single instruction to be included as part of Patch request content.
discriminator:
propertyName: operation
properties:
operation:
description: The type of operation.
enum:
- MERGE
type: string
selection:
description: 'The set of values to which the operation applies as a [JMESPath expression](https://jmespath.org/specification.html) for evaluation against the context resource.
An operation fails if the selection yields an exception, except as otherwise specified.
Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.
'
type: string
required:
- operation
- selection
TestNamedCredentialDetails:
description: The The [OCID](/Content/General/Concepts/identifiers.htm) of the database against which the credential is to be tested.
properties:
managedDatabaseId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Managed Database.
type: string
type: object
CloudAsmDiskGroupCollection:
description: A collection of cloud ASM disk groups.
properties:
items:
description: An array of cloud ASM disk groups.
items:
$ref: '#/components/schemas/CloudAsmDiskGroupSummary'
type: array
required:
- items
type: object
ExternalAsmInstanceSummary:
description: The summary of an external ASM instance.
properties:
adrHomeDirectory:
description: The Automatic Diagnostic Repository (ADR) home directory for the ASM instance.
type: string
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external ASM instance.
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
displayName:
description: The user-friendly name for the ASM instance. The name does not have to be unique.
type: string
externalAsmId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM that the ASM instance belongs to.
type: string
externalDbNodeId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB node on which the ASM instance is running.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the ASM instance is a part of.
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
hostName:
description: The name of the host on which the ASM instance is running.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external ASM instance.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external ASM instance.
type: string
x-obmcs-enumref: '#/definitions/ExternalAsmInstance/lifecycleState'
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
timeCreated:
description: The date and time the external ASM instance was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external ASM instance was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalAsmId
- externalDbSystemId
- lifecycleState
type: object
ExternalClusterSummary:
description: The summary of an external cluster.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external cluster.
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
displayName:
description: The user-friendly name for the external cluster. The name does not have to be unique.
type: string
externalConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external connector.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the cluster is a part of.
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
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external cluster.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external cluster.
type: string
x-obmcs-enumref: '#/definitions/ExternalCluster/lifecycleState'
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
timeCreated:
description: The date and time the external cluster was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external cluster was last updated.
format: date-time
type: string
required:
- id
- displayName
- componentName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
WorkRequestErrorCollection:
description: 'The results of a work request error search. This contains WorkRequestError items and other data.
'
properties:
items:
description: A collection of work request errors.
items:
$ref: '#/components/schemas/WorkRequestError'
type: array
required:
- items
type: object
OpenAlertSummary:
description: An alert from the Exadata storage server.
properties:
message:
description: The alert message.
type: string
severity:
description: The severity of the alert.
enum:
- CLEAR
- INFO
- WARNING
- CRITICAL
type: string
x-obmcs-top-level-enum: '#/definitions/AlertSeverityEnum'
timeStartAt:
description: The start time of the alert.
format: date-time
type: string
type:
description: The type of alert.
enum:
- STATEFUL
- STATELESS
type: string
x-obmcs-top-level-enum: '#/definitions/AlertTypeEnum'
type: object
ManagedDatabaseCollection:
description: A collection of Managed Database objects.
properties:
items:
description: An array of ManagedDatabaseSummary resources.
items:
$ref: '#/components/schemas/ManagedDatabaseSummary'
type: array
required:
- items
type: object
ExternalListenerServicedDatabase:
allOf:
- $ref: '#/components/schemas/ExternalServicedDatabase'
description: The details of a database serviced by an external listener.
MetricDataPoint:
description: The metric values with dimension details.
properties:
dimensions:
description: The dimensions of the metric.
items:
$ref: '#/components/schemas/MetricDimensionDefinition'
type: array
unit:
description: The unit of the metric value.
type: string
value:
description: The value of the metric.
format: double
type: number
type: object
TopSqlCpuActivity:
description: A list of SQL IDs with most CPU activity.
properties:
activity:
description: A list of sql CPU activity.
items:
$ref: '#/components/schemas/SqlCpuActivity'
type: array
required:
- activity
type: object
ConfigureAutomaticCaptureFiltersDetails:
description: 'The details required to configure automatic capture filters.
It takes either credentials or databaseCredential. It''s recommended to provide databaseCredential
'
properties:
autoCaptureFilters:
description: The filters used in automatic initial plan capture.
items:
$ref: '#/components/schemas/AutomaticCaptureFilterDetails'
type: array
credentials:
$ref: '#/components/schemas/ManagedDatabaseCredential'
databaseCredential:
$ref: '#/components/schemas/DatabaseCredentialDetails'
required:
- autoCaptureFilters
type: object
ExternalDbHomeSummary:
description: The summary of an external database home.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
type: string
componentName:
description: The name of the external DB home.
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
displayName:
description: The user-friendly name for the external DB home. The name does not have to be unique.
type: string
externalDbSystemId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB system that the DB home is a part of.
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
homeDirectory:
description: The location of the DB home.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the external DB home.
type: string
lifecycleDetails:
description: Additional information about the current lifecycle state.
type: string
lifecycleState:
description: The current lifecycle state of the external DB home.
type: string
x-obmcs-enumref: '#/definitions/ExternalDbHome/lifecycleState'
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
timeCreated:
description: The date and time the external DB home was created.
format: date-time
type: string
timeUpdated:
description: The date and time the external DB home was last updated.
format: date-time
type: string
required:
- id
- displayName
- compartmentId
- externalDbSystemId
- lifecycleState
- timeCreated
- timeUpdated
type: object
TimeSeriesMetricDefinition:
description: 'The response object representing time series metric details
for a specific Managed Database at a particular time.
'
properties:
datapoints:
description: The time series metric data for the given metric.
items:
$ref: '#/components/schemas/TimeSeriesMetricDataPoint'
type: array
metricName:
description: The name of the metric the time series data corresponds to.
type: string
required:
- metricName
- datapoints
type: object
CloudServicedDatabase:
description: The details of a database serviced by a cloud DB system component such as a listener or ASM.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the cloud database resides.
type: string
databaseSubType:
description: 'The subtype of Oracle Database. Indicates whether the database is a Container Database,
Pluggable Database, Non-container Database, Autonomous Database, or Autonomous Container Database.
'
enum:
- CDB
- PDB
- NON_CDB
- ACD
- ADB
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseSubType'
databaseType:
description: The type of Oracle Database installation.
enum:
- EXTERNAL_SIDB
- EXTERNAL_RAC
- CLOUD_SIDB
- CLOUD_RAC
- SHARED
- DEDICATED
- CLOUD_AT_CUSTOMER
type: string
x-obmcs-top-level-enum: '#/definitions/DatabaseType'
dbUniqueName:
description: The unique name of the cloud database.
type: string
dbaasId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the existing DBaas OCI resource matching the discovered DB system component.
type: string
displayName:
description: The user-friendly name for the database. The name does not have to be unique.
type: string
id:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cloud database.
type: string
isManaged:
description: Indicates whether the database is a Managed Database or not.
type: boolean
required:
- id
- dbaasId
- displayName
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