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 Autonomous 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: DistributedAutonomousDbService paths: /distributedAutonomousDatabases: get: description: 'List of Globally distributed autonomous databases. ' operationId: ListDistributedAutonomousDatabases parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PrivateEndpointIdQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseLifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DistributedAutonomousDatabaseDisplayNameQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseDbDeploymentTypeQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseMetadata' responses: 200: description: A page of Globally distributed autonomous 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/DistributedAutonomousDatabaseCollection' 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 autonomous databases. tags: - DistributedAutonomousDbService x-example: 'GET /20250101/distributedAutonomousDatabases?compartmentId= Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a Globally distributed autonomous database. ' operationId: CreateDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: The Globally distributed autonomous 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/DistributedAutonomousDatabase' 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "Below is an sample payload to create dedicated infrastructure based distributed autonomous database\nPOST /20250101/distributedAutonomousDatabases\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"databaseVersion\": \"19c\",\n \"dbWorkload\": \"OLTP\",\n \"displayName\": \"my-dadb\",\n \"listenerPortTls\": 1201,\n \"listenerPort\": 1202,\n \"onsPortLocal\": 1203,\n \"onsPortRemote\": 1204,\n \"prefix\": \"pre\",\n \"shardingMethod\": \"USER\",\n \"characterSet\": \"AL32UTF8\",\n \"ncharacterSet\": \"AL16UTF16\",\n \"dbDeploymentType\": \"ADB_D\",\n \"privateEndpointIds\": [\n \"ocid1.osddistributeddbprivateendpoint.oc1.iad.\"\n ],\n \"shardDetails\":\n [\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.iad.\",\n \"shardSpace\": \"ss1\"\n },\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.phx.\",\n \"shardSpace\": \"ss2\"\n }\n ],\n \"catalogDetails\":\n [\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.iad.\"\n }\n ],\n \"dbBackupConfig\":{\n \"recoveryWindowInDays\": 15,\n \"backupDestinationDetails\":[\n {\n \"type\": \"OBJECT_STORAGE\"\n }\n ]\n },\n}\n\nPOST /20250101/distributedAutonomousDatabases\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"chunks\": 100,\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"databaseVersion\": \"19c\",\n \"dbWorkload\": \"OLTP\",\n \"displayName\": \"my-dadb\",\n \"listenerPortTls\": 1401,\n \"listenerPort\": 1402,\n \"onsPortLocal\": 1403,\n \"onsPortRemote\": 1404,\n \"prefix\": \"pre\",\n \"shardingMethod\": \"SYSTEM\",\n \"characterSet\": \"AL32UTF8\",\n \"ncharacterSet\": \"AL16UTF16\",\n \"dbDeploymentType\": \"ADB_D\",\n \"privateEndpointIds\": [\n \"ocid1.osddistributeddbprivateendpoint.oc1.iad.\"\n ],\n \"shardDetails\":\n [\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.iad.\",\n \"vaultId\": \"ocid1.vault.oc1.phx.\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.\"\n },\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.iad.\",\n \"vaultId\": \"ocid1.vault.oc1.phx.\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.\"\n }\n ],\n \"catalogDetails\":\n [\n {\n \"source\": \"ADB_D\",\n \"computeCount\": 2.0,\n \"dataStorageSizeInGbs\": 128,\n \"isAutoScalingEnabled\": false,\n \"adminPassword\": \"example-password\",\n \"cloudAutonomousVmClusterId\": \"ocid1.cloudautonomousvmcluster.oc1.iad.\",\n \"vaultId\": \"ocid1.vault.oc1.phx.\",\n \"kmsKeyId\": \"ocid1.key.oc1.phx.\"\n }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDistributedAutonomousDatabaseDetails' description: Details of the Globally distributed autonomous database to be created. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}: delete: description: 'Terminate the given Globally distributed autonomous databases. ' operationId: DeleteDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database identified by the identifier. tags: - DistributedAutonomousDbService x-example: 'DELETE /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId} Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DistributedAutonomousDatabase' get: description: 'Gets the details of the Globally distributed autonomous database identified by given id. ' operationId: GetDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseMetadata' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Details of Globally distributed autonomous 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/DistributedAutonomousDatabase' 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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'GET /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId} Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' patch: description: 'Patch operation to add, remove or update shards to the Globally distributed autonomous database topology. In single patch operation, multiple shards can be either added, or removed or updated. Combination of inserts, update and remove in single operation is not allowed. ' operationId: PatchDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "PATCH /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n { \"operation\": \"INSERT\",\n \"selection\": \"shardDetails\",\n \"value\": \"{ \\\"adminPassword\\\": \\\"example-password\\\", \\\"computeCount\\\": 2, \\\"dataStorageSizeInGbs\\\": 32, \\\"shardSpace\\\": \\\"ss19\\\", \\\"isAutoScalingEnabled\\\": \\\"false\\\", \\\"cloudAutonomousVmClusterId\\\": \\\"ocid1.cloudautonomousvmcluster.oc1.iad.\\\", \\\"source\\\": \\\"ADB_D\\\" }\"\n }\n ]\n}\n\nPATCH /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n { \"operation\": \"MERGE\",\n \"selection\": \"shardDetails[?name == 'abc00003']\",\n \"value\": \"{ \\\"computeCount\\\": 2, \\\"dataStorageSizeInGbs\\\": 32, \\\"isAutoScalingEnabled\\\": \\\"false\\\", \\\"source\\\": \\\"ADB_D\\\" }\"\n }\n ]\n}\n\nPATCH /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n { \"operation\": \"MERGE\",\n \"selection\": \"shardDetails[?name == 'abc00003']\",\n \"value\": \"{ \\\"subOperation\\\": \\\"INSERTDG\\\", \\\"peerDetails\\\": [{ \\\"cloudAutonomousVmClusterId\\\": \\\"ocid1.cloudautonomousvmcluster.oc1.phx.anyhqljstavdrbqam4g4rjb7vthbnfu2ad7vzpailnbfbxl5jiy6sv53wv6q\\\", \\\"protectionMode\\\": \\\"MAXIMUM_AVAILABILITY\\\" }] }\"\n }\n ]\n}\n\nPATCH /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"items\": [\n { \"operation\": \"REMOVE\", \"selection\": \"shardDetails[?name == 'abc00004' || name == 'abc00003']\" }\n ]\n}\n" x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDistributedAutonomousDatabaseDetails' description: The payload containing instructions to patch the Globally distributed autonomous database. required: true put: description: 'Updates the configuration of the Globally distributed autonomous database. ' operationId: UpdateDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The Globally distributed autonomous 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/DistributedAutonomousDatabase' 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "PUT /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\nNOTE: Below is the payload for update Globally distributed autonomous database where display-name, along with tags are updated.\n{\n \"displayName\": \"\",\n \"freeformTags\" : {\n \"tagKey\" : \"value\"\n },\n \"definedTags\" : {\n \"namespace\" : {\n \"key\" : \"value\"\n }\n }\n}\n" x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDistributedAutonomousDatabaseDetails' description: The configuration of the Globally distributed autonomous database to be updated. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/addGdsControlNode: post: description: 'Add new Global database services control(GDS CTL) node for the Globally distributed autonomous database. ' operationId: AddDistributedAutonomousDatabaseGdsControlNode parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/addGdsControlNode\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"publicSshKey\" : \"ssh-rsa CCCCB3NzaC1yc2EAAAADAQABAAABAQDO7gE9zAgsAlN/RyBV+OEdB6Pv8vTwdS5K3WvqiXK9hWCtoR2siam9jZ1MOueddedwwdwdwddwwdwdwdw\",\n \"subnetId\": \"ocid1.subnet.oc1.iad.aaaaaaaart2zrqsfn36zdn4o2xxua6uwfqhestr5yysalkgzp46tvmterikq\"\n}\n" x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDistributedAutonomousDatabaseGdsControlNodeDetails' description: 'Details required to provision the new Global database services control(GDS CTL) node for the Distributed autonomous database. ' required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeCompartment: post: description: 'Move the Globally distributed autonomous database and its dependent resources to the specified compartment. ' operationId: ChangeDistributedAutonomousDatabaseCompartment parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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: ChangeDistributedAutonomousDatabaseCompartment tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeCompartment\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\"\n}\n" x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDistributedAutonomousDatabaseCompartmentDetails' description: Request to move the Globally distributed autonomous database to a different compartment. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeDbBackupConfig: post: description: 'Change the DbBackupConfig for the Globally distributed autonomous database. ' operationId: ChangeDistributedAutonomousDbBackupConfig parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'Request to change the DbBackupConfig for the Globally distributed autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/changeDbBackupConfig\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"recoveryWindowInDays\": 15,\n \"backupDestinationDetails\": [\n {\n \"type\": \"OBJECT_STORE\",\n \"isRemote\": true,\n \"remoteRegion\": \"eu-frankfurt-1\"\n }\n ]\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDistributedAutonomousDbBackupConfigDetails' description: Details of the DistributedAutonomousDbBackupConfig for the Globally distributed autonomous database. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsmWallet: post: description: 'Configure wallets on Global Service Manager(GSM) instances for a Globally distributed autonomous database. ' operationId: ConfigureDistributedAutonomousDatabaseGsmWallet parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request was successfully received and the configure gsm wallet 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 GSM wallet for the Globally distributed autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsmWallet\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateId\": \"\",\n \"caBundleId\": \"\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureDistributedAutonomousDatabaseGsmWalletDetails' description: Details to configure wallets on GSM instances for the distributed autonomous database. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsms: post: description: 'Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed autonomous database. ' operationId: ConfigureDistributedAutonomousDatabaseGsms parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureGsms\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"oldGsmNames\": [\"abc00001\", \"abc00002\"],\n \"isLatestGsmImage\": false,\n}\n" x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigureDistributedAutonomousDatabaseGsmsDetails' description: Details to configure the new GSM instances for the distributed autonomous database. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureSharding: post: description: 'Once all components of Globally distributed autonomous database are provisioned, this api shall be invoked to configure sharding on the Globally distributed autonomous database. Note that this ''ConfigureSharding'' API also needs to be invoked after successfully adding a new shard to the Globally distributed autonomous 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 autonomous database. ' operationId: ConfigureDistributedAutonomousDatabaseSharding parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseRebalanceQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseCertificateIdQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseCaBundleIdQueryParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/configureSharding Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/downloadGsmCertificateSigningRequest: post: description: 'Generate the common certificate signing request for GSMs. Download the .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 autonomous database. ' operationId: DownloadDistributedAutonomousDatabaseGsmCertificateSigningRequest parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/downloadGsmCertificateSigningRequest Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateGsmCertificateSigningRequest: post: description: 'Generate the certificate signing request for GSM instances of the Globally distributed autonomous database. Once certificate signing request is generated, then customers can download the certificate signing request using ''downloadGsmCertificateSigningRequest'' api call. ' operationId: GenerateDistributedAutonomousDatabaseGsmCertificateSigningRequest parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/DistributedAutonomousDatabaseCaBundleIdQueryParam' responses: 202: description: 'Request to generate the certificate signing request for GSMs of the Globally distributed autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateGsmCertificateSigningRequest Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateWallet: post: description: 'Generate the wallet associated with Globally distributed autonomous database. ' operationId: GenerateDistributedAutonomousDatabaseWallet parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: A wallet for the specified Globally distributed autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/generateWallet\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"password\": \"\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateDistributedAutonomousDatabaseWalletDetails' description: Details for generating Globally distributed autonomous database wallet. required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/moveReplicationUnit: post: description: 'Move the replication units for RAFT based globally distributed autonomous database from source shard to destination shard. ' operationId: MoveDistributedAutonomousDatabaseReplicationUnit parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/moveReplicationUnit\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"sourceShardName\": \"abc00001td\",\n \"destinationShardName\": \"abc00004td\",\n \"replicationUnits\": [ 1 ]\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveDistributedAutonomousDatabaseReplicationUnitDetails' description: 'Details required to move the replication units from the source shard to destination shard. ' required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/recreateFailedResource: post: description: 'Recreate the failed resource for the Globally Distributed Autonomous Database. ' operationId: RecreateFailedDistributedAutonomousDatabaseResource parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RecreateAutonomousResourceNameQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseShardGroupQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' 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 Autonomous Database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/recreateFailedResource?resourceName=abc00001td&shardGroup=Shardgroupa Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/rotateDbPasswords: post: description: Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed autonomous database. This operation will also remove GdsCtlNodes if present. operationId: RotateDistributedAutonomousDatabasePasswords parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/rotateDbPasswords Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/startDatabase: post: description: Start the shards, catalog and GSMs of Globally distributed autonomous database. operationId: StartDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request is accepted and the Globally distributed autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/startDatabase Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/stopDatabase: post: description: Stop the shards, catalog and GSM instances for the Globally distributed autonomous database. operationId: StopDistributedAutonomousDatabase parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous database. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/stopDatabase Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/uploadSignedCertificateAndGenerateWallet: post: description: 'Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the Globally distributed autonomous database. Customer shall provide the CA signed certificate key details by adding the certificate in request body. ' operationId: UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWallet parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $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 autonomous 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 autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/uploadSignedCertificateAndGenerateWallet\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\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/DistributedAutonomousDatabase' requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletDetails' description: 'Details required to upload the CA signed certificates to GSM instances of Globally distributed autonomous database and generate the wallets. ' required: true /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateCaBundle: post: description: 'Validate the CA Bundles consistency of the globally distributed autonomous database. ' operationId: ValidateDistributedAutonomousDatabaseCaBundle parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request is successfully received and consistency of the CA Bundles is being validated 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 CA Bundles consistency of the globally distributed autonomous database. tags: - DistributedAutonomousDbService x-example: "POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateCaBundle\nHost: globaldb.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"certificateId\": \"\",\n \"caBundleId\": \"\"\n}\n" x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateNetwork: post: description: 'Validate the network connectivity between components of the globally distributed autonomous database. ' operationId: ValidateDistributedAutonomousDatabaseNetwork parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseIsSurrogateQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseResourceNameQueryParam' - $ref: '#/components/parameters/DistributedAutonomousDatabaseShardGroupQueryParam' - $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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'POST /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/actions/validateNetworks?resourceName=abc00001td Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/DistributedAutonomousDatabase' /distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/raftMetrics: get: description: 'Operation to retrieve RAFT metrics for the Globally distributed autonomous database. If the Globally distributed autonomous database is not RAFT based then empty response is returned from the API. ' operationId: GetDistributedAutonomousDatabaseRaftMetric parameters: - $ref: '#/components/parameters/DistributedAutonomousDatabaseIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The Globally distributed autonomous 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/DistributedAutonomousDatabaseRaftMetric' 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 autonomous database. tags: - DistributedAutonomousDbService x-example: 'Below is an example to run GetRaftMetrics api. GET /20250101/distributedAutonomousDatabases/{distributedAutonomousDatabaseId}/raftMetrics Host: globaldb.us-ashburn-1.oci.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/DistributedDatabase' components: schemas: ConfigureDistributedAutonomousDatabaseGsmsDetails: description: 'Details of the request to configure new global service manager(GSM) instances for the distributed autonomous 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 DistributedAutonomousDatabaseRaftMetric: description: Raft metrics for shards and catalog for the Globally distributed autonomous 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 autonomous database. type: object required: - raftMetrics type: object ChangeDistributedAutonomousDatabaseCompartmentDetails: description: 'The configuration details for moving the resource for Globally distributed autonomous 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 DistributedAutonomousDatabaseConnectionString: description: Details of Globally distributed autonomous database connection String. properties: allConnectionStrings: additionalProperties: type: string description: Collection of connection strings. type: object required: - allConnectionStrings DistributedAutonomousDbBackupConfig: description: 'Backup options for the Distributed Autonomous Database. ' properties: backupDestinationDetails: description: Backup destination details. items: $ref: '#/components/schemas/DistributedAutonomousDbBackupDestination' type: array recoveryWindowInDays: description: 'Number of days between the current and the earliest point of recoverability covered by automatic backups. This value applies to automatic backups. When the value is updated, it is applied to all existing automatic backups. If the number of specified days is 0 then there will be no backups. ' maximum: 95 minimum: 0 type: integer DistributedAutonomousDatabaseCatalog: description: Globally distributed autonomous database catalog. discriminator: propertyName: source properties: name: description: The name of catalog. maxLength: 255 minLength: 1 type: string source: 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 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 DistributedAutonomousDatabaseShard: description: Globally distributed autonomous database shard. discriminator: propertyName: source properties: name: description: Name of the shard. maxLength: 255 minLength: 1 type: string source: 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 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 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 CreateDistributedAutonomousDatabaseDetails: description: Details required for creation of the Globally distributed autonomous database. properties: catalogDetails: description: Collection of catalog for the Globally distributed autonomous database. items: $ref: '#/components/schemas/CreateDistributedAutonomousDatabaseCatalogDetails' 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 autonomous 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 autonomous database compartment. maxLength: 255 minLength: 1 type: string databaseVersion: description: Oracle Database version for the shards and catalog used in Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string dbBackupConfig: $ref: '#/components/schemas/DistributedAutonomousDbBackupConfig' dbDeploymentType: description: 'The distributed autonomous database deployment type. ' enum: - ADB_D type: string dbWorkload: description: Possible workload types. Currently only OLTP workload type is supported. enum: - OLTP - DW 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 autonomous 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 listenerPort: description: 'The listener port number for the Globally distributed autonomous database. The listener port number has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database. ' maximum: 65535 minimum: 1024 type: integer listenerPortTls: description: 'The TLS listener port number for Globally distributed autonomous database. The TLS listener port number has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database. The listenerPortTls is mandatory for dedicated infrastructure based distributed autonomous databases. ' maximum: 65535 minimum: 1024 type: integer ncharacterSet: description: The national character set for the database. maxLength: 255 minLength: 1 type: string onsPortLocal: description: 'Ons local port number for Globally distributed autonomous database. The onsPortLocal has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database. ' maximum: 65535 minimum: 1024 type: integer onsPortRemote: description: 'Ons remote port number for Globally distributed autonomous database. The onsPortRemote has to be unique for a customer tenancy across all distributed autonomous databases. Same port number should not be re-used for any other distributed autonomous database. ' maximum: 65535 minimum: 1024 type: integer prefix: description: 'Unique name prefix for the Globally distributed autonomous 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 autonomous database. Currently supported values are 3, 5 and 7. ' maximum: 7 minimum: 3 type: integer replicationMethod: description: 'The Replication method for Globally distributed autonomous 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 autonomous database. For RAFT replication based Globally distributed autonomous database, the value should be at least twice the number of shards. ' maximum: 1000 minimum: 6 type: integer shardDetails: description: Collection of shards for the Globally distributed autonomous database. items: $ref: '#/components/schemas/CreateDistributedAutonomousDatabaseShardDetails' minItems: 1 type: array shardingMethod: description: Sharding Methods for the Globally distributed autonomous database. enum: - USER - SYSTEM type: string required: - compartmentId - displayName - prefix - databaseVersion - privateEndpointIds - shardDetails - catalogDetails - shardingMethod - characterSet - ncharacterSet - listenerPort - onsPortLocal - onsPortRemote - dbWorkload - dbDeploymentType type: object CreateDistributedAutonomousDatabaseCatalogDetails: description: Details of the Globally distributed autonomous database catalog. discriminator: propertyName: source properties: source: 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 required: - source PatchDistributedAutonomousDatabaseDetails: 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 DistributedAutonomousDatabase: description: Globally distributed autonomous database. properties: catalogDetails: description: Collection of catalogs associated with the Globally distributed autonomous database. items: $ref: '#/components/schemas/DistributedAutonomousDatabaseCatalog' 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 autonomous database compartment. maxLength: 255 minLength: 1 type: string connectionStrings: $ref: '#/components/schemas/DistributedAutonomousDatabaseConnectionString' databaseVersion: description: Oracle Database version for the shards and catalog used in Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string dbBackupConfig: $ref: '#/components/schemas/DistributedAutonomousDbBackupConfig' dbDeploymentType: description: 'The distributed autonomous database deployment type. ' enum: - ADB_D type: string dbWorkload: description: Possible workload types. Currently only OLTP workload type is supported. enum: - OLTP - DW 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 autonomous 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 autonomous database. items: $ref: '#/components/schemas/DistributedAutonomousDatabaseGsm' maxItems: 10 type: array id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string latestGsmImage: $ref: '#/components/schemas/DistributedAutonomousDatabaseGsmImage' lifecycleDetails: description: The lifecycleDetails for the Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string lifecycleState: description: Lifecycle states for the Globally distributed autonomous database. enum: - ACTIVE - FAILED - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - UPDATING - CREATING type: string listenerPort: description: The listener port number for the Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer listenerPortTls: description: The TLS listener port number for Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer metadata: $ref: '#/components/schemas/DistributedAutonomousDbMetadata' ncharacterSet: description: The national character set for the database. maxLength: 255 minLength: 1 type: string onsPortLocal: description: Ons local port number for Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer onsPortRemote: description: Ons remote port number for Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer prefix: description: 'Unique name prefix for the Globally distributed autonomous 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 autonomous database. Currently supported values are 3, 5 and 7. ' maximum: 7 minimum: 3 type: integer replicationMethod: description: 'The Replication method for Globally distributed autonomous 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 autonomous database. For RAFT replication based Globally distributed autonomous database, the value should be at least twice the number of shards. ' maximum: 1000 minimum: 6 type: integer shardDetails: description: Collection of shards associated with the Globally distributed autonomous database. items: $ref: '#/components/schemas/DistributedAutonomousDatabaseShard' minItems: 1 type: array shardingMethod: description: Sharding Methods for the Globally distributed autonomous 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 autonomous database was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Globally distributed autonomous 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 - dbWorkload - dbDeploymentType UploadDistributedAutonomousDatabaseSignedCertificateAndGenerateWalletDetails: description: 'Details of the request to upload the CA signed certificates to GSMs and generate wallets for GSMs of the Globally distributed autonomous database. ' properties: caSignedCertificate: description: The CA signed certificate key. maxLength: 51200 minLength: 1 type: string required: - caSignedCertificate UpdateDistributedAutonomousDatabaseDetails: description: The details of Globally distributed autonomous 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 autonomous 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 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 DistributedAutonomousDbMetadata: description: Additional metadata related to Globally distributed autonomous database resources. properties: map: additionalProperties: type: string description: The map containing key-value pair of additional metadata. type: object DistributedAutonomousDatabaseGsmImage: 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 MoveDistributedAutonomousDatabaseReplicationUnitDetails: description: 'The details for moving replication units from source shard to destination shard for the Globally distributed autonomous 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 GenerateDistributedAutonomousDatabaseWalletDetails: description: 'Details to create and download an Globally distributed autonomous 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 ConfigureDistributedAutonomousDatabaseGsmWalletDetails: description: 'Details of the request to configure wallet on global service manager(GSM) instances for a distributed autonomous database. ' properties: caBundleId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the ca bundle id. maxLength: 255 minLength: 1 type: string certificateId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the cluster certificate. maxLength: 255 minLength: 1 type: string required: - certificateId - caBundleId DistributedAutonomousDatabaseGsm: description: Details of global service manager(GSM also known as shard director) instances for the Globally distributed autonomous 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/DistributedAutonomousDatabaseGsmImage' metadata: $ref: '#/components/schemas/DistributedAutonomousDbMetadata' name: description: Name of the Global service manager instance maxLength: 255 minLength: 1 type: string status: description: Status of the gsm for the Globally distributed autonomous database. 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 DistributedAutonomousDatabaseSummary: description: Globally distributed autonomous 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 autonomous database compartment. maxLength: 255 minLength: 1 type: string connectionStrings: $ref: '#/components/schemas/DistributedAutonomousDatabaseConnectionString' databaseVersion: description: Oracle Database version for the shards and catalog used in Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string dbDeploymentType: description: 'The distributed autonomous database deployment type. ' enum: - ADB_D type: string dbWorkload: description: The workload type for the database. type: string x-obmcs-enumref: '#/definitions/DistributedAutonomousDatabase/dbWorkload' 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 autonomous 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 autonomous database. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: The lifecycleDetails for the Globally distributed autonomous database. maxLength: 255 minLength: 1 type: string lifecycleState: description: Lifecycle state of sharded database. type: string x-obmcs-enumref: '#/definitions/DistributedAutonomousDatabase/lifecycleState' listenerPort: description: The listener port number for the Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer listenerPortTls: description: The TLS listener port number for the Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer metadata: $ref: '#/components/schemas/DistributedAutonomousDbMetadata' 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 autonomous database. maximum: 65535 minimum: 1024 type: integer onsPortRemote: description: Ons remote port number for the Globally distributed autonomous database. maximum: 65535 minimum: 1024 type: integer prefix: description: 'Unique name prefix for the Globally distributed autonomous 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 autonomous database. Currently supported values are 3, 5 and 7. ' maximum: 7 minimum: 3 type: integer replicationMethod: description: 'The Replication method for Globally distributed autonomous 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/DistributedAutonomousDatabase/replicationMethod' replicationUnit: description: 'The replication unit count for RAFT based distributed autonomous database. For RAFT replication based Globally distributed autonomous 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 autonomous database. type: string x-obmcs-enumref: '#/definitions/DistributedAutonomousDatabase/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 autonomous database was created. An RFC3339 formatted datetime string format: date-time type: string timeUpdated: description: The time the Globally distributed autonomous 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 - dbWorkload - dbDeploymentType CreateDistributedAutonomousDatabaseShardDetails: description: Globally distributed autonomous database shard. discriminator: propertyName: source properties: source: 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 required: - source AddDistributedAutonomousDatabaseGdsControlNodeDetails: 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 ChangeDistributedAutonomousDbBackupConfigDetails: description: Details of the DbBackupConfig to be updated for the Globally distributed autonomous database. properties: dbBackupConfig: $ref: '#/components/schemas/DistributedAutonomousDbBackupConfig' required: - dbBackupConfig type: object DistributedAutonomousDatabaseCollection: description: Collection of Globally distributed autonomous databases. properties: items: description: Array of Globally distributed autonomous database summaries. items: $ref: '#/components/schemas/DistributedAutonomousDatabaseSummary' type: array required: - items type: object DistributedAutonomousDbBackupDestination: 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 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 parameters: 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 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 DistributedAutonomousDatabaseRebalanceQueryParam: 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 PrivateEndpointIdQueryParam: description: A filter to return only resources that are associated with the given privateEndpointId. in: query name: privateEndpointId schema: type: string RecreateAutonomousResourceNameQueryParam: description: 'Specify the name of Shard, Catalog or GSM. ' in: query name: resourceName required: true 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 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 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 DistributedAutonomousDatabaseResourceNameQueryParam: description: 'Specify the name of shard or catalog. ' in: query name: resourceName required: false x-default-description: 'null' schema: type: string DistributedAutonomousDatabaseMetadata: 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 DistributedAutonomousDatabaseCaBundleIdQueryParam: description: The ID of the Ca Bundle. in: query name: caBundleId required: false 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 DistributedAutonomousDatabaseShardGroupQueryParam: description: 'The shardGroup name example Shardgroupa, Shardgroupb. ' in: query name: shardGroup required: false x-default-description: Shardgroupa schema: type: string DistributedAutonomousDatabaseLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DistributedAutonomousDatabase/lifecycleState' 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 DistributedAutonomousDatabaseIsSurrogateQueryParam: description: Determines the surrogates check. Default is true. in: query name: isSurrogate required: false schema: type: boolean default: true DistributedAutonomousDatabaseCertificateIdQueryParam: description: The ID of the cluster certificate. in: query name: certificateId required: false x-default-description: 'null' schema: type: string DistributedAutonomousDatabaseIdentifierPathParam: description: Globally distributed autonomous database identifier in: path name: distributedAutonomousDatabaseId required: true schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string DistributedAutonomousDatabaseDisplayNameQueryParam: description: A filter to return only Globally distributed autonomous 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 DistributedAutonomousDatabaseDbDeploymentTypeQueryParam: 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/DistributedAutonomousDatabase/dbDeploymentType' schema: type: string 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