检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 文档数据库服务所提供的接口为扩展接口。通过使用文档数据库服务接口，您可以使用文档数据库服务的部分功能，具体如下表所示。 表1 接口说明 类型 描述 查询API版本 包括查询API版本信息列表、查询指定API版本信息接口。 查询数据库版本信息 查询指定实例类型的数据库版本信息。
API v3（推荐） 查询API版本 查询数据库版本信息 查询数据库规格 查询数据库磁盘类型 实例管理 连接管理 备份与恢复 参数配置 获取日志信息 标签管理 管理数据库和用户 配额管理 数据库运维 任务管理
查询API版本 查询API版本列表 查询API版本信息 父主题： API v3（推荐）
查询API版本信息 接口说明 查询指定API版本信息。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/{version} URI样例 https://dds.cn-north-1.myhuaweicloud
查询API版本列表 接口说明 查询当前支持的API版本信息列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/ URI样例 https://dds.cn-north-1.myhuaweicloud.com/
如何调用API 构造请求 认证鉴权 返回结果
jar”，此安装包提供了访问DDS数据库实例的API接口。 驱动安装请参考官方指南。 环境类 客户端需配置JDK1.8。JDK是跨平台的，支持Windows，Linux等多种平台。 下面以Windows为例，介绍JDK配置流程： DOS窗口输入“java -version”，查看JDK版本，确认为JDK1.8版本。如果未安装JDK，请下载安装包并安装。
API v3（即将下线） 查询所有实例规格信息 查询数据库慢日志 查询数据库错误日志
就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取，调用
应用参数模板 接口说明 指定实例变更参数模板。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 PUT https://{Endpoint}/v3/{pr
重置参数模板 接口说明 重置参数模板。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI URI格式 POST https://{Endpoint}/v3/{proje
中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到
修改实例名称 接口说明 修改实例的名称。 约束说明 创建中和创建失败的实例不支持修改实例名称。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name
查询资源实例 接口说明 根据标签查询指定的数据库实例。 约束说明 一个文档数据库实例具有20个标签配额，且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/action
完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于获取用户Token接口，返回如图1所示的消息头，其中“x-subject-tok
创建实例 接口说明 创建文档数据库实例，包括集群实例和副本集实例。 约束说明 该接口既支持创建包年包月实例，也支持按需实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances
查询项目标签 接口说明 查询指定project ID下实例的所有标签集合。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/tags URI样例 https://dds.cn-north-1
查询资源标签 接口说明 查询指定实例的标签信息。 约束说明 一个文档数据库实例具有20个标签配额，且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/insta
value的值。 如果待删除的标签不存在，调用该接口将默认处理成功，删除时，不对标签字符集范围做校验。该场景下，要求请求体中tags结构体不能缺失，且key不能为空，或者空字符串。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https:/
恢复到新实例 接口说明 根据备份恢复新实例。 约束说明 该接口既支持恢复到包年包月实例，也支持按需实例。 目标实例与源实例的数据库类型必须一致。 根据时间点恢复到新实例目前有副本集实例和集群实例支持该功能。 调试 您可以在API Explorer中调试该接口。 URI URI格式
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
