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

Creating a DDM instance

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

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

Querying instances

This API is used to query DDM instances.

Querying details of an instance

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

Restarting an instance

This API is used to restart a DDM instance.

Deleting a DDM instance

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

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 inbound and outbound rules of the security group of the DDM instance.

Reloading table data

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

Creating a schema

This API is used to create a schema.

Before creating a DDM schema, ensure that there is an RDS DB 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 the details about a schema.

Deleting a schema

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

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.