参数模版

更新时间：2026-09-09

查询参数模板列表

请求结构

Plain Text

1GET /v{version}/instance/parameterTemplate/list HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
type	String	否	Query参数	参数模板类型。取值：`system`：系统默认模板；`custom`：自定义模板。
clusterType	String	否	Query参数	实例类型。取值：`replica`：副本集；`sharding`：分片集。
engineVersion	String	否	Query参数	数据库引擎版本。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
templates	Array	参数模板列表。
templates[].uuid	String	参数模板 ID。
templates[].name	String	参数模板名称。
templates[].clusterType	String	实例类型。
templates[].engineVersion	String	数据库引擎版本。
templates[].description	String	参数模板描述。
templates[].type	String	参数模板类型。`system`：系统默认模板；`custom`：自定义模板。
templates[].parameterCount	Integer	参数数量。
templates[].needRestart	Boolean	应用参数模板后是否需要重启实例。
templates[].createTime	String	创建时间。
templates[].lastModify	String	最近修改时间。

请求示例

Plain Text

1GET /v1/instance/parameterTemplate/list?type=custom&clusterType=replica&engineVersion=5.0 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

返回示例

Plain Text

1{
2  "templates": [
3    {
4      "uuid": "pt-abc123",
5      "name": "replica-prod-5.0",
6      "clusterType": "replica",
7      "engineVersion": "5.0",
8      "description": "生产环境副本集参数模板",
9      "type": "custom",
10      "parameterCount": 1,
11      "needRestart": false,
12      "createTime": "2026-09-01T08:00:00Z",
13      "lastModify": "2026-09-09T08:00:00Z"
14    }
15  ]
16}

查询参数模板详情

请求结构

Plain Text

1GET /v{version}/instance/parameterTemplate/{templateId} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
templateId	String	是	URL参数	参数模板 ID。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
parameterTemplate	Object	参数模板详情。
parameterTemplate.uuid	String	参数模板 ID。
parameterTemplate.name	String	参数模板名称。
parameterTemplate.clusterType	String	实例类型。
parameterTemplate.engineVersion	String	数据库引擎版本。
parameterTemplate.description	String	参数模板描述。
parameterTemplate.type	String	参数模板类型。
parameterTemplate.parameters	Array	参数列表。
parameterTemplate.needRestart	Boolean	应用参数模板后是否需要重启实例。
parameterTemplate.createTime	String	创建时间。
parameterTemplate.lastModify	String	最近修改时间。

请求示例

Plain Text

1GET /v1/instance/parameterTemplate/pt-abc123 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

返回示例

Plain Text

1{
2  "parameterTemplate": {
3    "uuid": "pt-abc123",
4    "name": "replica-prod-5.0",
5    "clusterType": "replica",
6    "engineVersion": "5.0",
7    "description": "生产环境副本集参数模板",
8    "type": "custom",
9    "needRestart": false,
10    "createTime": "2026-09-01T08:00:00Z",
11    "lastModify": "2026-09-09T08:00:00Z",
12    "parameters": [
13      {
14        "name": "net_compression_compressors",
15        "value": "disabled",
16        "defaultValue": "snappy",
17        "candidates": "snappy|zlib|disabled",
18        "needRestart": true,
19        "modifiable": true,
20        "descriptionChinese": "Mongod或Mongos实例之间通信的默认压缩类型。",
21        "descriptionEnglish": "Default compression type for communication between Mongod or Mongos instances."
22      }
23    ]
24  }
25}

创建自定义参数模板

请求结构

Plain Text

1POST /v{version}/instance/parameterTemplate HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
name	String	是	请求Body	参数模板名称。长度为 1～64 个字符，首字符必须为字母或中文，仅支持中文、字母、数字以及 `-`、`_`、`.` 等字符，且不能以 `system_` 开头。
clusterType	String	是	请求Body	实例类型。取值：`replica`：副本集；`sharding`：分片集。
engineVersion	String	是	请求Body	数据库引擎版本。
description	String	否	请求Body	参数模板描述。UTF-8 编码长度不超过 256 字节。
sourceTemplateId	String	否	请求Body	源模板 ID。基于已有模板创建自定义模板时传入。
parameters	Array	否	请求Body	参数列表。系统将对参数名称及参数值进行合法性校验。
parameters[].name	String	是	请求Body	参数名称。
parameters[].value	String	是	请求Body	参数值。

返回头域

除公共头域外，无其他特殊头域。

返回参数

返回参数模板详情，参数说明与查询参数模板详情接口相同。

请求示例

Plain Text

1POST /v1/instance/parameterTemplate HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

Plain Text

1{
2  "name": "replica-prod-5.0",
3  "clusterType": "replica",
4  "engineVersion": "5.0",
5  "description": "生产环境副本集参数模板",
6  "parameters": [
7    {
8      "name": "oplogSizeMB",
9      "value": "2048"
10    }
11  ]
12}

返回示例

Plain Text

1{
2  "parameterTemplate": {
3    "uuid": "pt-abc123",
4    "name": "replica-prod-5.0",
5    "clusterType": "replica",
6    "engineVersion": "5.0",
7    "description": "生产环境副本集参数模板",
8    "type": "custom",
9    "needRestart": false,
10    "createTime": "2026-09-09T08:00:00Z",
11    "lastModify": "2026-09-09T08:00:00Z",
12    "parameters": [
13      {
14        "name": "oplogSizeMB",
15        "value": "2048",
16        "defaultValue": "1024",
17        "candidates": "",
18        "needRestart": false,
19        "modifiable": true,
20        "descriptionEnglish": "Size of the oplog in MB"
21      }
22    ]
23  }
24}

更新自定义参数模板

请求结构

Plain Text

1PUT /v{version}/instance/parameterTemplate/{templateId} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
templateId	String	是	URL参数	参数模板 ID。
name	String	是	请求Body	参数模板名称。
clusterType	String	否	请求Body	实例类型。创建后不可修改。
engineVersion	String	否	请求Body	数据库引擎版本。创建后不可修改。
description	String	否	请求Body	参数模板描述。UTF-8 编码长度不超过 256 字节。
parameters	Array	否	请求Body	参数列表。
parameters[].name	String	是	请求Body	参数名称。
parameters[].value	String	是	请求Body	参数值。

说明

仅支持更新自定义参数模板，系统默认模板不支持更新。

clusterType 和 engineVersion 在参数模板创建后不可修改。

返回头域

除公共头域外，无其他特殊头域。

请求示例

Plain Text

1PUT /v1/instance/parameterTemplate/pt-abc123 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

Plain Text

1{
2  "name": "replica-prod-5.0-v2",
3  "description": "更新后的描述",
4  "parameters": [
5    {
6      "name": "oplogSizeMB",
7      "value": "4096"
8    }
9  ]
10}

返回示例

HTTP/1.1 200 OK

删除自定义参数模板

请求结构

Plain Text

1DELETE /v{version}/instance/parameterTemplate/{templateId} HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
templateId	String	是	URL参数	参数模板 ID。

返回头域

除公共头域外，无其他特殊头域。

请求示例

Plain Text

1DELETE /v1/instance/parameterTemplate/pt-abc123 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

返回示例

HTTP/1.1 200 OK

说明系统默认模板不支持删除。

查询参数模板应用记录

请求结构

Plain Text

1GET /v{version}/instance/parameterTemplate/{templateId}/applyRecord HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
templateId	String	是	URL参数	参数模板 ID。
pageNo	Integer	否	Query参数	页码。
pageSize	Integer	否	Query参数	每页返回的记录数。

返回头域

除公共头域外，无其他特殊头域。

返回参数

参数名称	类型	描述
records	Array	参数模板应用记录列表。
records[].uuid	String	应用记录 ID。
records[].instanceName	String	实例名称。
records[].instanceId	String	实例 ID。
records[].instanceUuid	String	实例 UUID。
records[].region	String	实例所在地域。
records[].zone	String	实例所在可用区。
records[].status	String	应用状态。取值：`applying`：应用中；`success`：成功；`failed`：失败。
records[].createTime	String	应用记录创建时间。
records[].applyTime	String	参数模板实际生效时间。状态为 `applying` 时为空。
records[].deleted	Boolean	实例是否已删除。
totalCount	Integer	应用记录总数。

请求示例

Plain Text

1GET /v1/instance/parameterTemplate/pt-abc123/applyRecord?pageNo=1&pageSize=10 HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string

返回示例

Plain Text

1{
2  "records": [
3    {
4      "uuid": "ar-xyz789",
5      "instanceName": "mongo-prod",
6      "instanceId": "m-CH2TVe",
7      "instanceUuid": "90a1f5c8-b2d4-4e6f-8a9b-c1d2e3f4a5b6",
8      "region": "gz",
9      "zone": "cn-gz-c",
10      "status": "success",
11      "createTime": "2026-09-09T08:00:00Z",
12      "applyTime": "2026-09-09T08:01:00Z",
13      "deleted": false
14    }
15  ],
16  "totalCount": 1
17}

应用参数模板到实例

请求结构

Plain Text

1PUT /v{version}/instance/{instanceId}?applyParameterTemplate HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

请求头域

除公共头域外，无其他特殊头域。

请求参数

参数名称	类型	是否必选	参数位置	描述
version	String	是	URL参数	API版本号。
instanceId	String	是	URL参数	实例 ID。
templateId	String	是	请求Body	参数模板 ID。
executionMode	String	否	请求Body	执行方式。`atOnce`：立即执行；`duringMaintenance`：维护窗口执行。

返回头域

除公共头域外，无其他特殊头域。

请求示例

Plain Text

1PUT /v1/instance/m-CH2TVe?applyParameterTemplate HTTP/1.1
2HOST: mongodb.bj.baidubce.com
3Authorization: authorization string
4Content-Type: application/json

Plain Text

1{
2  "templateId": "pt-abc123",
3  "executionMode": "atOnce"
4}

返回示例

Plain Text

1{
2  "result": true
3}

说明参数模板应用操作等价于一次实例参数修改操作。实际生效状态请通过查询参数模板应用记录接口确认。

评价此篇文章

有帮助没帮助

标签管理

云数据库 DocDB for MongoDB

参数模版

查询参数模板列表

请求结构

请求头域

请求参数

返回头域

返回参数

请求示例

返回示例

查询参数模板详情

请求结构

请求头域

请求参数

返回头域

返回参数

请求示例

返回示例

创建自定义参数模板

请求结构

请求头域

请求参数

返回头域

返回参数

请求示例

返回示例

更新自定义参数模板

请求结构

请求头域

请求参数

返回头域

请求示例

返回示例

删除自定义参数模板

请求结构

请求头域

请求参数

返回头域

请求示例

返回示例

查询参数模板应用记录

请求结构

请求头域

请求参数

返回头域

返回参数

请求示例

返回示例

应用参数模板到实例

请求结构

请求头域

请求参数

返回头域

请求示例

返回示例