更新时间:2024-06-20 GMT+08:00
分享

设备控制设置

功能介绍

设备控制设置

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/edge-nodes/{edge_node_id}/devices/{device_id}/controls/set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见 获取项目ID

最小长度:1

最大长度:64

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

device_id

String

设备ID

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

表3 请求Body参数

参数

是否必选

参数类型

描述

control_id

String

控制id

最小长度:1

最大长度:128

service_id

String

服务id,可选

priority

Integer

调度计划优先级。

最小值:1

最大值:16

end_time

Long

控制结束时间,毫秒级时间戳

最小值:0

最大值:4828176000000

properties

Object

属性key和value的map,用于设置属性的值

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result_code

Integer

属性设置的响应码,具体为实际设备返回的响应码

最小值:0

最大值:600

result_desc

String

属性设置的描述,具体为实际设备返回的描述

最小长度:0

最大长度:2048

请求示例

{
  "control_id" : "control_id",
  "service_id" : "service1",
  "priority" : 8,
  "end_time" : 1691573256000,
  "properties" : {
    "property1" : "123456",
    "property2" : 1111
  }
}

响应示例

状态码: 200

OK

{
  "result_code" : 0,
  "result_desc" : "success"
}

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档