Querying Details About a Resource Management Plan

Function

This API is used to query details about a resource management plan.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}

**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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
workload_res_code	Integer	Definition Result status code. Range N/A
workload_res_str	String	Definition Result description. Range N/A
workload_plan	WorkloadPlanInfo object	Definition Queue details. Range N/A

**Table 3** WorkloadPlanInfo
Parameter	Type	Description
status	Integer	Definition: Plan status. Range: 0: The plan is not executed. 1: The plan is being executed.
project_id	String	Definition Project ID. Range N/A
cluster_id	String	Definition Cluster ID. Range It is a 36-digit UUID.
plan_id	String	Definition Plan ID. Range N/A
plan_name	String	Definition Plan name Range N/A
current_stage	String	Definition Current plan stage. Range N/A
logical_cluster_name	String	Definition Logical cluster name. Range N/A
stage_list	Array of PlanStage objects	Definition List of plan stages Range N/A

**Table 4** PlanStage
Parameter	Type	Description
month	String	Definition Month. Range N/A
day	String	Definition Date. Range N/A
plan_id	String	Definition Plan ID. Range N/A
stage_id	String	Definition Plan stage ID. Range N/A
stage_name	String	Definition Plan stage name. Range N/A
start_time	String	Definition Planned start time. Range Only the time part, for example, 00:00:00
end_time	String	Definition Planned end time. Range Only the time part, for example, 00:00:00
next_valid_time	String	Definition Next validation time. Range N/A
queue_list	Array of QueueResourceItem objects	Definition Resource queue list. Range N/A

**Table 5** QueueResourceItem
Parameter	Type	Description
queue_name	String	Definition Resource pool name. Range N/A
queue_resources	Array of WorkloadResourceItem objects	Definition Resource configuration queue. Range N/A

**Table 6** WorkloadResourceItem
Parameter	Type	Description
resource_name	String	Definition Resource name. 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 tablespace: tablespace activestatements: number of active statements cpu_share: CPU share
resource_value	Integer	Definition Resource attribute value. Range The value range varies depending on 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 that there is no limit. If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that there is no limit. If resource_name is concurrency, the value is an integer from –1 to 2147483647. The value –1 or 0 indicates that there is no limit. If resource_name is shortQueryConcurrencyNum, the value is an integer from –1 to 2147483647. The value –1 or 0 indicates that there is no limit. If resource_name is weight, the value is an integer from –1 to 2147483647. The default value is –1, indicating that there is no limit.
value_unit	String	Definition Resource attribute unit. Range N/A
resource_description	String	Definition Additional resource description. Range N/A

Example Requests

Query details about a resource management plan.

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

Example Responses

Status code: 200

{
  "workload_res_code" : 0,
  "workload_res_str" : "",
  "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" : "23:59:59",
      "next_valid_time" : "2024-04-04 00:00:00",
      "queue_list" : [ {
        "queue_name" : "resource1",
        "queue_resources" : [ {
          "resource_name" : "cpu",
          "resource_value" : 1,
          "value_unit" : "%",
          "resource_description" : "Workload Queue Memory Percent"
        } ]
      } ]
    } ]
  }
}

Status Codes

Status Code	Description
200	Details about a resource management plan queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.

Parent Topic: Resource Management

Previous topic: Stopping a Resource Management Plan

Next topic: Deleting a Resource Management Plan