检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询数据库角色列表 接口说明 查询数据库角色列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时，不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https:/
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token缓存，避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
应用示例 查询实例列表 修改实例名称 删除实例
欢迎使用文档数据库服务（Document Database Service，简称DDS）。您可以使用本文档提供API对文档数据库服务进行相关操作，如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前，请确保已经充分了解文档数据库服务相关概念，详细信息请参见产品介绍。 调用说明
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 错误码说明
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
获取项目ID 操作场景 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下获取方式： 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:/
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。
删除实例 场景描述 本章节指导用户通过删除实例接口删除DDS实例。 操作步骤 删除DDS实例。 接口相关信息 URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} {Endpoint}信息请从地区和终端节点获取。
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001"
修改实例名称 场景描述 本章节指导用户通过调用修改实例名称接口修改实例名称。 操作步骤 修改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
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。 命名空间 SYS.DDS 监控指标 表1 DDS推荐的监控指标 指标ID 指标名称 指标含义
须具备调用该接口所需的权限，否则，API请求将调用失败。每个接口所需要的权限，与各个接口所对应的授权项相对应，只有发起请求的用户被授予授权项所对应的策略，该用户才能成功调用该接口。例如，用户要调用接口来查询文档数据库实例列表，那么这个IAM用户被授予的策略中必须包含允许“dds:
文档数据库服务授权项说明 表1 实例管理 权限 对接API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建实例 POST /v3/{project_id}/instances dds:instance:create
SDK概述 本文介绍了文档数据库服务DDS提供的SDK语言版本，列举了最新版本SDK的获取地址。 在线生成SDK代码 API Explorer能根据需要动态生成SDK代码功能，降低您使用SDK的难度，推荐使用。 SDK列表 表1提供了文档数据库服务DDS支持的SDK列表，您可以在
文档数据库服务支持的监控指标 设置告警规则 支持审计的关键操作列表 查看追踪事件 06 API 您可以使用DDS提供的API对DDS实例进行相关操作，如创建实例、删除实例、查询实例列表等。 API文档 创建实例 删除实例 查询实例列表 创建手动备份 设置自动备份策略 查询资源实例 常见问题
and、delete、insert语句执行频率，活跃连接数等指标。 日志管理 支持查询和下载数据库错误日志和慢日志。 参数配置 控制台支持在线修改并生效配置参数，以及参数模板配置管理功能。 跨可用区容灾 所在区域支持3个及以上可用区时，支持跨3个可用区部署，从而实现跨可用区容灾能力。
实例状态 数据库实例状态是数据库实例的运行情况。用户可以使用管理控制台和API操作查看数据库实例状态。 数据库实例状态 表1 状态和说明 状态 说明 正常 数据库实例运行正常。 异常 数据库实例不可用。 创建中 正在创建数据库实例。 创建失败 数据库实例创建失败。 备份中 正在创建数据库实例备份。
文档数据库服务监控指标说明 本节定义了文档数据库服务上报云监控的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控提供的API接口来检索文档数据库服务产生的监控指标和告警信息。 命名空间 SYS.DDS 监控指标 表1 DDS推荐的监控指标 指标ID 指标名称 指标含义
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
