文档首页> 分布式数据库中间件 DDM> API参考> API（推荐）> 实例管理> 重启DDM实例
更新时间：2023-07-10 GMT+08:00
查看PDF

重启DDM实例

功能介绍

重启指定的DDM实例。

接口约束

无。

URI

POST /v1/{project_id}/instances/{instance_id}/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

DDM实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

restart

否

RestarInstanceInfo object

重启相关的参数。
表4 RestarInstanceInfo

参数

是否必选

参数类型

描述

type

否

String

重启的类型，soft或者hard。

  • soft表示软重启（只重启进程）。
  • hard表示强制重启（重启虚拟机）。

枚举值：

  • soft
  • hard

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

instanceId

String

DDM实例ID。

instanceName

String

DDM实例名称。

jobId

String

任务ID。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

重启实例，只重启进程。

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/action

{
  "restart" : {
    "type" : "soft"
  }
}

响应示例

状态码： 200

ok

{
  "instanceId" : "28e8841d0b9c4f6a9a30742ee60e1068in09",
  "instanceName" : "BUG-ddm-fb88-test",
  "jobId" : "1eb697c0-1842-43a3-8671-f562d0385cb9"
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码： 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

ok

400

bad request

500

server error

错误码

请参见错误码。

父主题： 实例管理