获取水文模拟结果

前提条件

已获取AK和SK，获取方法参见《安全规范.MD》

对象与返回值

各类对象和对应返回值包括：
子流域: Qo,Qi,Z,R,WU,WL,WD,S,RS,RI,RG,SSW,SW,GW；
水文站: Qo,Qi,Z；
水库: Qo,Qi,Z,Res_V,Qs；

精简格式说明

{
    "datetimes": [
        "2022-05-07 00:00:00",
        "2022-05-07 01:00:00"
    ],
    "ids": [
        "流域1",
        "水库1",
        "流域2",
        "水文站1"
    ],
    "propertyMap": { 
        "z": [
            [
                0.0,
                -9999.0,
                0.0,
                -9999.0
            ],
            [
                2.7845936,
                -9999.0,
                2.6146162,
                -9999.0
            ]
        ]
    },
    "types": [
        "BASIN",
        "RESERVOIR",
        "BASIN",
        "STATION"
    ]
}

z的第一层数组是对应上面的datetimes，z的第二层数组对应ids和types

请求参数

Query 参数

taskId

integer

任务ID

必需

type

string

必需

对象类型，子流域：BASIN；站点:STATION；水库:RESERVOIR

beginTime

string

必需

起始时间,yyyy-MM-dd HH:mm:ss格式

endTime

string

必需

结束时间,yyyy-MM-dd HH:mm:ss格式

properties

array[string]

属性名

必需

示例值:

["z 水位；qo 出流量；qi 入流量；r 产流量，即净雨，需要流量开启产流计算；wu 上层土壤含水量；wl 下层土壤含水量；wd 深层土壤含水量；s 流域平均自由蓄水量；rs 地面产流；ri 壤中产流；rg 地下产流；ssw 地表水量；sw 土壤水量；gw 地下水量；res_v 库容；qs 指定出流(如果水库为指定出流调度方式)；p 面雨量"]

objectIds

array[string]

可选

对象Ids，传的是对象名称

simpleFormat

string

可选

精简格式，true时，除taskId、properties，其他过滤条件无效

示例值:

是 true; 否 false

Header 参数

apiKey

string

apiKey

必需

默认值:

timestamp

string

时间戳

必需

默认值:

sign

string

签名

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

array of:

string

对象ID

必需

type

string

对象类型

必需

dateTime

string

时间

必需

number

水位(m)

可选

需要配置流域水位流量曲线

number

出流量(m³/s)

可选

number

入流量(m³/s)

可选

number

产流量(mm)

可选

即净雨，需要流量开启产流计算

number

上层土壤含水量(mm)

可选

number

下层土壤含水量(mm)

可选

number

深层土壤含水量(mm)

可选

number

流域平均自由蓄水量(mm)

可选

number

地面产流(mm)

可选

number

壤中产流(mm)

可选

number

地下产流(mm)

可选

ssw

number

地表水量(mm)

可选

number

土壤水量(mm)

可选

number

地下水量(mm)

可选

res_v

number

库容(m³)

可选

number

指定出流(m³/s)

可选

如果水库为指定出流调度方式

number

面雨量

可选

示例

成功示例异常示例异常示例

[
    {
        "id": "HS2",
        "type": "STATION",
        "dateTime": "2023-04-21 00:00:00",
        "z": 75,
        "qi": 8
    },
    {
        "id": "HS2",
        "type": "STATION",
        "dateTime": "2023-04-21 01:00:00",
        "z": 50,
        "qi": 4
    }
]

🟠400400参数错误

🟠401401签名无效

前提条件#

对象与返回值#

精简格式说明#

请求参数

示例代码

返回响应

前提条件

对象与返回值

精简格式说明