Help Center/ GaussDB(DWS)/ API Reference/ API Description/ Resource Management/ Updating Configuration Information of a Resource Pool
Updated on 2024-04-18 GMT+08:00

Updating Configuration Information of a Resource Pool

Function

This API is used to update the resource configuration information of a resource pool.

Call Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/resources
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.

queue_name

Yes

String

Resource pool name

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

workload_queue

Yes

WorkloadQueueInfo object

Resource pool

Table 3 WorkloadQueueInfo

Parameter

Mandatory

Type

Description

workload_queue_name

Yes

String

Resource pool name

logical_cluster_name

No

String

Name of the logical cluster

resource_item_list

Yes

Array of WorkloadResourceItem objects

Resource configuration queue

Table 4 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 5 Response body parameters

Parameter

Type

Description

workload_res_code

Integer

Response code

workload_res_str

String

Response message

Example Request

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/{queue_name}/resources

{
  "workload_queue" : {
    "workload_queue_name" : "test11",
    "resource_item_list" : [ {
      "resource_name" : "memory",
      "resource_value" : "0"
    }, {
      "resource_name" : "tablespace",
      "resource_value" : "-1"
    }, {
      "resource_name" : "activestatements",
      "resource_value" : "10"
    }, {
      "resource_name" : "cpu_limit",
      "resource_value" : 0
    }, {
      "resource_name" : "cpu_share",
      "resource_value" : 12
    } ],
    "logical_cluster_name" : ""
  }
}

Example Response

Status code: 200

Resource pool resource configuration information updated 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
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 UpdateQueueResourcesSolution {

    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();
        UpdateQueueResourcesRequest request = new UpdateQueueResourcesRequest();
        WorkloadQueueRequest body = new WorkloadQueueRequest();
        List<WorkloadResourceItem> listWorkloadQueueResourceItemList = new ArrayList<>();
        listWorkloadQueueResourceItemList.add(
            new WorkloadResourceItem()
                .withResourceName("memory")
                .withResourceValue(0)
        );
        listWorkloadQueueResourceItemList.add(
            new WorkloadResourceItem()
                .withResourceName("tablespace")
                .withResourceValue(-1)
        );
        listWorkloadQueueResourceItemList.add(
            new WorkloadResourceItem()
                .withResourceName("activestatements")
                .withResourceValue(10)
        );
        listWorkloadQueueResourceItemList.add(
            new WorkloadResourceItem()
                .withResourceName("cpu_limit")
                .withResourceValue(0)
        );
        listWorkloadQueueResourceItemList.add(
            new WorkloadResourceItem()
                .withResourceName("cpu_share")
                .withResourceValue(12)
        );
        WorkloadQueueInfo workloadQueuebody = new WorkloadQueueInfo();
        workloadQueuebody.withWorkloadQueueName("test11")
            .withLogicalClusterName("")
            .withResourceItemList(listWorkloadQueueResourceItemList);
        body.withWorkloadQueue(workloadQueuebody);
        request.withBody(body);
        try {
            UpdateQueueResourcesResponse response = client.updateQueueResources(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
# 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 = UpdateQueueResourcesRequest()
        listResourceItemListWorkloadQueue = [
            WorkloadResourceItem(
                resource_name="memory",
                resource_value=0
            ),
            WorkloadResourceItem(
                resource_name="tablespace",
                resource_value=-1
            ),
            WorkloadResourceItem(
                resource_name="activestatements",
                resource_value=10
            ),
            WorkloadResourceItem(
                resource_name="cpu_limit",
                resource_value=0
            ),
            WorkloadResourceItem(
                resource_name="cpu_share",
                resource_value=12
            )
        ]
        workloadQueuebody = WorkloadQueueInfo(
            workload_queue_name="test11",
            logical_cluster_name="",
            resource_item_list=listResourceItemListWorkloadQueue
        )
        request.body = WorkloadQueueRequest(
            workload_queue=workloadQueuebody
        )
        response = client.update_queue_resources(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
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.UpdateQueueResourcesRequest{}
	var listResourceItemListWorkloadQueue = []model.WorkloadResourceItem{
        {
            ResourceName: "memory",
            ResourceValue: int32(0),
        },
        {
            ResourceName: "tablespace",
            ResourceValue: int32(-1),
        },
        {
            ResourceName: "activestatements",
            ResourceValue: int32(10),
        },
        {
            ResourceName: "cpu_limit",
            ResourceValue: int32(0),
        },
        {
            ResourceName: "cpu_share",
            ResourceValue: int32(12),
        },
    }
	logicalClusterNameWorkloadQueue:= ""
	workloadQueuebody := &model.WorkloadQueueInfo{
		WorkloadQueueName: "test11",
		LogicalClusterName: &logicalClusterNameWorkloadQueue,
		ResourceItemList: listResourceItemListWorkloadQueue,
	}
	request.Body = &model.WorkloadQueueRequest{
		WorkloadQueue: workloadQueuebody,
	}
	response, err := client.UpdateQueueResources(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

Resource pool resource configuration information updated 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.