openapi: 3.2.0
info:
  description: Use the Globally Distributed Database service APIs to create and manage the Globally distributed databases.
  title: Globally Distributed Database Distributed Db Service API
  version: '20250101'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Globally Distributed Database 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/7768559c5720cb1b8396abdb1463b1ad39f9b837f25af9d8852377ad772e93bf.yaml
    what: the harvested document for Globally Distributed Database
servers:
- url: https://127.0.0.1/20250101
tags:
- name: DistributedDbService
paths:
  /distributedDatabases:
    get:
      description: 'List of Globally distributed databases.

        '
      operationId: ListDistributedDatabases
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PrivateEndpointIdQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DistributedDatabaseDisplayNameQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseDbDeploymentTypeQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseMetadata'
      responses:
        200:
          description: A page of Globally distributed database objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabaseCollection'
        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 of Globally distributed databases.
      tags:
      - DistributedDbService
      x-example: 'GET /20250101/distributedDatabases?compartmentId=<compartmentId>

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a Globally distributed database.

        '
      operationId: CreateDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The Globally distributed database resource creation request is accepted and being processed.
          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/DistributedDatabase'
        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: Create a Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n  \"databaseVersion\": \"23ai\",\n  \"displayName\": \"CreateSdb567\",\n  \"dbDeploymentType\": \"EXADB_XS\",\n  \"chunks\": 100,\n  \"listenerPort\": 6987,\n  \"onsPortLocal\": 6986,\n  \"replicationMethod\": \"RAFT\",\n  \"replicationFactor\": 3,\n  \"replicationUnit\": 8,\n  \"onsPortRemote\": 4889,\n  \"prefix\": \"yy9\",\n  \"shardingMethod\": \"SYSTEM\",\n  \"characterSet\": \"AL32UTF8\",\n  \"ncharacterSet\": \"AL16UTF16\",\n  \"privateEndpointIds\": [\"ocid1.osddistributeddbprivateendpoint.oc1.ap-mumbai-1.<unique_ID>\"],\n  \"shardDetails\": [{\n    \"adminPassword\": \"example-password\",\n    \"vmClusterId\": \"ocid1.exadbvmcluster.oc1.us-sanjose-1.<unique_ID>\",\n    \"kmsKeyId\": \"ocid1.key.oc1.us-sanjose-1.<unique_ID>\",\n    \"vaultId\": \"ocid1.vault.oc1.us-sanjose-1.<unique_ID>\",\n    \"source\": \"EXADB_XS\"      \n  },{\n    \"adminPassword\": \"example-password\",\n    \"vmClusterId\": \"ocid1.exadbvmcluster.oc1.us-sanjose-1.<unique_ID>\",\n    \"kmsKeyId\": \"ocid1.key.oc1.us-sanjose-1.<unique_ID>\",\n    \"vaultId\": \"ocid1.vault.oc1.us-sanjose-1.<unique_ID>\",\n    \"source\": \"EXADB_XS\"\n  },{\n    \"adminPassword\": \"example-password\",\n    \"vmClusterId\": \"ocid1.exadbvmcluster.oc1.us-sanjose-1.<unique_ID>\",\n    \"kmsKeyId\": \"ocid1.key.oc1.us-sanjose-1.<unique_ID>\",\n    \"vaultId\": \"ocid1.vault.oc1.us-sanjose-1.<unique_ID>\",\n    \"source\": \"EXADB_XS\"\n  }],\n  \"catalogDetails\": [{\n    \"adminPassword\": \"example-password\",\n    \"kmsKeyId\": \"ocid1.key.oc1.us-sanjose-1.<unique_ID>\",\n    \"vaultId\":   \"ocid1.vault.oc1.us-sanjose-1.<unique_ID>\",\n    \"vmClusterId\": \"ocid1.exadbvmcluster.oc1.us-sanjose-1.<unique_ID>\",\n    \"source\": \"EXADB_XS\"      \n  }]\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDistributedDatabaseDetails'
        description: Details of the Globally distributed database to be created.
        required: true
  /distributedDatabases/{distributedDatabaseId}:
    delete:
      description: 'Terminate the given Globally distributed databases.

        For an EXADB_XS based distributed database, if the parameter mustDeleteInfra is set to true,

        then the VmCluster and DbStorageVault associated with each shard and catalog will also be deleted.

        '
      operationId: DeleteDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/DistributedDatabaseMustDeleteInfraQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: No Content
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Terminate the Globally distributed database identified by the identifier.
      tags:
      - DistributedDbService
      x-example: 'DELETE /20250101/distributedDatabases/{distributedDatabaseId}

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DistributedDatabase'
    get:
      description: 'Gets the details of the Globally distributed database identified by given id.

        '
      operationId: GetDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/DistributedDatabaseMetadata'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Details of Globally distributed database identified by the given ocid.
          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/DistributedDatabase'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets the details of the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'GET /20250101/distributedDatabases/{distributedDatabaseId}

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    patch:
      description: "Patch operation to add, remove or update shards to the Globally distributed database topology. In single patch\noperation, multiple shards can be either added, or removed or updated. Combination of inserts, update\nand remove in single operation is not allowed.\nFor an EXADB_XS based distributed database, removing a shard with the parameter mustDeleteInfra set to true \nwill also delete the associated VmCluster and DbStorageVault.\n"
      operationId: PatchDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the patch request. Patch instructions are being applied on the Globally distributed database.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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: Patch the configuration of Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "PATCH /20250101/distributedDatabases/{distributedDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nPATCH /20250101/distributedDatabases/{distributedDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"items\":\n  [\n    { \"operation\": \"REMOVE\", \"selection\": \"shardDetails[?name == 'dd300002v']\" }\n\n  ]\n}\n\nPATCH /20250101/distributedDatabases/{distributedDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n    \"items\": [\n        {\n            \"operation\": \"MERGE\",\n            \"selection\": \"catalogDetails[?name=='sol00000v']\",\n            \"value\": \" { \\\"dataStorageSizeInGbs\\\": 2048, \\\"recoStorageSizeInGbs\\\": 2048, \\\"cpuCoreCount\\\": 12,  \\\"source\\\": \\\"BASE_DB\\\" }\"\n        }\n    ]\n}\n\nPATCH /20250101/distributedDatabases/{distributedDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>        \n{\n    \"items\": [ { \"operation\": \"INSERT\",\n    \"selection\": \"shardDetails\",\n    \"value\": \"{ \\\"adminPassword\\\": \\\"example-password\\\", \\\"vaultId\\\": \\\"ocid1.exascaledbstoragevault.oc1.us-sanjose-1.<unique_ID>\\\", \\\"vmClusterId\\\": \\\"ocid1.exadbvmcluster.oc1.us-sanjose-1.<unique_ID>\\\",  \\\"source\\\": \\\"EXADB_XS\\\" }\"\n     } ]\n}\n"
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchDistributedDatabaseDetails'
        description: The payload containing instructions to patch the Globally distributed database.
        required: true
    put:
      description: 'Updates the configuration of the Globally distributed database.

        '
      operationId: UpdateDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The Globally distributed database update request is processed.
          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/DistributedDatabase'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates the configuration of the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "PUT /20250101/distributedDatabases/{distributedDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\nNOTE: Below is the payload for update Globally distributed database where display-name, along with tags are updated.\n{\n  \"displayName\": \"<new-display-name>\",\n  \"freeformTags\" : {\n    \"tagKey\" : \"value\"\n  },\n  \"definedTags\" : {\n    \"namespace\" : {\n      \"key\" : \"value\"\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDistributedDatabaseDetails'
        description: The configuration of the Globally distributed database to be updated.
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/addGdsControlNode:
    post:
      description: 'Add new Global database services control(GDS CTL) node for the Globally distributed database.

        '
      operationId: AddDistributedDatabaseGdsControlNode
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Request to create the new Global database services control(GDS CTL) node for the Globally distributed database is 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
        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: Add new Global database services control(GDS CTL) node for the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/addGdsControlNode\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"publicSshKey\" : \"ssh-rsa CCCCB3NzaC1yc2EAAAADAQABAAABAQDO7gE9zAgsAlN/RyBV+OEdB6Pv8vTwdS5K3WvqiXK9hWCtoR2siam9jZ1MOueddedwwdwdwddwwdwdwdw\",\n  \"subnetId\": \"ocid1.subnet.oc1.iad.aaaaaaaart2zrqsfn36zdn4o2xxua6uwfqhestr5yysalkgzp46tvmterikq\"\n}\n"
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddDistributedDatabaseGdsControlNodeDetails'
        description: 'Details required to provision the new Global database services control(GDS CTL) node for the Distributed database.

          '
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/changeCompartment:
    post:
      description: 'Move the Globally distributed database and its dependent resources to the specified compartment.

        '
      operationId: ChangeDistributedDatabaseCompartment
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: The request was successfully received and the change compartment action is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: ChangeDistributedDatabaseCompartment
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/changeCompartment\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\"\n}\n"
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDistributedDatabaseCompartmentDetails'
        description: Request to move the Globally distributed database to a different compartment.
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/changeDbBackupConfig:
    post:
      description: 'Change the DbBackupConfig for the Globally distributed database.

        '
      operationId: ChangeDistributedDbBackupConfig
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Request to change the DbBackupConfig for the Globally distributed database is 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
        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: Change the DbBackupConfig details for the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/changeDbBackupConfig

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeDistributedDbBackupConfigDetails'
        description: Details of the DistributedDbBackupConfig for the Globally distributed database.
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/configureGsms:
    post:
      description: 'Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.

        '
      operationId: ConfigureDistributedDatabaseGsms
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request was successfully received and the configure gsms action is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Configure GSMs for the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/configureGsms\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"oldGsmNames\": [\"abc00001\", \"abc00002\"],\n  \"isLatestGsmImage\": false\n}\n"
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigureDistributedDatabaseGsmsDetails'
        description: Details to configure the new GSM instances for the distributed database.
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/configureSharding:
    post:
      description: 'Once all components of Globally distributed database are provisioned, and signed GSM certificates are successfully uploaded, this

        api shall be invoked to configure sharding on the Globally distributed database. Note that this ''ConfigureSharding'' API also needs to be

        invoked after successfully adding a new shard to the Globally distributed database using PATCH api. If this API is not

        invoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology of

        the Globally distributed database.

        '
      operationId: ConfigureDistributedDatabaseSharding
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/DistributedDatabaseRebalanceQueryParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request was successfully received and the configure sharding action is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Configure sharding for the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/configureSharding

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/downloadGsmCertificateSigningRequest:
    post:
      description: 'Generate the common certificate signing request for GSMs. Download the <globaldb-prefix>.csr file from

        API response. Users can use this .csr file to generate the CA signed certificate, and as a next step

        use ''uploadSignedCertificateAndGenerateWallet'' API to upload the CA signed certificate to GSM, and

        generate wallets for the GSM instances of the Globally distributed database.

        '
      operationId: DownloadDistributedDatabaseGsmCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: Downloads certificate signing request in .csr format
          headers:
            content-length:
              description: Size of the file.
              schema:
                type: integer
                format: int64
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            last-modified:
              description: The date and time the certificate signing request was created.
              schema:
                type: string
                format: date-time
            opc-request-id:
              description: 'Unique 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/octet-stream:
              schema:
                format: binary
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Download the common certificate signing request for global service manager(GSM) instances of Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/downloadGsmCertificateSigningRequest

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/generateGsmCertificateSigningRequest:
    post:
      description: 'Generate the certificate signing request for GSM instances of the Globally distributed database. Once certificate signing

        request is generated, then customers can download the certificate signing request using

        ''downloadGsmCertificateSigningRequest'' api call.

        '
      operationId: GenerateDistributedDatabaseGsmCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/DistributedDatabaseCaBundleIdQueryParam'
      responses:
        202:
          description: 'Request to generate the certificate signing request for GSMs of the Globally distributed database is 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
        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: Generate the certificate signing request for global service manager(GSM) instances of the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/generateGsmCertificateSigningRequest

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/generateWallet:
    post:
      description: 'Generate the wallet associated with Globally distributed database.

        '
      operationId: GenerateDistributedDatabaseWallet
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: A wallet for the specified Globally distributed database is being retrieved.
          headers:
            content-length:
              description: Size of the file.
              schema:
                type: integer
                format: int64
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            last-modified:
              description: The date and time the wallet was created.
              schema:
                type: string
                format: date-time
            opc-request-id:
              description: 'Unique 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/octet-stream:
              schema:
                format: binary
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Generate the wallet associated with Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/generateWallet\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"password\": \"<password>\"\n}\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateDistributedDatabaseWalletDetails'
        description: Details for generating Globally distributed database wallet.
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/moveReplicationUnit:
    post:
      description: 'Move the replication units for RAFT based globally distributed database from source shard to destination shard.

        '
      operationId: MoveDistributedDatabaseReplicationUnit
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'The request is successfully received and the move replication unit operation is being performed which can be tracked

            by opc-work-request-id.

            '
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Move the replication units for RAFT based globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/moveReplicationUnit\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"sourceShardName\": \"abc00001td\",\n  \"destinationShardName\": \"abc00004td\",\n  \"replicationUnits\": [ 1 ]\n}\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveDistributedDatabaseReplicationUnitDetails'
        description: 'Details required to move the replication units from source shard to destination shard.

          '
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/recreateFailedResource:
    post:
      description: 'Recreate the failed resource for the Globally Distributed Database.

        '
      operationId: RecreateFailedDistributedDatabaseResource
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RecreateResourceNameQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseShardGroupQueryParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is successfully received and failed resource is being recreated which can be tracked by opc-work-request-id.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Recreate the failed resource for the Globally Distributed Database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/recreateFailedResource?resourceName=abc00001td&shardGroup=Shardgroupa

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/rotateDbPasswords:
    post:
      description: Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database.  This operation will also remove GdsCtlNodes if present.
      operationId: RotateDistributedDatabasePasswords
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: The request was successfully received and the rotate database passwords action is being performed.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Rotate passwords for different components of the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/rotateDbPasswords

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/startDatabase:
    post:
      description: Start the shards, catalog and GSMs of Globally distributed database.
      operationId: StartDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request is accepted and the Globally distributed database is being 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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Start Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/startDatabase

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: START
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/stopDatabase:
    post:
      description: Stop the shards, catalog and GSM instances for the Globally distributed database.
      operationId: StopDistributedDatabase
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: The request is accepted and the stop operation is being performed for the Globally distributed database.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous 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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Stop Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/stopDatabase

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: STOP
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/actions/uploadSignedCertificateAndGenerateWallet:
    post:
      description: 'Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the

        Globally distributed database. Customer shall provide the CA signed certificate key details by adding the certificate

        in request body.

        '
      operationId: UploadDistributedDatabaseSignedCertificateAndGenerateWallet
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        202:
          description: 'Request to upload the CA signed certificate to GSMs and generate wallet for GSMs of the Globally distributed database

            is 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
        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: Upload the CA signed certificate for new GSM compute instances of the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: "POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/uploadSignedCertificateAndGenerateWallet\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"caSignedCertificate\" : \"-----BEGIN CERTIFICATE-----\\cmdnMIIBIjANBgkqhkiG9w0BAQEFA...AOCAQ8AMIIBCgKCAQEA7hglbuGudIO3sgoAa1n/\\nHgUdIGeQmwf/QIv3Y0nOEP4TB7rbdCH99oJYzF86M2\\nmwIDAQAB\\n-----END CERTIFICATE-----\"\n}\n"
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadDistributedDatabaseSignedCertificateAndGenerateWalletDetails'
        description: 'Details required to upload the CA signed certificates to GSM instances of Globally distributed database and generate

          the wallets.

          '
        required: true
  /distributedDatabases/{distributedDatabaseId}/actions/validateNetwork:
    post:
      description: 'Validate the network connectivity between components of the globally distributed database.

        '
      operationId: ValidateDistributedDatabaseNetwork
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/DistributedDatabaseIsSurrogateQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseResourceNameQueryParam'
      - $ref: '#/components/parameters/DistributedDatabaseShardGroupQueryParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: The request is successfully received and the network connectivity check is being performed which can be tracked by opc-work-request-id.
          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'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Validate the network connectivity for the globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'POST /20250101/distributedDatabases/{distributedDatabaseId}/actions/validateNetworks?resourceName=abc00001td

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-terraform:
        actionType: SPECIAL_UPDATE
      x-related-resource: '#/definitions/DistributedDatabase'
  /distributedDatabases/{distributedDatabaseId}/raftMetrics:
    get:
      description: 'Operation to retrieve RAFT metrics for the Globally distributed database. If the Globally distributed database is not

        RAFT based then empty response is returned from the API.

        '
      operationId: GetDistributedDatabaseRaftMetric
      parameters:
      - $ref: '#/components/parameters/DistributedDatabaseIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The Globally distributed database raft metrics response.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistributedDatabaseRaftMetric'
        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: Operation to retrieve RAFT metrics for the Globally distributed database.
      tags:
      - DistributedDbService
      x-example: 'Below is an example to run GetRaftMetrics api.

        GET /20250101/distributedDatabases/{distributedDatabaseId}/raftMetrics

        Host: globaldb.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DistributedDatabase'
components:
  parameters:
    DistributedDatabaseIdentifierPathParam:
      description: Globally distributed database identifier
      in: path
      name: distributedDatabaseId
      required: true
      schema:
        type: string
    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
      schema:
        type: string
        minLength: 1
    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
        - timeUpdated
        default: timeCreated
    DistributedDatabaseMustDeleteInfraQueryParam:
      description: The flag to indicate if infra like VmCluster & DbStorageVault associated with the resource should be deleted.
      in: query
      name: mustDeleteInfra
      required: false
      schema:
        type: boolean
        default: false
    PrivateEndpointIdQueryParam:
      description: A filter to return only resources that are associated with the given privateEndpointId.
      in: query
      name: privateEndpointId
      schema:
        type: string
    IfNoneMatchHeader:
      description: 'For conditional requests. In the GET call for a resource, set the

        `If-None-Match` header to the value of the ETag from a previous GET (or

        POST or PUT) response for that resource. The server will return with

        either a 304 Not Modified response if the resource has not changed, or a

        200 OK response with the updated representation.

        '
      in: header
      name: if-none-match
      required: false
      x-default-description: 'null'
      schema:
        type: string
    DistributedDatabaseMetadata:
      description: 'Comma separated names of argument corresponding to which metadata need to be retrived.

        '
      in: query
      name: metadata
      required: false
      x-default-description: 'null'
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      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.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    DistributedDatabaseRebalanceQueryParam:
      description: 'The flag to indicate whether chunks need to be re-balanced. This flag is not applicable for USER-defined

        sharding type.

        '
      in: query
      name: isRebalanceRequired
      required: false
      schema:
        type: boolean
        default: true
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    DistributedDatabaseCaBundleIdQueryParam:
      description: The ID of the Ca Bundle.
      in: query
      name: caBundleId
      required: true
      x-default-description: 'null'
      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
    RecreateResourceNameQueryParam:
      description: 'Specify the name of Shard, Catalog or GSM.

        '
      in: query
      name: resourceName
      required: true
      schema:
        type: string
    DistributedDatabaseShardGroupQueryParam:
      description: 'The shardGroup name example Shardgroupa, Shardgroupb.

        '
      in: query
      name: shardGroup
      required: false
      x-default-description: Shardgroupa
      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, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    DistributedDatabaseDisplayNameQueryParam:
      description: A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive.
      in: query
      name: displayName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    DistributedDatabaseIsSurrogateQueryParam:
      description: Determines the surrogates check. Default is true.
      in: query
      name: isSurrogate
      required: false
      schema:
        type: boolean
        default: true
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    DistributedDatabaseDbDeploymentTypeQueryParam:
      description: A filter to return only resources their dbDeploymentType matches the given dbDeploymentType.
      in: query
      name: dbDeploymentType
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/DistributedDatabase/dbDeploymentType'
      schema:
        type: string
    DistributedDatabaseResourceNameQueryParam:
      description: 'Specify the name of shard or catalog.

        '
      in: query
      name: resourceName
      required: false
      x-default-description: 'null'
      schema:
        type: string
    DistributedDatabaseLifecycleStateQueryParam:
      description: A filter to return only resources their lifecycleState matches the given lifecycleState.
      in: query
      name: lifecycleState
      required: false
      x-obmcs-enumref: '#/definitions/DistributedDatabase/lifecycleState'
      schema:
        type: string
  schemas:
    DistributedDatabaseCollection:
      description: Collection of Globally distributed databases.
      properties:
        items:
          description: Array of Globally distributed database summaries.
          items:
            $ref: '#/components/schemas/DistributedDatabaseSummary'
          type: array
      required:
      - items
      type: object
    DistributedDatabaseSummary:
      description: Globally distributed database.
      properties:
        characterSet:
          description: The character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        chunks:
          description: 'The default number of unique chunks in a shardspace. The value of chunks must be

            greater than 2 times the size of the largest shardgroup in any shardspace.

            '
          type: integer
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed database compartment.
          maxLength: 255
          minLength: 1
          type: string
        connectionStrings:
          $ref: '#/components/schemas/DistributedDbConnectionString'
        databaseVersion:
          description: Oracle Database version for the shards and catalog used in Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        dbDeploymentType:
          description: 'The distributed database deployment type.

            '
          enum:
          - EXADB_XS
          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: The display name of the Globally distributed database.
          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
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: The lifecycleDetails for the Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle state of sharded database.
          type: string
          x-obmcs-enumref: '#/definitions/DistributedDatabase/lifecycleState'
        listenerPort:
          description: The listener port number for the Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        listenerPortTls:
          description: The TLS listener port number for the Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        metadata:
          $ref: '#/components/schemas/DistributedDbMetadata'
        ncharacterSet:
          description: The national character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        onsPortLocal:
          description: Ons local port number for the Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        onsPortRemote:
          description: Ons remote port number for the Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        prefix:
          description: 'Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character

            has to be a letter followed by any combination of letter and number.

            '
          maxLength: 3
          minLength: 3
          pattern: '[a-z][a-z0-9][a-z0-9]'
          type: string
        privateEndpointIds:
          description: The collection of [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint associated with Globally distributed autonomous database.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 2
          minItems: 1
          type: array
        replicationFactor:
          description: 'The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.

            '
          maximum: 7
          minimum: 3
          type: integer
        replicationMethod:
          description: 'The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for

            DataGuard. If replicationMethod is not provided, it defaults to DG.

            '
          type: string
          x-obmcs-enumref: '#/definitions/DistributedDatabase/replicationMethod'
        replicationUnit:
          description: 'The replication unit count for RAFT based distributed database. For RAFT replication based

            Globally distributed database, the value should be at least twice the number of shards.

            '
          maximum: 1000
          minimum: 6
          type: integer
        shardingMethod:
          description: Sharding Methods for the Globally distributed database.
          type: string
          x-obmcs-enumref: '#/definitions/DistributedDatabase/shardingMethod'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the Globally distributed database was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - timeCreated
      - timeUpdated
      - lifecycleState
      - lifecycleDetails
      - databaseVersion
      - privateEndpointIds
      - prefix
      - shardingMethod
      - characterSet
      - ncharacterSet
      - listenerPort
      - onsPortLocal
      - onsPortRemote
      - dbDeploymentType
    DistributedDbGsmImage:
      description: The Global service manager image details
      properties:
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Global service manager software image.
          maxLength: 255
          minLength: 1
          type: string
        versionNumber:
          description: The version number associated with the image identified by id.
          minimum: 1
          type: integer
      required:
      - id
      - versionNumber
      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
    DistributedDatabaseRaftMetric:
      description: Raft metrics for shards and catalog for the Globally distributed database.
      properties:
        configTasks:
          additionalProperties:
            type: object
          description: Details of in-progress configuration tasks.
          maxProperties: 100
          type: object
        raftMetrics:
          additionalProperties:
            type: object
          description: Raft metrics for the Globally distributed database.
          type: object
      required:
      - raftMetrics
      type: object
    DistributedDatabaseCatalog:
      description: Globally distributed database catalog.
      discriminator:
        propertyName: source
      properties:
        name:
          description: The name of catalog.
          maxLength: 255
          minLength: 1
          type: string
        source:
          description: 'Type of Globally distributed database Shard or Catalog.

            Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

            Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

            EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

            '
          enum:
          - EXADB_XS
          - NEW_VAULT_AND_CLUSTER
          - EXISTING_CLUSTER
          type: string
        timeCreated:
          description: The time the catalog was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the catalog was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - source
      - name
      - timeCreated
      - timeUpdated
    DistributedDbMetadata:
      description: Additional metadata related to Globally distributed database resources.
      properties:
        map:
          additionalProperties:
            type: string
          description: The map containing key-value pair of additional metadata.
          type: object
    ConfigureDistributedDatabaseGsmsDetails:
      description: 'Details of the request to configure new global service manager(GSM) instances for the distributed database.

        '
      properties:
        isLatestGsmImage:
          description: 'Flag to indicate if new global service manager(GSM) instances shall use latest image or re-use image used by existing

            GSM instances.

            '
          type: boolean
        oldGsmNames:
          description: Names of old global service manager(GSM) instances corresponding to which new GSM instances need to be configured.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 250
          minItems: 1
          type: array
      required:
      - oldGsmNames
      - isLatestGsmImage
    DistributedDatabaseGsm:
      description: Details of global service manager(GSM also known as shard director) instances for the Globally distributed database.
      properties:
        computeCount:
          description: The compute count for the Global service manager instance.
          format: float
          minimum: 0.2
          type: number
        dataStorageSizeInGbs:
          description: The data disk group size to be allocated in GBs for the Global service manager instance.
          format: double
          minimum: 32
          type: number
        gsmImageDetails:
          $ref: '#/components/schemas/DistributedDbGsmImage'
        metadata:
          $ref: '#/components/schemas/DistributedDbMetadata'
        name:
          description: Name of the Global service manager instance
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: Status of the gsm.
          enum:
          - FAILED
          - DELETING
          - DELETED
          - UPDATING
          - CREATING
          - CREATED
          - READY_FOR_CONFIGURATION
          - CONFIGURED
          - NEEDS_ATTENTION
          type: string
        supportingResourceId:
          description: the identifier of the underlying supporting resource.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: The time the Global service manager instance was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeSslCertificateExpires:
          description: The time the ssl certificate associated with Global service manager expires. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Global service manager instance was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - name
      - computeCount
      - dataStorageSizeInGbs
      - timeCreated
      - timeUpdated
      - status
    DistributedDbBackupConfig:
      description: 'Backup Options

        To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).

        '
      properties:
        autoBackupWindow:
          description: 'Time window selected for initiating automatic backup for the database system. There are twelve available two-hour time windows. If no option is selected, a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive).

            Example: `SLOT_TWO`

            '
          enum:
          - SLOT_ONE
          - SLOT_TWO
          - SLOT_THREE
          - SLOT_FOUR
          - SLOT_FIVE
          - SLOT_SIX
          - SLOT_SEVEN
          - SLOT_EIGHT
          - SLOT_NINE
          - SLOT_TEN
          - SLOT_ELEVEN
          - SLOT_TWELVE
          type: string
        autoFullBackupDay:
          default: SUNDAY
          description: Day of the week the full backup should be applied on the database system. If no option is selected, the value is null and we will default to Sunday.
          enum:
          - SUNDAY
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          type: string
        autoFullBackupWindow:
          description: 'Time window selected for initiating full backup for the database system. There are twelve available two-hour time windows. If no option is selected, the value is null and a start time between 12:00 AM to 7:00 AM in the region of the database is automatically chosen. For example, if the user selects SLOT_TWO from the enum list, the automatic backup job will start in between 2:00 AM (inclusive) to 4:00 AM (exclusive).

            Example: `SLOT_TWO`

            '
          enum:
          - SLOT_ONE
          - SLOT_TWO
          - SLOT_THREE
          - SLOT_FOUR
          - SLOT_FIVE
          - SLOT_SIX
          - SLOT_SEVEN
          - SLOT_EIGHT
          - SLOT_NINE
          - SLOT_TEN
          - SLOT_ELEVEN
          - SLOT_TWELVE
          type: string
          x-default-description: 'null'
        backupDeletionPolicy:
          description: This defines when the backups will be deleted. - IMMEDIATE option keep the backup for predefined time i.e 72 hours and then delete permanently... - RETAIN will keep the backups as per the policy defined for database backups.
          enum:
          - DELETE_IMMEDIATELY
          - DELETE_AFTER_RETENTION_PERIOD
          type: string
        backupDestinationDetails:
          description: Backup destination details.
          items:
            $ref: '#/components/schemas/DistributedDbBackupDestination'
          type: array
        canRunImmediateFullBackup:
          default: true
          description: If set to true, configures automatic full backups in the local region (the region of the DB system) for the first backup run immediately.
          type: boolean
        isAutoBackupEnabled:
          description: If set to true, configures automatic backups. If you previously used RMAN or dbcli to configure backups and then you switch to using the Console or the API for backups, a new backup configuration is created and associated with your database. This means that you can no longer rely on your previously configured unmanaged backups to work.
          type: boolean
        isRemoteBackupEnabled:
          description: 'If set to true, configures automatic incremental backups in the local region (the region of the DB system) and the remote region with a default frequency of 1 hour.

            If you previously used RMAN or dbcli to configure backups, using the Console or the API for manged backups creates a new backup configuration for your database. The new configuration replaces the configuration created with RMAN or dbcli.

            This means that you can no longer rely on your previously configured unmanaged backups to work.

            '
          type: boolean
        recoveryWindowInDays:
          description: 'Number of days between the current and the earliest point of recoverability covered by automatic backups.

            This value applies to automatic backups only. After a new automatic backup has been created, Oracle removes old automatic backups that are created before the window.

            When the value is updated, it is applied to all existing automatic backups.

            '
          maximum: 60
          minimum: 1
          type: integer
        remoteRegion:
          description: 'The name of the remote region where the remote automatic incremental backups will be stored.

            For information about valid region names, see

            [Regions and Availability Domains](/Content/General/Concepts/regions.htm).

            '
          type: string
    CreateDistributedDatabaseShardDetails:
      description: Globally distributed database shard.
      discriminator:
        propertyName: source
      properties:
        source:
          description: 'Type of Globally distributed database Shard or Catalog.

            Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

            Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

            EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

            '
          enum:
          - EXADB_XS
          - NEW_VAULT_AND_CLUSTER
          - EXISTING_CLUSTER
          type: string
      required:
      - source
    PatchInstruction:
      description: A single instruction to be included as part of Patch request content.
      discriminator:
        propertyName: operation
      properties:
        operation:
          description: 'The operation that need to be performed on an element inside list.

            '
          enum:
          - INSERT
          - REMOVE
          - 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
    ChangeDistributedDatabaseCompartmentDetails:
      description: 'The configuration details for moving the resource for Globally distributed database to other compartment.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the resource to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
    AddDistributedDatabaseGdsControlNodeDetails:
      description: 'Details required to create a new Global database services control(GDS CTL) compute node.

        '
      properties:
        publicSshKey:
          description: The public sshKey for Global database services control(GDS CTL) node.
          maxLength: 51200
          minLength: 1
          type: string
        subnetId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet on which the Global database services control(GDS CTL) node should be created.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - publicSshKey
    DistributedDatabase:
      description: Globally distributed database.
      properties:
        catalogDetails:
          description: Collection of catalogs associated with the Globally distributed database.
          items:
            $ref: '#/components/schemas/DistributedDatabaseCatalog'
          maxItems: 1
          minItems: 1
          type: array
        characterSet:
          description: The character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        chunks:
          description: 'The default number of unique chunks in a shardspace. The value of chunks must be

            greater than 2 times the size of the largest shardgroup in any shardspace.

            '
          type: integer
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed database compartment.
          maxLength: 255
          minLength: 1
          type: string
        connectionStrings:
          $ref: '#/components/schemas/DistributedDbConnectionString'
        databaseVersion:
          description: Oracle Database version for the shards and catalog used in Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        dbBackupConfig:
          $ref: '#/components/schemas/DistributedDbBackupConfig'
        dbDeploymentType:
          description: 'The distributed database deployment type.

            '
          enum:
          - EXADB_XS
          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: The display name of the Globally distributed database.
          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
        gsmDetails:
          description: Collection of catalogs associated with the Globally distributed database.
          items:
            $ref: '#/components/schemas/DistributedDatabaseGsm'
          maxItems: 10
          type: array
        gsmSshPublicKey:
          description: The SSH public key for Global service manager instances.
          maxLength: 51200
          minLength: 1
          type: string
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        latestGsmImageDetails:
          $ref: '#/components/schemas/DistributedDbGsmImage'
        lifecycleDetails:
          description: The lifecycleDetails for the Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: Lifecycle states for the Globally distributed database.
          enum:
          - ACTIVE
          - FAILED
          - NEEDS_ATTENTION
          - INACTIVE
          - DELETING
          - DELETED
          - UPDATING
          - CREATING
          type: string
        listenerPort:
          description: The Global service manager listener port number for the Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        listenerPortTls:
          description: The TLS listener port number for Globally distributed database.
          maximum: 65535
          minimum: 1024
          type: integer
        metadata:
          $ref: '#/components/schemas/DistributedDbMetadata'
        ncharacterSet:
          description: The national character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        onsPortLocal:
          description: Ons local port number.
          maximum: 65535
          minimum: 1024
          type: integer
        onsPortRemote:
          description: Ons remote port number.
          maximum: 65535
          minimum: 1024
          type: integer
        prefix:
          description: 'Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character

            has to be a letter followed by any combination of letter and number.

            '
          maxLength: 3
          minLength: 3
          pattern: '[a-z][a-z0-9][a-z0-9]'
          type: string
        privateEndpointIds:
          description: The collection of [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint associated with Globally distributed autonomous database.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 2
          minItems: 1
          type: array
        replicationFactor:
          description: 'The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.

            '
          maximum: 7
          minimum: 3
          type: integer
        replicationMethod:
          description: 'The Replication method for Globally distributed database. Use RAFT for Raft replication, and DG for

            DataGuard. If replicationMethod is not provided, it defaults to DG.

            '
          enum:
          - RAFT
          - DG
          type: string
        replicationUnit:
          description: 'The replication unit count for RAFT based distributed database. For RAFT replication based

            Globally distributed database, the value should be at least twice the number of shards.

            '
          maximum: 1000
          minimum: 6
          type: integer
        scanListenerPort:
          description: The TCP Single Client Access Name (SCAN) port for Globally distributed database clusters.
          maximum: 8999
          minimum: 1024
          type: integer
        shardDetails:
          description: Collection of shards associated with the Globally distributed database.
          items:
            $ref: '#/components/schemas/DistributedDatabaseShard'
          minItems: 1
          type: array
        shardingMethod:
          description: Sharding Methods for the Globally distributed database.
          enum:
          - USER
          - SYSTEM
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time the Globally distributed database was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the Globally distributed database was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - timeCreated
      - timeUpdated
      - lifecycleState
      - lifecycleDetails
      - databaseVersion
      - privateEndpointIds
      - prefix
      - shardingMethod
      - characterSet
      - ncharacterSet
      - listenerPort
      - onsPortLocal
      - onsPortRemote
      - dbDeploymentType
    CreateDistributedDatabaseCatalogDetails:
      description: Details of the Globally distributed database catalog.
      discriminator:
        propertyName: source
      properties:
        source:
          description: 'Type of Globally distributed database Shard or Catalog.

            Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

            Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

            EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

            '
          enum:
          - EXADB_XS
          - NEW_VAULT_AND_CLUSTER
          - EXISTING_CLUSTER
          type: string
      required:
      - source
    DistributedDbConnectionString:
      description: Details of Globally distributed database connection String.
      properties:
        allConnectionStrings:
          additionalProperties:
            type: string
          description: Collection of connection strings.
          type: object
      required:
      - allConnectionStrings
    PatchDistributedDatabaseDetails:
      description: 'Provide PatchInstuction(s) in items array. All instructions in items have to be of same type.

        All instructions in items have to either PatchInsertInstruction type, PatchRemoveInstruction or

        PatchMergeInstruction. Multiple instructions of different types is not allowed to be performed in

        single operation.

        '
      properties:
        items:
          description: List of patch instructions.
          items:
            $ref: '#/components/schemas/PatchInstruction'
          type: array
      type: object
    UpdateDistributedDatabaseDetails:
      description: The details of Globally distributed database 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
        displayName:
          description: Display name of the Globally distributed database.
          maxLength: 255
          minLength: 1
          pattern: ^[a-zA-Z_]((?!.*[-]{2})[a-zA-Z0-9_-]{0,254})$
          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
    CreateDistributedDatabaseDetails:
      description: Details required for creation of the Globally distributed database.
      properties:
        catalogDetails:
          description: Collection of catalog for the Globally distributed database.
          items:
            $ref: '#/components/schemas/CreateDistributedDatabaseCatalogDetails'
          maxItems: 1
          minItems: 1
          type: array
        characterSet:
          description: The character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        chunks:
          description: 'Number of chunks in a shardspace. The value of chunks must be

            greater than 2 times the size of the largest shardgroup in any shardspace. Chunks is

            required to be provided for distributed databases being created with

            SYSTEM shardingMethod. For USER shardingMethod, chunks should not be set in create payload.

            '
          type: integer
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed database compartment.
          maxLength: 255
          minLength: 1
          type: string
        databaseVersion:
          description: Oracle Database version for the shards and catalog used in Globally distributed database.
          maxLength: 255
          minLength: 1
          type: string
        dbBackupConfig:
          $ref: '#/components/schemas/DistributedDbBackupConfig'
        dbDeploymentType:
          description: 'The distributed database deployment type.

            '
          enum:
          - EXADB_XS
          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: The display name of the Globally distributed database.
          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
        gsmSshPublicKey:
          description: The SSH public key for Global service manager instances.
          maxLength: 51200
          minLength: 1
          type: string
        listenerPort:
          description: 'The listener port number for the Globally distributed database. The listener port number

            has to be unique for a customer tenancy across all distributed databases. Same port number should

            not be re-used for any other distributed database.

            '
          maximum: 65535
          minimum: 1024
          type: integer
        listenerPortTls:
          description: 'The TLS listener port number for the Globally distributed database. The TLS listener port number

            has to be unique for a customer tenancy across all distributed databases. Same port number should

            not be re-used for any other distributed database. For BASE_DB and EXADB_XS based distributed databases,

            tls is not supported hence the listenerPortTls is not needed to be provided in create payload.

            '
          maximum: 65535
          minimum: 1024
          type: integer
        ncharacterSet:
          description: The national character set for the database.
          maxLength: 255
          minLength: 1
          type: string
        onsPortLocal:
          description: 'The ons local port number for the Globally distributed database. The onsPortLocal has to be

            unique for a customer tenancy across all distributed databases. Same port number should not be

            re-used for any other distributed database.

            '
          maximum: 65535
          minimum: 1024
          type: integer
        onsPortRemote:
          description: 'The ons remote port number for the Globally distributed database. The onsPortRemote has to be

            unique for a customer tenancy across all distributed databases. Same port number should not be

            re-used for any other distributed database.

            '
          maximum: 65535
          minimum: 1024
          type: integer
        prefix:
          description: 'Unique name prefix for the Globally distributed databases. Only alpha-numeric values are allowed. First character

            has to be a letter followed by any combination of letter and number.

            '
          maxLength: 3
          minLength: 3
          pattern: '[a-z][a-z0-9][a-z0-9]'
          type: string
        privateEndpointIds:
          description: The collection of [OCID](/Content/General/Concepts/identifiers.htm) of the private endpoint associated with Globally distributed autonomous database.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 2
          minItems: 1
          type: array
        replicationFactor:
          description: 'The Replication factor for RAFT replication based Globally distributed database. Currently supported values are 3, 5 and 7.

            '
          maximum: 7
          minimum: 3
          type: integer
        replicationMethod:
          description: 'The Replication method for Globally distributed database. Use RAFT for Raft based replication.

            With RAFT replication, shards cannot have peers details set on them. In case shards need to

            have peers, please do not set RAFT replicationMethod. For all non RAFT replication cases (with or

            without peers), please set replicationMethod as DG or do not set any value for replicationMethod.

            '
          enum:
          - RAFT
          - DG
          type: string
        replicationUnit:
          description: 'The replication unit count for RAFT based distributed database. For RAFT replication based

            Globally distributed database, the value should be at least twice the number of shards.

            '
          maximum: 1000
          minimum: 6
          type: integer
        scanListenerPort:
          description: 'The TCP Single Client Access Name (SCAN) port for clusters created for Globally distributed database.

            The scanListenerPort number should only be provided if shard and catalog have source type NEW_VAULT_AND_CLUSTER.

            If shard and catalog have source type NEW_VAULT_AND_CLUSTER and scanListenerPort is not provided then the

            scanListenerPort will default to value 1521.

            '
          maximum: 8999
          minimum: 1024
          type: integer
          x-default-description: 'null'
        shardDetails:
          description: Collection of shards for the Globally distributed database.
          items:
            $ref: '#/components/schemas/CreateDistributedDatabaseShardDetails'
          minItems: 1
          type: array
        shardingMethod:
          description: Sharding Methods for the Globally distributed database.
          enum:
          - USER
          - SYSTEM
          type: string
      required:
      - compartmentId
      - displayName
      - prefix
      - databaseVersion
      - privateEndpointIds
      - shardingMethod
      - characterSet
      - ncharacterSet
      - listenerPort
      - onsPortLocal
      - onsPortRemote
      - dbDeploymentType
      - shardDetails
      - catalogDetails
      type: object
    GenerateDistributedDatabaseWalletDetails:
      description: 'Details to create and download an Globally distributed database wallet.

        '
      properties:
        password:
          description: The password to encrypt the keys inside the wallet. The password must be at least 8 characters long and must include at least 1 letter and either 1 numeric character or 1 special character.
          minLength: 8
          type: string
      required:
      - password
    DistributedDbBackupDestination:
      description: Backup destination details
      properties:
        dbrsPolicyId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DBRS policy used for backup.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the backup destination.
          maxLength: 255
          minLength: 1
          type: string
        internetProxy:
          description: Proxy URL to connect to object store.
          type: string
        isRemote:
          default: false
          description: Indicates whether the backup destination is cross-region or local region.
          type: boolean
        isZeroDataLossEnabled:
          default: true
          description: Indicates whether Zero Data Loss functionality is enabled for a Recovery Appliance backup destination in an Autonomous Container Database. When enabled, the database automatically ships all redo logs in real-time to the Recovery Appliance for a Zero Data Loss recovery setup (sub-second RPO). Defaults to `TRUE` if no value is given.
          type: boolean
        remoteRegion:
          description: 'The name of the remote region where the remote automatic incremental backups will be stored.

            For information about valid region names, see

            [Regions and Availability Domains](/Content/General/Concepts/regions.htm).

            '
          maxLength: 50
          minLength: 1
          type: string
        type:
          description: Type of the database backup destination.
          enum:
          - NFS
          - RECOVERY_APPLIANCE
          - OBJECT_STORE
          - LOCAL
          - DBRS
          type: string
        vpcPassword:
          description: For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.
          type: string
        vpcUser:
          description: For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.
          type: string
      required:
      - type
    MoveDistributedDatabaseReplicationUnitDetails:
      description: 'The details for moving replication units from source shard to destination shard for the Globally distributed database.

        '
      properties:
        destinationShardName:
          description: The name of the destination shard to which the chunks moved out from source shard should be relocate to.
          maxLength: 255
          minLength: 1
          type: string
          x-default-description: 'null'
        replicationUnits:
          description: For RAFT databases please provide replication unit numbers to be moved from source shard to destination shard.
          items:
            minimum: 1
            type: integer
          maxItems: 2
          minItems: 1
          type: array
        sourceShardName:
          description: The name of the source shard from which to move the chunks out to other shards.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - sourceShardName
      type: object
    ChangeDistributedDbBackupConfigDetails:
      description: Details of the DbBackupConfig to be updated for the Globally distreibuted database.
      properties:
        dbBackupConfig:
          $ref: '#/components/schemas/DistributedDbBackupConfig'
      required:
      - dbBackupConfig
      type: object
    UploadDistributedDatabaseSignedCertificateAndGenerateWalletDetails:
      description: 'Details of the request to upload the CA signed certificates to GSMs and generate wallets for

        GSMs of the Globally distributed database.

        '
      properties:
        caSignedCertificate:
          description: The CA signed certificate key.
          maxLength: 51200
          minLength: 1
          type: string
      required:
      - caSignedCertificate
    DistributedDatabaseShard:
      description: Globally distributed database shard.
      discriminator:
        propertyName: source
      properties:
        name:
          description: Name of the shard.
          maxLength: 255
          minLength: 1
          type: string
        source:
          description: 'Type of Globally distributed database Shard or Catalog.

            Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

            Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

            EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

            '
          enum:
          - EXADB_XS
          - NEW_VAULT_AND_CLUSTER
          - EXISTING_CLUSTER
          type: string
        timeCreated:
          description: The time the shard was created. An RFC3339 formatted datetime string
          format: date-time
          type: string
        timeUpdated:
          description: The time the shard was last updated. An RFC3339 formatted datetime string
          format: date-time
          type: string
      required:
      - source
      - name
      - timeCreated
      - timeUpdated
  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:
  distributedAutonomousDbDeploymentType:
    description: 'The distributed autonomous database deployment type.

      '
    enum:
    - ADB_D
    type: string
  distributedAutonomousDbLifecycleState:
    description: Lifecycle states for the Globally distributed autonomous database.
    enum:
    - ACTIVE
    - FAILED
    - NEEDS_ATTENTION
    - INACTIVE
    - DELETING
    - DELETED
    - UPDATING
    - CREATING
    type: string
  distributedAutonomousDbSource:
    description: 'The source of Globally distributed autonomous database type: Use ADB_D for the Globally distributed autonomous database with

      autonomous dedicated cloudautonomousvmclusters.

      '
    enum:
    - ADB_D
    type: string
  distributedDbDeploymentType:
    description: 'The distributed database deployment type.

      '
    enum:
    - EXADB_XS
    type: string
  distributedDbLifecycleState:
    description: Lifecycle states for the Globally distributed database.
    enum:
    - ACTIVE
    - FAILED
    - NEEDS_ATTENTION
    - INACTIVE
    - DELETING
    - DELETED
    - UPDATING
    - CREATING
    type: string
  distributedDbSource:
    description: 'Type of Globally distributed database Shard or Catalog.

      Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch.

      Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters.

      EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

      '
    enum:
    - EXADB_XS
    - NEW_VAULT_AND_CLUSTER
    - EXISTING_CLUSTER
    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
  systemTags:
    additionalProperties:
      additionalProperties:
        description: 'The value of the tag. Only string, integer and boolean types are supported.

          '
        type: object
      description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

        Example: `{"bar-key": "value"}`

        '
      type: object
    description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

      Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

      '
    type: object
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous 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
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.distributeddb