Help Center/ Data Warehouse Service/ API Reference/ API Description/ Intelligent O&M/ Obtaining O&M Task Execution Information
Updated on 2026-11-11 GMT+08:00

Obtaining O&M Task Execution Information

Function

Obtain the execution information about an O&M task.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/clusters/{cluster_id}/operational-tasks/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

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

Constraints:

None

Range:

None

Default Value:

None

cluster_id

Yes

String

Definition:

Cluster ID For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

None

Range:

None

Default Value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

category

No

String

Definition:

Page offset. The value starts from 0 and decreases by 1.

Constraints:

None

Range:

VacuumFull

Default Value:

VacuumFull

task_id

No

String

Definition:

Page offset. The value starts from 0 and decreases by 1.

Constraints:

None

Range:

None

Default Value:

None

status

No

String

Definition:

Status.

Constraints:

None

Range:

running, waiting, finished, canceled

Default Value:

None

start_time

No

String

Definition:

Start date.

Constraints:

None

Range:

None

Default Value:

None

end_time

No

String

Definition:

End date.

Constraints:

None

Range:

None

Default Value:

None

limit

No

Integer

Definition:

Size of each page to be queried

Constraints:

None

Range:

None

Default Value:

100

offset

No

Integer

Definition:

Page offset. The value starts from 0 and decreases by 1.

Constraints:

None

Range:

≥ 0

Default Value:

0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

Array of TaskStatusOpenResp objects

Definition:

Details.

count

Integer

Definition:

Total number of records.

Table 4 TaskStatusOpenResp

Parameter

Type

Description

task_id

String

Definition:

Task ID.

task_dead_line

String

Definition:

Task due date.

category

String

Definition:

Category information.

status

String

Definition:

Status.

time_left

String

Definition:

Remaining time.

start_time

String

Definition:

Start time.

end_time

String

Definition:

End time.

finished_percentage

String

Definition:

Indicates the completion percentage.

vacuumed_space

String

Definition:

Task ID.

table_vacuum_info

TableVacuumInfoOpen object

Definition

Information about running tables.

vacuum_info

Array of objects

Definition:

Vacuum information.

table_vacuum_num_info

TableVacuumNumInfo object

Definition

Number of running tables.

Table 5 TableVacuumInfoOpen

Parameter

Type

Description

vacuum_running_info

Array of TableInfoOpen objects

Definition

Information about running tables.

vacuum_waiting_info

Array of TableInfoOpen objects

Definition

Information about waiting tables.

vacuum_finished_info

Array of TableInfoOpen objects

Definition

Information about the finished tables.

vacuum_canceled_info

Array of TableInfoOpen objects

Definition

Information about canceled tables.

Table 6 TableInfoOpen

Parameter

Type

Description

database_name

String

Definition:

Database name

schema_name

String

Definition:

Schema name

table_name

String

Definition:

Table name.

Table 7 TableVacuumNumInfo

Parameter

Type

Description

waiting_num

Integer

Definition

Number of waiting tables.

running_num

Integer

Definition

Number of running tables.

finished_num

Integer

Definition

Number of completed tables.

canceled_num

Integer

Definition

Number of canceled tables.

total_num

Integer

Definition

Total number.

Example Requests

Obtain the execution information about an O&M task.

GET https://{Endpoint}/v1/169439ece752470aa5171633e9d3e47f/clusters/50aee999-9215-4dd0-a142-254ac6bf80e7/operational-tasks/detail?start_time=&end_time=&category=&task_id=&status=

Example Responses

Status code: 200

{
  "data" : [ {
    "task_id" : "VacuumFull_h5dUUB0XA2PYQ0I1xg7cvP",
    "task_dead_line" : "2026-01-07 09:00:42,2026-01-08 09:00:42",
    "category" : "VacuumFull",
    "status" : "Waiting",
    "time_left" : "16h 0m 33s",
    "start_time" : "2026-01-07T09:00:42Z",
    "end_time" : "2026-01-08T09:00:42Z",
    "finished_percentage" : "0",
    "vacuumed_space" : "0",
    "table_vacuum_info" : {
      "vacuum_running_info" : [ ],
      "vacuum_waiting_info" : [ ],
      "vacuum_finished_info" : [ ],
      "vacuum_canceled_info" : [ ]
    },
    "table_vacuum_num_info" : {
      "waiting_num" : 0,
      "running_num" : 0,
      "finished_num" : 0,
      "canceled_num" : 0
    },
    "vacuum_info" : [ ]
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request error.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

Internal service error.

503

Service unavailable.