Oracle Cloud Infrastructure DB Systems API

openapi: 3.0.3
info:
  title: Oracle Cloud Compute Alarms DB Systems API
  description: Manage compute instances, images, shapes, and related resources in Oracle Cloud Infrastructure.
  version: '20160918'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  contact:
    name: Oracle Cloud Infrastructure
    url: https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API server
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociSignature: []
tags:
- name: DB Systems
paths:
  /dbSystems:
    get:
      operationId: listDbSystems
      summary: Oracle Cloud List DB Systems
      description: Gets a list of DB systems in the specified compartment.
      tags:
      - DB Systems
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      - name: limit
        in: query
        required: false
        description: Maximum number of items to return.
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DbSystemSummary'
              examples:
                ListDbSystems200Example:
                  summary: Default listDbSystems 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: my-resource
                    shape: VM.Standard.E4.Flex
                    lifecycleState: example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dbSystems/{dbSystemId}:
    get:
      operationId: getDbSystem
      summary: Oracle Cloud Get DB System
      description: Gets the specified DB system.
      tags:
      - DB Systems
      parameters:
      - name: dbSystemId
        in: path
        required: true
        description: The OCID of the DB system.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbSystem'
              examples:
                GetDbSystem200Example:
                  summary: Default getDbSystem 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.resource.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: my-resource
                    shape: VM.Standard.E4.Flex
                    availabilityDomain: Uocm:US-ASHBURN-AD-1
                    cpuCoreCount: 1
                    nodeCount: 1
                    dataStorageSizeInGBs: 1
                    databaseEdition: STANDARD_EDITION
                    lifecycleState: example-value
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    DbSystemSummary:
      type: object
      description: Summary of a DB system.
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: my-resource
        shape:
          type: string
          example: VM.Standard.E4.Flex
        lifecycleState:
          type: string
          example: example-value
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
    DbSystem:
      type: object
      description: A DB system.
      properties:
        id:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          example: my-resource
        shape:
          type: string
          example: VM.Standard.E4.Flex
        availabilityDomain:
          type: string
          example: Uocm:US-ASHBURN-AD-1
        cpuCoreCount:
          type: integer
          example: 1
        nodeCount:
          type: integer
          example: 1
        dataStorageSizeInGBs:
          type: integer
          example: 1
        databaseEdition:
          type: string
          enum:
          - STANDARD_EDITION
          - ENTERPRISE_EDITION
          - ENTERPRISE_EDITION_HIGH_PERFORMANCE
          - ENTERPRISE_EDITION_EXTREME_PERFORMANCE
          example: STANDARD_EDITION
        lifecycleState:
          type: string
          example: example-value
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys.