文档首页/智能边缘云 IEC/API参考/API/边缘实例/批量关机边缘实例 - BatchStopInstance
更新时间：2025-10-29 GMT+08:00
查看PDF
分享

批量关机边缘实例 - BatchStopInstance

功能介绍

批量关闭边缘实例。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/cloudservers/action

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表2 请求Body参数

参数

是否必选

参数类型

描述

os-stop

否

BatchStop object

标记为关闭边缘实例操作。

表3 BatchStop

参数

是否必选

参数类型

描述

servers

是

Array of BaseId objects

待停止的边缘实例列表。

type

否

String

关机类型，默认为SOFT。

取值范围：

  • SOFT：普通关机。

  • HARD：强制关机。

表4 BaseId

参数

是否必选

参数类型

描述

id

是

String

对象ID，uuid。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

jobs

Array of JobResult objects

任务列表对象。

表6 JobResult

参数

参数类型

描述

job_id

String

提交任务成功后返回的任务ID，用户可以使用该ID对任务执行情况进行查询。

请求示例

批量关闭边缘实例，请求参数必须以"os-stop"字段下发

POST https://{endpoint}/v1/cloudservers/action

{
  "os-stop" : {
    "type" : "HARD",
    "servers" : [ {
      "id" : "cedd5deb-9386-4605-b2e3-2de387c39a80"
    }, {
      "id" : "28fddce3-3797-4a26-8145-abeb335c0abb"
    } ]
  }
}

响应示例

状态码：200

OK

{
  "jobs" : [ {
    "job_id" : "3c35a99c76a887cc0176ae2fd3b33666"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：边缘实例

相关文档