- 最新动态
- 功能总览
-
服务公告
- 漏洞公告
-
产品公告
- 【通知】2024年11月5日起文档数据库服务DDS5.0版本集群开放公测
- 【通知】2024年10月11日起文档数据库服务DDS副本集5.0版本开始转商计费
- 【通知】华为云文档数据库服务DDS3.4版本计划于2024年10月11日停售
- 【通知】2024年07月24日起文档数据库服务DDS5.0版本开放公测
- 【通知】2023年02月15日起文档数据库服务上线x86架构增强Ⅱ型副本集和集群shard的1:8系列规格
- 【通知】文档数据库服务DDS4.4邀请公测
- 【停售公告】华为云文档数据库服务DDS单节点规格计划于2023年07月15日停售内部通知
- 【通知】2023年10月8日起文档数据库服务DDS4.4版本开始转商计费
- 版本说明
- 产品发布说明
- 产品介绍
- 计费说明
- 快速入门
- 开发指南
-
用户指南
- 购买实例
- 连接实例
- 数据迁移
- 性能调优
- 权限管理
- 实例生命周期管理
- 变更实例
- 数据备份
- 数据恢复
- 参数模板管理
- 连接管理
- 数据库使用
- 数据安全性
- 监控与告警
- 审计
- 日志管理
- 任务中心
- 智能DBA助手
- SQL自动查杀
- 跨可用区容灾
- 标签管理
- 配额管理
- DDS使用规范建议
- 最佳实践
- 安全白皮书
- 性能白皮书
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 快速入门
-
API v3(推荐)
- 查询API版本
- 查询数据库版本信息
- 查询数据库规格
- 查询数据库磁盘类型
-
实例管理
- 创建实例
- 重启实例
- 删除实例
- 查询实例列表和详情
- 扩容实例存储容量
- 扩容集群实例的节点数量
- 变更实例规格
- 切换副本集实例的主备节点
- 切换SSL开关
- 修改实例名称
- 修改实例备注
- 修改数据库端口
- 变更实例安全组
- 绑定弹性公网IP
- 解绑弹性公网IP
- 修改实例内网地址
- 创建集群的Shard/Config IP
- 副本集跨网段访问配置
- 查询实例可迁移到的可用区
- 实例可用区迁移
- 设置实例回收站策略
- 扩容副本集实例的节点数量
- 实例新增只读节点
- 数据库补丁升级
- 开启/关闭秒级监控
- 查询秒级监控配置
- 设置可维护时间段
- 查询实例回收站策略
- 查询回收站实例列表
- 检查弱密码
- 查询数据库补丁升级预估时长
- 查询实例磁盘信息
- 获取SSL证书下载地址
- 查询数据库复制集名称
- 修改数据库复制集名称
- 删除实例的节点
- 删除实例的只读节点
- 查询副本集跨网段访问配置
- 查询LTS日志配置信息
- 关联LTS日志流
- 解除关联LTS日志流
- 设置磁盘自动扩容策略
- 查询磁盘自动扩容策略
- 批量数据库补丁升级
- 连接管理
- 备份与恢复
- 参数配置
- 获取日志信息
- 标签管理
- 管理数据库和用户
- 配额管理
- 数据库运维
- 任务管理
- API v3(即将下线)
- 应用示例
- 权限策略和授权项
- 附录
- SDK参考
- 场景代码示例
- 常见问题
-
故障排除
- 概述
- DDS实例节点故障处理机制
- 连接失败,提示:network error while attempting to run command ‘isMaster’
- 连接失败,提示:No route to host以及connection attempt failed
- 连接失败,提示:Authentication failed
- 连接失败,提示:couldn't connect to server
- 连接失败,提示:cannot list multiple servers in URL without ‘replicaSet’ option
- Java驱动连接实例失败,提示:Timeout while receiving message
- 连接失败,提示:exception: login failed 以及 U_STRINGPREP_PROHIBITED_ERROR
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
创建参数模板
接口说明
创建参数模板信息,包含参数模板名称、描述、数据库版本信息、参数值。
约束说明
- 该接口仅支持DDS社区版。
- 创建参数模板的名称“name”不能与默认参数模板或已有参数模板的名称重复,并且区分大小写。
- 创建参数模板的parameter_values参数必须在指定数据库版本的默认参数范围内,具体可配置范围请参见《文档数据库服务用户指南》中“编辑参数模板”的内容。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
名称 |
类型 |
IN |
是否必选 |
描述 |
---|---|---|---|---|
X-Auth-Token |
string |
header |
是 |
从IAM服务获取的用户Token。请参考认证鉴权。 |
project_id |
string |
path |
是 |
租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 |
请求消息
- 参数说明
表2 请求Body参数 参数
参数类型
是否必选
描述
name
String
是
参数模板名称。
取值范围:长度1到64位之间,区分大小写字母,可包含字母、数字、中划线、下划线或句点,不能包含其他特殊字符。
description
String
是
参数模板描述。默认为空。
取值范围:长度不超过256位,且不能包含回车和>!<"&'=特殊字符。
parameter_values
Map<String,String>
是
参数名和参数值映射关系。用户可以基于默认参数模板的参数,自定义的参数值。
datastore
Object
是
数据库对象。
请参见表3。
表3 datastore字段数据结构说明 名称
参数类型
是否必选
说明
node_type
String
是
node_type参数模板节点类型。取值范围:- mongos,表示集群mongos节点类型。
- shard,表示集群shard节点类型。
- config,表示集群config节点类型。
- replica,表示副本集类型。
- readonly,表示副本集只读节点类型。
- shard_readonly,表示集群只读节点类型。
- single,表示单节点类型。
version
String
是
数据库版本。支持5.0、4.4、4.2、4.0、3.4版本,取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。
请求示例
{ "name" : "myparameter", "description" : "parameter1", "datastore" : { "node_type" : "shard", "version" : "3.4" }, "parameter_values" : { "max_connections" : "10" } }
响应消息
- 参数说明
表4 响应Body参数 名称
参数类型
描述
configuration
ParamGroupInfoResult object
参数模板列表。
表5 configuration字段数据结构说明 名称
参数类型
说明
id
String
参数模板ID。
name
String
参数模板名称。
description
String
参数模板描述。
datastore_version
String
数据库版本。
datastore_name
String
数据库类型。
created
String
创建时间,格式为“yyyy-MM-ddTHH:mm:ssZ”。
其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。
updated
String
更新时间,格式为“yyyy-MM-ddTHH:mm:ssZ”。
其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。
- 响应示例
{ "configuration": { "id": "7b4e07852bd54016906e89461b3182cdpr02", "name": "myparameter", "description": "parameter1", "datastore_version": "3.4", "datastore_name": "mongodb", "created": "2018-09-19T02:54:21", "updated": "2018-09-19T02:54:21" } }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。