检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息
如何调用API 构造请求 认证鉴权 返回结果
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud.com
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
API v3(即将下线) 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。
当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码说明 表1 错误码说明 状态码 错误码 错误信息 描述 处理措施 400 DBS.200001 Parameter Error 参数错误 检查传入的参数或URL是否全部正确。
修改实例内网地址 接口说明 修改实例的内网地址。 约束说明 冻结实例,异常实例不支持该操作。 已使用的IP地址,不能作为实例的新内网地址。 修改内网地址会导致原地址链接失效,如果有绑定弹性公网IP,那么在修改内网地址的过程中,请不要操作解绑。 如果已经开启连接地址切换,不能进行该操作
实例管理 创建实例 重启实例 删除实例 查询实例列表和详情 扩容实例存储容量 扩容集群实例的节点数量 变更实例规格 切换副本集实例的主备节点 切换SSL开关 修改实例名称 修改实例备注 修改数据库端口 变更实例安全组 绑定弹性公网IP 解绑弹性公网IP 修改实例内网地址 创建集群的
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
参数配置 获取参数模板列表 创建参数模板 删除参数模板 获取参数模板详情 修改参数模板 应用参数模板 获取指定实例的参数信息 修改指定实例的参数 查询可应用的实例 查询参数模板应用历史 查询参数修改历史 参数模板比较 复制参数模板 重置参数模板 校验参数模板名称是否存在 查询实例参数的修改历史
涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 IAM获取Token的API 创建DDS实例的API 具体步骤 Token认证,具体操作请参考认证鉴权。
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI
解绑弹性公网IP 接口说明 解绑实例下节点已经绑定的弹性公网IP。 约束说明 冻结实例不支持该操作。 没有绑定弹性公网IP的节点不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id
网络安全 文档数据库服务有哪些安全保障措施 为什么在虚拟私有云中使用文档数据库 如何确保在虚拟私有云中运行的文档数据库的安全 DDS是否支持选择创建IPV6子网 将根证书导入Windows/Linux操作系统
什么是文档数据库服务 文档数据库服务(Document Database Service,简称DDS)完全兼容MongoDB协议,提供安全、高可用、高可靠、弹性伸缩和易用的数据库服务,同时提供一键部署、弹性扩容、容灾、备份、恢复、监控和告警等功能。 使用DDS之前,需要您了解MongoDB
备份与恢复 创建手动备份 删除手动备份 查询备份列表 查询自动备份策略 设置自动备份策略 恢复到新实例 获取备份下载链接 查询可恢复的时间段 获取可恢复的数据库列表 获取可恢复的数据库集合列表 恢复到当前实例 库表级时间点恢复 停止备份 批量删除手动备份 父主题: API v3(推荐