You need to enable JavaScript to run this app.
导航
文档数据库 MongoDB 版
  • 文档首页
    • /
  • 文档数据库 MongoDB 版

ModifyDBInstanceParameters

最近更新时间：2024.04.26 11:09:10

首次发布时间：2022.08.04 11:24:57

我的收藏

调用 ModifyDBInstanceParameters 接口修改指定实例的参数。

请求类型

异步请求。

注意事项

部分参数值修改后需要重启实例才能生效。实例重启会造成连接中断，建议在业务低峰期修改相关参数，并确保业务具备重连机制。

请求参数

参数类型是否必选示例值描述

InstanceId

String

是

mongo-shard-9a554522****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

ParametersObject

Object of ParametersObject

是

{
"ParameterName":"cursorTimeoutMillis",
"ParameterRole":"Node",
"ParameterValue":"600001"
}

需要修改的参数详情。

ParametersObject

参数类型是否必选示例值描述

ParameterName

String

是

cursorTimeoutMillis

目标参数的名称。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情，包括参数名称。

ParameterRole

String

是

Node

目标参数所属的节点类型，取值范围如下：

  • Node：副本集实例节点。
  • Shard：分片集群实例中的 Shard 节点。
  • ConfigServer：分片集群实例中的 ConfigServer 节点。
  • Mongos：分片集群实例中的 Mongos 节点。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情，包括参数所属的节点类型。

ParameterValue

String

是

600001

目标参数的取值。

说明

您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情，包括目标参数的取值范围（即 CheckingCode 的值）。

返回参数

参数类型示例值描述
InstanceIdStringmongo-replica-55d59354****实例 ID。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Host: mongodb.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-55d59354****",
    "ParametersObject": {
        "ParameterName": "cursorTimeoutMillis",
        "ParameterRole": "Node",
        "ParameterValue": "600001"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022052716480301022508219902F0****",
        "Action": "ModifyDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "mongo-replica-55d59354****"
    }
}