ModifyMultiDBInstanceParameters--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

ModifyMultiDBInstanceParameters

最近更新时间：2025.05.26 16:11:44首次发布时间：2024.12.04 11:48:54

调用 ModifyMultiDBInstanceParameters 接口修改目标 MongoDB 实例中的多个参数。

请求类型

异步请求。

注意事项

部分参数修改后，需要重启实例，新参数值才能生效。实例重启时间取决于实例的负载状态，重启过程中实例可能会出现 1~2 次闪断，请谨慎操作。建议在业务低峰期操作并增加应用重连机制，可以大幅降低数据库连接闪断对业务的影响。更多详情，请参见修改实例参数。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-9a554522****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
ParameterObjects	Object[]	是		需要修改的参数列表。说明如需修改多个参数，必须保证多个参数的 `ParameterRole` 取值均一致。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例 1

同时修改副本集实例的 cursorTimeoutMillis 和 journalCommitInterval 参数值。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyMultiDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-replica-8d67f589****",
    "ParameterObjects": [
        {
            "ParameterName": "cursorTimeoutMillis",
            "ParameterValue": "600001",
            "ParameterRole": "Node"
        },
        {
            "ParameterName": "disableJavaScriptJIT",
            "ParameterValue": "false",
            "ParameterRole": "Node"
        }
    ]
}

返回示例 1

{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "ModifyMultiDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

请求示例 2

同时修改分片集群实例中 Shard 的 wiredTigerConcurrentWriteTransactions 和 net.maxIncomingConnections 参数值。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyMultiDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "mongo-shard-9a554522****",
    "ParameterObjects": [
        {
            "ParameterName": "net.maxIncomingConnections",
            "ParameterValue": "Default",
            "ParameterRole": "Shard"
        },
        {
            "ParameterName": "wiredTigerConcurrentWriteTransactions",
            "ParameterValue": "120",
            "ParameterRole": "Shard"
        }
    ]
}

返回示例 2

{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "ModifyMultiDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。