更新时间:2023-11-29 GMT+08:00

批量下线设备

功能介绍

设备批量下线

URI

POST /v2/{project_id}/link/instances/{instance_id}/devices/force-offline

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:0

最大长度:32

instance_id

String

实例的ID

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:100000

表3 请求Body参数

参数

是否必选

参数类型

描述

device_ids

Array of integers

设备ID列表,自动向下取整

最小值:1

最大值:99999999999999999

数组长度:0 - 999999

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

success

Array of DeviceInfoSimple objects

下线成功设备列表

数组长度:0 - 9999

failed

Array of DeviceInfoSimple objects

下线失败设备列表

数组长度:0 - 9999

表5 DeviceInfoSimple

参数

参数类型

描述

id

Integer

设备ID

最小值:1

最大值:99999999999999999

device_name

String

设备名称

最小长度:0

最大长度:32

device_id

Integer

设备ID(兼容20.0)

最小值:1

最大值:99999999999999999

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码

最小长度:0

最大长度:64

error_msg

String

错误描述

最小长度:0

最大长度:200

request_id

String

消息ID

最小长度:0

最大长度:64

请求示例

批量下线列表中的设备

{
  "device_ids" : [ 10001, 10002 ]
}

响应示例

状态码: 200

OK

{
  "success" : [ {
    "id" : 711554,
    "device_name" : "success",
    "device_id" : 711554
  } ],
  "failed" : [ {
    "id" : 711554,
    "device_name" : "failed",
    "device_id" : 711554
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-device.forceDisconnect]. Parameter is [deviceDisconnectRequest]. Processor is [body].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码: 404

Not Found

{
  "error_code" : "ROMA.00110006",
  "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.",
  "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01"
}

状态码: 500

Internal Server Error

{
  "error_code" : "ROMA.00110002",
  "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611",
  "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01"
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

错误码

请参见错误码