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

获取管网模拟结果

GET
/api/results/v1/gw/getByTypeAndProperties
最后修改时间:2024-09-24 06:27:08

前提条件#

已获取AK和SK,获取方法参见《安全规范.MD》
管网节点、管段、子汇水区分别对应工具上哪些对象,可以参考 https://cloud.keepsoft.net/technical/detail/986

请求参数

Query 参数
taskId
integer 
任务ID
必需
示例值:
357
beginFrame
integer 
必需
开始帧序号,从0开始,结果包含该帧
endFrame
integer 
必需
结束帧序号,从1开始,结果不包含该帧
nodeps
array[string]
可选
节点属性查询器,支持d/h/v/lf/inf/of,水深/水位/容积/边侧进流量/总进流量/积水
pps
array[string]
可选
管道,支持f/d/vel/vol/cap,流量/水深/流速/容积/充满度 5个属性
subps
array[string]
可选
子汇水区,支持rf/sd/ep/inf/ro/gf/ge/sm,降水/雪深/蒸发/下渗/径流/地下水流量/地下水标高/土壤湿度
子汇水区、节点、管线至少传入一个属性
Header 参数
apiKey
string 
apiKey
必需
默认值:
{{apiKey}}
timestamp
string 
时间戳
必需
默认值:
{{timestamp}}
sign
string 
签名
必需
默认值:
{{sign}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://cloud.keepsoft.net:30100/api/results/v1/gw/getByTypeAndProperties?taskId=357&beginFrame&endFrame&nodeps&pps&subps' \
--header 'apiKey;' \
--header 'timestamp;' \
--header 'sign;'

返回响应

🟢200成功
application/json
Body
sub
object 
子汇水区数据
必需
rf
object 
降水(mm/h)
必需
sd
object 
雪深(mm)
必需
ep
object 
蒸发(mm/d)
必需
inf
object 
下渗(mm/h)
必需
ro
object 
径流(m³/s)
必需
gf
object 
地下水流量(m³/s)
必需
ge
object 
地下水标高(m)
必需
sm
object 
土壤湿度(%)
必需
node
object 
节点数据
必需
d
object 
水深(m)
必需
h
object 
水位(m)
必需
v
object 
容积(m³/s)
必需
lf
object 
边侧进流量(m³/s)
必需
inf
object 
总进流量(m³/s)
必需
of
object 
积水(m³/s)
必需
pipeline
object 
管道数据
必需
f
object 
流量(m³/s)
必需
d
object 
水深(m)
必需
vel
object 
流速(m/s)
必需
vol
object 
容积(m³)
必需
cap
object 
充满度(%)
必需
示例
{
    "node": {
        "inf": {
            "values": [
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        },
        "d": {
            "values": [
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        },
        "v": {
            "values": [
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        },
        "of": {
            "values": [
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        },
        "h": {
            "values": [
                "1047.0000",
                "1046.5000",
                "1047.0000",
                "1046.5000",
                "1046.0000",
                "1045.0000",
                "1047.0000",
                "1046.5000",
                "1046.0000",
                "1046.0000",
                "1044.5000",
                "1045.5000",
                "0.0000",
                "1042.0000",
                "1044.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        },
        "lf": {
            "values": [
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000",
                "0.0000"
            ],
            "ids": [
                "531",
                "2120",
                "1761",
                "2169",
                "2163",
                "2155",
                "1243",
                "2196",
                "2382",
                "14",
                "2183",
                "2448",
                "MH1",
                "8",
                "蓄水池"
            ]
        }
    }
}
🟠400400参数错误
🟠401401签名无效
修改于 2024-09-24 06:27:08
上一页
获取二维指定帧范围内所有节点的信息 V2
下一页
根据对象ID获取管网数据
Built with