openapi: 3.2.0 info: description: "Use the OCI Database with PostgreSQL API to manage resources such as database systems, database nodes, backups, and configurations. \nFor information, see the user guide documentation for the [service](/iaas/Content/postgresql/home.htm).\n" title: PGSQL Control Plane Postgresql API version: '20220915' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/41c6596552822093c78c49e89c9267229a4c9622e08f0898a70c61c814f851d3.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the PGSQL Control Plane 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/41c6596552822093c78c49e89c9267229a4c9622e08f0898a70c61c814f851d3.yaml what: the harvested document for PGSQL Control Plane API servers: - url: https://127.0.0.1/20220915 tags: - name: postgresql paths: /backups: get: description: 'Returns a list of backups. ' operationId: ListBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/StartDateTimeQueryParam' - $ref: '#/components/parameters/EndDateTimeQueryParam' - $ref: '#/components/parameters/BackupLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/BackupIdentifierQueryParam' - $ref: '#/components/parameters/DbSystemIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of BackupSummary objects. headers: opc-next-page: description: 'For pagination of a list 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/BackupCollection' 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 all backups in a compartment tags: - postgresql x-related-resource: '#/definitions/BackupCollection' post: description: 'Creates a new backup. ' operationId: CreateBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The backup will be 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status. ' schema: type: string 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 backup. tags: - postgresql x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBackupDetails' description: Details for the new backup. required: true /backups/{backupId}: delete: description: Deletes a backup by identifier. operationId: DeleteBackup parameters: - $ref: '#/components/parameters/BackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The backup will be 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 work. You can use this to query its status. ' 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 a backup. tags: - postgresql x-related-resource: '#/definitions/Backup' get: description: Gets a backup by identifier. operationId: GetBackup parameters: - $ref: '#/components/parameters/BackupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the backup with the given ID. 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/Backup' 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 Backup tags: - postgresql x-related-resource: '#/definitions/Backup' put: description: Updates the backup. operationId: UpdateBackup parameters: - $ref: '#/components/parameters/BackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The backup was 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/Backup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the backup identified by the ID. tags: - postgresql x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBackupDetails' description: The information to be updated. required: true /backups/{backupId}/actions/changeCompartment: post: description: Moves a backup from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeBackupCompartment parameters: - $ref: '#/components/parameters/BackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The backup will be moved into a different compartment. 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 work. You can use this to query its status. ' schema: type: string 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: Moves a backup into a different compartment. tags: - postgresql x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeBackupCompartmentDetails' description: The information to be updated. required: true /backups/{backupId}/actions/copy: post: description: Backup Copy Request to copy back up in remote region. When provided, If-Match is checked against ETag values of the resource. operationId: BackupCopy parameters: - $ref: '#/components/parameters/BackupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the Backup copy request. 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 work. You can use this to query its status. ' schema: type: string 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: Backup Copy Request to copy back up in remote region tags: - postgresql x-related-resource: '#/definitions/Backup' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupCopyDetails' description: The information to be updated. required: true /configurations: get: description: 'Returns a list of configurations. ' operationId: ListConfigurations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/ConfigTypeQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DbVersionQueryParam' - $ref: '#/components/parameters/ComputeShapeQueryParam' - $ref: '#/components/parameters/ConfigurationIdentifierQueryParam' - $ref: '#/components/parameters/InstanceOcpuCountQueryParam' - $ref: '#/components/parameters/InstanceMemorySizeInGBsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ConfigSummary objects. headers: opc-next-page: description: 'For pagination of a list 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/ConfigurationCollection' 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 all configurations in a compartment. tags: - postgresql x-related-resource: '#/definitions/ConfigurationCollection' post: description: 'Creates a new configuration. ' operationId: CreateConfiguration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The configuration was created. 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/Configuration' 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 configuration. tags: - postgresql x-related-resource: '#/definitions/Configuration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConfigurationDetails' description: Details for the new configuration. required: true /configurations/{configurationId}: delete: description: Deletes a configuration by identifier. operationId: DeleteConfiguration parameters: - $ref: '#/components/parameters/ConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The configuration has been 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' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a configuration. tags: - postgresql x-related-resource: '#/definitions/Configuration' get: description: Gets a configuration by identifier. operationId: GetConfiguration parameters: - $ref: '#/components/parameters/ConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the configuration with the given ID. 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/Configuration' 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 a configuration. tags: - postgresql x-related-resource: '#/definitions/Configuration' put: description: 'Updates a display name or description of the configuration. ' operationId: UpdateConfiguration parameters: - $ref: '#/components/parameters/ConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The configuration was 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/Configuration' 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 display name or description of a configuration. tags: - postgresql x-related-resource: '#/definitions/Configuration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationDetails' description: Details for updating display name or description for a configuration. required: true /configurations/{configurationId}/actions/changeCompartment: post: description: Moves a configuration from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeConfigurationCompartment parameters: - $ref: '#/components/parameters/ConfigurationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '204': description: The configuration was successfully moved to another compartment. 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 '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: Moves a configuration into a different compartment. tags: - postgresql x-related-resource: '#/definitions/Configuration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeConfigurationCompartmentDetails' description: The information to be updated. required: true /dbSystems: get: description: 'Returns a list of database systems. ' operationId: ListDbSystems parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DbSystemIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of DbSystemSummary objects. headers: opc-next-page: description: 'For pagination of a list 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/DbSystemCollection' 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 all database systems in a compartment. tags: - postgresql x-related-resource: '#/definitions/DbSystemCollection' post: description: 'Creates a new database system. ' operationId: CreateDbSystem parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Created the database system. 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 work. You can use this to query its status. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DbSystem' 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 new database system. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDbSystemDetails' description: Details for the new database system. required: true /dbSystems/{dbSystemId}: delete: description: Deletes a database system by identifier. operationId: DeleteDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The database system will be 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 work. You can use this to query its status. ' 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 a database system. tags: - postgresql x-related-resource: '#/definitions/DbSystem' get: description: Gets a database system by identifier. operationId: GetDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ShowOverrideDbConfigQueryParam' responses: 200: description: Retrieves the database system with the given ID. 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/DbSystem' 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 DbSystem tags: - postgresql x-related-resource: '#/definitions/DbSystem' patch: description: Modifies the database system by adding or removing database instance nodes. operationId: PatchDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. Updates a database system. 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 work. You can use this to query its status. ' schema: type: string 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: Modifies the database system. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDbSystemDetails' description: The information to be modified. required: true put: description: Updates the database system. operationId: UpdateDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The database system will be 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 work. You can use this to query its status. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 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 database system identified by the ID. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDbSystemDetails' description: The information to be updated. required: true /dbSystems/{dbSystemId}/actions/changeCompartment: post: description: Moves a database system from one compartment to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeDbSystemCompartment parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The database system will be moved into a different compartment. 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 work. You can use this to query its status. ' schema: type: string 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: Moves a database system into a different compartment. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDbSystemCompartmentDetails' description: The information to be updated. required: true /dbSystems/{dbSystemId}/actions/failover: post: description: Runs a failover operation. Optionally, specify the desired AD for regions with three ADs. operationId: FailoverDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The service will run the failover operation. 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 work. You can use this to query its status. ' schema: type: string 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: Runs the manual failover operation. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/FailoverDbSystemDetails' description: The information to be updated. required: true /dbSystems/{dbSystemId}/actions/resetMasterUserPassword: post: description: Resets the database system's master password. operationId: ResetMasterUserPassword parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The database system master password reset request 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 work. You can use this to query its status. ' schema: type: string 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: Resets the database system's master password. tags: - postgresql x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResetMasterUserPasswordDetails' description: The information to be updated. required: true /dbSystems/{dbSystemId}/actions/restartDbInstance: post: description: Restarts the running database instance node. operationId: RestartDbInstanceInDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The database instance node will be restarted. 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 work. You can use this to query its status. ' schema: type: string 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: Restarts the database instance node. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestartDbInstanceInDbSystemDetails' description: Database instance node restart parameters. required: true /dbSystems/{dbSystemId}/actions/restore: post: description: Restore the database system. operationId: RestoreDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The database system will run the restore operation. 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 work. You can use this to query its status. ' schema: type: string 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: Restore the database system. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreDbSystemDetails' description: Database system restore parameters. required: true /dbSystems/{dbSystemId}/actions/start: post: description: Start the DB System. operationId: StartDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The DB System will be started. 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 work. You can use this to query its status. ' schema: type: string 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: Start the DB System. tags: - postgresql x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartDbSystemDetails' description: The information to be updated the DB System while starting DB System after stop. required: true /dbSystems/{dbSystemId}/actions/stop: post: description: Stop the DB System. operationId: StopDbSystem parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The DB System will be stopped. 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 work. You can use this to query its status. ' schema: type: string 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: Stop the DB System. tags: - postgresql x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/DbSystem' /dbSystems/{dbSystemId}/connectionDetails: get: description: Gets the database system connection details. operationId: GetConnectionDetails parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the database system with the given ID. 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/ConnectionDetails' 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 database system connection details. tags: - postgresql x-related-resource: '#/definitions/ConnectionDetails' /dbSystems/{dbSystemId}/dbinstances/{dbInstanceId}: put: description: Updates the database instance node. operationId: UpdateDbSystemDbInstance parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/DbInstanceIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The database instance node will be 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 work. You can use this to query its status. ' schema: type: string 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: Updates the database instance node. tags: - postgresql x-related-resource: '#/definitions/DbSystem' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDbSystemDbInstanceDetails' description: Database instance node update parameters. required: true /dbSystems/{dbSystemId}/primaryDbInstance: get: description: Gets the primary database instance node details. operationId: GetPrimaryDbInstance parameters: - $ref: '#/components/parameters/DbSystemIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the primary database instance node details. 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/PrimaryDbInstanceDetails' 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 primary database instance node details. tags: - postgresql x-related-resource: '#/definitions/DbSystem' /defaultConfigurations: get: description: 'Returns a list of default configurations. ' operationId: ListDefaultConfigurations parameters: - $ref: '#/components/parameters/ConfigLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DbVersionQueryParam' - $ref: '#/components/parameters/ComputeShapeQueryParam' - $ref: '#/components/parameters/InstanceOcpuCountQueryParam' - $ref: '#/components/parameters/InstanceMemorySizeInGBsQueryParam' - $ref: '#/components/parameters/ConfigurationIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of ConfigSummary objects. headers: opc-next-page: description: 'For pagination of a list 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/DefaultConfigurationCollection' 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 all default configurations. tags: - postgresql x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/DefaultConfigurationCollection' /defaultConfigurations/{defaultConfigurationId}: get: description: Gets a default configuration by identifier. operationId: GetDefaultConfiguration parameters: - $ref: '#/components/parameters/DefaultConfigurationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the default configuration with the given ID. 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/DefaultConfiguration' 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 default configuration. tags: - postgresql x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/DefaultConfiguration' /shapes: get: description: Returns the list of shapes allowed in the region. operationId: ListShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: A list of available database system shapes. headers: opc-next-page: description: 'For pagination of a list 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/ShapeCollection' 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 all possible database system shapes. tags: - postgresql x-obmcs-authz-declarations: authorizationRequired: false x-related-resource: '#/definitions/ShapeSummary' /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WorkRequestIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' responses: 200: description: The list of work request summaries. headers: opc-next-page: description: 'For pagination of a list 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/WorkRequestSummaryCollection' 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: - postgresql x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Gets details of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The details of the work request. 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 retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. schema: type: integer 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: - postgresql x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Returns a (paginated) list of errors for the work request with the given ID. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request errors. headers: opc-next-page: description: 'For pagination of a list 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: List work request errors tags: - postgresql x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Returns a (paginated) list of logs for the work request with the given ID. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For pagination of a list 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: List work request logs tags: - postgresql x-related-resource: '#/definitions/WorkRequestLogEntry' components: parameters: NameQueryParam: description: A filter to return the feature by the shape name. in: query name: id schema: type: string ConfigLifecycleStateQueryParam: description: A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Configuration/lifecycleState' schema: type: string 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. \nThe resource will be updated or deleted only if the etag you provide matches the resource's current etag value.\n" in: header name: if-match required: false schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC DefaultConfigurationIdentifierPathParam: description: A unique identifier for the configuration. in: path name: defaultConfigurationId required: true schema: type: string DbVersionQueryParam: description: Version of the PostgreSQL database, such as 14.9. in: query name: dbVersion x-default-description: 'null' schema: type: string DbSystemIdentifierPathParam: description: A unique identifier for the database system. in: path name: dbSystemId required: true schema: type: string InstanceOcpuCountQueryParam: description: The instance ocpu count for the configuration. in: query name: instanceOcpuCount x-default-description: 'null' schema: type: integer RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string LifecycleStateQueryParam: description: A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DbSystem/lifecycleState' schema: type: string SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated ResourceIdentifierQueryParam: description: The ID of the resource affected by the request. in: query name: resourceId x-default-description: 'null' schema: type: string WorkRequestStatusQueryParam: description: A filter to return only resources if their `lifecycleState` matches the given OperationStatus. in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED ComputeShapeQueryParam: description: 'The compute name of the shape for the configuration. ' in: query name: shape x-default-description: 'null' schema: type: string WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 ConfigurationIdentifierPathParam: description: A unique identifier for the configuration. in: path name: configurationId required: true schema: type: string BackupLifecycleStateQueryParam: description: A filter to return only resources if their `lifecycleState` matches the given `lifecycleState`. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Backup/lifecycleState' schema: type: string WorkRequestIdQueryParam: description: The ID of the asynchronous work request. in: query name: workRequestId x-default-description: 'null' schema: type: string WorkRequestLogAndErrorSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp InstanceMemorySizeInGBsQueryParam: description: The instance memory size in GBs for the configuration. in: query name: instanceMemorySizeInGBs x-default-description: 'null' schema: type: integer EndDateTimeQueryParam: description: The end date for getting backups. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string. in: query name: timeEnded x-default-description: 'null' schema: type: string format: date-time ConfigTypeQueryParam: description: A filter to return only resources if their `configType` matches the given `configType`. in: query name: configType required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Configuration/configType' schema: type: string DbInstanceIdentifierPathParam: description: A unique identifier for the database instance node. in: path name: dbInstanceId required: true schema: type: string 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, `retrytoken` could be expired or invalidated. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted ShowOverrideDbConfigQueryParam: description: A filter to exclude database configuration when this query parameter is set to OverrideDbConfig. in: query name: excludedFields x-default-description: 'null' style: form explode: true schema: type: array items: enum: - dbConfigurationParams type: string BackupIdentifierPathParam: description: A unique identifier for the backup. in: path name: backupId required: true schema: type: string DbSystemIdentifierQueryParam: description: A unique identifier for the database system. in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string BackupIdentifierQueryParam: description: A unique identifier for the backup. in: query name: backupId x-default-description: 'null' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 StartDateTimeQueryParam: description: The start date for getting backups. An [RFC 3339](https://tools.ietf.org/rfc/rfc3339) formatted datetime string. in: query name: timeStarted x-default-description: 'null' schema: type: string format: date-time ConfigurationIdentifierQueryParam: description: A unique identifier for the configuration. in: query name: configurationId x-default-description: 'null' schema: type: string schemas: Configuration: description: PostgreSQL configuration for a database system. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration. type: string compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array configType: description: The type of configuration. Either user-created or a default configuration. enum: - DEFAULT - CUSTOM - COPIED type: string configurationDetails: $ref: '#/components/schemas/ConfigurationDetails' dbVersion: description: Version of the PostgreSQL database. maxLength: 255 minLength: 1 type: string defaultConfigId: description: The Default configuration used for this configuration. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description for the configuration. type: string displayName: description: A user-friendly display name for the configuration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the configuration. Immutable on creation. type: string instanceMemorySizeInGBs: description: 'Memory size in gigabytes with 1GB increment. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer instanceOcpuCount: description: 'CPU core count. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer isFlexible: description: Whether the configuration supports flexible shapes. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the configuration. enum: - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string shape: description: "The name of the shape for the configuration. \n\nFor multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.\n" maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time that the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - instanceOcpuCount - instanceMemorySizeInGBs - shape - compatibleShapes - defaultConfigId - configType - lifecycleState - timeCreated - configurationDetails - dbVersion type: object CreateConfigurationDetails: description: The information to create a new configuration. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration. type: string compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array dbConfigurationOverrides: $ref: '#/components/schemas/DbConfigurationOverrideCollection' dbVersion: description: Version of the PostgreSQL database. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Details about the configuration set. type: string displayName: description: A user-friendly display name for the configuration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object instanceMemorySizeInGBs: description: 'Memory size in gigabytes with 1GB increment. Skip or set it''s value to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer instanceOcpuCount: description: 'CPU core count. Skip or set it''s value to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer isFlexible: default: false description: Whether the configuration supports flexible shapes. type: boolean shape: description: "The name of the shape for the configuration. \n\nFor multi-shape enabled configurations, it is set to PostgreSQL.X86 or similar. Please use compatibleShapes property to set the list of supported shapes.\n" type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - displayName - compartmentId - dbVersion - dbConfigurationOverrides 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 ConfigurationCollection: description: Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata. properties: items: description: List of configurations. items: $ref: '#/components/schemas/ConfigurationSummary' type: array required: - items type: object ManagementPolicyDetails: description: PostgreSQL database system management policy update details. properties: backupPolicy: $ref: '#/components/schemas/BackupPolicy' maintenanceWindowStart: description: 'The start of the maintenance window in UTC. This string is of the format: "{day-of-week} {time-of-day}". "{day-of-week}" is a case-insensitive string like "mon", "tue", &c. "{time-of-day}" is the "Time" portion of an RFC3339-formatted timestamp. Any second or sub-second time data will be truncated to zero. ' type: string type: object ResetMasterUserPasswordDetails: description: 'Password detail that will be used to reset the database system''s master user. These details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}. ' properties: passwordDetails: $ref: '#/components/schemas/PasswordDetails' required: - passwordDetails type: object DefaultConfigurationSummary: description: Summary of the configuration. properties: compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array dbVersion: description: Version of the PostgreSQL database. type: string displayName: description: A user-friendly display name for the configuration. type: string id: description: A unique identifier for the configuration. type: string instanceMemorySizeInGBs: description: 'Memory size in gigabytes with 1GB increment. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer instanceOcpuCount: description: 'CPU core count. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer isFlexible: description: True if the configuration supports flexible shapes, false otherwise. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the configuration. type: string x-obmcs-enumref: '#/definitions/DefaultConfiguration/lifecycleState' shape: description: "The name of the shape for the configuration. \n\nFor multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.\n" type: string timeCreated: description: 'The date and time that the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - lifecycleState - timeCreated - displayName - shape - instanceOcpuCount - instanceMemorySizeInGBs - compatibleShapes - dbVersion type: object UpdateDbSystemDetails: description: The information to be updated. properties: dbConfigurationParams: $ref: '#/components/schemas/UpdateDbConfigParams' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-provided description of the database system. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly display name for the database system. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object instanceMemorySizeInGBs: description: The total amount of memory available to each database system node, in gigabytes. minimum: 1 type: integer instanceOcpuCount: description: The total number of OCPUs available to each database system node. minimum: 1 type: integer managementPolicy: $ref: '#/components/schemas/ManagementPolicyDetails' networkDetails: $ref: '#/components/schemas/UpdateNetworkDetails' shape: description: 'The name of the shape for the database system nodes. Example: `VM.Standard.E4.Flex` ' maxLength: 255 minLength: 5 type: string storageDetails: $ref: '#/components/schemas/UpdateStorageDetailsParams' type: object WorkRequestSummaryCollection: description: Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata. properties: items: description: List of work requests. items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object ChangeConfigurationCompartmentDetails: description: The information to move a configuration to a different compartment. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the configuration will be moved. type: string required: - compartmentId type: object BackupCopyPolicy: description: Backup copy details properties: compartmentId: description: target compartment to place a new backup maxLength: 255 minLength: 1 type: string regions: description: List of region names of the remote region items: maxLength: 255 minLength: 1 type: string type: array retentionPeriod: description: Retention period in days of the backup copy. type: integer required: - compartmentId type: object WorkRequestSummary: description: A summary of the status of a work request. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The ID of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_POSTGRESQL_DB_SYSTEM - UPDATE_POSTGRESQL_DB_SYSTEM - DELETE_POSTGRESQL_DB_SYSTEM - MOVE_POSTGRESQL_DB_SYSTEM - CREATE_POSTGRESQL_DB_SYSTEM_BACKUP - UPDATE_POSTGRESQL_DB_SYSTEM_BACKUP - DELETE_POSTGRESQL_DB_SYSTEM_BACKUP - MOVE_POSTGRESQL_DB_SYSTEM_BACKUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the request was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted NetworkDetails: description: Network details for the database system. properties: isReaderEndpointEnabled: default: false description: Specifies if the reader endpoint is enabled on the dbSystem. type: boolean nsgIds: description: List of customer Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the database system. items: maxLength: 255 minLength: 1 type: string type: array primaryDbEndpointPrivateIp: description: 'Private IP in customer subnet. The value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses from the specified subnet. ' maxLength: 39 minLength: 7 type: string subnetId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the customer subnet associated with the database system. maxLength: 255 minLength: 1 type: string required: - subnetId type: object ShapeMemoryOptions: description: Options for the the shape memory properties: defaultPerOcpuInGBs: description: Default per OCPU configuration in GBs type: integer maxInGBs: description: Maximum Memory configuration in GBs type: integer maxPerOcpuInGBs: description: Maximum Memory configuration per OCPU in GBs type: integer minInGBs: description: Minimum Memory configuration in GBs type: integer minPerOcpuInGBs: description: Minimum Memory configuration per OCPU in GBs type: integer required: - defaultPerOcpuInGBs - minInGBs - minPerOcpuInGBs - maxInGBs - maxPerOcpuInGBs type: object DbInstanceEndpoint: description: The database instance node endpoint information. properties: dbInstanceId: description: Unique identifier of the database instance node. type: string endpoint: $ref: '#/components/schemas/Endpoint' required: - dbInstanceId - endpoint type: object ConfigurationSummary: description: Summary of the configuration. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the configuration. type: string compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array dbVersion: description: Version of the PostgreSQL database. type: string defaultConfigId: description: The Default configuration used for this configuration. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly display name for the configuration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration. Immutable on creation. type: string instanceMemorySizeInGBs: description: 'Memory size in gigabytes with 1GB increment. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer instanceOcpuCount: description: 'CPU core count. It''s value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer isFlexible: default: false description: Whether the configuration supports flexible shapes. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the configuration. type: string x-obmcs-enumref: '#/definitions/Configuration/lifecycleState' shape: description: "The name of the shape for the configuration. \n\nFor multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.\n" type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - shape - instanceOcpuCount - instanceMemorySizeInGBs - compatibleShapes - defaultConfigId - dbVersion type: object Backup: description: Database system backup information. properties: backupSize: description: The size of the backup, in gigabytes. type: integer compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup. type: string copyStatus: description: List of status for Backup Copy items: $ref: '#/components/schemas/BackupCopyStatusDetails' type: array dbSystemDetails: $ref: '#/components/schemas/DbSystemDetails' dbSystemId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup's source database system. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description for the backup. type: string displayName: description: A user-friendly display name for the backup. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup. type: string lastAcceptedRequestToken: description: lastAcceptedRequestToken from MP. type: string lastCompletedRequestToken: description: lastCompletedRequestToken from MP. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the backup. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED type: string retentionPeriod: description: Backup retention period in days. type: integer sourceBackupDetails: $ref: '#/components/schemas/SourceBackupDetails' sourceType: description: Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location. enum: - SCHEDULED - MANUAL - COPIED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the backup request was received, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeCreatedPrecise: description: 'The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the backup was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags - backupSize - dbSystemDetails type: object UpdateConfigurationDetails: description: The information to update a configuration. properties: compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Details about the configuration set. type: string displayName: description: A user-friendly display name for the configuration. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object CreateDbSystemDetails: description: The information about new database system. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system. maxLength: 255 minLength: 1 type: string configId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system. maxLength: 255 minLength: 1 type: string credentials: $ref: '#/components/schemas/Credentials' dbVersion: description: Version of database system software. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user-provided description of a database system. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly display name for the database system. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object instanceCount: default: 1 description: 'Count of database instances nodes to be created in the database system. ' minimum: 1 type: integer instanceMemorySizeInGBs: description: The total amount of memory available to each database instance node, in gigabytes. minimum: 1 type: integer instanceOcpuCount: description: The total number of OCPUs available to each database instance node. minimum: 1 type: integer instancesDetails: description: 'Details of database instances nodes to be created. This parameter is optional. If specified, its size must match `instanceCount`. ' items: $ref: '#/components/schemas/CreateDbInstanceDetails' type: array managementPolicy: $ref: '#/components/schemas/ManagementPolicyDetails' networkDetails: $ref: '#/components/schemas/NetworkDetails' shape: description: 'The name of the shape for the database instance node. Use the /shapes API for accepted shapes. Example: `VM.Standard.E4.Flex` ' maxLength: 255 minLength: 5 type: string source: $ref: '#/components/schemas/SourceDetails' storageDetails: $ref: '#/components/schemas/StorageDetails' systemType: description: Type of the database system. type: string x-obmcs-enumref: '#/definitions/DbSystem/systemType' required: - displayName - compartmentId - storageDetails - networkDetails - shape - credentials type: object UpdateStorageDetailsParams: description: Storage details of the database system. properties: iops: description: 'Guaranteed input/output storage requests per second (IOPS) available to the database system. Only valid for `OCI_OPTIMIZED_STORAGE` database system type. ' format: int64 type: integer type: object ShapeCollection: description: The list of shapes that can be used to create a database system. properties: items: description: List of supported shapes. items: $ref: '#/components/schemas/ShapeSummary' type: array required: - items type: object Credentials: description: 'Initial database system credentials that the database system will be provisioned with. The password details are not visible on any subsequent operation, such as GET /dbSystems/{dbSystemId}. ' properties: passwordDetails: $ref: '#/components/schemas/PasswordDetails' username: description: The database system administrator username. maxLength: 255 minLength: 1 type: string required: - username - passwordDetails type: object BackupCopyDetails: description: Backup Copy details properties: compartmentId: description: target compartment to place a new backup maxLength: 255 minLength: 1 type: string regions: description: List of region names of the remote regions items: maxLength: 255 minLength: 1 type: string type: array retentionPeriod: description: Retention period in days of the backup copy. type: integer required: - compartmentId - regions type: object DefaultConfigurationCollection: description: Results of a configuration search. Contains the ConfigurationSummary items and other information, such as metadata. properties: items: description: List of configurations. items: $ref: '#/components/schemas/DefaultConfigurationSummary' type: array required: - items type: object UpdateBackupDetails: description: The backup information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description for the backup. maxLength: 2000 minLength: 1 type: string displayName: description: A user-friendly display name for the backup. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionPeriod: description: Backup retention period in days. type: integer type: object DefaultConfigParams: description: Default database configuration. properties: allowedValues: description: Range or list of allowed values. type: string configKey: description: The configuration variable name. type: string dataType: description: Data type of the variable. type: string defaultConfigValue: description: Default value for the variable. type: string description: description: Details about the PostgreSQL variable. type: string isOverridable: default: false description: Whether the value can be overridden or not. type: boolean isRestartRequired: description: If true, modifying this configuration value will require a restart. type: boolean required: - configKey - defaultConfigValue - allowedValues - isRestartRequired - dataType - isOverridable - description type: object ConnectionDetails: description: Database system connection information. Used to connect to PostgreSQL instance(s). properties: caCertificate: description: "The CA certificate to be used by the PosgreSQL client to connect to the database.\nThe CA certificate is used to authenticate the server identity. \nIt is issued by PostgreSQL Service Private CA.\n" type: string instanceEndpoints: description: The list of database instance node endpoints in the database system. items: $ref: '#/components/schemas/DbInstanceEndpoint' type: array primaryDbEndpoint: $ref: '#/components/schemas/Endpoint' readerEndpoint: $ref: '#/components/schemas/Endpoint' required: - caCertificate - primaryDbEndpoint - instanceEndpoints type: object ConfigOverrides: description: Configuration overrides for a PostgreSQL instance. properties: configKey: description: Configuration variable name. type: string overridenConfigValue: description: User-selected variable value. type: string required: - configKey - overridenConfigValue type: object ConfigurationDetails: description: List of configuration details. properties: items: description: List of ConfigParms object. items: $ref: '#/components/schemas/ConfigParams' type: array required: - items type: object FailoverDbSystemDetails: description: Database system failover information. properties: ad: description: "The preferred AD for regions with three availability domains. This parameter is optional. \nIf not set, the AD will be chosen based on availability.\n" maxLength: 255 minLength: 1 type: string dbInstanceId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the database instance node. This parameter is optional. If not set, an existing database instance node will be chosen based on availability. ' maxLength: 255 minLength: 1 type: string type: object DbConfigurationOverrideCollection: description: Configuration overrides for a PostgreSQL instance. properties: items: description: List of configuration overridden values. items: $ref: '#/components/schemas/ConfigOverrides' type: array required: - items type: object BackupCollection: description: Results of a backup search. Contains the BackupSummary items and other information, such as metadata. properties: items: description: List of backups. items: $ref: '#/components/schemas/BackupSummary' type: array required: - items type: object DbInstance: description: Information about a database instance node. properties: availabilityDomain: description: The availability domain in which the database instance node is located. maxLength: 255 minLength: 1 type: string description: description: Description of the database instance node. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the database instance node. Avoid entering confidential information. type: string id: description: A unique identifier for the database instance node. Immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the database instance node. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string timeCreated: description: 'The date and time that the database instance node was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the database instance node was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - availabilityDomain - lifecycleState - timeCreated type: object DbSystemCollection: description: Results of a database system search. Contains both DbSystemSummary items and other information, such as metadata. properties: items: description: List of database systems. items: $ref: '#/components/schemas/DbSystemSummary' type: array required: - items type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - message - timestamp StorageDetails: description: Storage details of the database system. discriminator: propertyName: systemType properties: availabilityDomain: description: 'Specifies the availability domain of AD-local storage. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. ' maxLength: 255 minLength: 1 type: string isRegionallyDurable: default: false description: 'Specifies if the block volume used for the database system is regional or AD-local. If not specified, it will be set to false. If `isRegionallyDurable` is set to true, `availabilityDomain` should not be specified. If `isRegionallyDurable` is set to false, `availabilityDomain` must be specified. ' type: boolean systemType: description: Type of the database system. type: string x-obmcs-enumref: '#/definitions/DbSystem/systemType' required: - systemType - isRegionallyDurable type: object RestoreDbSystemDetails: description: Backup details to restore the database system. properties: ad: description: 'The desired AD for regions with three ADs. This parameter is optional. If not set, the AD is chosen based on the database system''s current AD. ' maxLength: 255 minLength: 1 type: string backupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the database system backup. maxLength: 255 minLength: 1 type: string required: - backupId type: object WorkRequest: description: An asynchronous work request. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used ' type: string id: description: The ID of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_POSTGRESQL_DB_SYSTEM - UPDATE_POSTGRESQL_DB_SYSTEM - DELETE_POSTGRESQL_DB_SYSTEM - MOVE_POSTGRESQL_DB_SYSTEM - CREATE_POSTGRESQL_DB_SYSTEM_BACKUP - UPDATE_POSTGRESQL_DB_SYSTEM_BACKUP - DELETE_POSTGRESQL_DB_SYSTEM_BACKUP - MOVE_POSTGRESQL_DB_SYSTEM_BACKUP type: string x-obmcs-top-level-enum: '#/definitions/OperationType' percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the request was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted CreateDbInstanceDetails: description: Information about the new database instance node. properties: description: description: A user-provided description of the database instance node. maxLength: 255 minLength: 1 type: string displayName: description: Display name of the database instance node. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string privateIp: description: 'Private IP in customer subnet that will be assigned to the database instance node. This value is optional. If the IP is not provided, the IP will be chosen from the available IP addresses in the specified subnet. ' maxLength: 39 minLength: 7 type: string type: object BackupPolicy: description: PostgreSQL database system backup policy. discriminator: propertyName: kind properties: copyPolicy: $ref: '#/components/schemas/BackupCopyPolicy' kind: description: The kind of backup policy. enum: - DAILY - WEEKLY - MONTHLY - NONE type: string retentionDays: description: How many days the data should be stored after the database system deletion. maximum: 35 minimum: 1 type: integer type: object SourceBackupDetails: description: Information about the Source Backup associated with a backup. properties: sourceBackupId: description: Backup ID of the COPY source type. type: string sourceRegion: description: Backup Region of the COPY source type. type: string required: - sourceRegion - sourceBackupId type: object ManagementPolicy: description: PostgreSQL database system management policy. properties: backupPolicy: $ref: '#/components/schemas/BackupPolicy' maintenanceWindowStart: description: 'The start of the maintenance window. ' type: string required: - maintenanceWindowStart - backupPolicy type: object PrimaryDbInstanceDetails: description: The primary database instance node details. properties: dbInstanceId: description: A unique identifier for the primary database instance node. maxLength: 255 minLength: 1 type: string required: - dbInstanceId type: object BackupSummary: description: Summary information for a backup. properties: backupSize: description: The size of the backup, in gigabytes. type: integer compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup. type: string copyStatus: description: List of status for Backup Copy items: $ref: '#/components/schemas/BackupCopyStatusDetails' type: array dbSystemId: description: The backup's source database system's [OCID](/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly display name for the backup. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the backup. Immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the backup. type: string x-obmcs-enumref: '#/definitions/Backup/lifecycleState' retentionPeriod: description: Backup retention period in days. type: integer sourceType: description: Specifies whether the backup was created manually, taken on schedule defined in the a backup policy, or copied from the remote location. type: string x-obmcs-enumref: '#/definitions/Backup/sourceType' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the backup was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeCreatedPrecise: description: 'The date and time the backup was created. This is the time the actual point-in-time data snapshot was taken, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the backup was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object Endpoint: description: Information about the database instance node endpoint. properties: fqdn: description: The FQDN of the endpoint. type: string ipAddress: description: The IP address of the endpoint. type: string port: description: The port address of the endpoint. maximum: 65535 minimum: 1 type: integer required: - fqdn - port type: object WorkRequestResource: description: A resource 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. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS - RELATED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/ActionType' entityType: description: The resource type that the work request affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string metadata: additionalProperties: type: string description: Additional information that helps to explain the resource. enum: - IS_DRY_RUN type: object x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey' required: - actionType - entityType - identifier RestartDbInstanceInDbSystemDetails: description: Database instance node restart parameters. properties: dbInstanceId: description: A unique identifier for the database instance, or node. maxLength: 255 minLength: 1 type: string restartType: default: NORMAL description: The restart type for the database instance. enum: - NORMAL - NODE_REBOOT type: string required: - dbInstanceId - restartType type: object DbSystemDetails: description: Information about the database system associated with a backup. properties: configId: description: OCID of the configuration that was applied on the source dbSystem at the time when backup was taken. type: string dbVersion: description: The major and minor versions of the database system software. type: string systemType: description: Type of the database system. type: string x-obmcs-enumref: '#/definitions/DbSystem/systemType' required: - systemType - dbVersion type: object DbSystemSummary: description: Summary information about a database system. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system. type: string configId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system. maxLength: 255 minLength: 1 type: string dbVersion: description: Version of database system software. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: A user-friendly display name for the database system. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the database system. Immutable on creation. type: string instanceCount: description: Count of database instances, or nodes, in the database system. minimum: 1 type: integer instanceMemorySizeInGBs: description: The total amount of memory available to each database instance node, in gigabytes. minimum: 1 type: integer instanceOcpuCount: description: The total number of OCPUs available to each database instance node. minimum: 1 type: integer lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the database system. type: string x-obmcs-enumref: '#/definitions/DbSystem/lifecycleState' shape: description: 'The name of the shape for the database instance node. Example: `VM.Standard.E4.Flex` ' maxLength: 255 minLength: 5 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object systemType: description: Type of the database system. type: string x-obmcs-enumref: '#/definitions/DbSystem/systemType' timeCreated: description: 'The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - systemType - instanceCount - instanceOcpuCount - instanceMemorySizeInGBs - dbVersion - freeformTags - definedTags type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: A machine-usable [code](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) for the error that occured. type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - code - message - timestamp UpdateDbConfigParams: description: Configuration for the PostgreSQL database instance. properties: applyConfig: default: RELOAD description: 'Whether a configuration update requires a restart of the database instance or a reload of the configuration. Some configuration changes require a restart of database instances to be applied. ' enum: - RESTART - RELOAD type: string configId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration. maxLength: 255 minLength: 1 type: string required: - configId type: object UpdateDbSystemDbInstanceDetails: description: Database instance node update parameters. properties: description: description: A user-provided description of the database instance node. maxLength: 255 minLength: 1 type: string displayName: description: A user-friendly display name of the database instance node. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string type: object PasswordDetails: description: 'Details for the database system password. Password can be passed as `VaultSecretPasswordDetails` or `PlainTextPasswordDetails`. ' discriminator: propertyName: passwordType properties: passwordType: description: The password type. enum: - PLAIN_TEXT - VAULT_SECRET type: string required: - passwordType SourceDetails: description: The source of the database system. discriminator: propertyName: sourceType properties: sourceType: description: 'The source descriminator. ' enum: - BACKUP - NONE type: string required: - sourceType type: object DbSystem: description: Information about a database system. properties: adminUsername: description: The database system administrator username. maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the database system. type: string configId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the configuration associated with the database system. maxLength: 255 minLength: 1 type: string dbVersion: description: The major and minor versions of the database system software. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description of the database system. maxLength: 400 minLength: 1 type: string displayName: description: A user-friendly display name for the database system. Avoid entering confidential information. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A unique identifier for the database system. Immutable on creation. type: string instanceCount: description: Count of instances, or nodes, in the database system. minimum: 1 type: integer instanceMemorySizeInGBs: description: The total amount of memory available to each database instance node, in gigabytes. minimum: 1 type: integer instanceOcpuCount: description: The total number of OCPUs available to each database instance node. minimum: 1 type: integer instances: description: The list of instances, or nodes, in the database system. items: $ref: '#/components/schemas/DbInstance' type: array lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the database system. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED - NEEDS_ATTENTION type: string managementPolicy: $ref: '#/components/schemas/ManagementPolicy' networkDetails: $ref: '#/components/schemas/NetworkDetails' shape: description: 'The name of the shape for the database instance. Example: `VM.Standard.E4.Flex` ' maxLength: 255 minLength: 5 type: string source: $ref: '#/components/schemas/SourceDetails' storageDetails: $ref: '#/components/schemas/StorageDetails' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object systemType: description: Type of the database system. enum: - OCI_OPTIMIZED_STORAGE type: string timeCreated: description: 'The date and time that the database system was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time that the database system was updated, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - dbVersion - systemType - networkDetails - storageDetails - shape - instanceOcpuCount - instanceMemorySizeInGBs - managementPolicy type: object DefaultConfiguration: description: Default configurations for PostgreSQL database systems. properties: compatibleShapes: description: 'Indicates the collection of compatible shapes for this configuration. ' items: maxLength: 255 minLength: 1 type: string type: array configurationDetails: $ref: '#/components/schemas/DefaultConfigurationDetails' dbVersion: description: Version of the PostgreSQL database. type: string description: description: A description for the configuration. type: string displayName: description: A user-friendly display name for the configuration. type: string id: description: A unique identifier for the configuration. type: string instanceMemorySizeInGBs: description: 'Memory size in gigabytes with 1GB increment. Its value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer instanceOcpuCount: description: 'CPU core count. Its value is set to 0 if configuration is for a flexible shape. ' minimum: 0 type: integer isFlexible: description: True if the configuration supports flexible shapes, false otherwise. type: boolean lifecycleDetails: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the configuration. enum: - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string shape: description: "The name of the shape for the configuration. \n\nFor multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.\n" maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time that the configuration was created, expressed in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - displayName - shape - instanceOcpuCount - instanceMemorySizeInGBs - compatibleShapes - lifecycleState - timeCreated - configurationDetails - dbVersion type: object StartDbSystemDetails: description: DB System start parameters to update ocpu, memory, shape and configuration. properties: configId: description: 'The updated configId for the database system. ' maxLength: 255 minLength: 5 type: string instanceMemorySizeInGBs: description: The total amount of memory available to each database system node, in gigabytes. minimum: 1 type: integer instanceOcpuCount: description: The total number of OCPUs available to each database system node. minimum: 1 type: integer shape: description: 'The name of the shape for the database system nodes. Example: `VM.Standard.E4.Flex` ' maxLength: 255 minLength: 5 type: string type: object ChangeBackupCompartmentDetails: description: The information used to move a backup to a different compartment. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the backup will be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object DefaultConfigurationDetails: description: List of default configuration values for databases. properties: items: description: List of ConfigParms object. items: $ref: '#/components/schemas/DefaultConfigParams' type: array required: - items type: object PatchInstruction: description: A single instruction to be included as part of Patch request content. discriminator: propertyName: operation properties: operation: enum: - REQUIRE - PROHIBIT - REPLACE - INSERT - REMOVE - MOVE - 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 CreateBackupDetails: description: The information to create a new backup. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains the backup. maxLength: 255 minLength: 1 type: string dbSystemId: description: The ID of the database system. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description for the backup. maxLength: 2000 minLength: 1 type: string displayName: description: A user-friendly display name for the backup. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object retentionPeriod: description: Backup retention period in days. type: integer required: - displayName - compartmentId - dbSystemId type: object PatchDbSystemDetails: description: "For adding read replica database instances, the operation is INSERT and value object to specify is \n#/definitions/CreateDbInstanceDetails.\nFor removing read replica database instances, the operation is REMOVE and value object needs to be an array of dbInstanceId's.\n" properties: items: description: List of patch instructions. items: $ref: '#/components/schemas/PatchInstruction' type: array type: object WorkRequestErrorCollection: description: Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata. properties: items: description: List of work request errors. items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object UpdateNetworkDetails: description: Network details for the database system. properties: isReaderEndpointEnabled: default: false description: Specifies if the reader endpoint is enabled on the dbSystem. type: boolean nsgIds: description: List of Network Security Group [OCIDs](/Content/General/Concepts/identifiers.htm) associated with the database system. items: maxLength: 255 minLength: 1 type: string type: array type: object ConfigParams: description: Database configuration. properties: allowedValues: description: Range or list of allowed values. type: string configKey: description: The configuration variable name. type: string dataType: description: Data type of the variable. type: string defaultConfigValue: description: Default value for the configuration variable. type: string description: description: Details about the PostgreSQL parameter. type: string isOverridable: default: false description: Whether the value can be overridden or not. type: boolean isRestartRequired: description: If true, modifying this configuration value will require a restart of the database. type: boolean overridenConfigValue: description: User-selected configuration variable value. type: string required: - configKey - defaultConfigValue - allowedValues - isRestartRequired - dataType - isOverridable - description type: object BackupCopyStatusDetails: description: Backup Copy Status details properties: backupId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup in the source region maxLength: 255 minLength: 1 type: string region: description: Region name of the remote region maxLength: 255 minLength: 1 type: string state: description: Copy States enum: - NOT_STARTED - COPYING - COPIED - FAILED type: string stateDetails: description: A message describing the current state of copy in more detail type: string required: - region type: object ChangeDbSystemCompartmentDetails: description: Change database system compartment operation details. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the database system should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ShapeOcpuOptions: description: Options for the the shape OCPU properties: max: description: Maximum OCPU configuration type: integer min: description: Minimum OCPU configuration type: integer required: - min - max type: object ShapeSummary: description: Summary of the database system shape. properties: id: description: A unique identifier for the shape. type: string isFlexible: description: Indicates if the shape is a flex shape. type: boolean memorySizeInGBs: description: The amount of memory in gigabytes. minimum: 1 type: integer ocpuCount: description: The number of OCPUs. minimum: 1 type: integer shape: description: 'The name of the Compute VM shape. Example: `VM.Standard.E4.Flex` ' type: string shapeMemoryOptions: $ref: '#/components/schemas/ShapeMemoryOptions' shapeOcpuOptions: $ref: '#/components/schemas/ShapeOcpuOptions' required: - shape - ocpuCount - memorySizeInGBs type: object WorkRequestLogEntryCollection: description: Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata. properties: items: description: List of work request log entries. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list 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 work. You can use this to query its status. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.psql.control