检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
应用示例 查询实例列表 修改实例名称 删除实例
修改数据库用户密码 检查数据库密码 查询集群均衡设置 设置集群均衡开关 设置集群均衡活动时间窗 删除数据库用户 删除数据库角色 查询数据库列表 父主题: API v3(推荐)
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
变更实例规格 接口说明 变更实例的规格,包括同系列和跨系列变更规格。 调整实例规格时,文档数据库服务会有5~10分钟的业务中断重启,请谨慎操作。 变更规则 华为云文档数据库DDS因考虑到实例的稳定性和相关性能,当前支持的规格变更规则如表1。请谨慎操作。 表1 变更规则 原系列 变更后的系列
就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。 Token可通过调用获取用户Token接口获取,调用
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
删除实例 接口说明 删除数据库实例。 约束说明 暂不支持删除包周期实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例
检查弱密码 接口说明 检查弱密码。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/weak-password-verification URI样例 https://dds.cn-north-1
} ] } SDK 单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 状态码 详情请参见状态码。 错误码 详情请参见错误码。 父主题: API v3(推荐)
查询资源实例 接口说明 根据标签查询指定的数据库实例。 约束说明 一个文档数据库实例具有20个标签配额,且标签key唯一。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/action
停止备份 接口说明 支持紧急情况下停止备份功能。 约束说明 仅支持状态为备份中或备份上传中的实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/backups/{backup_id}
备份与恢复 DDS实例删除后,手动备份是否继续收费 如何将文档数据库备份到弹性云服务器上 文档数据库服务能够保存多长时间的备份 如何找回DDS丢失的备份数据 备份空间里面包含哪些文件 DDS的备份是如何收费的
查询参数修改历史 接口说明 查询参数修改历史。 约束说明 当前仅查询7天之内的参数修改历史。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 GET ht
删除参数模板 接口说明 删除指定参数模板。 约束说明 该接口仅支持DDS社区版。 默认参数模板不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式
重启实例 接口说明 重启实例的数据库服务。 文档数据库实例重启过程中将不可用,请谨慎操作。 约束说明 实例状态非“normal”时,不允许重启实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{
查询配额 接口说明 查询单租户在DDS服务下的资源配额,包括集群实例配额、单节点实例配额和副本集实例配额。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/quotas URI样例
欢迎使用文档数据库服务(Document Database Service,简称DDS)。您可以使用本文档提供API对文档数据库服务进行相关操作,如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前,请确保已经充分了解文档数据库服务相关概念,详细信息请参见产品介绍。
获取参数模板详情 接口说明 获取指定参数模板的参数信息。 约束说明 该接口仅支持DDS社区版。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI URI格式 GET h