1. 描述
查询设备。
2. 调用场景
开发者登录http://consolex.xdua.com后,可以以God角色查询属于所有设备。
3. 配置参数
参数意义参考接口参数
参数名 | 参数值 | 说明 |
---|---|---|
Name | QryDev | |
URL | https://api.xdua.com/dev | |
Method | GET | |
XduaApiHttpSchema | HTTPS | 只走HTTPS |
XduaApiMethod | QRY | |
XduaApiColor | X | 只有持有神设备,才可以创建设备 |
XduaApiAudience | ConsoleX | 只有dev_id为ConsoleX的设备,也就是consolex.xdua.com才可以发起本请求 |
XduaApiShop | XdUaXduA | 设备直辖店铺,只有这个店铺的登录人员才可以访问 |
XduaApiSubject | u | 所有注册设备均可以使用 |
XduaApiRoles | God | 必须是Zoon才可以查询角色 |
XduaApiResource | dev | |
XduaApiKparam | where |
常量where |
XduaApiAction | QueryDev | |
XduaApiRule | QueryDev | |
XduaApiAstates | 0 | 所有状态都必须是0(STATE_ENABLED) |
XduaApiEnable | true | 接口使能 |
4. URL
5. 请求参数
6. 返回参数
result.list部分,注意下面的位置表达,result.list[]表示这些字段在list里的每一项里都出现。
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result.list[] | string | rYub4wrT | 详情的设备ID |
name | result.list[] | string | 设备的名称 | |
avatar | result.list[] | string | 设备图标 | |
brief | result.list[] | string | 设备的描述 | |
state | result.list[] | int | 0 | 设备的状态 |
stato | result.list[] | string | "冻服更新" | 设备的状态说 |
expire | result.list[] | int | 0 | 设备状态过期时间(UNIX时间戳) |
creator_id | result.list[] | string | Dmtv7TrE | 设备创建者ID |
creator_name | result.list[] | string | 辣椒帅 | 设备创建者名字 |
updator_id | result.list[] | string | XiyRvUp3 | 设备最近一次更新者ID |
updator_name | result.list[] | string | 周海潮 | 设备最近一次更新者名字 |
cstamp | result.list[] | string | 2020-01-20 02:19:55 | 设备创建时间 |
istamp | result.list[] | string | 2020-01-20 02:23:24 | 设备最近更新时间 |
7. 错误码
错误码来自于error字段,通用错误码参考地球号通用错误码
8. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
/*----------------------------
* 运行如下代码
* 下面的代码是直接可以运行的
*--------------------------*/
api_name = "查询设备";
/*------------------------------------------------------
* 分页查询ProductKey是`a1eIYars0q4`的所有设备,显示第2页,每页显示20条
*----------------------------------------------------*/
let query_param = {
limit:20,
page:2,
where:{pkey:"a1eIYars0q4"}
}
/*------------------------------------------------------
* 分页查询unid以`IMEI.`开头的设备,显示第2页,每页显示20条
*----------------------------------------------------*/
let query_param = {
limit:20,
page:2,
where:{"unid[~]":"IMEI.%"}
}
const res_api = await xduaClient.qryDev(query_params)
if(res.error == 0){
console.log("测试成功");
}else{
console.log("测试失败");
console.log(res);
}
文档还没有实现
```
{% sample lang="php" -%}
文档还没有实现
```bash