Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Task Center/ Viewing Details About an Asynchronous Task
Updated on 2025-10-11 GMT+08:00

Viewing Details About an Asynchronous Task

Function

This API is used to view details about an asynchronous task. Before calling this API:

URI

GET /v3/{project_id}/instances/{instance_id}/task-center-detail

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Definition

Task ID.

Constraints

N/A

Range

N/A

Default Value

N/A

job_name

Yes

String

Definition

Task name.

Constraints

N/A

Range

  • RestoreTaurusInInstanceToExisted: restoring data to an existing instance

  • RestoreTaurusInInstanceToCurrent: restoring data to the original instance

  • RestoreGaussDBforMySQLNewInstance: restoring data to a new instance

  • RestoreTableTaurus: restoring tables to a specified point in time

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instance_id

String

Definition

Instance ID.

Range

N/A

instance_name

String

Definition

Instance name.

Range

N/A

job_id

String

Definition

Task ID.

Range

N/A

job_name

String

Definition

Task name.

Range

N/A

status

String

Definition

Task status.

Range

  • Pending

  • Running

  • Completed

sub_task_list

Array of SubTaskInfo objects

Definition

Task list.

Range

N/A

Table 5 SubTaskInfo

Parameter

Type

Description

sub_task_name

String

Definition

Subtask name.

Range

N/A

percent

String

Definition

Subtask progress, in percentage.

Range

0–100

remaining_time

String

Definition

Remaining time, in seconds.

Range

N/A

Example Request

Viewing details about an asynchronous task

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/task-center-detail

Example Response

Status code: 200

Success.

{
  "instance_id" : "a23fb62bd61e4e9e9636fd2225f395bein07",
  "instance_name" : "taurusdb-12cd",
  "job_id" : "866b2273-f5ce-44bd-bc10-949baeb22163",
  "job_name" : "RestoreTaurusInInstanceToExisted",
  "sub_task_list" : [ {
    "sub_task_name" : "INIT",
    "percent" : 19,
    "status" : "complete",
    "remaining_time" : 66
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.