模型云开放接口
  1. 数据回调
模型云开放接口
  • 文档说明
    • 应用集成
    • 阅读对象
    • 版本说明
    • 业务流程
  • 接口规则
    • 协议规则
    • 安全规范
  • 服务器API
    • 获取模型对象数据-新版
      • 通用
        • 获取指定类型对象列表
        • 获取面雨量(雨量站和权重)
        • 获取水工调度方案列表
        • 获取图层列表
        • 下载图层
        • 导出断面形状
      • 水文
        • 获取水文站的属性参数
        • 获取水库的属性参数
        • 获取子流域的模型参数
      • 率定
        • 获取率定场次列表
      • 一维
        • 获取一维水闸的闸孔列表
      • 管网
        • 获取排水泵参数
    • 应用计算-新版
      • 提交应用计算
      • 提交应用率定-自动率定
      • 停止计算
      • 获取计算状态详情
      • 获取计算日志-字符串
      • 提交自定义方案计算
      • 提交智能模型计算
    • 获取计算结果-新版
      • 通用
        • 获取解析后的文件路径
        • 获取计算结果目录
        • 获取计算结果文件
      • 水文
        • 获取水文模拟结果
      • 率定
        • 获取率定评定结果
        • 获取率定结果参数
        • 获取率定评定结果 V2
      • 一维
        • 获取一维结果的总体信息
        • 获取一维指定帧范围内所有断面的信息
        • 获取一维水闸信息
        • 获取一维水泵信息
        • 获取一维结果的总体信息 V2
        • 获取一维指定帧范围内所有断面的信息 V2
        • 获取一维蓄水池
      • 二维
        • 获取二维结果的总体信息
        • 获取二维指定帧范围内所有节点的信息
        • 获取二维指定帧范围内所有网格数据
        • 获取二维结果的总体信息 V2
        • 获取二维指定帧范围内所有节点的信息 V2
      • 管网
        • 获取管网模拟结果
        • 根据对象ID获取管网数据
        • 根据对象属性获取管网数据
    • 数据回调
      • 计算状态推送
  • 最佳实践
    • 管网项目实践
    • 城市内涝项目实践
    • 对接demo示例
    • 一维示例
      • 一维demo示例
    • 二维示例
      • 二维demo示例
    • 管网示例
      • 管网demo示例
    • 水文示例
      • 水文demo示例
  • 常见问题
    • 网格文件格式
  1. 数据回调

计算状态推送

本接口只推送计算状态,而不推送数据。

应用场景#

计算完成后,模型云会使用此接口通知三方系统,三方系统需要接收处理,并按文档规范返回应答。
注意:
1.
同样的推送可能会多次发送给三方系统,三方系统必须能够正确的处理重复的推送。
2.
数据推送交互时,如果模型云收到三方系统的应答不符合规范或超时,模型云会判定本次推送失败,重新推送数据,直到成功为止(在推送一直不成功的情况下,模型云总共会发起多次推送。推送频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m),但模型云不保证推送最终一定能成功。
3.
在计算状态不明或没有收到计算结果的情况下,建议三方系统主动调用模型云获取结果【获取计算结果】。
特别提醒:
1.
当收到结果回调时,首先检查对应业务数据的状态,判断该推送是否已经处理过,如果没有处理过再进行处理,如果处理过直接返回成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。

接口链接#

该链接是通过【提交模拟计算】中提交的参数cbUrl设置,如果链接无法访问,三方系统将无法接收到模型云通知。
通知url必须为直接可访问的url,不能携带参数。示例:cbUrl:"http://172.10.104.22:8080/api/callback"。
该需要满足restful风格,请求类型为POST。推送参数在Body体内。如下形式:

推送参数#

字段名变量名示例值描述位置
计算任务IDtaskId2564计算任务的IDBody
计算状态statusSUCCESS/FAILSUCCESS:成功;FAIL:失败Body
错误消息message模拟结果与实测流量的数据长度不一致,无法完成计算当status为FAIL时,才会有messageBody
Request Body 举例如下:

返回参数#

三方系统需要接收处理,并按以下格式返回应答
字段名变量名必填示例值描述
返回状态码code是SUCCESSSUCCESS/FAIL SUCCESS表示三方接收数据成功并校验成功
返回信息message否返回信息,如非空,为错误原因: 签名失败 参数格式校验错误
修改于 2023-12-05 01:23:16
上一页
根据对象属性获取管网数据
下一页
管网项目实践
Built with