Function

This API is used to query all resource management plans in a cluster.

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
logical_cluster_name	No	String	Definition Logical cluster name. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value 10
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** 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
plan_list	Array of WorkloadPlanInfo objects	Definition Resource pool name. Range N/A
count	Integer	Definition Total number. Range N/A

**Table 4** WorkloadPlanInfo
Parameter	Type	Description
status	Integer	Definition Plan status Range N/A
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 5** 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 Start time of the plan. Range N/A
end_time	String	Definition End time. Range N/A
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 6** 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 7** WorkloadResourceItem
Parameter	Type	Description
resource_name	String	Definition Resource name. Constraints N/A 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 Default Value N/A
resource_value	Integer	Definition Resource attribute value. Constraints N/A Range The value range varies according to 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 no limit. If resource_name is memory, the value is an integer from 0 to 100. The value 0 indicates that no limit. If resource_name is concurrency, the value is an integer from 1 to 2147483647. The value -1 or 0 indicates no limit. If resource_name is shortQueryConcurrencyNum, the value is an integer from -1 to 2147483647. The value -1 or 0 indicates no limit. If resource_name is weight, the value is an integer from 1 to 2147483647. The default value is -1. Default Value N/A
value_unit	String	Definition Resource attribute unit. Constraints N/A Range N/A Default Value N/A
resource_description	String	Definition Additional resource description. Constraints N/A Range N/A Default Value N/A

Example Requests

Query all resource management plans in a cluster.

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

Example Responses