Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Resource Management/ Querying the Resource Management Plan List
Updated on 2024-04-18 GMT+08:00

Querying the Resource Management Plan List

Function

This API is used to query all resource management plans in a cluster.

Call Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

cluster_id

Yes

String

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

Table 2 Query parameters

Parameter

Mandatory

Type

Description

logical_cluster_name

No

String

Logical cluster name In non-logical cluster mode, leave this parameter blank. In logical cluster mode, it is the logical cluster name.

limit

No

Integer

Number of records to be queried

offset

No

Integer

Offset

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Status code

workload_res_str

String

Result description

plan_list

Array of WorkloadPlanInfo objects

Resource pool name

count

Integer

Total number of records

Table 4 WorkloadPlanInfo

Parameter

Type

Description

status

Integer

Plan Status

project_id

String

Project ID.

cluster_id

String

Cluster ID

plan_id

String

Plan ID

plan_name

String

Plan name

current_stage

String

Current plan stage

logical_cluster_name

String

Name of the logical cluster

stage_list

Array of PlanStage objects

List of plan stages

Table 5 PlanStage

Parameter

Type

Description

month

String

Month of the plan

day

String

Date of the plan

plan_id

String

Plan ID

stage_id

String

Plan stage ID

stage_name

String

Plan stage name

start_time

String

Plan start time

end_time

String

Plan end time

next_valid_time

String

Next validation time

queue_list

Array of QueueResourceItem objects

Resource queue list

Table 6 QueueResourceItem

Parameter

Type

Description

queue_name

String

Resource pool name

queue_resources

Array of WorkloadResourceItem objects

Resource configuration queue

Table 7 WorkloadResourceItem

Parameter

Type

Description

resource_name

String

Resource name

resource_value

Integer

Resource attribute value

value_unit

String

Resource attribute unit

resource_description

String

Additional resource description

Example Request

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans

Example Response

Status code: 200

The resource management plan list is queried successfully.

{
  "plan_list" : [ {
    "status" : 0,
    "cluster_id" : "862201cd-f822-4dbc-ae3b-c7b9d080eea6",
    "project_id" : "0536cdee2200d5912f7cc00b877980f1",
    "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
    "plan_name" : "plan1",
    "current_stage" : null,
    "logical_cluster_name" : null,
    "stage_list" : null
  } ],
  "count" : 1
}

SDK Sample Code

The 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 ListWorkloadPlansSolution {

    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");

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWorkloadPlansRequest request = new ListWorkloadPlansRequest();
        request.withLogicalClusterName("<logical_cluster_name>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListWorkloadPlansResponse response = client.listWorkloadPlans(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

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListWorkloadPlansRequest()
        request.logical_cluster_name = "<logical_cluster_name>"
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_workload_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
39
40
41
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

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

    request := &model.ListWorkloadPlansRequest{}
	logicalClusterNameRequest:= "<logical_cluster_name>"
	request.LogicalClusterName = &logicalClusterNameRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListWorkloadPlans(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The resource management plan list is queried successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.