{ "opencollection": "1.0.0", "info": { "name": "Globally Distributed Database Distributed Db Service API", "version": "20250101" }, "items": [ { "info": { "name": "DistributedDbService", "type": "folder" }, "items": [ { "info": { "name": "List of Globally distributed databases.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20250101/distributedDatabases", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "privateEndpointId", "value": "", "type": "query", "description": "A filter to return only resources that are associated with the given privateEndpointId." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "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.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only Globally distributed databases that match the entire name given. The match is not case sensitive." }, { "name": "dbDeploymentType", "value": "", "type": "query", "description": "A filter to return only resources their dbDeploymentType matches the given dbDeploymentType." }, { "name": "metadata", "value": "", "type": "query", "description": "Comma separated names of argument corresponding to which metadata need to be retrived.\n" } ] }, "docs": "List of Globally distributed databases.\n" }, { "info": { "name": "Create a Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Globally distributed database.\n" }, { "info": { "name": "Gets the details of the Globally distributed database.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId", "headers": [ { "name": "if-none-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "metadata", "value": "", "type": "query", "description": "Comma separated names of argument corresponding to which metadata need to be retrived.\n" } ] }, "docs": "Gets the details of the Globally distributed database identified by given id.\n" }, { "info": { "name": "Updates the configuration of the Globally distributed database.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of the Globally distributed database.\n" }, { "info": { "name": "Patch the configuration of Globally distributed database.", "type": "http" }, "http": { "method": "PATCH", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patch operation to add, remove or update shards to the Globally distributed database topology. In single patch\noperation, multiple shards can be either added, or removed or updated. Combination of inserts, update\nand remove in single operation is not allowed.\nFor an EXADB_XS based distributed database, removing a shard with the parameter mustDeleteInfra set to true \nwill also delete the associated VmCluster and DbStorageVault.\n" }, { "info": { "name": "Terminate the Globally distributed database identified by the identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "mustDeleteInfra", "value": "", "type": "query", "description": "The flag to indicate if infra like VmCluster & DbStorageVault associated with the resource should be deleted." } ] }, "docs": "Terminate the given Globally distributed databases.\nFor an EXADB_XS based distributed database, if the parameter mustDeleteInfra is set to true,\nthen the VmCluster and DbStorageVault associated with each shard and catalog will also be deleted.\n" }, { "info": { "name": "Add new Global database services control(GDS CTL) node for the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/addGdsControlNode", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add new Global database services control(GDS CTL) node for the Globally distributed database.\n" }, { "info": { "name": "ChangeDistributedDatabaseCompartment", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the Globally distributed database and its dependent resources to the specified compartment.\n" }, { "info": { "name": "Change the DbBackupConfig details for the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/changeDbBackupConfig", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the DbBackupConfig for the Globally distributed database.\n" }, { "info": { "name": "Configure GSMs for the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/configureGsms", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure new Global Service Manager(GSM aka shard manager) instances for the Globally distributed database.\n" }, { "info": { "name": "Configure sharding for the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/configureSharding", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "isRebalanceRequired", "value": "", "type": "query", "description": "The flag to indicate whether chunks need to be re-balanced. This flag is not applicable for USER-defined\nsharding type.\n" } ] }, "docs": "Once all components of Globally distributed database are provisioned, and signed GSM certificates are successfully uploaded, this\napi shall be invoked to configure sharding on the Globally distributed database. Note that this 'ConfigureSharding' API also needs to be\ninvoked after successfully adding a new shard to the Globally distributed database using PATCH api. If this API is not\ninvoked after successfully adding a new shard, then that new shard will not be a participant in sharding topology " }, { "info": { "name": "Download the common certificate signing request for global service manager(GSM) instances of Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/downloadGsmCertificateSigningRequest", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ] }, "docs": "Generate the common certificate signing request for GSMs. Download the .csr file from\nAPI response. Users can use this .csr file to generate the CA signed certificate, and as a next step\nuse 'uploadSignedCertificateAndGenerateWallet' API to upload the CA signed certificate to GSM, and\ngenerate wallets for the GSM instances of the Globally distributed database.\n" }, { "info": { "name": "Generate the certificate signing request for global service manager(GSM) instances of the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/generateGsmCertificateSigningRequest", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "caBundleId", "value": "", "type": "query", "description": "The ID of the Ca Bundle." } ] }, "docs": "Generate the certificate signing request for GSM instances of the Globally distributed database. Once certificate signing\nrequest is generated, then customers can download the certificate signing request using\n'downloadGsmCertificateSigningRequest' api call.\n" }, { "info": { "name": "Generate the wallet associated with Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/generateWallet", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate the wallet associated with Globally distributed database.\n" }, { "info": { "name": "Move the replication units for RAFT based globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/moveReplicationUnit", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move the replication units for RAFT based globally distributed database from source shard to destination shard.\n" }, { "info": { "name": "Recreate the failed resource for the Globally Distributed Database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/recreateFailedResource", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "resourceName", "value": "", "type": "query", "description": "Specify the name of Shard, Catalog or GSM.\n" }, { "name": "shardGroup", "value": "", "type": "query", "description": "The shardGroup name example Shardgroupa, Shardgroupb.\n" } ] }, "docs": "Recreate the failed resource for the Globally Distributed Database.\n" }, { "info": { "name": "Rotate passwords for different components of the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/rotateDbPasswords", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ] }, "docs": "Rotate the gsmuser and gsmcatuser passwords for shards and catalog of the Globally distributed database. This operation will also remove GdsCtlNodes if present." }, { "info": { "name": "Start Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/startDatabase", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ] }, "docs": "Start the shards, catalog and GSMs of Globally distributed database." }, { "info": { "name": "Stop Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/stopDatabase", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ] }, "docs": "Stop the shards, catalog and GSM instances for the Globally distributed database." }, { "info": { "name": "Upload the CA signed certificate for new GSM compute instances of the Globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/uploadSignedCertificateAndGenerateWallet", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upload the CA signed certificate to the GSM instances and generate wallets for GSM instances of the\nGlobally distributed database. Customer shall provide the CA signed certificate key details by adding the certificate\nin request body.\n" }, { "info": { "name": "Validate the network connectivity for the globally distributed database.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/actions/validateNetwork", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" }, { "name": "isSurrogate", "value": "", "type": "query", "description": "Determines the surrogates check. Default is true." }, { "name": "resourceName", "value": "", "type": "query", "description": "Specify the name of shard or catalog.\n" }, { "name": "shardGroup", "value": "", "type": "query", "description": "The shardGroup name example Shardgroupa, Shardgroupb.\n" } ] }, "docs": "Validate the network connectivity between components of the globally distributed database.\n" }, { "info": { "name": "Operation to retrieve RAFT metrics for the Globally distributed database.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20250101/distributedDatabases/:distributedDatabaseId/raftMetrics", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "distributedDatabaseId", "value": "", "type": "path", "description": "Globally distributed database identifier" } ] }, "docs": "Operation to retrieve RAFT metrics for the Globally distributed database. If the Globally distributed database is not\nRAFT based then empty response is returned from the API.\n" } ] } ], "bundled": true }