API概览
分布式数据库中间件所提供的接口为REST（Representational State Transfer）风格API。通过使用DDM接口，您可以使用DDM的所有功能，包括创建实例、创建逻辑库等。
| 类型 | 接口名称 | 说明 |
|---|---|---|
| DDM实例类接口 | 购买DDM实例 | 购买DDM实例。该接口创建的DDM实例为按需计费的方式。 DDM运行于虚拟私有云。申请DDM实例前，需保证有可用的虚拟私有云，并且已配置好子网与安全组。 |
| 查询DDM实例列表 | 查询DDM实例列表。 | |
| 查询DDM实例详情 | 查询指定DDM实例的详细信息。 | |
| 修改DDM实例名称 | 修改现有DDM实例的名称。 | |
| 修改DDM实例安全组 | 修改DDM实例安全组。 | |
| 删除DDM实例 | 删除指定的DDM实例，释放该实例的所有资源。 | |
| 重启DDM实例 | 重启指定的DDM实例。 | |
| DDM表数据重载 | DDM实例跨region容灾场景下，针对目标DDM实例实现表数据RELOAD，使数据同步。 | |
| DDM实例节点扩容 | 对指定的DDM实例的节点个数进行扩容。 | |
| DDM实例节点缩容 | 对指定的DDM实例的节点个数进行缩容。 | |
| 修改DDM已关联的数据库实例的读策略 | 修改DDM已关联的数据库实例的读策略。 | |
| 同步DN信息 | 同步当前DDM实例已关联的所有DN配置信息。 | |
| 查询DDM实例节点列表 | 查询DDM实例节点列表。 | |
| 查询DDM实例节点详情 | 查询DDM实例节点详情。 | |
| 查询DDM指定实例的参数详情 | 查询DDM指定实例的参数详情。 | |
| 修改DDM的实例参数 | 修改DDM实例参数。 | |
| 查询DDM引擎信息 | 查询DDM引擎信息详情。 | |
| 查询DDM可用区规格信息 | 查询DDM可用区规格信息详情。 | |
| 变更DDM实例规格 | 变更DDM实例规格。 | |
| 获取实例组信息列表 | 获取DDM实例的组信息详情。 | |
| 查询DDM指定实例的参数详情 | 查询DDM指定实例的参数详情。 | |
| DDM实例节点扩容V3 | DDM实例节点扩容。 | |
| 删除实例V3 | 删除实例。 | |
| 设置SSL数据加密V3 | 设置SSL数据加密。 | |
| 修改实例端口 | 修改实例端口。 | |
| 重启实例V3 | 重启实例。 | |
| 重启节点 | 重启节点。 | |
| 绑定弹性公网IP | 绑定弹性公网IP。 | |
| 解绑弹性公网IP | 解绑弹性公网IP。 | |
| 修改实例的ELB | 修改实例的ELB。 | |
| 删除实例的节点 | 删除实例的节点。 | |
| 批量删除实例的节点V3 | 批量删除实例的节点。 | |
| 查询实例节点详情V3 | 查询实例节点详情。 | |
| 购买实例V3 | 购买实例。 | |
| 获取实例绑定的弹性公网IP信息V3 | 获取实例绑定的弹性公网IP信息。 | |
| 同步数据节点V3 | 同步数据节点。 | |
| DDM逻辑库类接口 | 创建DDM逻辑库 | 创建DDM逻辑库。 创建前需确保存在RDS实例，实例状态正常且没有被其他DDM实例关联使用。 |
| 查询DDM逻辑库列表 | 查询DDM逻辑库列表。 | |
| 查询DDM逻辑库详细信息 | 查询指定逻辑库的详细信息。 | |
| 删除DDM逻辑库 | 删除指定的逻辑库，释放该逻辑库的所有资源。 | |
| 查询创建逻辑库可选取的数据库实例列表 | 查询创建逻辑库可选取的数据库实例列表。 | |
| 创建逻辑库V3 | 创建逻辑库。 | |
| 删除逻辑库V3 | 删除逻辑库。 | |
| 查询逻辑库详情V3 | 查询逻辑库详情。 | |
| 导出逻辑库元数据V3 | 导出逻辑库元数据。 | |
| 导入逻辑库元数据V3 | 导入逻辑库元数据。 | |
| 查询创建逻辑库可选取的数据节点实例列表V3 | 查询创建逻辑库可选取的数据节点实例列表。 | |
| 查询分片变更可选取的数据节点实例列表V3 | 查询分片变更可选取的数据节点实例列表。 | |
| 分片变更预校验V3 | 分片变更预校验。 | |
| 查询分片变更预校验异步结果V3 | 查询分片变更预校验异步结果。 | |
| 分片变更V3 | 分片变更。 | |
| 查询分片变更任务详情V3 | 查询分片变更任务详情。 | |
| 取消分片变更V3 | 取消分片变更。 | |
| 回滚分片变更V3 | 回滚分片变更。 | |
| 清理分片变更V3 | 清理分片变更。 | |
| 重试分片变更V3 | 重试分片变更。 | |
| 修改切换路由策略V3 | 修改切换路由策略。 | |
| 切换路由V3 | 切换路由。 | |
| DDM账号类接口 | 创建DDM账号 | DDM账号用于连接和管理逻辑库。一个DDM账号可以关联多个逻辑库。 |
| 查询DDM账号列表 | 查询DDM账号列表。 | |
| 修改DDM账号 | 修改现有DDM账号的权限或者与逻辑库的管理关系。 | |
| 删除DDM账号 | 删除指定的DDM实例账号，如果账号关联了逻辑库，则对应的关联关系也会删除。 | |
| 重置DDM账号密码 | 重置现有DDM账号的密码。 | |
| DDM管理员账号密码管理V3 | DDM管理员账号密码管理。 | |
| 弱密码校验V3 | 弱密码校验。 | |
| 任务管理 | 获取指定ID的任务信息 | 获取指定ID的任务信息。 |
| 查询任务列表V3 | 查询任务列表。 | |
| 监控管理类 | 慢日志监控 | 查询指定时间段内在DDM实例上执行过的慢SQL相关信息。 |
| 读写比例监控（即将下线） | 查询指定时间段内在DDM实例的读写次数。 | |
| 会话管理 | 查询逻辑会话列表V3 | 查询逻辑会话列表。 |
| kill逻辑会话V3 | kill逻辑会话。 | |
| 查询物理会话列表V3 | 查询物理会话列表。 | |
| kill物理会话V3 | kill物理会话。 | |
| 查询kill会话审计日志V3 | 查询kill会话审计日志。 | |
| 版本管理 | 查询DDM可变更内核版本V3 | 查询DDM可变更内核版本。 |
| 变更DDM内核版本V3 | 变更DDM内核版本。 | |
| 回滚DDM内核版本V3 | 回滚DDM内核版本。 | |
| DDM内核版本风险提醒V3 | DDM内核版本风险提醒。 | |
| 参数管理 | 获取参数模板列表 | 获取参数模板列表。 |
| 获取指定参数模板的参数 | 获取指定参数模板的参数。 | |
| 修改实例参数V3 | 修改实例参数。 | |
| 修改实例参数V3.1 | 修改实例参数。推荐使用。 | |
| 创建参数组V3 | 创建参数组。 | |
| 删除参数组V3 | 删除参数组。 | |
| 备份管理 | 获取备份列表 | 获取备份列表。 |
| 删除备份 | 删除备份。 | |
| 查询备份详情V3 | 查询备份详情。 | |
| 查询实例在恢复时间点关联的数据节点V3 | 查询实例在恢复时间点关联的数据节点。 | |
| 查询可恢复时间段V3 | 查询可恢复时间段。 | |
| 查询可用于时间点恢复的数据节点列表V3 | 查询可用于时间点恢复的数据节点列表。 | |
| 查询可用于恢复的实例列表V3 | 查询可用于恢复的实例列表。 | |
| 元数据恢复V3 | 元数据恢复。 | |
| 恢复到新实例V3 | 恢复到新实例。 |
