说明
获取指定项目下的设备列表
请求地址
https://openapi.haiwell.com/api/v1/projects/devices
请求方法
GET
公共请求参数
| 参数名称 | 参数类型 | 数据类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| Client-ID | Header | String | 是 | 开发者中心应用密钥 clientID |
| Authorization | Header | Strings | 是 | 通过 Credentials 获取的 token |
请求参数
| 参数 | 参数类型 | 数据类型 | 是否必需 | 描述 |
|---|---|---|---|---|
| limit | Query | Long | 是 | 获取的最大记录数,默认为 10,最大 100 |
| offset | Query | Long | 是 | 返回页码,默认 1,页码从 1 开始(当前采用分页返回,记录数和页数必需一起传) |
| project_id | Query | Long | 是 | 所属项目 id |
HTTP 状态码
| 返回值 | 描述 |
|---|---|
| 200 | 操作成功,详见响应参数 |
| 429 | 并发限流 |
| 500 | 服务端异常 |
业务错误码
| 返回值 | 描述 |
|---|---|
| 10000 | 客户端传参异常,详见异常响应参数 |
| 10001 | 公共参数错误 |
| 10016 | client 下线或者 clientId 不正确(身份不正确) |
| 10019 | token 已过期 |
| 50000 | 服务端异常 |
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | Long | 成功返回码默认 0 |
| reason | String | 服务端定义的标签,用于业务快速定位问题 |
| data | Object | 返回数据结构体 |
| - data.total | Long | 数据总数 |
| - data.list | Object[] | 工程列表 |
| -- data.list[0].device_name | String | 设备名称 |
| -- data.list[0].device_code | String | 设备 PN 码 |
| -- data.list[0].device_remark | String | 设备备注 |
异常响应参数
| 参数 | 数据类型 | 描述 |
|---|---|---|
| error_msg | String | 表示一个错误代码字符串,可以用于对错误进行分类,并对错误进行处理 |
| code | String | 服务端定义的错误码,用于快速定位问题 |
| reason | String | 服务端定义的标签,用于业务快速定位问题 |
请求消息示例
GET /webscadas?limit=10&offset=1&project_id=1 HTTP/1.1
Host: openapi.haweill.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"code": 0,
"data": {
"taotal": 2,
"list": [
{
"device_code": "71025299910020100005",
"device_name": "cloud device",
"device_remark": "演示设备1"
},
{
"device_code": "71025299910020100006",
"device_name": "cloud device",
"device_remark": "演示设备2"
}
]
}
}