Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Management/ Counting the number of tasks of different types and states
Updated on 2023-06-29 GMT+08:00

Counting the number of tasks of different types and states

Function

This API is used to count the number of tasks of different types and states.

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/statistics/tasks

Table 1 Path Parameters

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.

Minimum: 1

Maximum: 64

instance_id

Yes

String

Instance ID.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header 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

Table 3 Response body parameters

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.

Table 4 TaskStatisticDetails

Parameter

Type

Description

running_tasks_count

Integer

Number of running tasks

Minimum: 0

Maximum: 999999999999

abnormal_tasks_count

Integer

Number of abnormal tasks.

Minimum: 0

Maximum: 999999999999

terminated_tasks_count

Integer

Number of terminated tasks.

Minimum: 0

Maximum: 999999999999

completed_tasks_count

Integer

Number of successful tasks.

Minimum: 0

Maximum: 999999999999

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Example Requests

https://{{ServerHost}}/v2/:project_id/fdi/instances/:instance_id/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.