文档首页/ 数据仓库服务 GaussDB(DWS)/ API参考/ API说明/ 资源管理/ 查询某个资源管理计划详细信息
更新时间:2024-03-26 GMT+08:00
分享

查询某个资源管理计划详细信息

功能介绍

该接口用于查询某个资源管理计划详细信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}
表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

cluster_id

String

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

plan_id

String

计划ID。获取方法,请参见查询资源管理计划列表

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

workload_res_code

Integer

结果状态码。

workload_res_str

String

结果描述。

workload_plan

WorkloadPlanInfo object

队列详情。

表3 WorkloadPlanInfo

参数

参数类型

描述

status

Integer

计划状态。

有效值包括:

  • 1:计划运行中。
  • 0:计划未启动。

project_id

String

项目ID。

cluster_id

String

集群ID。

plan_id

String

计划ID。

plan_name

String

计划名称。

current_stage

String

当前计划阶段。

logical_cluster_name

String

逻辑集群名称。

stage_list

Array of PlanStage objects

计划阶段列表。

表4 PlanStage

参数

参数类型

描述

month

String

计划月份。

day

String

计划日期。

plan_id

String

计划ID。

stage_id

String

计划阶段ID。

stage_name

String

计划阶段名称。

start_time

String

计划开始时间。

end_time

String

计划结束时间。

next_valid_time

String

下次校验时间。

queue_list

Array of QueueResourceItem objects

资源队列列表。

表5 QueueResourceItem

参数

参数类型

描述

queue_name

String

资源池名称。

queue_resources

Array of WorkloadResourceItem objects

资源配置队列。

表6 WorkloadResourceItem

参数

参数类型

描述

resource_name

String

资源名称。

resource_value

Integer

资源属性值。

value_unit

String

资源属性单位。

resource_description

String

资源附加描述

请求示例

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a

响应示例

状态码: 200

查询某个资源管理计划详细信息成功。

{
  "workload_plan" : {
    "status" : 0,
    "cluster_id" : "862201cd-f822-4dbc-ae3b-c7b9d080eea6",
    "project_id" : "0536cdee2200d5912f7cc00b877980f1",
    "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
    "plan_name" : "plan1",
    "current_stage" : "",
    "logical_cluster_name" : "",
    "stage_list" : [ {
      "month" : 4,
      "day" : 4,
      "plan_id" : "dde42d0c-38f7-4592-841d-5a16c5512408",
      "stage_id" : "00bc8bc5-c885-42e5-b205-80547d3f94c4",
      "stage_name" : "stage2",
      "start_time" : "00:00:00",
      "end_time" : "00:00:00",
      "next_valid_time" : "2024-04-04 00:00:00",
      "queue_list" : [ {
        "queue_name" : "resouce1",
        "queue_resources" : [ {
          "resource_name" : "cpu",
          "resource_value" : 1,
          "value_unit" : "%",
          "resource_description" : "Workload Queue Memory Percent"
        } ]
      } ]
    } ]
  }
}

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

    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("cn-north-4"))
                .build();
        ShowWorkloadPlanRequest request = new ShowWorkloadPlanRequest();
        try {
            ShowWorkloadPlanResponse response = client.showWorkloadPlan(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
# 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("cn-north-4")) \
        .build()

    try:
        request = ShowWorkloadPlanRequest()
        response = client.show_workload_plan(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
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("cn-north-4")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

查询某个资源管理计划详细信息成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档