yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
6283700aec391405f5cee993a3b429d48560972a
doc-exports/docs/dws/api-ref/ShowWorkloadPlan.html
luhuayi 007dffd756 DWS API 8.5.1_20260108 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2026-03-06 08:01:27 +00:00

512 lines
24 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002500174002"></a><a name="EN-US_TOPIC_0000002500174002"></a>
<h1 class="topictitle1">Querying Details About a Resource Management Plan</h1>
<div id="body8662426"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query details about a resource management plan.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_atuogenerate_1"><h4 class="sectiontitle">Calling Method</h4><p>For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_atuogenerate_2"><h4 class="sectiontitle">URI</h4><p>GET /v2/{project_id}/clusters/{cluster_id}/workload/plans/{plan_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p><strong>Definition</strong></p>
<p>Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p>N/A</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p><strong>Definition</strong></p>
<p>Cluster ID. For details about how to obtain the value, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
<p><strong>Constraints</strong></p>
<p>The value must be a valid DWS cluster ID.</p>
<p><strong>Range</strong></p>
<p>It is a 36-digit UUID.</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p><strong>Definition</strong></p>
<p>Plan ID.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p>N/A</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4><p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadPlanBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>workload_res_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Result status code.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>workload_res_str</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Result description.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p>workload_plan</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p><a href="#EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadPlanInfo">WorkloadPlanInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Queue details.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadPlanInfo"></a><a name="en-us_topic_0000002375015057_response_WorkloadPlanInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadPlanInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>WorkloadPlanInfo</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.4.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan status</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Project ID.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Cluster ID.</p>
<p><strong>Range</strong></p>
<p>It is a 36-digit UUID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan ID.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>plan_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan name</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>current_stage</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Current plan stage.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>logical_cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Logical cluster name.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.1 "><p>stage_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.4.2.4.1.2 "><p>Array of <a href="#EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_PlanStage">PlanStage</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p><strong>Definition</strong></p>
<p>List of plan stages</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_PlanStage"></a><a name="en-us_topic_0000002375015057_response_PlanStage"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_PlanStage" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PlanStage</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.5.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>month</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Month.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>day</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Date.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan ID.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>stage_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan stage ID.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>stage_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Plan stage name.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Start time of the plan.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>end_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>End time.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>next_valid_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Next validation time.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.1 "><p>queue_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.5.2.4.1.2 "><p>Array of <a href="#EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_QueueResourceItem">QueueResourceItem</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource queue list.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_QueueResourceItem"></a><a name="en-us_topic_0000002375015057_response_QueueResourceItem"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_QueueResourceItem" frame="border" border="1" rules="all"><caption><b>Table 5 </b>QueueResourceItem</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.6.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource pool name.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.1 "><p>queue_resources</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.6.2.4.1.2 "><p>Array of <a href="#EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadResourceItem">WorkloadResourceItem</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource configuration queue.</p>
<p><strong>Range</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadResourceItem"></a><a name="en-us_topic_0000002375015057_response_WorkloadResourceItem"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_response_WorkloadResourceItem" frame="border" border="1" rules="all"><caption><b>Table 6 </b>WorkloadResourceItem</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.7.2.4.1.2"><p>Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.2.4.1.3"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p>resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource name.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p><strong>cpu</strong>: percentage of CPU time</p>
<p><strong>cpu_limit</strong>: percentage of CPU cores</p>
<p><strong>memory</strong>: percentage of available memory resources on each data node</p>
<p><strong>concurrency</strong>: number of concurrent queries</p>
<p><strong>shortQueryConcurrencyNum</strong>: number of concurrent simple statements</p>
<p><strong>weight</strong>: weight for network scheduling</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p>resource_value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource attribute value.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p>The value range varies according to the value of <strong>resource_name</strong>.</p>
<p>If <strong>resource_name</strong> is <strong>cpu</strong>, the value is an integer from <strong>1</strong> to <strong>99</strong>.</p>
<p>If <strong>resource_name</strong> is <strong>cpu_limit</strong>, the value is an integer from <strong>0</strong> to <strong>100</strong>. The value <strong>0</strong> indicates no limit.</p>
<p>If <strong>resource_name</strong> is <strong>memory</strong>, the value is an integer from <strong>0</strong> to <strong>100</strong>. The value <strong>0</strong> indicates that no limit.</p>
<p>If <strong>resource_name</strong> is <strong>concurrency</strong>, the value is an integer from <strong>1</strong> to <strong>2147483647</strong>. The value <strong>-1</strong> or <strong>0</strong> indicates no limit.</p>
<p>If <strong>resource_name</strong> is <strong>shortQueryConcurrencyNum</strong>, the value is an integer from <strong>-1</strong> to <strong>2147483647</strong>. The value <strong>-1</strong> or <strong>0</strong> indicates no limit.</p>
<p>If <strong>resource_name</strong> is <strong>weight</strong>, the value is an integer from <strong>1</strong> to <strong>2147483647</strong>. The default value is <strong>-1</strong>.</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p>value_unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Resource attribute unit.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p>N/A</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.1 "><p>resource_description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.7.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.2.4.1.3 "><p><strong>Definition</strong></p>
<p>Additional resource description.</p>
<p><strong>Constraints</strong></p>
<p>N/A</p>
<p><strong>Range</strong></p>
<p>N/A</p>
<p><strong>Default Value</strong></p>
<p>N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Query details about a resource management plan.</p>
<pre class="screen">GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/plans/0c2145ad-4d76-4abe-bd1b-cdbe9128478a</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Details about a resource management plan queried.</p>
<pre class="screen">{
"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"
} ]
} ]
} ]
}
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002500174002__en-us_topic_0000002375015057_status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p>Description</p>
</th>
</tr>
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Details about a resource management plan queried.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Request error.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Authentication failed.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>You do not have required permissions.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>No resources found.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Internal server error.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p>503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p>Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0538.html">Resource Management</a></div>
</div>
</div>
View Git Blame Copy Permalink