检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
欢迎使用文档数据库服务（Document Database Service，简称DDS）。您可以使用本文档提供API对文档数据库服务进行相关操作，如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前，请确保已经充分了解文档数据库服务相关概念，详细信息请参见产品介绍。 父主题：
从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 请求消息
终结实例节点会话 接口说明 终结实例节点会话。 约束说明 支持版本为3.4、4.0、4.2、4.4和5.0的社区版实例。 非活跃会话不允许终结。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{pr
状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 304 Not modified 请求失败。 请求参数不符合规则。 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。
库表级时间点恢复 接口说明 为了保证数据完整性，降低对原实例的性能影响，在进行表级时间点恢复备份时，首先将选中时间点的全量数据和增量数据在后台恢复至一个临时实例，然后自动导出用户需要恢复的表，再将这些表恢复至原实例。 约束说明 该接口只支持副本集实例。 调试 您可以在API Explorer中调试该接口。
设置自动备份策略 接口说明 设置自动备份策略。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy URI样例
从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
查询任务列表和详情 接口说明 根据指定条件查询任务中心中的任务列表和详情。 约束说明 目前只支持查询DDS社区版任务中心一个月内的异步任务。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3.1/{project_id}/jobs
权限策略和授权项 策略和授权项说明 文档数据库服务授权项说明
查询数据库错误日志（新版） 接口说明 查询数据库错误日志信息。 约束说明 不支持使用 &&、||、AND、OR、NOT、*、？、:、>、<、=、>=、<= 这些关键字来搜索日志。 每页查询最大限制100条，日志最多保存30天。 调试 您可以在API Explorer中调试该接口。 URI URI格式
查询回收站实例列表 接口说明 查询回收站实例列表。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endpoint}/v3/{project_id}/recycle-instances URI样例 https://dds.cn-north-1
查询集群均衡设置 接口说明 查询DDS集群的数据均衡设置，包括均衡开关和均衡活动时间窗的设置。其中，均衡活动时间窗的信息仅在DDS 4.0及以上版本返回。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET http
从IAM服务获取的用户Token。请参考认证鉴权。 project_id string path 是 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 请求消息
绑定弹性公网IP 接口说明 为实例下的节点绑定弹性公网IP。 约束说明 冻结实例，异常实例不支持该操作。 集群实例的shard和config节点，副本集的Readonly节点以及Hidden角色节点不支持该操作。 不支持多个弹性公网IP绑定同一个节点。 调试 您可以在API Explorer中调试该接口。
从IAM服务获取的用户Token。请参考认证鉴权。 project_id 是 String 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id 是 String 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 请求消息
副本集跨网段访问配置 接口说明 副本集跨网段访问配置。 约束说明 只支持副本集实例。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network
获取项目ID 操作场景 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。有如下获取方式： 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:/
设置集群均衡开关 接口说明 设置DDS集群的数据均衡开关。 约束说明 冻结实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instan
异常请求结果 异常响应参数说明 表1 参数说明 名称 参数类型 描述 error_code String 提交任务异常时返回的错误编码。 error_msg String 提交任务异常时返回的错误描述信息。 异常响应示例 { "error_code": "DBS.200001"
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
