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

Adding a Resource Management Plan Stage

Function

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

Call Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages
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.

plan_id

Yes

String

Plan ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

workload_plan_stage

No

workload_plan_stage object

Resource management plan stage details

Table 3 workload_plan_stage

Parameter

Mandatory

Type

Description

day

No

String

Date

month

No

String

Month

stage_name

No

String

Plan

start_time

No

String

Start time

end_time

No

String

End time

queue_list

No

Array of QueueResourceItem objects

Resource queue

Table 4 QueueResourceItem

Parameter

Mandatory

Type

Description

queue_name

Yes

String

Resource pool name

queue_resources

Yes

Array of WorkloadResourceItem objects

Resource configuration queue

Table 5 WorkloadResourceItem

Parameter

Mandatory

Type

Description

resource_name

Yes

String

Resource name

resource_value

Yes

Integer

Resource attribute value

value_unit

No

String

Resource attribute unit

resource_description

No

String

Additional resource description

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Response code

workload_res_str

String

Response message

Example Request

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

{
  "workload_plan_stage" : {
    "day" : "1,2",
    "month" : "6",
    "stage_name" : "stage1",
    "start_time" : "00:00:00",
    "end_time" : "00:00:00",
    "queue_list" : [ {
      "queue_name" : "pool1",
      "queue_resources" : [ {
        "resource_name" : "cpu",
        "resource_value" : 20,
        "value_unit" : null,
        "resource_description" : null
      }, {
        "resource_name" : "cpu_limit",
        "resource_value" : 0,
        "value_unit" : null,
        "resource_description" : null
      }, {
        "resource_name" : "memory",
        "resource_value" : 0,
        "value_unit" : null,
        "resource_description" : null
      }, {
        "resource_name" : "concurrency",
        "resource_value" : 10,
        "value_unit" : null,
        "resource_description" : null
      }, {
        "resource_name" : "shortQueryConcurrencyNum",
        "resource_value" : -1,
        "value_unit" : null,
        "resource_description" : null
      } ]
    } ]
  }
}

Example Response

Status code: 200

The resource management plan stage is added successfully.

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

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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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.*;

import java.util.List;
import java.util.ArrayList;

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

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        AddWorkloadPlanStageRequest request = new AddWorkloadPlanStageRequest();
        WorkloadPlanStageReq body = new WorkloadPlanStageReq();
        List<WorkloadResourceItem> listQueueListQueueResources = new ArrayList<>();
        listQueueListQueueResources.add(
            new WorkloadResourceItem()
                .withResourceName("cpu")
                .withResourceValue(20)
        );
        listQueueListQueueResources.add(
            new WorkloadResourceItem()
                .withResourceName("cpu_limit")
                .withResourceValue(0)
        );
        listQueueListQueueResources.add(
            new WorkloadResourceItem()
                .withResourceName("memory")
                .withResourceValue(0)
        );
        listQueueListQueueResources.add(
            new WorkloadResourceItem()
                .withResourceName("concurrency")
                .withResourceValue(10)
        );
        listQueueListQueueResources.add(
            new WorkloadResourceItem()
                .withResourceName("shortQueryConcurrencyNum")
                .withResourceValue(-1)
        );
        List<QueueResourceItem> listWorkloadPlanStageQueueList = new ArrayList<>();
        listWorkloadPlanStageQueueList.add(
            new QueueResourceItem()
                .withQueueName("pool1")
                .withQueueResources(listQueueListQueueResources)
        );
        WorkloadPlanStageReqWorkloadPlanStage workloadPlanStagebody = new WorkloadPlanStageReqWorkloadPlanStage();
        workloadPlanStagebody.withDay("1,2")
            .withMonth("6")
            .withStageName("stage1")
            .withStartTime("00:00:00")
            .withEndTime("00:00:00")
            .withQueueList(listWorkloadPlanStageQueueList);
        body.withWorkloadPlanStage(workloadPlanStagebody);
        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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# 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 = AddWorkloadPlanStageRequest()
        listQueueResourcesQueueList = [
            WorkloadResourceItem(
                resource_name="cpu",
                resource_value=20
            ),
            WorkloadResourceItem(
                resource_name="cpu_limit",
                resource_value=0
            ),
            WorkloadResourceItem(
                resource_name="memory",
                resource_value=0
            ),
            WorkloadResourceItem(
                resource_name="concurrency",
                resource_value=10
            ),
            WorkloadResourceItem(
                resource_name="shortQueryConcurrencyNum",
                resource_value=-1
            )
        ]
        listQueueListWorkloadPlanStage = [
            QueueResourceItem(
                queue_name="pool1",
                queue_resources=listQueueResourcesQueueList
            )
        ]
        workloadPlanStagebody = WorkloadPlanStageReqWorkloadPlanStage(
            day="1,2",
            month="6",
            stage_name="stage1",
            start_time="00:00:00",
            end_time="00:00:00",
            queue_list=listQueueListWorkloadPlanStage
        )
        request.body = WorkloadPlanStageReq(
            workload_plan_stage=workloadPlanStagebody
        )
        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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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.AddWorkloadPlanStageRequest{}
	var listQueueResourcesQueueList = []model.WorkloadResourceItem{
        {
            ResourceName: "cpu",
            ResourceValue: int32(20),
        },
        {
            ResourceName: "cpu_limit",
            ResourceValue: int32(0),
        },
        {
            ResourceName: "memory",
            ResourceValue: int32(0),
        },
        {
            ResourceName: "concurrency",
            ResourceValue: int32(10),
        },
        {
            ResourceName: "shortQueryConcurrencyNum",
            ResourceValue: int32(-1),
        },
    }
	var listQueueListWorkloadPlanStage = []model.QueueResourceItem{
        {
            QueueName: "pool1",
            QueueResources: listQueueResourcesQueueList,
        },
    }
	dayWorkloadPlanStage:= "1,2"
	monthWorkloadPlanStage:= "6"
	stageNameWorkloadPlanStage:= "stage1"
	startTimeWorkloadPlanStage:= "00:00:00"
	endTimeWorkloadPlanStage:= "00:00:00"
	workloadPlanStagebody := &model.WorkloadPlanStageReqWorkloadPlanStage{
		Day: &dayWorkloadPlanStage,
		Month: &monthWorkloadPlanStage,
		StageName: &stageNameWorkloadPlanStage,
		StartTime: &startTimeWorkloadPlanStage,
		EndTime: &endTimeWorkloadPlanStage,
		QueueList: &listQueueListWorkloadPlanStage,
	}
	request.Body = &model.WorkloadPlanStageReq{
		WorkloadPlanStage: workloadPlanStagebody,
	}
	response, err := client.AddWorkloadPlanStage(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 stage is 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.