You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
参数管理
ModifyDBInstanceParameters
复制全文
下载 pdf
ModifyDBInstanceParameters
调用 ModifyDBInstanceParameters 接口修改目标 MongoDB 实例的指定参数。​
请求类型​
异步请求。​
注意事项​
部分参数值修改后需要重启实例才能生效。实例重启会造成连接中断,建议在业务低峰期修改相关参数,并确保业务具备重连机制。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
InstanceId String 必选 示例值:mongo-shard-9a554522****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。​
​
ParametersObject Object 必选 示例值:​
需要修改的参数详情。​
ParameterName String 必选 示例值:cursorTimeoutMillis​
目标参数的名称。​
说明​
您可以调用 DescribeDBInstanceParameters接口查询目标实例支持的参数详情,包括参数名称。​
​
ParameterRole String 必选 示例值:Node​
目标参数所属的节点类型,取值范围如下:​
  • Node:副本集实例节点。​
  • Shard:分片集群实例中的 Shard 节点。​
  • ConfigServer:分片集群实例中的 ConfigServer 节点。​
  • Mongos:分片集群实例中的 Mongos 节点。​
说明​
您可以调用 DescribeDBInstanceParameters接口查询目标实例支持的参数详情,包括参数所属的节点类型。​
​
ParameterValue String 必选 示例值:600001​
目标参数的取值。​
说明​
您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括目标参数的取值范围(即 CheckingCode的值)。​
​
​
​
返回参数​
InstanceId String 示例值:mongo-replica-55d59354****​
实例 ID。​
​
​
示例​
请求示例​
​
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceParameters&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-55d59354****",​
"ParametersObject": {​
"ParameterName": "cursorTimeoutMillis",​
"ParameterRole": "Node",​
"ParameterValue": "600001"​
}​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022052716480301022508219902F002F0",​
"Action": "ModifyDBInstanceParameters",​
"Version": "2022-01-01",​
"Service": "mongodb",​
"Region": "cn-beijing"​
},​
"Result": {​
"InstanceId": "mongo-replica-55d59354****"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.17 16:53:05
这个页面对您有帮助吗?
有用
有用
无用
无用