Help Center/ ROMA Connect/ API Reference/ Data Integration APIs/ Task Monitoring/ Querying Schedule Information About a Specified Task
Updated on 2025-03-26 GMT+08:00

Querying Schedule Information About a Specified Task

Function

This API is used to query schedule information about a specified task.

URI

GET /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/monitor-overview

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.

instance_id

Yes

String

Instance ID.

task_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_name

String

Task name.

total_num

Integer

Total number of tasks.

error_num

Integer

Number of failed tasks.

success_num

Integer

Number of successful tasks.

running_num

Integer

Number of running tasks

cancel_num

Integer

Number of canceled tasks.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more