获取设备列表

功能介绍

获取设备列表

调试

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

URI

GET /v2/{project_id}/device-manager/devices

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参见获取项目ID

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	查询的起始位置，取值范围为非负整数，默认为0
limit	否	Integer	每页显示的条目数量，取值范围1~100，默认为100
name	否	String	设备名称，模糊匹配，只允许中英文、数字、下划线、中划线，长度1-60

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	租户Token。获取方法请参见获取Token

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total	Integer	满足条件的设备总数
data	Array of GetDevicesListArrayObject objects	设备实体列表

表5 GetDevicesListArrayObject
参数	参数类型	描述
id	String	设备ID
name	String	设备名称
type	String	设备类型
status	Integer	设备状态(0:离线;1:在线)
cpu	Integer	cpu核数
memory	Integer	内存大小
os	String	操作系统
firmware_name	String	固件名称
firmware_version	String	固件版本
firmware_status	Integer	固件状态(1:更新中，2：更新失败，3：更新成功)
firmware_cause	String	固件更新失败原因
path	String	设备数据存储路径，该桶需要和当前region匹配
path_update_status	Integer	设备数据存储路径更新状态(0:更新成功，1：更新中)
path_update_cause	String	设备数据存储路径更新失败原因
create_time	Long	创建时间（时间戳）
update_time	Long	更新时间（时间戳）
user_time	String	IAM用户名
resource_spec_code	String	计费资源码
cloud_service_type	String	云服务计费类型
active_content	String	激活内容
active_flag	Integer	激活状态(0:未激活，1：已激活且付费，2：已激活且免费，3：付费到期，4：已激活使用SN码，5：已激活30天免费，6：免费到期)
topic_urn	String	关联设备的主题消息推送的URN地址

请求示例

无

响应示例

状态码： 200

获取设备列表成功

{
  "total" : 0,
  "data" : [ {
    "id" : "6b0e806f35c2470a825da1f1ab05caf5",
    "name" : "Hello_nihao",
    "type" : "HiLens Kit",
    "status" : 1,
    "cpu" : 2,
    "memory" : 3.5,
    "os" : "GNU/Linux",
    "firmware_name" : "HiLens_Device_Agent",
    "firmware_version" : "1.0.2",
    "firmware_status" : 1,
    "firmware_cause" : null,
    "path" : "https://datafortesting.obs.xxx.com/qwweere/",
    "path_update_status" : 1,
    "path_update_cause" : null,
    "create_time" : 1234563,
    "update_time" : 1234563,
    "user_time" : "Chace",
    "resource_spec_code" : "platform.management",
    "cloud_service_type" : "xxx.service.type.hilens",
    "active_content" : null,
    "active_flag" : 2,
    "topic_urn" : "urn:smn:xxx:xx:xxx"
  } ]
}