Get execution details
Information regarding a specific execution¶
GET/api/compute/execution/{id}
endpoints allow you to get detailed information about a specific triggered engine execution:
Click to show example commands to get the execution information
projectId="<replacewithprojectid>"
openapikey="<replacewithopenapikey>"
executionId="<replacewithexecutionid>"
# get execution details
curl -L -X GET "https://api.mike-cloud-test.com/api/compute/execution/$executionId" \
-H 'api-version: 2' \
-H 'dhi-service-id: engine' \
-H "dhi-project-id: $projectId" \
-H "dhi-open-api-key: $openapikey"
var execution = await computeClient.GetExecutionAsync(projectId, executionId);
{
"executionId": "7b103cbd-a932-4581-91b6-ced61047c746",
"outputLocation": "https://coreenginedevdata.blob.core.windows.net/7b103cbd-a932-4581-91b6-ced61047c746?sv=2018-03-28&sr=c&sig=Ec263t1VLiJrtk28SLytNDhRhoCXNFA035MtmQR3Qok%3D&se=2019-10-16T14%3A05%3A17Z&sp=rl"
"status": "InProgress",
"message": null
"projectId": "7da87338-ae51-466a-96a9-258162f39784",
"customerId": "8eb87858-046e-4a92-a739-e4668ed9d1fb",
"createdAt": "2019-12-19T17:24:25.2581912Z",
"startedAt": "2019-12-19T17:24:27.2704876Z",
"updatedAt": "2019-12-19T17:24:27.270486Z",
"finishedAt": null,
"engines": [
{
"name": "FemEngineHD",
"version": "2024.1"
}
],
"poolType": "VM-S-40",
"virtualMachineSize": "STANDARD_F16S_V2",
"nodeCount": 1,
"runningSetupIndex": 0,
"runningSetupProgress": "STATUS : 2004-01-01 02:21:00, MESSAG : Time step: 4230, COMSPD : 981736, PROGRE : 587, TIMLFT : 2",
"totalNumberOfSetups": 1,
"scenarioName": "Determine the wind set-up in a lake"
}
Note
Engine execution provided outputLocation
is available for 30 days if it is not enough override this behaviour by providing custom output location in the execution call under parameter output
.
The endpoint's response contains several properties that can be used to monitor the progress of the triggered execution :
status
: status of the execution, see execution status for detailsrunningSetupIndex
: index of the setup file that is currently executedrunningSetupProgress
: progress of the currently executed setup filetotalNumberOfSetups
: total number of setup files to be run as part of the execution
Information regarding all executions within a project¶
The GET/api/compute/execution/list
and GET/api/compute/execution/my-list
endpoints can be used to retrieve information about all the engine executions that are running in the context of the current project.
Click to show example shell script to get information about the executions within a project
projectId="<replacewithprojectid>"
openapikey="<replacewithopenapikey>"
# get executions in the project
curl -L -X GET "https://api.mike-cloud-test.com/api/compute/execution/list" \
-H 'api-version: 2' \
-H 'dhi-service-id: engine' \
-H "dhi-project-id: $projectId" \
-H "dhi-open-api-key: $openapikey"
projectId="<replacewithprojectid>"
openapikey="<replacewithopenapikey>"
# get all my executions
curl -L -X GET "https://api.mike-cloud-test.com/api/compute/execution/my-list" \
-H 'api-version: 2' \
-H 'dhi-service-id: engine' \
-H "dhi-open-api-key: $openapikey"
Example response:
[
{
"executionId": "0dc17188-8cf3-4c35-a314-fcce1527129a",
"status": "InProgress",
"projectId": "7da87338-ae51-466a-96a9-258162f39784",
"customerId": "8eb87858-046e-4a92-a739-e4668ed9d1fb",
"createdAt": "2020-08-20T08:22:15.7131918Z",
"startedAt": "2020-08-20T08:22:19.1088476Z",
"updatedAt": "2020-08-20T08:31:25.8751422Z",
"finishedAt": "2020-08-20T08:31:25.8751425Z",
"engines": [
{
"name": "FemEngineHD",
"version": "2024.1"
}
],
"poolType": "VM-S-5",
"virtualMachineSize": "Standard_DS2_v2",
"nodeCount": 1,
"outputLocation": "https://coreenginetestdata.blob.core.windows.net/0dc17188-8cf3-4c35-a314-fcce1527129a?sv=2018-03-28&sr=c&sig=Rf8ShVP%2FlWURvYwCCzFgP883IGI8QLb5U0WQ4EtNfxU%3D&se=2020-09-26T07%3A42%3A50Z&sp=rl",
"runningSetupIndex": 0,
"runningSetupProgress": "STATUS : 2004-01-01 02:21:00, MESSAG : Time step: 4230, COMSPD : 981736, PROGRE : 587, TIMLFT : 2",
"totalNumberOfSetups": 1,
"scenarioName": "Determine the wind set-up in a lake"
},
{
"executionId": "1bc5a795-ee62-444d-824d-7512bb6e5729",
"status": "Pending",
"projectId": "7da87338-ae51-466a-96a9-258162f39784",
"customerId": "8eb87858-046e-4a92-a739-e4668ed9d1fb",
"createdAt": "2020-08-19T13:42:42.35335Z",
"startedAt": "2020-08-19T13:42:46.6129322Z",
"updatedAt": "2020-08-19T13:42:58.3707195Z",
"finishedAt": "2020-08-19T13:42:58.3707198Z",
"engines": [
{
"name": "FemEngineHD",
"version": "2024.1"
}
],
"poolType": "VM-S-5",
"virtualMachineSize": "Standard_DS2_v2",
"nodeCount": 1,
"outputLocation": "https://coreenginetestdata.blob.core.windows.net/1bc5a795-ee62-444d-824d-7512bb6e5729?sv=2018-03-28&sr=c&sig=O0LnSX4zD7M96S9xcFDnAg3RM2KEZb%2BBd9WLn%2BE%2FM9Y%3D&se=2020-09-26T07%3A42%3A50Z&sp=rl",
"runningSetupIndex": 0,
"runningSetupProgress": null,
"totalNumberOfSetups": 2
}
...