检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询副本集跨网段访问配置 接口说明 查询副本集跨网段访问配置。 约束说明 只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id
切换副本集实例的主备节点 接口说明 切换副本集实例下的主备节点。 约束说明 该接口仅支持DDS副本集实例。 冻结实例，异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id
创建数据库用户 接口说明 给指定实例创建数据库用户。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https
删除数据库角色 接口说明 删除指定实例的数据库角色。 约束说明 该接口只支持DDS社区版。 系统默认角色不支持删除。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI
扩容副本集实例的节点数量 接口说明 扩容指定副本集实例的节点数量。 约束说明 该接口既支持包年包月实例，也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
获取可恢复的数据库列表 接口说明 获取可恢复的数据库列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id
修改数据库用户密码 接口说明 修改数据库密码。 约束说明 冻结实例，异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id
删除数据库用户 接口说明 删除指定实例的数据库用户。 约束说明 该接口只支持DDS社区版。 系统默认用户以及“rwuser”用户不支持删除。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer
查询数据库列表 接口说明 查询数据库列表。 约束说明 该接口只支持DDS社区版。 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://
查询数据库角色列表 接口说明 查询数据库角色列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://
查询数据库用户列表 接口说明 查询数据库用户列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://
获取可恢复的数据库集合列表 接口说明 获取可恢复的数据库集合列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token
应用示例 查询实例列表 修改实例名称 删除实例
使用前必读 概述 欢迎使用文档数据库服务（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}信息请从地区和终端节点获取
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 错误码说明
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
