云服务器内容精选

  • 参数说明 参数 必选/可选 类型 位置 描述 taskId 必选 String path 批量任务ID,创建批量任务后获得。 select 必选 String query 指定可选的返回值,可取值:tag。不指定时可填写null。 appId 必选 String query 如果是本应用的任务,此参数值可以填写null,否则填写授权应用的appId。 accessToken 必选 String header 如果调用了定时刷新token接口,此参数值可以填写null,否则要填写鉴权接口获取的accessToken。
  • 错误码 Http状态码 错误码 错误描述 说明 400 100019 Illegal request. 非法请求。 处理建议:请检查接口请求中的必须参数是否为空。 400 100022 The input is invalid 输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 403 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 403 100217 The application hasn't been authorized 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系 物联网平台 维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 404 105005 The batchTask is not existed. 批量任务不存在。 处理建议:请检查接口请求中的taskId是否有误。 500 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。
  • 返回结果 广播名称 广播参数 成员 描述 IOTA_TOPIC_HUB_RMVDEV_RSP HW_MSG对象 EN_IOTA_HUB_IE_TYPE 删除结果。 EN_IOTA_HUB_IE_TYPE: 枚举项 枚举值 类型 描述 EN_IOTA_HUB_IE_RESULT 0 EN_IOTA_HUB_RESULT_TYPE 添加/删除执行结果。 EN_IOTA_HUB_IE_DEVICEID 1 String 添加成功后分配的设备ID。 EN_IOTA_HUB_RESULT_TYPE: 枚举项 枚举值 描述 EN_IOTA_HUB_RESULT_SUC CES S 0 添加/删除执行成功。 EN_IOTA_HUB_RESULT_DEVICE_EXIST 1 设备已存在。 EN_IOTA_HUB_RESULT_DEVICE_NOTEXIST 2 设备不存在。 EN_IOTA_HUB_RESULT_DEVICE_FAILED 255 执行失败。
  • 示例 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 // 开发者调用该接口进行设备删除 HW_cHAR *pcDeviceId = stDevice.pcDeviceId; IOTA_HubDeviceRemove(HW_NULL, pcDeviceId); 结果处理: HW_iNT Device_RemoveResultHandler(HW_UiNT uiCookie, HW_MSG pstMsg) { uiResult = HW_MsgGetUint (pstMsg, EN_IOTA_HUB_IE_RESULT); if (EN_IOTA_HUB_RESULT_SUCCESS != uiResult) { // retry with uiCookie return 0; } return 0; } HW_BroadCastReg(“IOTA_TOPIC_HUB_RMVDEV_RSP”, Device_RemovResultHandler);
  • 参数说明 参数 必选/可选 类型 位置 描述 clientInfo 必选 ClientInfo - 见下表ClientInfo的描述。 ClientInfo 参数 必选/可选 类型 位置 描述 platformIp 必选 String(256) path 设置平台的IP。 platformPort 必选 String(256) path 设置平台的端口,如“8743”。 appId 必选 String(256) body 访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。 secret 必选 String(256) body 访问物联网平台的应用密钥,与appId对应,在物联网平台创建应用时由平台分配获得。
  • 返回值 AuthOutDTO 参数 类型 描述 scope String(256) 申请权限范围,即accessToken所能访问物联网平台资源的范围,参数值固定为default。 tokenType String(256) accessToken的类型,参数值固定为bearer。 expiresIn Number(256) 平台生成并返回accessToken的有效时间,单位为秒。 accessToken String(256) 鉴权参数,访问物联网平台API接口的凭证。 refreshToken String(256) 鉴权参数,用来刷新accessToken,refreshToken的有效时间为“1”个月。
  • 错误码 Http状态码 错误码 错误描述 说明 400 100247 Operation not allowed. The application has been frozen. 应用冻结。 处理建议:请检查应用是否因为欠费冻结。 400 102202 Required Parameter is null or empty. 必选参数为空。 处理建议:请检查请求参数中的必选参数是否已填写。 401 100208 AppId or secret is not right. appId或secret错误。 处理建议: 请检查appId和secret是否有误,是否新增字符或缺少字符。 请检查请求路径中的IP地址是否有误。 500 50252 Internal server error. 服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。
  • 错误码 Http状态码 错误码 错误描述 说明 200 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 200 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 200 100418 The deviceData is not existed. 设备信息不存在。 处理建议: 请求参数中携带的deviceId错误。请确认该deviceId是否属于该appId或者deviceId是否写错。 Header中携带的appId有误,请确认该appId下是否有该deviceId。 如果URL中携带了可选参数appId,请检查该appId是否有误。 200 100428 The device is not online. 设备不在线。 处理建议:请检查设备与网关的连接是否正常。 200 100432 The device command is muted. 设备命令已被禁用。 处理建议:请检查接口请求参数method中的命令是否有误。 400 100022 The input is invalid. 输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 400 102203 CommandName is invalid. 命令名称无效。 处理建议:请检查接口请求参数method中携带的命令是否有误。 403 100450 The gateway is not online. 网关不在线。 处理建议:请检查网关与物联网平台的连接是否正常。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 404 100444 The serviceType is not exist. 服务类型不存在。 处理建议:请检查接口请求参数toType中的服务类型是否有误。 500 100001 Internal server error. 服务内部处理错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 500 100023 The data in dataBase is abnomal. 数据库异常。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 500 50252 Internal server error. 服务内部处理错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 503 100501 Congestion occurs, and the current network has been flow-controlled 发生拥塞,当前的网络已经被流控。
  • 响应参数 InvokeDeviceServiceOutDTO 参数 类型 描述 status String(128) 命令状态。 “sent”:已发送 “deliveried”:已投递,toType为“CLOUD”的请求才有该返回值 “failed”:失败,toType为“CLOUD”的请求才有该返回值 timestamp String(128) 发送命令的时间戳,时间格式:yyyyMMdd'T'HHmmss'Z', 如“20151212T121212Z”。 requestId String(128) 设备命令ID。 toType为“GATEWAY”时,如果请求有requestId则同请求的requestId一致,如果请求无requestId则平台分配一个序列号。 toType为“CLOUD”时,则为空。
  • 参数说明 参数 必选/可选 类型 位置 描述 commandDTO 必选 CommandDTO body 见下表CommandDTO的描述。 deviceId 必选 String(1-64) path 设备ID,用于唯一标识一个设备。 serviceId 必选 String(1-64) path 服务ID,唯一标识一个服务。 appId 可选 String query 如果是本应用的设备,此参数值可以填写None,否则填写授权应用的appId。 accessToken 必选 String header 填写鉴权接口获取的accessToken。 CommandDTO 参数 必选/可选 类型 位置 描述 header 必选 CommandNA2CloudHeader body 具体参见CommandNA2CloudHeader结构体。 body 可选 Object body 消息的消息体。JsonObject里面是一个个健值对。每个健都是profile中命令的参数名(paraName)。 CommandNA2CloudHeader结构体说明: 参数 必选/可选 类型 位置 描述 requestId 可选 String(0-128) body 用于标识一个命令,不能重复。 mode 必选 Enum body 是否要确认消息。 “NOACK”:不需要确认消息 “ACK”:需要确认消息 其它值无效 from 可选 String(128) body 表示消息发布者的地址。 App发起的请求:“/users/{userId}” 第三方应用发起的请求:“/{serviceName}” 物联网平台发起的请求:“/cloud/{serviceName}” toType 可选 Enum body 消息接受者的类型,“CLOUD/GATEWAY”。 to 可选 String(128) body 消息接收者的地址。 method 必选 String(1-32) body 命令名称,如:“DISCOVERY”为发现非直连设备,“REMOVE”为删除非直连设备。 callbackURL 可选 String(1024) body 命令的回调路径。
  • 典型场景 设备Profile文件中定义了物联网平台可向设备下发的命令,第三方应用可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要第三方应用与设备自定义,物联网平台在接口中直接进行封装,透传。 此接口适用于使用MQTT协议接入的设备,例如集成了AgentLite SDK的设备。
  • 参数说明 参数 必选/可选 类型 位置 描述 cdcctInDTO 必选 CreateDeviceCmdCancelTaskInDTO body 见下表CreateDeviceCmdCancelTaskInDTO的描述。 appId 可选 String query 如果是本应用的设备,此参数值可以填写None,否则填写授权应用的appId。 accessToken 必选 String header 填写鉴权接口获取的accessToken。 CreateDeviceCmdCancelTaskInDTO 参数 必选/可选 类型 位置 描述 deviceId 必选 String(1-64) body 待撤销设备命令的设备ID,撤销任务将会撤销所有向该设备下发的命令。
  • 错误码 Http状态码 错误码 错误描述 说明 200 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 200 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 200 100418 The deviceData is not existed. 设备信息不存在。 处理建议: 请求参数中携带的deviceId错误。请确认该deviceId是否属于该appId或者deviceId是否写错。 Header中携带的appId有误,请确认该appId下是否有该deviceId。 如果URL中携带了可选参数appId,请检查该appId是否有误。 400 100022 The input is invalid. 输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 403 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 403 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 500 100001 Internal server error. 服务内部处理错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 500 100220 Get AppKey from header failed. 获取appKey失败。 处理建议 : 请检查接口请求的header中是否携带appId。 503 100501 Congestion occurs, and the current network has been flow-controlled 发生拥塞,当前的网络已经被流控。
  • 错误码 Http状态码 错误码 错误描述 说明 400 100216 The application input is invalid. 应用输入无效。 处理建议:请参考请求参数说明检查接口请求中的参数是否有误。 400 100218 The gatewayId and pageNo can't be both null. 网关ID和pageNo不能同时为空。 处理建议:请检查请求参数中gatewayId或pageNo是否填写。 400 100405 The request parameter is invalid. 请求参数不合法。 处理建议:请参考请求参数说明检查接口请求中的参数是否有误。 403 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 403 100217 The application hasn't been authorized. 应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 403 1010009 app throttle exceed. 应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 403 1010005 Invalid access token or appId. 错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 500 100203 The application is not existed. 应用不存在。 处理建议: 请检查HTTP请求头域中携带的appId是否有误。 请检查请求路径(url)中传入的appId是否有误。 500 50252 Internal server error. 服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。
  • 参数说明 参数 必选/可选 类型 位置 描述 qbdiInDTO 必选 QueryBatchDevicesInfoInDTO query 见下表QueryBatchDevicesInfoInDTO的描述。 accessToken 必选 String header 填写鉴权接口获取的accessToken。 QueryBatchDevicesInfoInDTO 参数 必选/可选 类型 位置 描述 appId 必选 String query 如果是本应用的设备,此参数值可以填写None,否则填写授权应用的appId。 gatewayId 可选 String query 网关ID,用于标识一个网关设备。 nodeType 可选 String query 节点类型,取值:“ENDPOINT/GATEWAY/UNKNOW”。 deviceType 可选 String query 设备类型。 pageNo 可选 Integer query 查询的页码。 值为空时查询内容不分页 值大于等于0的整数时分页查询 值等于0时查询第一页 pageSize 可选 Integer query 查询每页信息的数量, 缺省值:“1”。 status 可选 String query 查询设备的状态。 “ONLINE”:在线 “OFFLINE”:不在线 “ABNORMAL”:异常状态 startTime 可选 String query 查询注册设备信息时间在startTime之后的记录。时间格式:yyyyMMdd'T'HHmmss'Z',如 “20151212T121212Z”。 endTime 可选 String query 查询注册设备信息时间在endTime之前的记录。时间格式:yyyyMMdd'T'HHmmss'Z',如 “20151212T121212Z”。 sort 可选 String query 指定返回记录的排序。 “ASC”:按注册设备的时间升序排列 “DESC”:按注册设备的时间降序排列 缺省值:“DESC”。 select 可选 String query 指定返回记录,可取值:“imsi”。