Globally Distributed Database REST APIs
The following REST APIs are used to interact with the Globally Distributed Database (distributed-database) resource.
| REST API | Description |
|---|---|
AddDistributedDatabaseGdsControlNode |
Adds a new Global Data Services control node for running GDSCTL commands on the distributed database |
ChangeDistributedDatabaseCompartment |
Moves the distributed database and its dependent resources to the specified compartment |
ChangeDistributedDbBackupConfig |
Change the backup configuration for the specified distributed database |
ConfigureDistributedDatabaseGsms |
Configure GSMs for the distributed database |
ConfigureDistributedDatabaseSharding |
Initiates the distributed database configuration deployment |
CreateDistributedDatabase |
Creates a new distributed database resource |
DeleteDistributedDatabase |
Deletes the distributed database |
DownloadDistributedDatabaseGsmCertificateSigningRequest |
Generates the common certificate signing request for the distributed database GSM instances. |
GenerateDistributedDatabaseGsmCertificateSigningRequest |
Generates the certificate signing request for distributed database GSM instances. Once the certificate signing request is generated, you can download it using DownloadGsmCertificateSigningRequest. |
GenerateDistributedDatabaseWallet |
Generates the wallet for application connections with a distributed database. |
GetDistributedDatabase |
Gets the details of a distributed database resource |
PatchDistributedDatabase |
Lets you add, remove, or update shards in the distributed database topology. You can add, remove, or update multiple shards in a single patch operation; however, combinations of inserts, updates, and removes in a single operation are not allowed. This operation is followed by ConfigureDistributedDatabaseSharding to deploy the updated distributed database configuration. |
RotateDistributedDatabasePasswords |
Rotate passwords for different components of the distributed database |
StartDistributedDatabase |
Starts the specified distributed database |
StopDistributedDatabase |
Stops the specified distributed database |
UpdateDistributedDatabase |
Lets you change the display name and edit tags associated with a distributed database resource. |
UploadDistributedDatabaseSignedCertificateAndGenerateWallet |
Uploads the CA signed certificate to the distributed database GSM instances, and generate wallets for the GSM instances. |
ValidateDistributedDatabaseNetwork |
Validates the network connectivity between components of the distributed database |
ListDistributedDatabases |
Gets a list of distributed database resources |
See Globally Distributed Database Policies for API permissions and policy guidelines.