检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
API v3（推荐） 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
查询API版本 查询API版本列表 查询API版本信息 父主题： API v3（推荐）
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
API v3（即将下线） 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
如何调用API 构造请求 认证鉴权 返回结果
创建实例 接口说明 创建文档数据库实例，包括集群实例和副本集实例。 约束说明 该接口既支持创建包年包月实例，也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说
恢复到新实例 接口说明 根据备份恢复新实例。 约束说明 该接口既支持恢复到包年包月实例，也支持按需实例。 目标实例与源实例的数据库类型必须一致。 根据时间点恢复到新实例目前有副本集实例和集群实例支持该功能。 调试 您可以在API Explorer中调试该接口。 URI URI格式
获取参数模板详情 接口说明 获取指定参数模板的参数信息。 约束说明 该接口仅支持DDS社区版。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 GET h
获取指定实例的参数信息 接口说明 获取指定实例的参数信息。 约束说明 该接口仅支持DDS社区版。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 GET
查询数据库用户列表 接口说明 查询数据库用户列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https:/
删除参数模板 接口说明 删除指定参数模板。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许删除。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式
查询定时任务 功能介绍 根据指定条件查询定时任务列表。 调试 您可以在API Explorer中调试该接口。 URI GET https://{Endpoint}/v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id
取消定时任务 功能介绍 根据任务ID取消定时任务。 调试 您可以在API Explorer中调试该接口。 URI DELETE https://{Endpoint}/v3/{project_id}/scheduled-jobs/{job_id} 表1 路径参数 参数 是否必选 参数类型
查询项目标签 接口说明 查询指定project ID下实例的所有标签集合。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/tags URI样例 https://dds.cn-north-1
您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/kill-op-rule URI样例 https://dds.cn-north-1
批量删除手动备份 功能介绍 批量删除数据库实例的手动备份。 调试 您可以在API Explorer中调试该接口。 URI DELETE https://{Endpoint}/v3/{project_id}/instances/backups 表1 请求参数 名称 类型 IN 是否必选
启用/禁用killOp规则 接口说明 启用/禁用killOp规则。 约束说明 仅支持副本集，集群实例。 仅支持数据库版本3.4版本及以后版本。 仅支持执行节点规格4U及以上。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{En
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
