云服务器内容精选

  • 响应示例 状态码: 200 OK { "total" : 1, "size" : 1, "items" : [ { "id" : 711537, "parent_device_id" : 711536, "parent_device_name" : "parent-device", "product" : { "product_id" : 116303, "product_name" : "p1", "manufacturer_id" : "p1", "model" : "p1", "product_type" : 0, "protocol_type" : 0 }, "device_name" : "device", "instance_id" : "8993a690-cf61-46af-880d-587d823d14e5", "client_id" : "D116303711537sGDtK", "node_id" : "string", "status" : 0, "online_status" : 2, "description" : "device", "authentication" : { "user_name" : "F01A8D25FE6E4CF5A286B711B31888AE", "password" : "************************" }, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "tags" : [ ], "created_datetime" : 1607408244841, "last_updated_datetime" : 1607422571094, "connect_address" : "xx.xx.xx.xx", "ssl_connect_address" : "xx.xx.xx.xx", "ipv6_connect_address" : "xx.xx.xx.xx", "ipv6_ssl_connect_address" : "xx.xx.xx.xx", "app_id" : "cb4b3ec0-8f7f-432f-b05e-fc149d05da5d" } ] } 状态码: 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.batchQuerySubDevices]. Parameter is [deviceOid]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码: 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码: 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
  • 响应示例 状态码: 200 OK { "user_name" : "4MjxbCl4q461", "password" : "*************" } 状态码: 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.queryAuthentication]. Parameter is [deviceOid]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码: 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码: 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
  • 请求示例 PUT /v1/3266392d188c47d09948b1**********/devices/9339084235*****000001/channels/ 933908423****0000001/access-strategy { "start_time" : "10:00", "end_time" : "18:00", "total_length" : 240, "random_strategy" : "RANDOM", "periodicity" : "DAY", "state" : "STOPPED" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 普通租户的token。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String 使用AK/SK方式认证时必选,携带项目ID信息。 表3 请求Body参数 参数 是否必选 参数类型 描述 random_strategy 否 String 视频采集类型,可选值如下。 RANDOM:表示使用随机采集方法。在开始时间和结束时间内,随机采集总时长为total_length参数值的视频。 随机策略说明: 一天内从start_time到end_time的时间,会随机分成若干个时间分片(总分片个数不超过6个),每个时间分片最短为10min,最长不超过total_length时间,每两个时间分片之间的间隔至少为20min。时间分片之间的间隔即视频起始时间的间隔,例如中间断开10min,也就是间隔至少20min。 如果设置为每天执行采集(即“periodicity”为“DAY”),每天的时间分片会重新随机生成,以保证每天接入的时间分片不同。 如果更新了接入策略(例如修改了start_time、total_length等参数),并且当前接入策略运行状态为ACTIVE,则会重新生成分片,其中分片开始时间早于当前时间的不会在当天执行,分片开始时间晚于当前时间的会在当天执行。 CONSECUTIVE:表示从开始时间连续采集时长为total_length参数值的视频。 默认值为RANDOM,不区分大小写。 start_time 否 String 一天中 视频接入 的开始时间,时间格式为HH:MM,取值范围是00:10~23:40。分钟数值须为10的倍数,例如10:10、10:20、10:30等。第一次设置接入策略时,该参数必填。后续更新接入策略时,该参数可选。 end_time 否 String 一天中视频接入的结束时间,时间格式为HH:MM,取值范围是00:10~23:50。分钟数值须为10的倍数,如23:10、23:20等。end_time必须晚于start_time。第一次设置视频采集类型为RANDOM时,该参数必填。后续更新接入策略时,该参数可选采集类型为CONSECUTIVE时,该参数被忽略。 total_length 否 Integer 视频接入总采集时长,单位:分钟。参数值须为10的倍数,最小值为10分钟,最大值根据用户的配额决定。不同的视频采集类型,total_length有不同的配额设置:采集类型为RANDOM时,start_time加上total_length后的时间不能超过end_time。采集类型为CONSECUTIVE时,start_time加上total_length后的时间不能超过24:00,即采集时长不允许跨天。第一次设置接入策略时,该参数必填。后续更新接入策略时,该参数可选。 periodicity 否 String 采集周期,可选值如下。 ONCE:表示采集一次。 DAY:表示每天执行。 默认值为DAY,不区分大小写。 state 否 String 视频接入状态,可选值如下。 ACTIVE:表示激活当前视频接入策略。 STOPPED:表示停止当前视频接入策略。 默认值为STOPPED,不区分大小写。
  • 设备查询 地图上可查看已接入的设备。 通过筛选设备类型,在地图上高亮同类型的所有设备。 通过输入设备Id或esn,在地图上高亮显示相应的设备。 在线率统计:各个设备类型的统计原理详见表1。 表1 设备在线率统计 统计对象 统计原理 边缘Edge 在线率=设备在线数 / 边缘Edge设备总数 在线:该边缘Edge和 路网数字化服务 连接正常 运行中:该边缘Edge节点在IEF(华为云智能边缘平台)状态为运行中,即Atlas设备和IEF当前连接正常 待部署:该边缘Edge节点在IEF状态为待部署,即Atlas设备还未部署 部署中:该边缘Edge节点在IEF状态为部署中,即Atlas设备正在部署 离线:该边缘Edge和路网数字化服务连接断开 升级中:该边缘Edge节点在IEF状态为升级中,即Atlas设备正在升级 删除中:该边缘Edge节点在IEF状态为删除中,即Atlas设备正在删除 未接入:该边缘Edge设备信息导入后,和路网数字化服务从未建立过连接 路侧RSU 在线率=设备在线数 / RSU设备总数 在线:该RSU和路网数字化服务连接正常 离线:该RSU和路网数字化服务连接断开 未接入:该RSU设备信息导入后,RSU设备和路网数字化服务从未建立过连接 摄像头 在线率=设备在线数 / 摄像头设备总数 在线:该摄像头和路网数字化服务连接正常 离线:该摄像头和路网数字化服务连接断开 未接入:该摄像头设备信息导入后,和路网数字化服务从未建立过连接 雷达 在线率=设备在线数 / 雷达设备总数 在线:该雷达和路网数字化服务连接正常 离线:该雷达和路网数字化服务连接断开 未接入:该雷达设备信息导入后,和路网数字化服务从未建立过连接 设备删除:单击“删除”按钮,可以删除该设备信息。 设备详情:单击“详情”按钮,可以查看该设备的详细信息。 设备修改:单击“编辑”按钮,可以修改该设备信息。 父主题: 设备管理
  • 错误码 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是否有误。
  • 参数说明 参数 必选/可选 类型 位置 描述 taskId 必选 String path 批量任务ID,创建批量任务后获得。 select 必选 String query 指定可选的返回值,可取值:tag。不指定时可填写null。 appId 必选 String query 如果是本应用的任务,此参数值可以填写null,否则填写授权应用的appId。 accessToken 必选 String header 如果调用了定时刷新token接口,此参数值可以填写null,否则要填写鉴权接口获取的accessToken。
  • 示例 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_SUC CES S != uiResult) { // retry with uiCookie return 0; } return 0; } HW_BroadCastReg(“IOTA_TOPIC_HUB_RMVDEV_RSP”, Device_RemovResultHandler);
  • 返回结果 广播名称 广播参数 成员 描述 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_SUCCESS 0 添加/删除执行成功。 EN_IOTA_HUB_RESULT_DEVICE_EXIST 1 设备已存在。 EN_IOTA_HUB_RESULT_DEVICE_NOTEXIST 2 设备不存在。 EN_IOTA_HUB_RESULT_DEVICE_FAILED 255 执行失败。
  • 错误码 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. 服务器运行内部错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。
  • 参数说明 参数 必选/可选 类型 位置 描述 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状态码 错误码 错误描述 说明 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 发生拥塞,当前的网络已经被流控。
  • 典型场景 设备Profile文件中定义了物联网平台可向设备下发的命令,第三方应用可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。 物联网平台不对设备命令进行缓存而是直接下发命令,设备不在线时命令下发失败。下发命令的具体格式需要第三方应用与设备自定义,物联网平台在接口中直接进行封装,透传。 此接口适用于使用MQTT协议接入的设备,例如集成了AgentLite SDK的设备。
  • 响应参数 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”时,则为空。