更新时间:2024-08-02 GMT+08:00
分享

重启DDM实例

功能介绍

重启指定的DDM实例。

接口约束

无。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

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”接口来获取。

表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" : "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

错误码

请参见错误码

相关文档