修改MongoDB实例的参数。
接口说明
调用本接口时,云数据库 MongoDB 实例的状态为运行中。
如果修改的参数中包含需要重启才能生效的参数,调用本接口后实例将自动重启。您可以调用 DescribeParameterTemplates 接口查询哪些参数修改后需要重启实例才能生效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
dds:ModifyParameters |
update |
*Instance
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。您可以通过调用 DescribeRegions 接口查询。 |
cn-hangzhou |
DBInstanceId |
string |
是 |
实例 ID。 说明
当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。 |
dds-bp19f409d75**** |
NodeId |
string |
否 |
分片集群实例中的 Mongos 节点 ID 或 Shard 节点 ID。 说明
当 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。 |
d-bp1b7bb3bbe**** |
Parameters |
string |
是 |
需要修改的参数及参数值,格式为 JSON 串,例如:{"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。 说明
您可以通过调用 DescribeParameterTemplates 接口查询默认的参数模板列表。 |
{"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"} |
CharacterType |
string |
否 |
实例的角色类型,取值说明:
|
db |
SwitchMode |
string |
否 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回信息。 |
||
RequestId |
string |
请求 ID。 |
36923CC2-DDAB-4B48-A144-DA92C1E19537 |
示例
正常返回示例
JSON
格式
{
"RequestId": "36923CC2-DDAB-4B48-A144-DA92C1E19537"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidParameters.Format | Specified parameters is not valid. | 输入的参数无效。 |
400 | InvalidParameterForInstanceVersion | Parameter %s is not valid for instance's MinorVersion. | 当前实例小版本不支持参数 %s,请尝试升级小版本。 |
400 | InvalidParameter | The specified parameter %s is not valid. | 参数 %s 非有效参数。 |
400 | OplogSizeLowerThanInstanceStorage | The oplogSizeMB parameter entered is less than 10% of the instance store size. | 输入的oplogSizeMB参数低于实例存储大小的10%。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。