更新设备
描述
本接口用于更新设备。
- 接口请求域名:
qvs.qiniuapi.com
- 请求方式:PATCH
- 接口路径:
/v1/namespaces/{namespaceId}/devices/{gbId}
请求参数
路径参数
参数名称 | 必填 | 字段类型 | 说明 |
---|---|---|---|
namespaceId | 是 | string | 空间ID |
gbId | 是 | string | 设备国标Id |
Body
参数名称 | 必填 | 字段类型 | 说明 |
---|---|---|---|
operations | 是 | op数组 | op集合,详见:表一 |
表一: OP集合参数
参数名称 | 必填 | 字段类型 | 说明 |
---|---|---|---|
operations.key | 是 | string | 要修改的参数 |
operations.op | 是 | string | op操作(目前支持replace和delete) |
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略) |
表二: 可编辑参数说明
参数名称 | 字段类型 | 说明 |
---|---|---|
name | string | 设备名称 |
gbId | string | 设备国标ID |
username | string | 用户名 |
password | string | 密码 |
desc | string | 设备描述 |
pullIfRegister | boolean | 注册成功后启动拉流 |
响应参数
参数名称 | 类型 | 说明 |
---|---|---|
name | string | 设备名称 |
desc | string | 设备描述 |
nsId | string | 所属的空间ID |
nsName | string | 所属的空间名称 |
gbId | string | 设备国标ID |
state | string | 状态(offline: 离线, online: 在线, pushing:推流中,notReg: 未注册, locked: 锁定) |
username | string | 用户名 |
password | string | 密码 |
pullIfRegister | boolean | 注册成功后启动拉流, 默认关闭 |
createdAt | integer | 创建时间,Unix时间戳,秒 |
updatedAt | integer | 更新时间,Unix时间戳,秒 |
lastKeepaliveAt | integer | 最近心跳时间, Unix时间戳, 秒 |
lastRegisterAt | integer | 最近注册时间, Unix时间戳, 秒 |
示例
请求示例
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"operations":[{
"key":"desc",
"op":"replace",
"value":"gb patch test"
}]
}'
响应示例
{
"name": "device1",
"desc": "gb patch test",
"nsId": "2akrarvzvyijd",
"nsName": "gbt",
"gbId": "31011500991320000028",
"state": "notReg",
"username": "username",
"password": "password",
"pullIfRegister": false,
"createdAt": 1596166110,
"updatedAt": 1596176486,
"channels": 0,
"lastRegisterAt": 0,
"lastKeepaliveAt": 0
}
文档反馈
(如有产品使用问题,请提交工单)