检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
强制备节点升主 接口说明 支持副本集、shard和config备节点强制升主。 约束说明 在主备时延较大的情况下不保证成功。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
查询实例节点连接数统计 接口说明 查询各客户端IP访问至DDS数据库实例的连接数统计信息。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances
获取可恢复的数据库集合列表 接口说明 获取可恢复的数据库集合列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
修改数据库用户密码 接口说明 修改数据库密码。 约束说明 冻结实例，异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id
获取可恢复的数据库列表 接口说明 获取可恢复的数据库列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id
查询数据库用户列表 接口说明 查询数据库用户列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://
查询数据库角色列表 接口说明 查询数据库角色列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://
应用示例 查询实例列表 修改实例名称 删除实例
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001
使用前必读 概述 欢迎使用文档数据库服务（Document Database Service，简称DDS）。您可以使用本文档提供API对文档数据库服务进行相关操作，如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前，请确保已经充分了解文档数据库服务相关概念
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求
删除实例 场景描述 本章节指导用户通过删除实例接口删除DDS实例。 操作步骤 删除DDS实例。 接口相关信息 URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} {Endpoint}信息请从地区和终端节点获取
获取项目ID 操作场景 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下获取方式： 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https
修改实例名称 场景描述 本章节指导用户通过调用修改实例名称接口修改实例名称。 操作步骤 修改DDS实例名称。 接口相关信息 URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
查询实例列表 场景描述 本章节指导用户通过调用查询实例列表和详情接口，使用分页参数查询租户下所有DDS实例。 操作步骤 指定limit与offset查询DDS实例列表。 接口相关信息 URI格式：GET https://{Endpoint}/v3/{project_id}/instances
为什么在虚拟私有云中使用文档数据库 虚拟私有云允许您在私有、隔离的网络创建虚拟网络环境，从中可以对私有IP地址范围、子网、路由表和网络网关等方面进行控制。借助虚拟私有云，您可以定义虚拟网络拓扑和网络配置，使其非常类似于您在自己的数据中心所操作的传统IP网络。 在下面的情况下您可能想在虚拟私有云中使用文档数据库服务
策略和授权项说明 如果您需要对您所拥有的DDS服务进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），如果云平台账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用DDS服务的其它功能
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
