检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口,您可以使用文档数据库服务的部分功能,具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。 命名空间 SYS.DDS 监控指标 表1 DDS推荐的监控指标 指标ID 指标名称 指标含义
查询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版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
版本信息说明 文档数据库服务(Document Database Service,简称DDS)是兼容MongoDB协议的云数据库服务,除了兼容MongoDB接口以外,还具备高安全、高可用、高可靠等特征。此外还提供了丰富易用的一键部署、弹性扩容、容灾、备份、恢复、监控和告警等运维功能。
版本说明 版本信息说明 DDS4.4功能概述
如何调用API 构造请求 认证鉴权 返回结果
API v3(即将下线) 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要调用接口来查询文档数据库实例列表,那么这个IAM用户被授予的策略中必须包含允许“dds:
实例说明 引擎和版本 实例规格 只读节点简介
产品发布说明 内核版本说明
内核版本说明 本章节介绍文档数据库服务DDS的内核版本更新说明,补丁升级不会影响任何功能和接口。 表1 文档数据库服务DDS5.0版本说明 版本 日期 说明 5.0 2024年9月 支持重启时跳过索引重建,并在副本集索引不一致时自动修复。 oldestTsWindow支持最大值设置到100秒。
文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create
兼容性说明 版本兼容性 浏览器兼容性
查询资源标签 接口说明 查询指定实例的标签信息。 约束说明 一个文档数据库实例具有20个标签配额,且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/insta
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。
欠费说明 用户在使用云服务时,帐户的可用额度小于待结算的账单,即被判定为帐户欠费。欠费后,可能会影响云服务资源的正常运行,请及时充值。 欠费原因 未购买包年包月实例,在按需计费模式下帐户的余额不足。 欠费影响 包年/包月 对于包年/包月DDS实例,用户已经预先支付了资源费用,因此
事件监控支持的事件说明 表1 文档数据库服务 事件来源 事件名称 事件ID 事件级别 事件说明 处理建议 事件影响 DDS 创建实例业务失败 DDSCreateInstanceFailed 重要 创建文档数据库实例失败产生的事件,一般是由于磁盘个数、配额不足,底层资源耗尽导致。