You need to enable JavaScript to run this app.
导航
RestartDBInstance
最近更新时间:2024.10.17 14:42:41首次发布时间:2022.04.12 11:06:53

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

请求类型

异步请求。

注意事项

  • 仅实例状态为运行中(即 Running)的实例支持重启操作。
  • 实例重启过程中,部分服务的访问在短时间内会受到影响,请谨慎操作。
  • 建议在业务低峰期执行重启操作,并确保应用具备自动重连机制。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mongo-replica-e405f8e2****

实例 ID。

说明

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

返回参数

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

示例

请求示例

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

返回示例

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

错误码

更多详情,请参见错误码