云服务器内容精选

  • 响应示例 状态码: 200 OK { "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888", "response" : { "result_code" : 0, "response_name" : "COMMAND_RESPONSE", "paras" : { "result" : "success" } } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 command_id String 设备命令ID,用于唯一标识一条命令,在下发设备命令时由 物联网平台 分配获得。 response Object 设备上报的命令执行结果。Json格式,具体格式需要应用和设备约定。 error_code String 命令下发异常错误码。 error_msg String 命令下发异常错误信息。
  • URI POST /v5/iot/{project_id}/devices/{device_id}/commands 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:下发消息的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 功能介绍 设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可调用此接口向指定设备下发命令,以实现对设备的同步控制。平台负责将命令以同步方式发送给设备,并将设备执行命令结果同步返回, 如果设备没有响应,平台会返回给应用服务器超时,平台超时时间是20秒。如果命令下发需要超过20秒,建议采用消息下发。 注意: 此接口适用于MQTT设备同步命令下发,暂不支持NB-IoT设备命令下发。 此接口仅支持单个设备同步命令下发,如需多个设备同步命令下发,请参见 创建批量任务。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_id 否 String 参数说明:设备命令所属的设备服务ID,在设备关联的产品模型中定义。 取值范围:长度不超过64的字符串。 最大长度:64 command_name 否 String 参数说明:设备命令名称,在设备关联的产品模型中定义。 取值范围:长度不超过128的字符串。 最大长度:128 paras 是 Object 参数说明:设备执行的命令,Json格式,里面是一个个键值对,如果serviceId不为空,每个键都是profile中命令的参数名(paraName);如果serviceId为空则由用户自定义命令格式。设备命令示例:{"value":"1"},具体格式需要应用和设备约定。此参数仅支持Json格式,暂不支持字符串。 最大长度:261952
  • 链路检测 接口说明 请求对应的消息ID:0x8204 响应对应的消息ID:0x0001(终端通用响应) 请求示例 { "service_id": "Location", "command_name": "CheckConnection", "paras": {} } 响应示例 { "command_id": "1641971911322353065", "response": { "paras": { "flowNo": 0, "msgId": 33284, "resultCode": 0 }, "result_code": 0 } } 响应参数 paras字段定义 表7 参数描述 字段名 类型 参数描述 flowNo int 应答流水号 msgId int 对应的平台的消息ID resultCode int 结果
  • 临时位置跟踪控制 接口说明 请求对应的消息ID:0x8202 响应对应的消息ID:0x0001(终端通用响应) 请求示例 { "service_id": "Location", "command_name": "LocationTrace", "paras": { "timeInterval": 10, "period": 20 } } 请求参数 paras字段定义 表3 参数描述 字段名 必选/可选 类型 参数描述 timeInterval 必选 int 时间间隔,单位为秒(s) period 必选 int 位置跟踪有效期,单位为秒(s) 响应示例 { "command_id": "1641971752394383473", "response": { "paras": { "flowNo": 0, "msgId": 33282, "resultCode": 0 }, "result_code": 0 } } 响应参数 paras字段定义 表4 参数描述 字段名 类型 参数描述 flowNo int 应答流水号 msgId int 对应的平台的消息ID resultCode int 结果
  • 人工确认报警信息 接口说明 对应的消息ID:0x8203 请求示例 { "service_id": "Location", "command_name": "AlarmConform", "paras": { "flowNo": 123, "criticalAlarm": false, "dangerousWarning": false, "areaAlarm": true, "routeAlarm": false, "drivingTimeAlarm": false, "startingAbnormalAlarm": false, "displacementAbnormalAlarm": false } } 请求参数 paras字段定义 表5 参数描述 字段名 必选/可选 类型 参数描述 flowNo 必选 int 报警消息流水号 criticalAlarm 必选 boolean 确认紧急报警 dangerousWarning 必选 boolean 确认危险预警 areaAlarm 必选 boolean 确认进出区域报警 routeAlarm 必选 boolean 确认进出路线报警 drivingTimeAlarm 必选 boolean 确认路段行驶时间不足/过长报警 startingAbnormalAlarm 必选 boolean 确认车辆非法点火报警 displacementAbnormalAlarm 必选 boolean 确认车辆非法位移报警 响应示例 { "command_id": "1641971845905632317", "response": { "paras": { "flowNo": 0, "msgId": 33283, "resultCode": 0 }, "result_code": 0 } } 响应参数 paras字段定义 表6 参数描述 字段名 类型 参数描述 flowNo int 应答流水号 msgId int 对应的平台的消息ID resultCode int 结果
  • 位置信息查询 接口说明 请求对应的消息ID:0x8201 响应对应的消息ID:0x0201 请求示例 { "service_id": "Location", "command_name": "QueryLocation", "paras": {} } 响应示例 { "command_id": "1641971430850245415", "response": { "paras": { "flowNo": 0, "locationReport": { "alarm": { "emergencyAlarm": 0, "overSpeedAlarm": 1, "fatigueDrivingAlarm": 0, "dangerousDrivingAlarm": 1, "powerVoltageAlarm": 0, "powerOffAlarm": 0, "cameraErrorAlarm": 1, "overSpeedWarning": 1, "fatigueDrivingWarning": 0, "violationDrivingAlarm": 0, "tirePressureWarning": 0, "rightTurnErrorAlarm": 0, "overDrivingTimeAlarm": 0, "overParkAlarm": 0, "drivingAreaAlarm": 0, "drivingRouteAlarm": 0, "drivingTimeAbnormalAlarm": 0, "offCourseAlarm": 0, "gasolineAlarm": 0, "stolenAlarm": 0, "startingAbnormalAlarm": 0, "displacementAbnormalAlarm": 0, "rolloverAlarm": 0, "rolloverWarning": 0, "gnsserrorAlarm": 1, "gnssantennaNotConnectedAlarm": 0, "lcderrorAlarm": 1, "ttserrorAlarm": 0, "icerrorAlarm": 0, "vssalarm": 0, "gnssantennaShortCircuitAlarm": 1 }, "status": { "accStatus": 0, "positioningStatus": 0, "latitudeStatus": 0, "longitudeStatus": 1, "businessStatus": 0, "encryptedStatus": 1, "forwardCollisionWarningStatus": 0, "laneDeviationAlarmStatus": 0, "loadStatus": 0, "oilStatus": 1, "powerStatus": 0, "doorStatus": 1, "firstDoorStatus": 1, "secondDoorStatus": 1, "thirdDoorStatus": 0, "fourthDoorStatus": 0, "fifthDoorStatus": 0, "galileoStatus": 0, "vehicleStatus": 0, "gpsstatus": 0, "bdsstatus": 0, "glonassstatus": 0 }, "longitude": 0.041957, "latitude": 0.056143, "height": 48243, "speed": 10001, "direction": 300, "dateTime": "220112151406", "extend": [] } }, "result_code": 0 } } 响应参数 表1 参数描述 字段名 类型 参数描述 flowNo int 应答流水号 locationReport jsonObject 字段定义参考表2 表2 协议报文字段与属性对应表 起始字节 字段 数据类型 对应属性 0 报警标志 DWORD alarm 4 状态 DWORD status 8 纬度 DWORD longitude 12 经度 DWORD latitude 16 高程 WORD height 18 速度 WORD speed 20 方向 WORD direction 21 时间 BCD[6] dateTime