文档首页/ 数据仓库服务 DWS/ API参考/ API说明/ 智能运维/ 获取运维任务执行信息 - ListOperationalTaskDetail
更新时间:2026-09-28 GMT+08:00

获取运维任务执行信息 - ListOperationalTaskDetail

功能介绍

获取运维任务执行信息。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cluster_id

是

String

参数解释:

集群ID。获取方法请参见获取集群ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

category

否

String

参数解释:

分页偏移量,从0开始,页数减1。

约束限制:

不涉及。

取值范围:

VacuumFull

默认取值:

VacuumFull

task_id

否

String

参数解释:

分页偏移量,从0开始,页数减1。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

否

String

参数解释:

状态。

约束限制:

不涉及。

取值范围:

running、waiting、finished、canceled

默认取值:

不涉及。

start_time

否

String

参数解释:

开始日期。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

end_time

否

String

参数解释:

结束日期。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

limit

否

Integer

参数解释:

分页查询,每页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

100

offset

否

Integer

参数解释:

分页偏移量,从0开始,页数减1。

约束限制:

不涉及。

取值范围:

大于等于0

默认取值:

0

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

Array of TaskStatusOpenResp objects

参数解释:

详细列表。

取值范围:

不涉及。

count

Integer

参数解释:

总条数。

取值范围:

大于等于0。

表4 TaskStatusOpenResp

参数

参数类型

描述

task_id

String

参数解释:

任务ID。

取值范围:

不涉及。

task_dead_line

String

参数解释:

任务截止时间。

取值范围:

不涉及。

category

String

参数解释:

分类信息。

取值范围:

VacuumFull

status

String

参数解释:

状态。

取值范围:

不涉及。

time_left

String

参数解释:

剩余时间。

取值范围:

不涉及。

start_time

String

参数解释:

开始时间。

取值范围:

不涉及。

end_time

String

参数解释:

结束时间。

取值范围:

不涉及。

finished_percentage

String

参数解释:

完成百分比。

取值范围:

不涉及。

vacuumed_space

String

参数解释:

任务ID。

取值范围:

不涉及。

table_vacuum_info

TableVacuumInfoOpen object

参数解释:

运行的表信息。

取值范围:

不涉及。

vacuum_info

Array of objects

参数解释:

Vacuum信息。

取值范围:

不涉及。

table_vacuum_num_info

TableVacuumNumInfo object

参数解释:

运行的表数量信息。

取值范围:

不涉及。

表5 TableVacuumInfoOpen

参数

参数类型

描述

vacuum_running_info

Array of TableInfoOpen objects

参数解释:

运行中的表信息。

取值范围:

不涉及

vacuum_waiting_info

Array of TableInfoOpen objects

参数解释:

等待中的表信息。

取值范围:

不涉及

vacuum_finished_info

Array of TableInfoOpen objects

参数解释:

已结束的表信息。

取值范围:

不涉及

vacuum_canceled_info

Array of TableInfoOpen objects

参数解释:

取消的表信息。

取值范围:

不涉及

表6 TableInfoOpen

参数

参数类型

描述

database_name

String

参数解释:

数据库名。

取值范围:

不涉及。

schema_name

String

参数解释:

模式名。

取值范围:

不涉及。

table_name

String

参数解释:

表名。

取值范围:

不涉及。

表7 TableVacuumNumInfo

参数

参数类型

描述

waiting_num

Integer

参数解释:

等待的表数量。

取值范围:

大于等于0。

running_num

Integer

参数解释:

运行中的表数量。

取值范围:

大于等于0。

finished_num

Integer

参数解释:

已完成的表数量。

取值范围:

大于等于0。

canceled_num

Integer

参数解释:

取消的表数量。

取值范围:

大于等于0。

total_num

Integer

参数解释:

总数。

取值范围:

大于等于0。

请求示例

获取运维任务执行信息。

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

响应示例

状态码: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
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListOperationalTaskDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListOperationalTaskDetailRequest request = new ListOperationalTaskDetailRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListOperationalTaskDetailResponse response = client.listOperationalTaskDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListOperationalTaskDetailRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_operational_task_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dws.DwsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dws.NewDwsClient(hcClient)

    request := &model.ListOperationalTaskDetailRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListOperationalTaskDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。