Querying the Log Details of a Single Task
Function
This API is used to query all logs of a task.
URI
GET /v2/{project_id}/fdi/instances/{instance_id}/tasks/{task_id}/monitor-logs
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: 30 |
instance_id |
Yes |
String |
Instance ID. Minimum: 1 Maximum: 30 |
task_id |
Yes |
String |
Task ID. Minimum: 1 Maximum: 30 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Offset. The query starts from this offset. The value of offset is greater than or equal to 1. Minimum: 1 Maximum: 999999 Default: 1 |
limit |
No |
Integer |
Number of records displayed on each page. The maximum value is 999. Excessive records are not returned. Minimum: 0 Maximum: 999999 Default: 10 |
begin_time |
No |
Integer |
Start time for the logs to be queried. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
end_time |
No |
Integer |
End time for the logs to be queried. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
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 |
---|---|---|
total |
Integer |
Total number. Minimum: 1 Maximum: 99999 |
size |
Integer |
Number of logs on the current page. Minimum: 1 Maximum: 99999 |
entities |
Array of TaskMonitorLog objects |
Elements on the current page of task monitoring logs. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Trace ID of a single task. Minimum: 10 Maximum: 40 |
start_time |
Integer |
Start time of the current execution. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
dispatch_time |
Integer |
Scheduled execution time. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
end_time |
Integer |
End time of the current execution. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
execute_status |
String |
Task execution status.
Minimum: 10 Maximum: 3 |
position |
String |
Phase to which the task is executed.
Minimum: 10 Maximum: 3 |
position_status |
String |
Status of the current task execution phase.
Minimum: 20 Maximum: 3 |
status |
Integer |
Detailed task execution status. The status codes are classified as follows: 100 to 499 for the reader side, 500 to 899 for the writer side, and 900 and beyond for others.
Minimum: 1 Maximum: 1000 |
dirty_data_count |
Integer |
Number of abnormal data records. Minimum: 0 Maximum: 9999999999999 |
data_count |
Integer |
Number of successful data records. Minimum: 0 Maximum: 9999999999999 |
data_size |
Number |
Size of success data. The value is a floating-point number. Minimum: 0 Maximum: 9999999999999 |
data_size_unit |
String |
Unit for measuring the size of success data. Minimum: 2 Maximum: 1 |
spend_time |
Integer |
Execution duration, in milliseconds. Minimum: 0 Maximum: 9999999999999 |
read_spend_time |
Integer |
Read execution duration, in milliseconds. This parameter is available only for scheduled tasks. Minimum: 0 Maximum: 9999999999999 |
write_spend_time |
Integer |
Write execution duration, in milliseconds. Minimum: 0 Maximum: 9999999999999 |
remarks |
String |
Brief information about the execution result. Minimum: 0 Maximum: 1000 |
detail_logs |
Array of TaskMonitorDetailLog objects |
Detailed track information about the current execution. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Unique ID generated each time when a task is executed. Minimum: 10 Maximum: 40 |
status |
Integer |
Detailed task execution status. The status codes are classified as follows: 100 to 499 for the reader side, 500 to 899 for the writer side, and 900 and beyond for others.
Minimum: 1 Maximum: 1000 |
position |
String |
Phase at which the current step is.
Minimum: 10 Maximum: 3 |
position_status |
String |
Status of the current step of a task.
Minimum: 20 Maximum: 3 |
stage |
String |
FDI plug-in to which the current step belongs, for example, adapter, apireader, and rdbwriter. Minimum: 20 Maximum: 3 |
dirty_data_count |
Integer |
Number of abnormal data records. Minimum: 0 Maximum: 9999999999999 |
data_count |
Integer |
Number of successful data records. Minimum: 0 Maximum: 9999999999999 |
data_size |
Number |
Size of success data. The value is a floating-point number. Minimum: 0 Maximum: 9999999999999 |
data_size_unit |
String |
Unit for measuring the size of success data. Minimum: 2 Maximum: 1 |
spend_time |
Integer |
Execution duration, in milliseconds. Minimum: 0 Maximum: 9999999999999 |
remarks |
String |
Execution details. Minimum: 256 Maximum: 1 |
step_begin_time |
Integer |
Start time of this step. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
step_end_time |
Integer |
End time of this step. The value is in the format of timestamp(ms) and uses the UTC time zone. Minimum: 1 Maximum: 9999999999999 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Example Requests
None
Example Responses
None
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot