1. 描述

修改设备信息。本接口是God可以访问的,God几乎可以修改Dev的所有属性。在未来,Dev的不重要属性可以被其它角色修改。

2. 调用场景

开发者登录超级控制台后,可以修改自己创建的设备。开发者以God角色修改设备。未来可能开放给专门的设备/设备运维。

3. 配置参数

参数意义参考接口参数

参数名 参数值 说明
Name SetDev
URL https://api.xdua.com/devp
Method PUT
XduaApiHttpSchema HTTPS 只走HTTPS
XduaApiMethod SET
XduaApiColor X 只有持有神设备,才可以创建设备
XduaApiAudience ConsoleX 只有devp_id为ConsoleX的设备,也就是consolex.xdua.com才可以发起本请求
XduaApiShop XdUaXduA 设备直辖店铺,只有这个店铺的登录人员才可以访问
XduaApiSubject i i,只有创建者自己才可以修改
XduaApiRoles God 只要登录就可以创建设备
XduaApiResource dev
XduaApiKparam id
XduaApiAction UpdateDev
XduaApiRule UpdateDev
XduaApiAstates 0 按序devp,zone,corp,shop,devp,devp,login的状态都必须是0(STATE_ENABLED)
XduaApiEnable true 接口使能

4. 请求参数

名称 位置 类型 必填 默认值 示例 说明
id path String 6tYu82hM 设备ID
unid body String Minew unid
snid body String CBOX-7 snid
name body String 蓝牙网关 新的名字

5. 返回参数

名称 位置 类型 示例 说明
id result string rYub4wrT 修改的设备ID
updates result json dict 修改的内容

示例

result字段

{
    "id":"rYub4wrT",
    "updates":{
        "name":"新的设备名",
        "brief":"新的设备介绍",    
    }    
}

6. 错误码

错误码来自于error字段,通用错误码参考地球号通用错误码

7. SDK调用

为了方便测试SetDev接口。数据库专门提供了一个测试设备devp_id=TeStTeSt。可以对这个设备的所有属性进行修改,而不用担心损坏数据库。

const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
    LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})

/*----------------------------
 * 运行如下代码
 * 下面的代码是直接可以运行的
 *--------------------------*/
api_name = "修改设备";
const devp_id ="TeStTeSt"; //要修改的设备ID

/*----------------------------
 * 下面展示的是修改"TeStTeSt"所有属性的操作,实际上可以只修改其中任何一个到两个参数
 *--------------------------*/

const dev_id ="TeStTeSt"; //一个测试产品
const set_params = {
    unid:"VIR.TESTTEST",        //类别
    snid:"新的序列号",        //类别
    name:"新的名字",        //类别
}


const res_api = await xduaClient.setDev(dev_id,set_params)

if(res.error == 0){
    console.log("测试成功");    
}else{
    console.log("测试失败");   
    console.log(res); 
}

文档还没有实现

```

{% sample lang="php" -%}

文档还没有实现

```bash

results matching ""

    No results matching ""