文档首页/ 数据仓库服务 DWS/ API参考/ API说明/ 逻辑集群管理/ 查询逻辑集群定时增删计划
更新时间:2025-07-08 GMT+08:00

查询逻辑集群定时增删计划

功能介绍

查询逻辑集群定时增删计划。定时增删计划业务支持最多保存20条数据,接口最大返回20条数据。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/clusters/{cluster_id}/logical-cluster-plans

表1 路径参数

参数

是否必选

参数类型

描述

cluster_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

plans

Array of LogicalClusterPlanVo objects

参数解释

逻辑集群增删计划对象列表。列表最大返回一般不超过20条。

取值范围

不涉及。

表3 LogicalClusterPlanVo

参数

参数类型

描述

id

String

参数解释

增删逻辑集群计划ID。

取值范围

不涉及。

logical_cluster_name

String

参数解释

逻辑集群名字。

取值范围

不涉及。

node_num

Integer

参数解释

逻辑集群节点个数。

取值范围

不涉及。

plan_type

String

参数解释

逻辑集群增删计划类型,取值范围为 (once|periodicity),表示单次或周期性。

取值范围

不涉及。

status

String

参数解释

逻辑集群增删计划状态。

取值范围

running:运行中

waiting:等待中

deleted:已删除

finished:已完成

disabled:已禁用

failed:失败

start_time

String

参数解释

逻辑集群增删计划开始时间。

取值范围

不涉及。

end_time

String

参数解释

逻辑集群增删计划结束时间。

取值范围

不涉及。

update_time

String

参数解释

逻辑集群增删计划更新时间。

取值范围

不涉及。

user

String

参数解释

逻辑集群增删计划绑定的用户。

取值范围

不涉及。

actions

Array of LogicalClusterPlanActions objects

参数解释

任务信息。

取值范围

不涉及。

表4 LogicalClusterPlanActions

参数

参数类型

描述

next_fire_time

String

参数解释

下一次触发时间。

取值范围

不涉及。

failed_reason

String

参数解释

失败原因。

取值范围

不涉及。

id

String

参数解释

任务ID。

取值范围

不涉及。

type

String

参数解释

类型。

取值范围

create:创建

delete:删除

strategy

String

参数解释

周期信息。Cron表达式:如"0 0 0 ? * 3"。

取值范围

不涉及。

status

String

参数解释

任务状态。

取值范围

running|waiting|deleted|finished|disabled|failed。

pre_fire_time

Date

参数解释

上一次触发时间。

取值范围

不涉及。

请求示例

查询逻辑集群定时增删计划。

GET https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/logical-cluster-plans

响应示例

状态码:200

查询逻辑集群定时增删计划。

{
  "plans" : [ {
    "id" : "5f70f6ba-4683-4cae-a5e6-3b05a310f6f9",
    "status" : "finished",
    "user" : null,
    "actions" : [ {
      "strategy" : "1740134866526",
      "status" : "finished",
      "next_fire_time" : null,
      "failed_reason" : null,
      "id" : "b33f5783-8d9c-4ec6-9249-ccfd9186d105",
      "type" : "create"
    } ],
    "logical_cluster_name" : "LC_0221_02",
    "node_num" : 3,
    "plan_type" : "once",
    "start_time" : "2025-02-21T10:47:48Z",
    "end_time" : "2025-02-21T11:03:38Z",
    "update_time" : "2025-02-21T11:03:38Z"
  } ]
}

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 ListLogicalClusterPlansSolution {

    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();
        ListLogicalClusterPlansRequest request = new ListLogicalClusterPlansRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListLogicalClusterPlansResponse response = client.listLogicalClusterPlans(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 = ListLogicalClusterPlansRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_logical_cluster_plans(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

查询逻辑集群定时增删计划。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。