Updated on 2023-02-16 GMT+08:00

API Overview

DDM provides REST APIs. With DDM APIs, you can use all DDM functions, including creating DDM instances and schemas.

Table 1 API description

Type

Subtype

Description

APIs for managing DDM instances

Buying a DDM instance

This API is used to buy a DDM instance. DDM instances created using this API are billed in pay-per-use mode.

DDM runs in VPCs. Before you apply for a DDM instance, ensure that a VPC is available and a subnet and security group have been configured.

Querying DDM instances

This API is used to query DDM instances.

Querying details of a DDM instance

This API is used to query details about a DDM instance.

Modifying the name of a DDM instance

This API is used to modify the name of an existing DDM instance.

Modifying the security group of a DDM instance

This API is used to modify the security group of a DDM instance.

Deleting a DDM instance

This API is used to delete a DDM instance to release all its resources.

Restarting a DDM instance

This API is used to restart a DDM instance.

Reloading table data

This API is used to reload table data of the destination DDM instance for cross-region DR.

Scaling out a DDM instance

This API is used to add nodes to a specified DDM instance.

Scaling in a DDM instance

This API is used to remove nodes from a specified DDM instance.

Modifying the read policy of the associated DB instance

This API is used to modify the read policy of the DB instance associated with a DDM instance.

Synchronizing data node information

This API is used to synchronize configuration information of all data nodes that are associated with the current DDM instance.

Querying nodes of a DDM instance

This API is used to query nodes of a DDM instance.

Querying details of a DDM instance node

This API is used to query details of a DDM instance node.

Querying parameters of a specified DDM instance

This API is used to query parameters of a specified DDM instance.

Modifying parameters of a DDM instance

This API is used to modify parameters of a DDM instance.

Querying DDM engine information

This API is used to query information about DDM engine.

Querying DDM node classes available in an AZ

This API is used to query DDM node classes available in an AZ.

Changing the node class of a DDM Instance

This API is used to change the node class of a DDM instance.

APIs for managing schemas

Creating a schema

This API is used to create a schema.

Before creating a schema, ensure that there is an RDS instance available and that the instance is running properly and not associated with any DDM instance.

Querying schemas of a DDM instance

This API is used to query schemas of a DDM instance.

Querying details of a schema

This API is used to query details about a schema.

Deleting a schema

This API is used to delete a schema to release all its resources.

Querying DB instances available for creating a schema

This API is used to query DB instances that can be used for creating a schema.

APIs for managing DDM accounts

Creating a DDM account

This API is used to create a DDM account. DDM accounts are used to connect to and manage schemas. One DDM account can be associated with multiple schemas.

Querying DDM accounts

This API is used to query DDM accounts.

Modifying a DDM account

This API is used to modify the permissions and associated schemas of a DDM account.

Deleting a DDM account

This API is used to delete a DDM account. This operation will also disassociate the account from schemas if any.

Resetting the password of a DDM account

This API is used to reset the password of a DDM account.

Managing the administrator password

If it is the first time to call this API, it is used to create an administrator and reset its password for a DDM instance. Then this API can only be used to update the administrator password.

Validating password strength

This API is used to validate whether an instance password is a weak password.

Monitoring

Monitoring slow query logs

This API is used to query the SQL statements that take a long time to execute on the DDM instance within a specified time range.

Monitoring the read/write ratio (unavailable Soon)

This API is used to query reads and writes of a DDM instance in a specified time range.