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

ModifyDBInstanceParameters

最近更新时间：2023.09.20 21:54:54

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

我的收藏

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

注意事项

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

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述

InstanceId

String

是

mongo-shard-9a554522****

实例 ID。

说明

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

ParametersObjectObject是{
"ParameterName":"cursorTimeoutMillis",
"ParameterRole":"Node",
"ParameterValue":"600001"
}		需要修改的参数详情。关于 ParametersObject 的更多信息，请参见数据结构。

返回数据

名称类型示例值描述
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****"
    }
}