Help Center/ Data Warehouse Service/ API Reference/ API Description/ Resource Management/ Adding a Stage for a Resource Management Plan
Updated on 2026-06-22 GMT+08:00

Adding a Stage for a Resource Management Plan

Function

This API is used to add a resource management plan stage.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

cluster_id

Yes

String

Definition

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

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

plan_id

Yes

String

Definition

Plan ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

workload_plan_stage

No

workload_plan_stage object

Definition

Details of the resource management plan stage

Range

N/A

Table 3 workload_plan_stage

Parameter

Mandatory

Type

Description

day

No

String

Definition

Date.

Range

N/A

month

No

String

Definition

Month

Range

N/A

stage_name

No

String

Definition

Plan stage

Range

N/A

start_time

No

String

Definition

Start time

Range

N/A

end_time

No

String

Definition

End time.

Range

N/A

queue_list

No

Array of QueueResourceItem objects

Definition

Resource queue

Range

N/A

Table 4 QueueResourceItem

Parameter

Mandatory

Type

Description

queue_name

Yes

String

Definition

Resource pool name.

Range

N/A

queue_resources

Yes

Array of WorkloadResourceItem objects

Definition

Resource configuration queue.

Range

N/A

Table 5 WorkloadResourceItem

Parameter

Mandatory

Type

Description

resource_name

Yes

String

Definition

Resource name.

Constraints

N/A

Range

cpu: percentage of CPU time

cpu_limit: percentage of CPU cores

memory: percentage of available memory resources on each data node

concurrency: number of concurrent queries

shortQueryConcurrencyNum: number of concurrent simple statements

weight: weight for network scheduling

Default Value

N/A

resource_value

Yes

Integer

Definition

Resource attribute value.

Constraints

N/A

Range

The value range varies according to the value of resource_name.

If resource_name is cpu, the value is an integer from 1 to 99.

If resource_name is cpu_limit, the value is an integer from 0 to 100. The value 0 indicates no limit.

If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit.

If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit.

If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit.

If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1.

Default Value

N/A

value_unit

No

String

Definition

Resource attribute unit.

Constraints

N/A

Range

N/A

Default Value

N/A

resource_description

No

String

Definition

Additional resource description.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Definition

Response code

Range

N/A

workload_res_str

String

Definition

Response information.

Range

N/A

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0591129f-4970-44e7-b213-f7bce797de87/stages

Example Responses

Status code: 200

Stage added successfully.

{
  "workload_res_code" : 0,
  "workload_res_str" : ""
}

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
49
50
51
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 AddWorkloadPlanStageSolution {

    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();
        AddWorkloadPlanStageRequest request = new AddWorkloadPlanStageRequest();
        request.withClusterId("{cluster_id}");
        request.withPlanId("{plan_id}");
        WorkloadPlanStageReq body = new WorkloadPlanStageReq();
        request.withBody(body);
        try {
            AddWorkloadPlanStageResponse response = client.addWorkloadPlanStage(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
33
34
35
# 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 = AddWorkloadPlanStageRequest()
        request.cluster_id = "{cluster_id}"
        request.plan_id = "{plan_id}"
        request.body = WorkloadPlanStageReq(
        )
        response = client.add_workload_plan_stage(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")
    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.AddWorkloadPlanStageRequest{}
	request.ClusterId = "{cluster_id}"
	request.PlanId = "{plan_id}"
	request.Body = &model.WorkloadPlanStageReq{
	}
	response, err := client.AddWorkloadPlanStage(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

Stage added 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.