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

文档中心

立即注册

导航

ModifyDBInstanceParameters

最近更新时间：2024.12.12 21:46:13首次发布时间：2022.08.04 11:24:57

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

请求类型

异步请求。

注意事项

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-9a554522****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
ParametersObject	Object	是		需要修改的参数详情。

返回参数

参数	类型	示例值	描述
InstanceId	String	mongo-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****"
    }
}

错误码

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