Oracle Distributed Db Service API

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

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-distributeddbservice-api-openapi.yml