Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Details/ Displaying Timeline Information
Updated on 2025-01-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Displaying Timeline Information

Function

This API is used to display the timeline information about operations such as the creation time, start time, retry, and reset of a task with a specified task ID.

URI

GET /v5/{project_id}/jobs/{job_id}/timelines

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

job_id

Yes

String

Task ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0. The default value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of a request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Auth-Token

Yes

String

User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The token is the value of X-Subject-Token in the response header.

X-Language

Yes

String

Request language type.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Long

Total number.

timelines

Array of TimelineInfo objects

Timeline list.
Table 5 TimelineInfo

Parameter

Type

Description

name

String

Timeline name.

status

String

Status.

operation_time

String

Operation time.

user_name

String

Username.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Request for querying timeline information.

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/e7d99b2b-9f58-493c-aae1-2f97c62jb5a4/timelines?limit=10&offset=0

{
  "timelines" : [ {
    "name" : "CONFIG_SPEED",
    "status" : "success",
    "operation_time" : "2024-12-19T03:44:36Z",
    "user_name" : "user_name1"
  }, {
    "name" : "CREATE_JOB",
    "status" : "success",
    "operation_time" : "2024-12-19T03:39:18Z",
    "user_name" : "user_name1"
  } ],
  "count" : 2
}

Example Response

Status code: 200

OK

{
  "timelines" : [ {
    "name" : "CONFIG_SPEED",
    "status" : "success",
    "operation_time" : "2024-12-19T03:44:36Z",
    "user_name" : "user_name1"
  }, {
    "name" : "CREATE_JOB",
    "status" : "success",
    "operation_time" : "2024-12-19T03:39:18Z",
    "user_name" : "user_name1"
  } ],
  "count" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

Status Code

Status Code

Description

200

OK

400

Bad Request

Error Code

For details, see Error Code.

Parent topic: Task Details