V2.1 Set Measurement Point¶
测点设置接口。
该 API 支持在 EnOS 2.1.0 及以上环境中使用。
本接口用于执行缓存命令或者即时命令。当执行即时命令时，需要等待设备返回测点设置结果后才返回接口响应数据。如果设备在规定的测点设置超时时间内，未返回测点设置的结果，EnOS测点设置会等待到超时时间后，返回接口超时响应数据。
如果是缓存命令，则直接放入缓存后返回用户。
请求格式¶
POST https://{apigw-address}/connect-service/v2.1/commands?action=setMeasurepoint
请求参数（URI）¶
注解
以下非必需字段中，必须提供 assetId 或 productKey + deviceKey 的组合，用于指定设备。
| 名称 | 位置（Path/Query） | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|---|
| orgId | Query | 必需 | String | 资产所属的组织 ID。如何获取 orgId 信息>> |
| assetId | Query | 可选（见上述注解） | String | 资产 ID。如何获取 assetId 信息>> |
| productKey | Query | 可选（见上述注解） | String | 设备的 product key，需与 deviceKey 一起使用。 |
| deviceKey | Query | 可选（见上述注解） | String | 设备的 device key，需与 productKey 一起使用。 |
| measurepointId | Query | 必需 | String | 资产测点。 如何获取测点（pointId）信息>> |
| pendingTtl | Query | 可选 | Integer | 缓存存储时间，单位为秒，范围[0 - 172800（即 48 小时）]，默认值为 0。当 pendingTtl 为 0 时，表示命令即时执行。注：当 pendingTtl 为 0 且设备处于离线/未激活状态时，该接口将不会执行。 |
| timeout | Query | 可选 | Integer | 服务执行超时时间，单位为秒，范围[1 - 60]，默认值为 30 秒。 |
请求参数（Body）¶
| 名称 | 必需/可选 | 数据类型 | 描述 |
|---|---|---|---|
| value | 必需 | String、Number、Array 或 Object | 测点设置的参数值，需要符合物模型的定义。 |
响应参数¶
| 名称 | 数据类型 | 描述 |
|---|---|---|
| data | Command ID 结构体 | 测点设置结果，参见 Command ID 结构体>> |
Command ID 结构体¶
| 名称 | 数据类型 | 描述 |
|---|---|---|
| commandId | String | 命令 ID。 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.1/commands?action=setMeasurepoint&deviceKey=yourDeviceKey&measurepointId=measurepoint1&&pendingTtl=1000&productKey=yourProductKey&orgId=yourOrgId&timeout=30
method: POST
requestBody:
{
"value":1.0
}
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "7d863d517eae4f18a2776452eb1305bb",
"data": {
"commandId": "2078724684846989312"
}
}