检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
如何调用API 构造请求 认证鉴权 返回结果
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
DDS是否支持$round函数 DDS支持$round函数。详情请参见聚合函数兼容性列表。 父主题: 数据库基本使用
API v3(即将下线) 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取,调用
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
任务管理 获取指定ID的任务信息 查询任务列表和详情 查询定时任务 取消定时任务 父主题: API v3(推荐)
创建数据库角色 接口说明 给指定实例创建数据库角色。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST h
查询可恢复的时间段 获取可恢复的数据库列表 获取可恢复的数据库集合列表 恢复到当前实例 库表级时间点恢复 停止备份 批量删除手动备份 父主题: API v3(推荐)
慢日志最多保存30天。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/slow-logs URI样例 https://dds.cn-north-1
查询LTS日志配置信息 关联LTS日志流 解除关联LTS日志流 设置磁盘自动扩容策略 查询磁盘自动扩容策略 批量数据库补丁升级 父主题: API v3(推荐)
查询参数模板应用历史 查询参数修改历史 参数模板比较 复制参数模板 重置参数模板 校验参数模板名称是否存在 查询实例参数的修改历史 父主题: API v3(推荐)
恢复到新实例 接口说明 根据备份恢复新实例。 约束说明 该接口既支持恢复到包年包月实例,也支持按需实例。 目标实例与源实例的数据库类型必须一致。 根据时间点恢复到新实例目前有副本集实例和集群实例支持该功能。 调试 您可以在API Explorer中调试该接口。 URI URI格式
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例
DDS最佳实践汇总 本手册基于华为云文档数据库服务实践所编写,用于指导您完成相关设置,购买更符合业务的数据库实例。 章节名称 简介 安全最佳实践 介绍在DDS使用过程中的安全最佳实践,旨在为提高整体安全能力提供可操作的规范性指导。 连接DDS实例的常用方式 介绍DDS的常用连接方式。