绑定设备
接口描述
绑定一台或多台未被绑定的设备到账号下。
请求说明
接口ID |
协议 |
方法 |
PATH |
3 |
HTTPS |
POST |
/openapi/v1/stp/user/devices |
PATH参数
无
URL参数
参数 |
类型 |
必填 |
说明 |
accesskey_id |
string |
是 |
参见签名认证 |
expires |
int |
是 |
参见签名认证 |
signature |
string |
是 |
参见签名认证 |
HTTP请求头
字段 |
值 |
Content-Type |
application/json |
请求参数
请求参数以Json格式放置于Body中,此接口请求参数是一个Json对象数组,对象字段如下:
参数 |
类型 |
必填 |
说明 |
sn |
string |
是 |
设备SN |
group_id |
int |
是 |
需要绑定到的分组id |
username |
string |
否 |
设备的登录用户名,用于远程访问时自动登录,不会修改设备的用户名 |
password |
string |
否 |
设备的登录密码,用于远程访问时自动登录,不会修改设备的密码 |
remark |
string |
否 |
备注 |
注:group_id
可以在控制台的修改分组对话框内查看,如下图所示:

请求示例
POST https://open.vzicloud.com/openapi/v1/stp/user/devices?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Host: open.vzicloud.com
Content-Length: 202
Content-Type: application/json
[ {"sn": "12345678-87654321", "group_id": 0, "username": "admin", "password": "admin", "remark": ""}, {"sn": "12345678-87654322", "group_id": 0, "username": "admin", "password": "admin", "remark": ""} ]
返回说明
返回参数
参数 |
类型 |
说明 |
successes |
array |
成功的设备列表 |
+ sn |
string |
设备SN |
+ group_id |
int |
需要绑定到的分组id |
+ username |
string |
设备的登录用户名,用于远程访问时自动登录,不会修改设备的用户名 |
+ password |
string |
设备的登录密码,用于远程访问时自动登录,不会修改设备的密码 |
+ remark |
string |
备注 |
failures |
array |
失败的设备列表和原因 |
+ sn |
string |
设备SN |
+ group_id |
int |
需要绑定到的分组id |
+ username |
string |
设备的登录用户名,用于远程访问时自动登录,不会修改设备的用户名 |
+ password |
string |
设备的登录密码,用于远程访问时自动登录,不会修改设备的密码 |
+ remark |
string |
备注 |
+ error |
struct |
错误信息 |
++ code |
int |
错误码 |
++ message |
string |
错误描述 |
返回示例
{
"successes": [{"sn": "12345678-87654321", "group_id": 0, "username": "admin", "password": "admin", "remark": ""}],
"failures": [{"sn": "12345678-87654322", "group_id": 0, "username": "admin", "password": "admin", "remark": "", "error": { "code": 1003, "message": "该设备已被绑定" }}]
}