检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
DDS和社区版MongoDB有什么关系 DDS即文档数据库服务,完全兼容MongoDB社区版3.4/4.0/4.2,部分兼容社区版4.4。兼容性详情请参见版本兼容性。 DDS支持绝大部分的MongoDB命令操作,任何兼容MongoDB的客户端都可以与DDS建立连接进行数据存储及相应操作。
如何调用API 构造请求 认证鉴权 返回结果
申请和修改内网域名 DDS支持内网域名,您可以通过内网域名连接DDS。 使用须知 内网域名生成后,修改内网地址将会导致数据库连接中断,请谨慎操作。 使用和申请内网域名需要具有相应的操作权限。您可联系华为云客服人员申请内网域名的操作权限。 内网域名功能开启时,存量实例需要主动申请域名,新建实例自动申请域名。
API v3(推荐) 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
查询API版本 查询API版本列表 查询API版本信息 父主题: API v3(推荐)
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
/v3/{project_id}/instances/{instance_id}/tags dds:instance:list √ √ 表7 管理数据库和用户 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建数据库用户 POST
查询实例列表和详情 接口说明 根据指定条件查询实例列表和详情。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances?id={id}&name={name}&mo
管理数据库和用户 创建数据库用户 创建数据库角色 查询数据库用户列表 查询数据库角色列表 修改数据库用户密码 检查数据库密码 查询集群均衡设置 设置集群均衡开关 设置集群均衡活动时间窗 删除数据库用户 删除数据库角色 查询数据库列表 父主题: API v3(推荐)
连接管理 查询实例节点会话 终结实例节点会话 查询实例节点连接数统计 父主题: API v3(推荐)
查询任务列表和详情 接口说明 根据指定条件查询任务中心中的任务列表和详情。 约束说明 目前只支持查询DDS社区版任务中心一个月内的异步任务。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/jobs
设置集群均衡活动时间窗 接口说明 设置DDS集群的数据均衡活动时间窗。 设置的是utc时间,需要根据自身时区做时间换算。 约束说明 冻结实例不支持该操作。 4.0以下版本的DDS实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT
查询集群均衡设置 接口说明 查询DDS集群的数据均衡设置,包括均衡开关和均衡活动时间窗的设置。其中,均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET http
创建数据库角色 接口说明 给指定实例创建数据库角色。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST h
设置集群均衡开关 接口说明 设置DDS集群的数据均衡开关。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instan
检查数据库密码 接口说明 检查数据库密码。 约束说明 冻结实例,异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/check-password
设置磁盘自动扩容策略 功能介绍 设置磁盘自动扩容策略。 接口约束 包周期用户默认自动扣费,账户需要有足够的余额,才可进行自动扩容。 有只读节点的副本集和集群实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{End