提交应用计算

POST

/api/mcc/v1/app/sim

最后修改时间：2025-06-30 07:48:59

前提条件

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

解析器示例：

1.洪水风险分析解析器（注意simulationConfig-params2D-output中要开启floodRisk的参数）：

{
"name": "floodRisk",
"sourceCRS": "4549",
"targetCRS": "4490",
"minFloodDepth": 0.05
}

返回的properties中各个字段的含义：

字段名称	含义
FloodStartTime	单元最大洪峰达到洪水位的时刻
MaxVelocity	单元最大流速(m/s)
MaxDepth	单元最大洪峰水深(m)
TotalDuringTime	单元洪峰总持续时长(min)
cellId	网格id号
FloodDuringTime	单元最大洪峰持续时长(min)
FloodEndTime	单元最大洪峰降到洪水位以下的时刻
ArrivalTime	单元最大洪峰水深对应的时刻

2.GeoJson解析器：

{
"name": "D2GeoJson",
"sourceCRS": "4549",
"targetCRS": "4490",
"keepDecimal": "6",
"minimum": "0.05D",
"dimensions": "h"
}

3.地理信息png图片解析器：

{
"name": "D2GisPng",
"sourceCRS": "Y-3857",
"targetCRS": "4326",
"keepDecimal": "6",
"minimum": "0.05D",
"dimensions": "h",
"renderColors": [{
"lvalue": "0",
"hvalue": "0.05",
"color": "255,255,255"
}, {
"lvalue": "0.05",
"hvalue": "0.3",
"color": "179,204,255"
}, {
"lvalue": "0.3",
"hvalue": "0.5",
"color": "128,153,255"
}, {
"lvalue": "0.5",
"hvalue": "1.0",
"color": "89,128,255"
}, {
"lvalue": "1.0",
"hvalue": "2.0",
"color": "38,115,242"
}, {
"lvalue": "2.0",
"hvalue": "99999",
"color": "247,0,0"
}],
"transparency": "0.8",
"imgH": "600",
"imgW": "800"
}

4.生成三维贴图

{
"name": "D3Map"
}

请求参数

Header 参数

apiKey

string

apiKey

必需

默认值:

{{apiKey}}

timestamp

string

时间戳

必需

默认值:

{{timestamp}}

sign

string

签名

必需

默认值:

{{sign}}

Body 参数application/json

simulationConfig

object (模拟配置参数)

修改参数配置

必需

startTime

string

开始时间

必需

yyyy-MM-dd HH:mm:ss

endTime

string

结束时间

必需

yyyy-MM-dd HH:mm:ss

outputStep

string

输出步长

必需

HH:mm:ss

calculatingStep

string

计算步长

可选

HH:mm:ss
大部分情况不用设置，使用默认即可，设置时间大了容易发散

hasGlobalTimeStep

boolean

耦合方案 - 是否设置全局计算时间步长

可选

不传则默认为耦合方案参数的原始配置。
值为true，耦合里各子方案的计算步长参数取值为耦合的计算步长；值为false则可以修改各自子方案的计算步长值或取值为原参数。
耦合里的水文方案不受此参数影响。

params1D

object

一维参数

可选

params2D

object

二维参数

可选

paramsHydrology

object

水文参数

可选

水动力和水文耦合中修改水文参数

paramsDrainage

object

管网参数

可选

boundaryParams

array[object (边界条件参数) {6}]

修改边界条件

可选

objectType

string

对象类型

必需

当前支持，outfall(排放口)、bump_drainage(排水泵)、manhole(检查井)、boundary_1d_flow(一维流量边界)、boundary_1d_wl(一维水位边界)、evaporation_station(蒸发站)、catchment_zone(汇水分区)

objectId

integer

对象ID

必需

对应对象id

objectName

string

对象名称

可选

名称和ID必须传一个

conditionType

string

边界条件的类型

必需

示例值：time_series(时间序列)、relation_curves(关系曲线)、const(常量)

conditionSubType

enum<string>

边界条件的子类型

可选

可选，水泵曲线

枚举值:

PUMP1PUMP2PUMP3PUMP4

data

array [oneOf]

数据

必需

const时，data不为数组，格式为data:number

raingageStationParams

object

修改雨量站

可选

params

array [object {4}]

可选

hydraulicSchedule

object

新增水工调度

可选

type

enum<string>

类型

必需

枚举值:

1ddrainage2dsupply

content

string

调度规则内容

必需

sluiceContent

string

水闸调度规则内容

可选

supplyContent

string

供水 - 简单控制

可选

hydraulicScheduleBatch

array [object {4}]

批量新增水工调度

可选

type

enum<string>

类型

必需

枚举值:

1ddrainage2dsupply

content

string

调度规则内容

必需

sluiceContent

string

水闸调度规则内容

可选

supplyContent

string

供水 - 简单控制

可选

hydrologyModelParams

object

修改水文模型参数

可选

runoffs

array [object {2}]

产流

可选

slopeRouting

array [object {2}]

坡面汇流

可选

riverRouting

array [object {3}]

河道汇流

可选

reservoirParams

array [object {3}]

修改水库

可选

objectId

integer

水库对象ID

可选

objectName

string

水库对象名称

可选

ID和name必须传一个

initWaterLevel

number

初始水位

可选

reservoirRule

array [object {4}]

修改水库调度规则

可选

objectId

integer

水库对象ID

可选

objectName

string

水库对象名称

可选

ID和name必须传一个

schedulingRuleIsOpen

boolean

是否开启调度，开启时schedulingRules参数必填

必需

schedulingRules

array [array]

调度规则配置

可选

注意：是数组嵌套数组。调度开启时，本参数必填

reservoirMethod

array [object {4}]

修改水库调度方式

可选

objectId

integer

水库对象ID

可选

objectName

string

水库对象名称

可选

ID和name必须传一个

dispatchMethod

enum<string>

调度方式

必需

枚举值:

SPECIFIEDFREESLUICECUSTOMFLOODSLUICE2

dispatchMethodData

object

调度方式数据

可选

outletInflow

array [object {3}]

修改出水口的进流量

可选

水文站、水库

objectId

integer

对象ID

可选

objectName

string

对象名称

可选

ID和name必须传一个

inflowData

array [object {2}]

流量(时间序列)

必需

runoff

array [object {3}]

修改子流域的产流

可选

objectId

integer

对象ID

可选

objectName

string

对象名称

可选

ID和name必须传一个

XAJ

object

新安江产流参数

必需

sluiceParams

object

修改一维水闸

可选

sluices

array [object {2}]

可选

pumpParams

array [object {8}]

修改一维水泵

可选

objectId

integer

水泵ID

可选

ID和名称必须传入其中一个

objectName

string

水泵名称

可选

ID和名称必须传入其中一个

startDepthOfWater

number

启动水深(m)

可选

stopDepthOfWater

number

关闭水深(m)

可选

defaultState

enum<integer>

初始状态

可选

枚举值:

10

dataType

enum<string>

数据类型

可选

枚举值:

DEFAULTCURVESCONST

默认值:

DEFAULT

curve

object

水泵曲线

可选

const

number

常量

可选

pointSource

array [object {5}]

新增一维点源绑定断面

可选

objectName

string

对象名称

可选

修改已有对象数据时，ID和名称必须传入其中一个。

objectId

integer

对象ID

可选

修改已有对象数据时，ID和名称必须传入其中一个。

startCross

integer

起始断面ID

可选

新建对象时，起始断面ID必须

endCross

integer

终止断面ID

可选

新建对象时，终止断面ID必须

timeseriesData

array[object (时间序列) {2}]

时间序列数据

必需

blowDown

array [object {4}]

新增一维点源绑定断面

可选

水质污染物

startCross

integer

起始断面ID

可选

新建对象时，起始断面ID必须

endCross

integer

终止断面ID

可选

新建对象时，终止断面ID必须

timeseriesData

array[object (时间序列) {2}]

时间序列数据

必需

pollutants

array [object {2}]

污染物列表

必需

tidalBoundary

array [object {4}]

一维潮汐边界绑定潮水曲线

可选

crossName

string

断面名称

可选

新创建对象则必传，否则objectId/objectName为必传

curvesData

array [object {2}]

潮水曲线数据

必需

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个

wlflowBoundary

array [object {4}]

一维水位流量关系边界绑定水位流量曲线

可选

crossName

string

断面名称

可选

新创建对象则必传，否则objectId/objectName为必传

curvesData

array [object {2}]

水位流量曲线数据

必需

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个

pointSource2D

array[object (二维点源) {3}]

新增二维点源绑定网格输入

可选

水质污染物

meshNodeId

number

网格ID

必需

timeseriesData

array[object (时间序列) {2}]

时间序列数据

必需

pollutants

array [object {2}]

污染物列表

必需

flowBoundary2D

array [object {5}]

修改二维流量边界

可选

水质污染物

objectName

string

二维流量边界对象名称

必需

唯一，ID和名称必须传入其中一个

objectId

integer

二维流量边界对象ID

必需

唯一，ID和名称必须传入其中一个

flowDataType

enum<string>

流量数据类型

必需

枚举值:

consttimeSeries

flowData

流量数据

必需

多选一，只需要符合下列任意一组子节点

pollutants

array [object {2}]

污染物列表

必需

wlBoundary2dParams

array [object {6}]

修改二维水位边界

可选

objectId

number

对象ID

可选

ID和名称必须传入其中一个

objectName

string

对象名称

可选

ID和名称必须传入其中一个

dataType

enum<string>

水位数据类型

必需

枚举值:

consttimeSeries

startWaterLevelData

array [object {2}]

初始水位

可选

dataType = timeseries 时必需

endWaterLevelData

array [object {2}]

末端水位

可选

dataType = timeseries 时必需

const

number

常量

可选

dataType = const 时必需

pumpDrainageParams

array [object {7}]

修改排水泵

可选

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个

defaultState

number

初始状态

可选

startDepthOfWater

number

开启深度(m)

可选

stopDepthOfWater

number

关闭深度(m)

可选

pumpCurveType

enum<string>

水泵曲线类型

可选

枚举值:

PUMP1PUMP2PUMP3PUMP4

pumpCurveData

必需

manholeParams

array [object {6}]

修改检查井

可选

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个

initDeep

number

初始水深(m)

可选

overLoadDeep

number

超载深度(m)

可选

waterArea

number

积水面积(m²)

可选

inflows

array [object {3}]

进流量 - 直接进流

可选

conduitParams

object

修改排水管参数

可选

params

array [object {3}]

必需

timeseries

array [object {3}]

新增时间序列

可选

name

string

名称

必需

名称不支持特殊符号

labels

array[string]

列名数组

必需

data

array [object {4}]

数据值

必需

coupleSide1d2d

array [object {8}]

修改一二维侧向耦合溃坝

可选

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个。

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个。

coupleState

enum<integer>

溃坝

必需

开启或关闭一二维侧向耦合溃坝

枚举值:

01

dykeTypeState

enum<integer>

溃坝类型

可选

枚举值:

12

startWL

number

溃决水位(m)

可选

damBreakData

array [object {2}]

溃决过程

可选

damBreakNode

integer

溃口节点编号

必需

溃坝类型为指定深度宽度溃坝时必须

damBreakNodeData

array [object {3}]

溃决过程(溃口)

必需

溃坝类型为指定深度宽度溃坝时的溃决过程数据

catchmentZone

array[object (汇水分区) {7}]

修改汇水分区参数

可选

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个。

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个。

valueType

enum<string>

初值类型

必需

枚举值:

DepthWL

waterLevel

number

水位

可选

初值类型为水位和流速(WL)时必填

waterDepth

number

水深

可选

初值类型为水深和流速(Depth)时必填

Uspeed

number

U流速

必需

Vspeed

number

V流速

必需

dyke2d

array[object (二维溃坝) {4}]

修改二维溃坝

可选

objectName

string

对象名称

可选

唯一，ID和名称必须传入其中一个。

objectId

number

对象ID

可选

唯一，ID和名称必须传入其中一个。

breakWaterLevel

number

溃决水位(m)

可选

damBreakData

array [object {2}]

溃决过程

可选

analyzerParams

解析参数

可选

analyzerParams是数组，可以传入多个解析器，详细示例见接口说明

Any of

洪水风险分析解析器

GeoJson解析器

地理信息png图片解析器

三维贴图

注意simConfigParams-params2D-output中要开启floodRisk的参数

name

string

解析器名称

必需

floodRisk

sourceCRS

string

来源坐标系,EPSG代号

必需

targetCRS

string

目标坐标系,EPSG代号

必需

minFloodDepth

number

最小洪水深度

必需

超过该值为洪水

affineTransformationParams

object

坐标偏移量

可选

标准坐标系默认不填。
偏移方法：
x1 = ax +by +c;y1=dx+ey+f。x/y是原来的坐标，x1/y1是转换转换后的

cbUrl

string

回调接口

可选

示例

{
    "simulationConfig": {
        "startTime": "2021-01-01 00:00:00",
        "endTime": "2021-01-02 06:00:00",
        "outputStep": "00:30:00"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://cloud.keepsoft.net:30100/api/mcc/v1/app/sim' \
--header 'apiKey;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "simulationConfig": {
        "startTime": "2021-01-01 00:00:00",
        "endTime": "2021-01-02 06:00:00",
        "outputStep": "00:30:00"
    }
}'

返回响应

🟢200成功

application/json

Body

idx

integer

任务idx

必需

任务idx

示例

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

{
    "idx": 7344
}

🟠400400参数错误

🟠401401签名无效

修改于 2025-06-30 07:48:59

获取排水泵参数

提交应用率定-自动率定