Help Center/ Data Warehouse Service/ API Reference/ API Description/ Logical Cluster Management/ Querying the Scheduled Plan for Adding or Deleting a Logical Cluster
Updated on 2026-06-22 GMT+08:00

Querying the Scheduled Plan for Adding or Deleting a Logical Cluster

Function

This API is used to query the scheduled plan for adding or deleting a logical cluster. There are up to 20 data records in a plan.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

plans

Array of LogicalClusterPlanVo objects

Definition

Object list of the plan for adding or deleting a logical cluster. A maximum of 20 records can be returned.

Range

N/A

Table 3 LogicalClusterPlanVo

Parameter

Type

Description

id

String

Definition

ID of the plan for adding or deleting a logical cluster.

Range

N/A

logical_cluster_name

String

Definition

Logical cluster name.

Range

N/A

node_num

Integer

Definition

Number of nodes in the logical cluster.

Range

N/A

plan_type

String

Definition

Plan type. The value can be once or periodicity.

Range

N/A

status

String

Definition

Status of the plan for adding or deleting a logical cluster.

Range

running

waiting

deleted

finished

disabled

failed

start_time

String

Definition

Start time of the plan for adding or deleting a logical cluster.

Range

N/A

end_time

String

Definition

End time of the plan for adding or deleting a logical cluster.

Range

N/A

update_time

String

Definition

Time when the plan for adding or deleting a logical cluster is updated.

Range

N/A

user

String

Definition

User bound to the plan for adding or deleting a logical cluster.

Range

N/A

actions

Array of LogicalClusterPlanActions objects

Definition

Task information.

Range

N/A

Table 4 LogicalClusterPlanActions

Parameter

Type

Description

next_fire_time

String

Definition

Time when the next plan will be triggered.

Range

N/A

failed_reason

String

Definition

Failure cause.

Range

N/A

id

String

Definition

Task ID.

Range

N/A

type

String

Definition

Type.

Range

create

delete

strategy

String

Definition

Period information. Cron expression, for example, 0 0 0? * 3.

Range

N/A

status

String

Definition

Task status.

Range

running, waiting, deleted, finished, disabled, or failed

pre_fire_time

String

Definition

Time when the previous plan was triggered.

Range

N/A

Example Requests

Query the scheduled plan for adding or deleting a logical cluster.

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

Example Responses

Status code: 200

Scheduled plan for adding or deleting logical a cluster queried.

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Scheduled plan for adding or deleting logical a cluster queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.