正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 instance_id string path 是 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 type String 是
value的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。该场景下,要求请求体中tags结构体不能缺失,且key不能为空,或者空字符串。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https:/
String 实例ID,可以调用“查询实例列表和详情”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 请求消息 参数说明 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 连接地址复制集名称: 实例高可用连接地址的唯一标识。该参数可以将读请求发送到
获取killOp规则列表 接口说明 获取killOp规则列表。 约束说明 仅支持副本集,集群实例。 仅支持数据库版本3.4版本及以后版本。 仅支持执行节点规格4U及以上。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https://{Endp
查询数据库用户列表 接口说明 查询数据库用户列表。 约束说明 该接口支持DDS社区版。 实例在创建、规格变更、修改端口、重启等过程中以及状态为非“normal”时,不允许执行该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET https:/
绑定弹性公网IP 接口说明 为实例下的节点绑定弹性公网IP。 约束说明 冻结实例,异常实例不支持该操作。 集群实例的shard和config节点,副本集的Readonly节点以及Hidden角色节点不支持该操作。 不支持多个弹性公网IP绑定同一个节点。 调试 您可以在API Explorer中调试该接口。
修改数据库用户密码 接口说明 修改数据库密码。 约束说明 冻结实例,异常实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT https://{Endpoint}/v3/{project_id}/instances/{instanc
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:/
快速入门 本节通过调用API创建DDS集群实例。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。 涉及API 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。
解绑弹性公网IP 接口说明 解绑实例下节点已经绑定的弹性公网IP。 约束说明 冻结实例不支持该操作。 没有绑定弹性公网IP的节点不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 POST https://{Endpoint}/v3/{pro
设置集群均衡活动时间窗 接口说明 设置DDS集群的数据均衡活动时间窗。 设置的是utc时间,需要根据自身时区做时间换算。 约束说明 冻结实例不支持该操作。 4.0以下版本的DDS实例不支持该操作。 调试 您可以在API Explorer中调试该接口。 URI URI格式 PUT
数据库运维 获取killOp规则列表 创建killOp规则 启用/禁用killOp规则 删除killOp规则 强制备节点升主 父主题: API v3(推荐)
修改数据库用户密码 检查数据库密码 查询集群均衡设置 设置集群均衡开关 设置集群均衡活动时间窗 删除数据库用户 删除数据库角色 父主题: API v3(推荐)
fig IP、创建物理备份/快照备份、备份恢复新实例、备份恢复到指定时间点、库表级时间点恢复、添加只读节点。 调试 您可以在API Explorer中调试该接口。 URI URI格式 GET /v3/{project_id}/jobs?id={id} URI样例 https://dds
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,HTTP请求返回一个HTTP状态码。返回的消息体中是具体的错误编码及错误描述信息。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码说明
可以通过创建模板的方式创建实例吗 在创建文档数据库实例时,不需要使用模板。用户可选择不同实例规格,相当于提前准备好了很多模板,提供给用户创建实例。 父主题: 创建与删除
欢迎使用文档数据库服务(Document Database Service,简称DDS)。您可以使用本文档提供API对文档数据库服务进行相关操作,如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。 在调用文档数据库服务API之前,请确保已经充分了解文档数据库服务相关概念,详细信息请参见产品介绍。
附录 异常请求结果 状态码 错误码 获取项目ID 文档数据库服务监控指标说明
应用示例 查询实例列表 修改实例名称 删除实例
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念