应用参数模板v2
更新时间 2025-10-11 14:40:06
最近更新时间: 2025-10-11 14:40:06
接口功能介绍
应用参数模板到实例
接口约束
无
URI
POST /DDS2/v2/openApi/applyParameterTemplate
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 60d420bffb394************************* | |
| parameterGroupId | 是 | String | 参数模板ID | parameters | |
| dbVersion | 是 | String | 实例对应的数据库版本 | 4.0，版本号与实例对应 | |
| nodeType | 是 | String | 实例对应的节点类型 | 单节点或副本集为：Mongod，对于集群可选：Mongos，Configsvr，Shard |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 返回码 取值范围：800 成功 | 800 | |
| message | String | 返回消息 | 修改参数成功 | |
| returnObj | Object | 返回对象 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 |
枚举参数
无
请求示例
请求url
无
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
{
"prodInstId": "60d420bffb394*************************",
"parameterGroupId": "127",
"dbVersion": "4.0",
"nodeType": "Mongod"
}
/* 分片集群*/
{
"prodInstId": "60d420bffb394*************************",
"parameterGroupId": "127",
"dbVersion": "4.0",
"nodeType": "Shard"
}
响应示例
{
"statusCode": 800,
"message": "应用参数模板成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
