检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
删除和退订实例的区别是什么 针对不同计费模式的数据库实例,释放资源的方式不同。 对于“按需计费”模式的数据库实例,购买后无订单生成,根据业务需要释放资源时,在“实例管理”页面手动删除即可。 对于“包年/包月”模式的数据库实例,购买后会生成订单,您需要退订订单,从而释放数据库实例资源,详细操作请参见退订包周期实例。
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
品简介。 GeminiDB Mongo,也称增强版MongoDB,是基于华为自主研发的计算存储分离架构的分布式NoSQL数据库服务。100%兼容MongoDB接口,并提供高性能、高可靠的优势和企业级服务。更多GeminiDB Mongo信息请参见产品简介。 父主题: 产品咨询
恢复到新实例 接口说明 根据备份恢复新实例。 约束说明 该接口既支持恢复到包年包月实例,也支持按需实例。 目标实例与源实例的数据库类型必须一致。 根据时间点恢复到新实例目前有副本集实例和集群实例支持该功能。 调试 您可以在API Explorer中调试该接口。 URI URI格式
如何调用API 构造请求 认证鉴权 返回结果
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
备份与恢复 创建手动备份 删除手动备份 查询备份列表 查询自动备份策略 设置自动备份策略 恢复到新实例 获取备份下载链接 查询可恢复的时间段 获取可恢复的数据库列表 获取可恢复的数据库集合列表 恢复到当前实例 库表级时间点恢复 停止备份 批量删除手动备份 父主题: API v3(推荐)
节点组信息或节点信息的列表对象。 当参数模板是副本集或单节点类型时,不返回该字段,模板直接应用到对应实例。 当参数模板是集群类型时,如果是shard组或者config组的参数模板,则返回的是对应类型的节点组信息;如果是mongos组的参数模板,则返回的是对应类型的的节点信息。 例如:
查询可恢复的时间段 接口说明 查询实例的可恢复时间段。 约束说明 该接口目前支持副本集实例和4.0版本的集群实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instan
停止备份 接口说明 支持紧急情况下停止备份功能。 约束说明 仅支持状态为备份中或备份上传中的实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/backups/{backup_id}
修改指定实例的参数 接口说明 修改指定实例的参数,可以是实例,组,节点的参数模板。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 PUT https:/
删除手动备份 接口说明 删除数据库实例的手动备份。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id} URI样例 https://dds
获取可恢复的数据库列表 接口说明 获取可恢复的数据库列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{insta
Integer 否 索引位置偏移量,表示从指定project ID下最新的备份创建时间开始,按时间的先后顺序偏移offset条数据后查询对应的备份信息。 取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从最新的备份创建时间对应的备份开始查询。 limit Integer 否 查询备份个数上限值。
获取指定ID的任务信息 接口说明 获取DDS任务中心指定ID的任务信息。 约束说明 目前只支持查询DDS社区版任务中心一个月内的异步任务。 job生成后,通常需要数秒之后才能查询到job ID。 目前支持查询的主要异步任务:创建实例(单节点/副本集/集群)、存储扩容、规格变更、节
获取可恢复的数据库集合列表 接口说明 获取可恢复的数据库集合列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{i
批量删除手动备份 功能介绍 批量删除数据库实例的手动备份。 调试 您可以在API Explorer中调试该接口。 URI DELETE https://{Endpoint}/v3/{project_id}/instances/backups 表1 请求参数 名称 类型 IN 是否必选