模型计算服务
  1. ModelRun
模型计算服务
  • ModelRun
    • 创建计算任务
      POST
    • 获取方案计算状态
      POST
    • 获取方案计算日志
      GET
    • 通过方案Id取消计算
      POST
    • 清除方案计算状态
      POST
    • 查询模型的计算状态
      GET
    • 查询正在计算的方案信息
      GET
    • 获取计算队列的长度
      POST
    • 获取方案的状态
      POST
    • 查询计算资源信息
      POST
    • 获取方案的排队情况
      GET
    • [内部接口] 通过方案ID来更新minIO地址(后端内部调用)
      POST
    • 通过方案Id来更新计算状态
      POST
  • Health
    • 健康检查接口
      GET
  1. ModelRun

创建计算任务

POST
/ModelRun/RunModel
ModelRun
创建一个方案模型计算的任务,任务将被推送到消息队列中排队等待计算。能够同时执行计算任务的个数取决于该队列消费者的个数和授权的liense席位的最小值。
license席位个数在部署时确定,队列消费者的数量取决于消费者启动的实例个数。
发布任务时,可以指定计算任务的优先级,数值越大,优先级越高。否则将排队等待计算。
如果一个方案的任务已经在队列中,重复发布时将先取消已有的该模型的计算任务,再重新发布新的任务,先前排队的顺序无效。
如队列中有10个计算,方案1已经在排队中,序号为5,再次发布方案1的计算,则方案1的序号将变为11,原来序号为5的任务将被取消。

请求参数

Body 参数application/json
发布计算任务输入
projectName
string  | null 
可选
项目名称,可以区分计算模型类型,以及最终的计算任务最终被分配的队列
tenantId
string <uuid>
租户Id
可选
scenarioId
string <uuid>
要计算方案Id
可选
modelType
string  | null 
可选
模型类型,不同的模型类型对应不同的计算服务
priority
integer <int32>
可选
优先级:数值越大,优先级越高
modelInfo
string  | null 
可选
模型信息,json格式字符串,其中ScenarioId、TenantId、TemplateScenarioId为必要字段,首字母需要大写,否则将会在模型计算流程中无法正确识别 {"ScenarioId":"","TenantId":"","TemplateScenarioId":""}
示例
{
    "projectName": "bz",
    "tenantId": "3a07fc5a-e2cc-2136-6969-0e1f1ad4205f",
    "scenarioId": "903cfe80-779e-4e9e-a308-610f242596b1",
    "modelType": "WWTP",
    "priority": 0,
    "modelInfo": "{\"ScenarioId\":\"903cfe80-779e-4e9e-a308-610f242596b1\",\"TenantId\":\"3a07fc5a-e2cc-2136-6969-0e1f1ad4205f\",\"TemplateScenarioId\":\"6f331d41-39b8-4ae5-8bd0-3ecb4015e6ab\", \"type\":18}"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://online-products.dhichina.cn/gateway/global-model-driver-service/ModelRun/RunModel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "projectName": "bz",
    "tenantId": "3a07fc5a-e2cc-2136-6969-0e1f1ad4205f",
    "scenarioId": "903cfe80-779e-4e9e-a308-610f242596b1",
    "modelType": "WWTP",
    "priority": 0,
    "modelInfo": "{\"ScenarioId\":\"903cfe80-779e-4e9e-a308-610f242596b1\",\"TenantId\":\"3a07fc5a-e2cc-2136-6969-0e1f1ad4205f\",\"TemplateScenarioId\":\"6f331d41-39b8-4ae5-8bd0-3ecb4015e6ab\", \"type\":18}"
}'

返回响应

🟢200成功
application/json
Success
Body
模型操作结果
scenarioId
string <uuid>
方案ID
可选
hasError
boolean 
是否存在错误
可选
message
string  | null 
消息
可选
queueId
string  | null 
排队Id
可选
示例
{
    "scenarioId": "903cfe80-779e-4e9e-a308-610f242596b1",
    "hasError": false,
    "message": "Scenario running command have published",
    "queueId": "3a074933-c74d-e5d4-296d-64a8d887c5b0"
}
下一页
获取方案计算状态
Built with