文档中心

文档数据库 MongoDB 版

实例管理

RestartDBInstance

调用 RestartDBInstance 接口重启目标 MongoDB 实例。

请求类型

异步请求。

注意事项

仅实例状态为运行中（即 Running）的实例支持重启操作。

实例重启过程中，部分服务的访问在短时间内会受到影响，请谨慎操作。

建议在业务低峰期执行重启操作，并确保应用具备自动重连机制。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

InstanceId String 必选示例值：mongo-replica-e405f8e2****

实例 ID。

说明

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

返回参数

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

示例

请求示例

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=RestartDBInstance&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-e405f8e2****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2022022311243401021203723019071907",​
        "Action": "RestartDBInstance",​
        "Version": "2022-01-01",​
        "Service": "mongodb",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

错误码

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

最近更新时间：2026.06.17 15:58:13

这个页面对您有帮助吗？

有用

无用