文档

StopInstance - 停止实例

更新时间:

调用StopInstance,停止DSW实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

PUT /api/v2/instances/{InstanceId}/stop

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。如何获取实例 ID,请参见 ListInstances

dsw-730xxxxxxxxxx
SaveImageboolean

是否保存环境后再关闭实例。

  • 打开开关:保存环境后再关闭实例。
  • 关闭开关:不保存环境数据,直接关闭实例。
false

返回参数

名称类型描述示例值
object

执行结果。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码。

null
InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-01-20OpenAPI 返回结构发生变更查看变更详情