文档首页/ 数据仓库服务 DWS/ API参考/ API说明/ 资源管理/ 查询资源池 - ListWorkloadQueue
更新时间:2026-09-18 GMT+08:00
分享

查询资源池 - ListWorkloadQueue

功能介绍

查询资源池。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dws:cluster:listQueueForWLM

    List

    cluster *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dws:workLoadManager:get

    -

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/queues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cluster_id

是

String

参数解释:

集群ID。获取方法请参见获取集群ID。

约束限制:

必须是有效的dws集群ID。

取值范围:

36位UUID。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

logical_cluster_name

否

String

参数解释:

逻辑集群名称。逻辑集群模式下该字段必填。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

queue_list

Array of PlanStageQueue objects

资源池队列详情

workload_queue_name_list

Array of strings

资源池名称队列

workload_res_code

Integer

资源池队列查询返回码

表4 PlanStageQueue

参数

参数类型

描述

queue_name

String

参数解释:

资源池名称。

取值范围:

不涉及。

queue_resources

Array of WorkloadResourceItem objects

参数解释:

资源配置队列。

取值范围:

不涉及。

表5 WorkloadResourceItem

参数

参数类型

描述

resource_name

String

参数解释:

资源名称。

取值范围:

cpu:占用CPU时间片的百分比。

cpu_limit:使用CPU物理核数的百分比。

memory:指每个数据节点上可用内存资源的百分比。

concurrency:并发数。

shortQueryConcurrencyNum:简单语句并发数。

weight:网络调度时权重值。

tablespace:表空间。

activestatements:活跃语句数。

cpu_share:CPU共享。

resource_value

Integer

参数解释:

资源属性值。

取值范围:

根据配置不同,取值范围不同

cpu:取值范围为1~99的整数。

cpu_limit:取值范围为0~100的整数,0表示不限制。

memory:取值范围为0~100的整数,0表示不管控。

concurrency:取值范围为-1~2147483647(-1/0表示不限制)的整数。

shortQueryConcurrencyNum:取值范围为-1~2147483647(-1/0表示不限制)的整数。

weight:取值范围为-1~2147483647(-1表示不限制)的整数,默认配置为-1。

value_unit

String

参数解释:

资源属性单位。

取值范围:

不涉及。

resource_description

String

参数解释:

资源附加描述。

取值范围:

不涉及。

请求示例

查询资源池。

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

响应示例

状态码:200

{
  "workload_res_code" : 0,
  "workload_queue_name_list" : [ "test" ],
  "queue_list" : [ {
    "queue_name" : "test",
    "queue_resources" : [ {
      "resource_name" : "cpu",
      "resource_value" : 5
    }, {
      "resource_name" : "cpu_limit",
      "resource_value" : 0
    }, {
      "resource_name" : "memory",
      "resource_value" : 0
    }, {
      "resource_name" : "concurrency",
      "resource_value" : 10
    }, {
      "resource_name" : "shortQueryConcurrencyNum",
      "resource_value" : -1
    } ]
  } ]
}

SDK代码示例

SDK代码示例如下。

 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 ListWorkloadQueueSolution {

    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();
        ListWorkloadQueueRequest request = new ListWorkloadQueueRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListWorkloadQueueResponse response = client.listWorkloadQueue(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 = ListWorkloadQueueRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_workload_queue(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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dws.DwsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dws.NewDwsClient(hcClient)

    request := &model.ListWorkloadQueueRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListWorkloadQueue(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询资源池成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档