Updated on 2026-11-11 GMT+08:00

Querying the O&M Task List

Function

Query the O&M task list.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dws:cluster:listOperationalTask

    List

    cluster *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dws:operationalTask:get

    -

URI

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

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

time_zone

No

String

Definition:

Time zone offset. The default value is the UTC time (0 offset), that is, +0000.

Constraints:

None

Range:

-2359~+2359

Default Value:

+0000

type

No

String

Definition:

Job type

Constraints:

Only two values are supported.

Range:

Date: one-off task;

Window: periodic task;

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

count

Integer

Definition:

Total number of records.

data

Array of TaskInfoVo objects

Definition:

Job list.

Table 4 TaskInfoVo

Parameter

Type

Description

category

String

Definition:

Category.

description

String

Definition:

Description about the IPv6 address or CIDR block.

type

String

Definition:

Job type

task_id

String

Definition:

Task ID.

task_name

String

Definition:

Job name.

start_time

String

Definition:

Job start time.

end_time

String

Definition:

Task end time.

white_list

Array of DateInfo objects

Definition:

Task time window.

vacuum_mode

String

Definition:

Task mode

vacuum_target

String

Definition:

Automatic vacuum target.

is_paused

Integer

Definition:

Whether to pause.

vacuum_threshold

String

Definition

Expansion rate, in percentage.

vacuum_retrieving_space

String

Definition

Reclaimable space of the target table.

vacuum_priority

Array of TableInfoOpen objects

Definition:

Preferred Vacuum target.

time_zone

String

Definition:

Time zone.

Table 5 DateInfo

Parameter

Type

Description

date_type

String

Definition:

Date type. For example, if the scheduled task is executed on the first day of each month, the value is 1th.

Range:

None

date_start

String

Definition:

Start time, for example, 04:00:00.

Range:

None

date_end

String

Definition:

End time, for example, 08:00:00.

Range:

None

Table 6 TableInfoOpen

Parameter

Type

Description

database_name

String

Definition:

Database name

schema_name

String

Definition:

Schema name

table_name

String

Definition:

Table name.

Example Requests

Query the O&M task list.

GET https://{Endpoint}/v1/169439ece752470aa5171633e9d3e47f/clusters/50aee999-9215-4dd0-a142-254ac6bf80e7/operational-tasks

Example Responses

Status code: 200

{
  "data" : [ {
    "category" : "VacuumFull",
    "description" : "desc",
    "type" : "Window",
    "task_id" : "VacuumFull_68FCLmSTSScb87zWrxEFZ",
    "task_name" : "test1",
    "start_time" : "2025-12-31T20:00:00Z",
    "end_time" : "2026-01-01T00:00:00Z",
    "white_list" : [ {
      "date_type" : "31th",
      "date_start" : "20:00:00",
      "date_end" : "23:59:59"
    }, {
      "date_type" : "1th",
      "date_start" : "00:00:00",
      "date_end" : "00:00:00"
    } ],
    "vacuum_mode" : "manual",
    "vacuum_target" : "",
    "is_paused" : 0,
    "vacuum_threshold" : "",
    "vacuum_retrieving_space" : "",
    "vacuum_priority" : [ {
      "database_name" : null,
      "schema_name" : "public",
      "table_name" : "a"
    } ],
    "time_zone" : null
  } ],
  "count" : 1
}

Status Codes

Status Code

Description

200

Response to the request for querying the O&M task list.

400

Request error.

401

Authentication failed.

403

No operation permissions.

404

No resources found.

500

Internal service error.

503

Service unavailable.