API Overview

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 create 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 the 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.

Obtaining the instance group information

This API is used to obtain DDM instance group information.

Querying parameters of a specified DDM instance

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

Scaling out a DDM instance (a V3 API)

This API is used to scale out a DDM instance.

Deleting an instance (a V3 API)

This API is used to delete an instance.

Enabling or disabling SSL (a V3 API)

This API is used to enable or disable SSL.

Changing an instance port

This API is used to change an instance port.

Restarting an instance (a V3 API)

This API is used to restart an instance.

Restarting a node

This API is used to restart a node.

Binding an EIP

This API is used to bind an EIP.

Unbinding an EIP

This API is used to unbind an EIP.

Changing the ELB load balancer IP address of an instance

This API is used to change the ELB load balancer IP address of an instance.

Deleting instance nodes

This API is used to delete nodes from an instance.

Deleting multiple nodes from an instance at a time (a V3 API)

This API is used to delete nodes from an instance at a time.

Querying details of an instance node (a V3 API)

This API is used to query details of an instance node.

Buying an instance (a V3 API)

This API is used to buy an instance.

Obtaining information about the EIP bound to an instance (a V3 API)

This API is used to obtain information about the EIP bound to an instance.

Synchronizing data node information (a V3 API)

This API is used to synchronize data node information.

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.

Creating a schema (a V3 API)

This API is used to create a schema.

Deleting a schema (a V3 API)

This API is used to delete a schema.

Querying details about a schema (a V3 API)

This API is used to query details about a schema.

Exporting schema metadata (a V3 API)

This API is used to export schema metadata.

Importing schema metadata (a V3 API)

This API is used to import schema metadata.

Querying data nodes available for creating a schema (a V3 API)

This API is used to query data nodes available for creating a schema.

Querying data nodes available for shard configuration (a V3 API)

This API is used to query data nodes that can be used for shard configuration.

Pre-checking shard configuration (a V3 API)

This API is used to pre-check shard configuration.

Querying the asynchronous pre-check result of shard configuration (a V3 API)

This API is used to query the asynchronous pre-check result of shard configuration.

Configuring shards (a V3 API)

This API is used to configure shards.

Querying details about a shard configuration task (a V3 API)

This API is used to query details about a shard configuration task.

Canceling shard configuration (a V3 API)

This API is used to cancel shard configuration.

Rolling back shard configuration (a V3 API)

This API is used to roll back shard configuration.

Clearing shard configuration data (a V3 API)

This API is used to clear shard configuration data.

Retrying shard configuration (a V3 API)

This API is used to retry shard configuration.

Changing a route switching policy (a V3 API)

This API is used to change a route switching policy.

Switching a route (a V3 API)

This API is used to switch a route.

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 an administrator password (a V3 API)

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

Validating password strength (a V3 API)

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

Task management

Obtaining information about a task with a specified ID

This API is used to obtain information about a task with a specified ID.

Querying tasks (a V3 API)

This API is used to query tasks.

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.

Session management

Querying logical sessions (a V3 API)

This API is used to query logical sessions.

Killing logical sessions (a V3 API)

This API is used to kill logical sessions.

Querying physical sessions (a V3 API)

This API is used to query physical sessions.

Killing physical sessions (a V3 API)

This API is used to kill physical sessions.

Querying audit logs of killing sessions (a V3 API)

This API is used to query audit logs of killing sessions.

Version management

Querying a DDM kernel version that can be changed (a V3 API)

This API is used to query a DDM kernel version that can be changed.

Changing a DDM kernel version (a V3 API)

This API is used to change a DDM kernel version.

Rolling back a DDM kernel version (a V3 API)

This API is used to roll back a DDM kernel version.

Reminding users of risks for a DDM kernel version (a V3 API)

This API is used to remind users of risks for a DDM kernel version.

Parameter management

Obtaining parameter templates

This API is used to obtain parameter templates.

Obtaining parameters of a specified parameter template

This API is used to obtain parameters of a specified parameter template.

Modifying parameters of an instance (a V3 API)

This API is used to modify parameters of an instance.

Modifying parameters of an instance (a V3.1 API)

This API is used to modify parameters of an instance. It is recommended.

Creating a parameter template (a V3 API)

This API is used to create a parameter template.

Deleting a parameter template (a V3 API)

This API is used to delete a parameter template.

Backup management

Obtaining backups

This API is used to query backups.

Deleting a backup

This API is used to delete a backup.

Querying backup details (a V3 API)

This API is used to query backup details.

Querying data nodes associated with an instance at a restoration time point (a V3 API)

This API is used to query data nodes associated with an instance at a restoration time point.

Querying the restoration time range (a V3 API)

This API is used to query the restoration time range of an instance.

Querying data nodes available to restore data to a point in time (a V3 API)

This API is used to query data nodes available to restore data to a point in time.

Querying instances that can be used for restoration (a V3 API)

This API is used to query instances that can be used for restoration.

Restoring metadata (a V3 API)

This API is used to restore metadata.

Restoring data to a new instance (a V3 API)

This API is used to restore data to a new instance.