Querying Stage Details About a Resource Management Plan

Function

This API is used to query details stage details of resource management plan.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}/stages/{stage_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
stage_id	Yes	String	Definition Plan stage 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_stage	PlanStage object	Definition Plan stage details. Range N/A

**Table 3** 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 4** 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 5** 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

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a/stages/00bc8bc5-c885-42e5-b205-80547d3f94c4

Example Responses

Status code: 200

Stage details about the resource management plan queried.

{
  "workload_plan_stage" : {
    "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" : null,
        "resource_description" : null
      } ]
    } ]
  }
}

Status Codes

Status Code	Description
200	Stage details about the 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.