文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 设备集成API/ 设备管理/ 导出设备
更新时间：2024-10-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

导出设备

功能介绍

导出设备。

调试

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

URI

GET /v2/{project_id}/link/instances/{instance_id}/devices/export

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：32

instance_id

是

String

实例的ID。

最小长度：0

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

device_ids

否

Array

待导出设备ID列表。

最小长度：0

最大长度：999999

数组长度：1 - 500

password_type

否

Integer

0-无密码 1-明文密码

最小值：0

最大值：1

file_export_type

否

String

导出文件类型xls和csv。

缺省值：csv

最小长度：1

最大长度：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

最大长度：100000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

-

File

OK

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

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

最小长度：0

最大长度：64

error_msg

String

错误描述。

最小长度：0

最大长度：200

request_id

String

消息ID。

最小长度：0

最大长度：64

请求示例

GET /{project_id}/link/instances/{instance_id}/devices/export

响应示例

状态码： 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-product.exportProduct]. Parameter is [X-Auth-Token]. Processor is [header].",
  "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01"
}

状态码： 404

Not Found

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Not Found",
  "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

错误码

请参见错误码。

父主题： 设备管理

相关文档