Querying Task Status Statistics
Function
This API is used to query the status statistics of different tasks.
URI
GET /v2/{project_id}/fdi/instances/{instance_id}/statistics/tasks
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference. |
|
instance_id |
Yes |
String |
Instance ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
common_task_details |
TaskStatisticDetails object |
Number of tasks in each status. |
|
cdc_task_details |
TaskStatisticDetails object |
Number of tasks in each status. |
|
Parameter |
Type |
Description |
|---|---|---|
|
running_tasks_count |
Integer |
Number of running tasks |
|
abnormal_tasks_count |
Integer |
Number of abnormal tasks. |
|
terminated_tasks_count |
Integer |
Number of terminated tasks. |
|
completed_tasks_count |
Integer |
Number of successful tasks. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
Querying FDI task status statistics of a specified instance
https://{{ServerHost}}/v2/c53626012ba84727b938ca8bf03108ef/fdi/instances/fae7ff6c-8e07-4cf8-9e67-589cab2f017c/statistics/tasks
Example Responses
Status code: 200
OK
{
"common_task_details" : {
"running_tasks_count" : 2,
"abnormal_tasks_count" : 2,
"terminated_tasks_count" : 6,
"completed_tasks_count" : 8
},
"cdc_task_details" : {
"running_tasks_count" : 1,
"abnormal_tasks_count" : 0,
"terminated_tasks_count" : 6,
"completed_tasks_count" : 0
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.