更新设备状态 - UpdateStatus
功能介绍
功能介绍:批量更新第三方设备的运行状态。请求体中设备ID列表为必填且每个设备ID需为UUID格式,目标状态仅支持离线(0)与可用(1);更新成功后返回操作结果状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/devices/status
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 以IAM服务接口返回值为准,字符长度为32个字符。 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| device_ids | 是 | Array of strings | 参数解释: 设备ID列表,数组中的每个元素为设备ID(String类型),可通过查询设备列表接口获取设备ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| status | 是 | Integer | 参数解释: 要更新的设备状态值,用于设置设备的目标状态 约束限制: 不涉及 取值范围: 0-离线 1-可用 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
更新设备状态
{
"device_ids" : [ "826314dd-1b5b-4037-b976-5f9b7a17df46", "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e" ],
"status" : 1
} 响应示例
状态码:200
{
"status" : "success"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 更新成功 |
错误码
请参见错误码。