检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
获取可恢复的数据库集合列表 接口说明 获取可恢复的数据库集合列表。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。
查询数据库角色列表 接口说明 查询数据库角色列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。
应用示例 查询实例列表 修改实例名称 删除实例
您可以使用本文档提供API对文档数据库服务进行相关操作，如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前，请确保已经充分了解文档数据库服务相关概念，详细信息请参见产品介绍。
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
删除实例 场景描述 本章节指导用户通过删除实例接口删除DDS实例。 操作步骤 删除DDS实例。
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求
获取项目ID 操作场景 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下获取方式： 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。
修改实例名称 场景描述 本章节指导用户通过调用修改实例名称接口修改实例名称。 操作步骤 修改DDS实例名称。
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001
接口相关信息 URI格式：GET https://{Endpoint}/v3/{project_id}/instances?
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。
账号具备所有接口的调用权限，如果使用账号下的IAM用户发起API请求时，该IAM用户必须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的用户被授予授权项所对应的策略，该用户才能成功调用该接口。
文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create
网络安全 文档数据库服务有哪些安全保障措施 为什么在虚拟私有云中使用文档数据库 如何确保在虚拟私有云中运行的文档数据库的安全 DDS是否支持选择创建IPV6子网 将根证书导入Windows/Linux操作系统
API方式 您可以通过编写代码调用API来访问文档数据库服务，具体操作请参见《文档数据库服务API参考》。 兼容的引擎和版本 文档数据库服务兼容的引擎和版本，请参见引擎和版本。 部署建议 建议从以下维度考虑如何创建并使用文档数据库服务。
用户可以使用管理控制台和API操作查看数据库实例状态。 数据库实例状态 表1 状态和说明 状态 说明 正常 数据库实例运行正常。 异常 数据库实例不可用。 创建中 正在创建数据库实例。 创建失败 数据库实例创建失败。 备份中 正在创建数据库实例备份。
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。
产品发布说明 内核版本说明
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
