API概览

更新时间：2025-01-16 GMT+08:00

查看PDF

文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。

表1 接口说明
类型	描述
查询API版本	包括查询API版本信息列表、查询指定API版本信息接口。
查询数据库版本信息	查询指定实例类型的数据库版本信息。
查询数据库规格	查询指定条件下的所有实例规格信息。
查询数据库磁盘类型	查询当前区域下的数据库磁盘类型。
实例管理	包括创建实例、重启实例、删除实例、查询实例列表、扩容实例存储容量、扩容集群实例的节点数量、变更实例规格、切换副本集实例的主备节点、切换SSL开关、修改实例名称、修改数据库端口、变更实例安全组、绑定弹性公网IP、解绑弹性公网IP、修改实例内网地址、打开集群的Shard/Config IP开关接口、副本集跨网段访问配置、查询实例可迁移到的可用区、实例可用区迁移。
连接管理	包括查询实例节点会话、终结实例节点会话、查询实例节点连接数统计接口。
备份与恢复	包括创建手动备份、删除手动备份、查询备份列表、查询自动备份策略、设置自动备份策略、恢复到新实例、获取备份下载链接、查询可恢复的时间段、获取可恢复的数据库列表、获取可恢复的数据库集合列表、获取到当前实例、库表级时间点恢复接口。
参数配置	包括获取参数模板列表、创建参数模板、删除参数模板、获取参数模板的详情、修改参数模板、应用参数模板、获取指定实例的参数信息、修改指定实例的参数接口。
获取日志信息	包括查询数据库慢日志、获取慢日志下载链接、查询数据库错误日志、获取错误日志下载链接、设置审计日志策略、查询审计日志策略、获取审计日志列表、获取审计日志下载链接接口。
标签管理	包括查询资源实例、批量添加或删除资源标签、查询资源标签、查询项目标签接口。
管理数据库和用户	包括创建数据库用户、创建数据库角色、查询数据库用户列表、查询数据库角色列表、修改数据库用户密码、检查数据库密码接口、查询集群均衡设置、设置集群均衡开关、设置集群均衡活动时间窗、删除数据库用户、删除数据库角色。
配额管理	查询单租户在DDS服务下的资源配额，包括集群实例配额、单节点实例配额和副本集实例配额。
任务管理	获取DDS任务中心指定ID的任务信息。