yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
e174bcb810edc89088d161d67c1b2fa3ca93642d
doc-exports/docs/rfs/api-ref/GetExecutionPlanMetadata.html
vladimirhasko e174bcb810 testing old commit
2025-07-24 16:47:34 +00:00

677 lines
62 KiB
HTML
Raw Blame History

<a name="GetExecutionPlanMetadata"></a><a name="GetExecutionPlanMetadata"></a>
<h1 class="topictitle1">Obtaining Execution Plan Metadata</h1>
<div id="body8662426"><div class="section" id="GetExecutionPlanMetadata__section08061915174214"><h4 class="sectiontitle">Function</h4><p id="GetExecutionPlanMetadata__p18807315104216">GetExecutionPlanMetadata</p>
<p id="GetExecutionPlanMetadata__p15808615104218">This API obtains the metadata of a specified execution plan, including the ID and name of the stack and the ID, name, description, creation time, execution time, and status of the execution plan.</p>
<p id="GetExecutionPlanMetadata__p1780841514215">You can obtain details by referring to GetExecutionPlanMetadataResponseBody.</p>
<p id="GetExecutionPlanMetadata__p17808515164212">To obtain the details of an execution plan, call GetExecutionPlan.</p>
</div>
<div class="section" id="GetExecutionPlanMetadata__section780941518429"><h4 class="sectiontitle">URI</h4><p id="GetExecutionPlanMetadata__p8810191510427">GET /v1/{project_id}/stacks/{stack_name}/execution-plans/{execution_plan_name}/metadata</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table5811101511424" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row38117155420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="GetExecutionPlanMetadata__p118126155423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="GetExecutionPlanMetadata__p4812515194219">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="GetExecutionPlanMetadata__p16812615134211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="GetExecutionPlanMetadata__p1481281517422">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row981151519425"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetExecutionPlanMetadata__p68131315134216">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetExecutionPlanMetadata__p1281319158427">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetExecutionPlanMetadata__p168131815204214">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetExecutionPlanMetadata__p1281341518423">A project ID is obtained by calling an API or from the console.</p>
<p id="GetExecutionPlanMetadata__p1814101504211">Minimum: <strong id="GetExecutionPlanMetadata__b981451584210">3</strong></p>
<p id="GetExecutionPlanMetadata__p4814315164215">Maximum: <strong id="GetExecutionPlanMetadata__b881431517426">64</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row158111715174210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetExecutionPlanMetadata__p14814191519425">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetExecutionPlanMetadata__p10814131544211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetExecutionPlanMetadata__p1781521514210">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetExecutionPlanMetadata__p14815181584213">A stack name is unique within its domain (domain_id), region, and project (project_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
<p id="GetExecutionPlanMetadata__p581561534218">Minimum: <strong id="GetExecutionPlanMetadata__b281517158429">1</strong></p>
<p id="GetExecutionPlanMetadata__p168157152424">Maximum: <strong id="GetExecutionPlanMetadata__b12815111514429">128</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row481191520421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetExecutionPlanMetadata__p198161015174220">execution_plan_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetExecutionPlanMetadata__p128161615104218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetExecutionPlanMetadata__p19817111512424">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetExecutionPlanMetadata__p1881712154425">An execution plan name is unique within its domain (domain_id), region, project (project_id), and stack (stack_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
<p id="GetExecutionPlanMetadata__p17817415144220">Minimum: <strong id="GetExecutionPlanMetadata__b20817101524218">1</strong></p>
<p id="GetExecutionPlanMetadata__p208185159429">Maximum: <strong id="GetExecutionPlanMetadata__b1881871513423">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table158191615124211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row7818131514215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="GetExecutionPlanMetadata__p381917154421">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="GetExecutionPlanMetadata__p17819715114213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="GetExecutionPlanMetadata__p68198157424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="GetExecutionPlanMetadata__p12820181544217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row14818181516425"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="GetExecutionPlanMetadata__p68208159423">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="GetExecutionPlanMetadata__p1582061554211">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="GetExecutionPlanMetadata__p158202154425">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="GetExecutionPlanMetadata__p10821171544212">Unique stack ID.</p>
<p id="GetExecutionPlanMetadata__p7821141515420">It is a UUID generated by RFS when a stack is created.</p>
<p id="GetExecutionPlanMetadata__p13821215164216">Stack names are unique at one specific time, so you can create a stack named HelloWorld and another stack with the same name after deleting the first one.</p>
<p id="GetExecutionPlanMetadata__p188221715174215">For parallel development, team members may want to ensure that they are operating the stack they created, not one with the same name created by other members after deleting the previous one.</p>
<p id="GetExecutionPlanMetadata__p17822101516422">To avoid this mismatch, check the ID, since RFS ensures each stack has a unique ID that does not change with updates. If the stack_id value differs from the current stack ID, 400 is returned.</p>
<p id="GetExecutionPlanMetadata__p2082271514215">Minimum: <strong id="GetExecutionPlanMetadata__b582391511423">36</strong></p>
<p id="GetExecutionPlanMetadata__p68247158423">Maximum: <strong id="GetExecutionPlanMetadata__b1982418151427">36</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1381881513422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="GetExecutionPlanMetadata__p17824141564217">execution_plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="GetExecutionPlanMetadata__p9825151514427">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="GetExecutionPlanMetadata__p2082519153428">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="GetExecutionPlanMetadata__p12826131512421">Unique execution plan ID.</p>
<p id="GetExecutionPlanMetadata__p12826141584218">A UUID is generated by RFS when an execution plan is created.</p>
<p id="GetExecutionPlanMetadata__p178261155421">Execution plan names are unique at one specific time, so you can create an execution plan named HelloWorld and another execution plan with the same name after deleting the first one.</p>
<p id="GetExecutionPlanMetadata__p16826915144217">For parallel development, team members may want to ensure that they are operating the execution plan they created, not one with the same name created by other members after deleting the previous one.</p>
<p id="GetExecutionPlanMetadata__p14827315164216">To avoid this mismatch, check the ID, since RFS ensures each execution plan has a unique ID that does not change with updates. If the execution_plan_id value differs from the current execution plan ID, 400 is returned.</p>
<p id="GetExecutionPlanMetadata__p9827615204210">Minimum: <strong id="GetExecutionPlanMetadata__b16827615124216">36</strong></p>
<p id="GetExecutionPlanMetadata__p1827111554211">Maximum: <strong id="GetExecutionPlanMetadata__b128271215194212">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetExecutionPlanMetadata__section1382815151428"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row782815154429"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="GetExecutionPlanMetadata__p20829315124219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="GetExecutionPlanMetadata__p2830515144212">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="GetExecutionPlanMetadata__p13830121564214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="GetExecutionPlanMetadata__p11830915174217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row5828171519427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="GetExecutionPlanMetadata__p168314158428">Client-Request-Id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="GetExecutionPlanMetadata__p483191515424">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="GetExecutionPlanMetadata__p6831161534212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="GetExecutionPlanMetadata__p15832111518428">A unique request ID is specified by a user to locate a request. UUID is recommended.</p>
<p id="GetExecutionPlanMetadata__p2832515124211">Minimum: <strong id="GetExecutionPlanMetadata__b683210156421">36</strong></p>
<p id="GetExecutionPlanMetadata__p28321515164211">Maximum: <strong id="GetExecutionPlanMetadata__b4832141514425">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetExecutionPlanMetadata__section1283315152428"><h4 class="sectiontitle">Response Parameters</h4><p id="GetExecutionPlanMetadata__p1983361517421"><strong id="GetExecutionPlanMetadata__b4833915104210">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_GetExecutionPlanMetadataResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row8833415184217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="GetExecutionPlanMetadata__p3835171574219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="GetExecutionPlanMetadata__p168351815124215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="GetExecutionPlanMetadata__p148351915184218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row168342015114215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p17835315184213">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1083581504210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p3836141513428">Unique stack ID.</p>
<p id="GetExecutionPlanMetadata__p3836115164216">It is a UUID generated by RFS when a stack is created.</p>
<p id="GetExecutionPlanMetadata__p20836715124218">Stack names are unique at one specific time, so you can create a stack named HelloWorld and another stack with the same name after deleting the first one.</p>
<p id="GetExecutionPlanMetadata__p5836171584210">For parallel development, team members may want to ensure that they are operating the stack they created, not one with the same name created by other members after deleting the previous one.</p>
<p id="GetExecutionPlanMetadata__p15836201534210">To avoid this mismatch, check the ID, since RFS ensures each stack has a unique ID that does not change with updates. If the stack_id value differs from the current stack ID, 400 is returned.</p>
<p id="GetExecutionPlanMetadata__p583751512422">Minimum: <strong id="GetExecutionPlanMetadata__b48372015194215">36</strong></p>
<p id="GetExecutionPlanMetadata__p10837151516424">Maximum: <strong id="GetExecutionPlanMetadata__b8837121534218">36</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row118349157420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p118371315134218">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p983781544210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p13837815184212">A stack name is unique within its domain (domain_id), region, and project (project_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
<p id="GetExecutionPlanMetadata__p14838131519425">Minimum: <strong id="GetExecutionPlanMetadata__b28381015154215">1</strong></p>
<p id="GetExecutionPlanMetadata__p784081513429">Maximum: <strong id="GetExecutionPlanMetadata__b6840101524212">128</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1183451534220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p2841171517421">execution_plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1484121564212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p484231512421">Unique execution plan ID.</p>
<p id="GetExecutionPlanMetadata__p8842191519426">A UUID is generated by RFS when an execution plan is created.</p>
<p id="GetExecutionPlanMetadata__p18842121519422">Execution plan names are unique at one specific time, so you can create an execution plan named HelloWorld and another execution plan with the same name after deleting the first one.</p>
<p id="GetExecutionPlanMetadata__p08422015164213">For parallel development, team members may want to ensure that they are operating the execution plan they created, not one with the same name created by other members after deleting the previous one.</p>
<p id="GetExecutionPlanMetadata__p084331512424">To avoid this mismatch, check the ID, since RFS ensures each execution plan has a unique ID that does not change with updates. If the execution_plan_id value differs from the current execution plan ID, 400 is returned.</p>
<p id="GetExecutionPlanMetadata__p19843101520420">Minimum: <strong id="GetExecutionPlanMetadata__b1384381510423">36</strong></p>
<p id="GetExecutionPlanMetadata__p58431815184212">Maximum: <strong id="GetExecutionPlanMetadata__b1884391513422">36</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row4834815174213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p48441715164215">execution_plan_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p18844191516421">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1184412159427">An execution plan name is unique within its domain (domain_id), region, project (project_id), and stack (stack_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
<p id="GetExecutionPlanMetadata__p5844101544212">Minimum: <strong id="GetExecutionPlanMetadata__b10844141518429">1</strong></p>
<p id="GetExecutionPlanMetadata__p284451574219">Maximum: <strong id="GetExecutionPlanMetadata__b384591517425">128</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1283411151422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p78454155429">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p984531554213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1845181518426">Execution plan description. It is used to identify your own execution plans.</p>
<p id="GetExecutionPlanMetadata__p198453154426">Minimum: <strong id="GetExecutionPlanMetadata__b198451315194218">0</strong></p>
<p id="GetExecutionPlanMetadata__p11846715124214">Maximum: <strong id="GetExecutionPlanMetadata__b178461515154217">1024</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row2834111594213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p1684613157427">vars_structure</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p284671594217">Array of <a href="#GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_VarsStructure">VarsStructure</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p16846121511425">HCL variable structure. Transferring variables is supported by the HCL template. The same template can use different variables for different purposes.</p>
<ul id="GetExecutionPlanMetadata__ul784791515422"><li id="GetExecutionPlanMetadata__li88471615174217">var_structure allows string variables.</li><li id="GetExecutionPlanMetadata__li16847115164219">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="GetExecutionPlanMetadata__li17847111594216">vars_structure only supports string variables. To use variables of other types, you need to convert them in HCL reference. Alternatively, you can use vars_uri and vars_body, which support various types and complex structures supported by HCL.</li><li id="GetExecutionPlanMetadata__li1084791515423">If vars_structure is too large, you can use vars_uri.</li><li id="GetExecutionPlanMetadata__li13848141519423">Note: vars_structure cannot contain any sensitive information. RFS directly uses, logs, displays, and stores the corresponding vars in plaintext. If the information is sensitive, you are advised to set the encryption field.</li></ul>
<p id="GetExecutionPlanMetadata__p7848191511424">Array Length: <strong id="GetExecutionPlanMetadata__b88481415194218">0 - 100</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row783416154422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p1884841514211">vars_uri_content</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p7848161574220">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1884911514215">File content corresponding to vars_uri.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row198345159423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p0849181512429">vars_body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p17849141515425">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p0849131514213">Content of the HCL variable file. Transferring variables is supported by the HCL template. The same template can use different variables for different purposes.</p>
<ul id="GetExecutionPlanMetadata__ul884915156421"><li id="GetExecutionPlanMetadata__li13849101516427">The vars_body uses the tfvars format of HCL. You can submit the content in the .tfvars file to the vars_body.</li><li id="GetExecutionPlanMetadata__li1785081574211">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="GetExecutionPlanMetadata__li985019158423">If vars_body is too large, you can use vars_uri.</li><li id="GetExecutionPlanMetadata__li1985017157422">If the content in vars is simple strings, you can use var_structure.</li><li id="GetExecutionPlanMetadata__li108501515154218">vars_body cannot contain any sensitive information. RFS directly uses, logs, displays, and stores the corresponding vars in plaintext. If the information is sensitive, you are advised to use vars_structure and set the encryption field for transmission.</li></ul>
<p id="GetExecutionPlanMetadata__p14851111515429">Minimum: <strong id="GetExecutionPlanMetadata__b1985113158429">0</strong></p>
<p id="GetExecutionPlanMetadata__p485117157421">Maximum: <strong id="GetExecutionPlanMetadata__b285161512427">51200</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1983416156428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p98511115154213">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p10851191574212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1785211154428">Status of an execution plan. * CREATION_IN_PROGRESS indicates that creation is in progress. * CREATION_FAILED indicates the creation failed. You can obtain the error information summary from status_message. * AVAILABLE indicates the creation completed. You can call ApplyExecutionPlan to apply the plan. * APPLY_IN_PROGRESS indicates the execution is in progress. You can call GetStackMetadata to query the stack status, or call ListStackEvents to obtain the stack events generated during the execution. * APPLIED indicates the plan has been applied.</p>
<p id="GetExecutionPlanMetadata__p18852215204212">Enumeration values:</p>
<ul id="GetExecutionPlanMetadata__ul58525154423"><li id="GetExecutionPlanMetadata__li128521315134212"><strong id="GetExecutionPlanMetadata__b118521115204219">CREATION_IN_PROGRESS</strong></li><li id="GetExecutionPlanMetadata__li7853111511423"><strong id="GetExecutionPlanMetadata__b6853101514420">CREATION_FAILED</strong></li><li id="GetExecutionPlanMetadata__li1985319157423"><strong id="GetExecutionPlanMetadata__b2085311524215">AVAILABLE</strong></li><li id="GetExecutionPlanMetadata__li1985341518427"><strong id="GetExecutionPlanMetadata__b08537159425">APPLY_IN_PROGRESS</strong></li><li id="GetExecutionPlanMetadata__li585381515425"><strong id="GetExecutionPlanMetadata__b485361512423">APPLIED</strong></li></ul>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row18834201574212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p14854915134210">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p5854615184211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p188541415204220">If an execution plan is in a CREATION_FAILED status, a brief error information summary is displayed for debugging.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row10834121516421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p198557158423">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1385571544213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p11856181513422">Creation time of an execution plan. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row3834111515428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p17857201564210">apply_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p3857151519429">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1285791554219">Time of applying an execution plan. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row783461511426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetExecutionPlanMetadata__p1885818157420">summary</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1285871554213"><a href="#GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_ExecutionPlanSummary">ExecutionPlanSummary</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetExecutionPlanMetadata__p285801534211">Summary of the execution plan result may include:</p>
<ul id="GetExecutionPlanMetadata__ul1085951524218"><li id="GetExecutionPlanMetadata__li148591315124220">Number of resources to be added.</li><li id="GetExecutionPlanMetadata__li10859111518422">Number of resources to be updated.</li><li id="GetExecutionPlanMetadata__li1686041512427">Number of resources to be deleted. </li><li id="GetExecutionPlanMetadata__li38601615184210">The summary is returned only when the execution plan is in the following states: <em id="GetExecutionPlanMetadata__i98601415174214">AVAILABLE</em>, <em id="GetExecutionPlanMetadata__i58601815164210">APPLY_IN_PROGRESS</em> or <em id="GetExecutionPlanMetadata__i58601615184212">APPLIED</em>.</li><li id="GetExecutionPlanMetadata__li13860121524213">The summary also includes resource changes brought by a drift. The resource status drift is caused by inconsistency between the resource status recorded in the stack and the remote resource status.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_VarsStructure"></a><a name="en-us_topic_0000001709318818_response_VarsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_VarsStructure" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VarsStructure</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row1786114154426"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="GetExecutionPlanMetadata__p19861161534219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="GetExecutionPlanMetadata__p178611915124214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="GetExecutionPlanMetadata__p48621156427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row14861215194218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetExecutionPlanMetadata__p0862201534212">var_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetExecutionPlanMetadata__p086214159420">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="GetExecutionPlanMetadata__p19862715184210">Variable name.</p>
<p id="GetExecutionPlanMetadata__p15863131574220">Minimum: <strong id="GetExecutionPlanMetadata__b12863915134210">1</strong></p>
<p id="GetExecutionPlanMetadata__p6863111514215">Maximum: <strong id="GetExecutionPlanMetadata__b10863415124211">32</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1486141519421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetExecutionPlanMetadata__p88636151422">var_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1864101511424">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1886481584219">Variable value.</p>
<p id="GetExecutionPlanMetadata__p1286401519420">Variables must be in the form of a string. If a parameter is a number, it must also be in the form of a string, for example, '10'.</p>
<p id="GetExecutionPlanMetadata__p20864915104217">For different types or complex structures, you can use vars_uri or vars_body.</p>
<p id="GetExecutionPlanMetadata__p6865111594216">Minimum: <strong id="GetExecutionPlanMetadata__b15865121519423">0</strong></p>
<p id="GetExecutionPlanMetadata__p18651515104215">Maximum: <strong id="GetExecutionPlanMetadata__b3865215104211">2048</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row286151584214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetExecutionPlanMetadata__p11865101544220">encryption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetExecutionPlanMetadata__p8866101534213"><a href="#GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_EncryptionStructure">EncryptionStructure</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="GetExecutionPlanMetadata__p786681511423">If a transferred var_value has been encrypted, you can declare this variable to require RFS to decrypt the var_value before using it. Currently, only KMS encryption and decryption are supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_EncryptionStructure"></a><a name="en-us_topic_0000001709318818_response_EncryptionStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_EncryptionStructure" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EncryptionStructure</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row686651594218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="GetExecutionPlanMetadata__p1086771534215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="GetExecutionPlanMetadata__p1986701513424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="GetExecutionPlanMetadata__p286761544215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row15866181504210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="GetExecutionPlanMetadata__p2868115154211">kms</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="GetExecutionPlanMetadata__p188681159425"><a href="#GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_KmsStructure">KmsStructure</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="GetExecutionPlanMetadata__p6868121554214">If an assigned var_value is encrypted by KMS, related encryption information can be transferred. RFS will help you decrypt the var_value by KMS.</p>
<p id="GetExecutionPlanMetadata__p138696153427"><strong id="GetExecutionPlanMetadata__b15869111554215">Note:</strong></p>
<ul id="GetExecutionPlanMetadata__ul1486991544215"><li id="GetExecutionPlanMetadata__li148691015104219">The agency you specify for RFS should have the operation permissions on the specified key ID.</li><li id="GetExecutionPlanMetadata__li1463511361690">KMS provides a quota for free trial every month. If the quota is exceeded, you will be billed for KMS. The fee is not billed by RFS.</li><li id="GetExecutionPlanMetadata__li1186951594211">KMS encryption only indicates that RFS uses ciphertext for storage and transmission. However, RFS still uses plaintext in stack-events. If you want RFS to use ciphertext in logs, you can declare sensitive in templates. For more information about sensitive, refer to https://learn.hashicorp.com/tutorials/terraform/sensitive-variables.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_KmsStructure"></a><a name="en-us_topic_0000001709318818_response_KmsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_KmsStructure" frame="border" border="1" rules="all"><caption><b>Table 7 </b>KmsStructure</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row1887071574219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="GetExecutionPlanMetadata__p78721815104217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="GetExecutionPlanMetadata__p128725153424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="GetExecutionPlanMetadata__p687312159425">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row58701815194214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="GetExecutionPlanMetadata__p149934159425">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1899371584219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1499351534217">KMS key ID is used by RFS during decryption. Generally, the key ID is that used for encryption.</p>
<p id="GetExecutionPlanMetadata__p199317153424">Minimum: <strong id="GetExecutionPlanMetadata__b1799391574215">36</strong></p>
<p id="GetExecutionPlanMetadata__p6993215104212">Maximum: <strong id="GetExecutionPlanMetadata__b119933159429">36</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row2087116152424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="GetExecutionPlanMetadata__p6994111534220">cipher_text</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="GetExecutionPlanMetadata__p16994815114218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="GetExecutionPlanMetadata__p699413154422">Ciphertext of data encryption key.</p>
<p id="GetExecutionPlanMetadata__p209941115144214">Minimum: <strong id="GetExecutionPlanMetadata__b1994141512427">2</strong></p>
<p id="GetExecutionPlanMetadata__p1999441554211">Maximum: <strong id="GetExecutionPlanMetadata__b149941615164212">2048</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_ExecutionPlanSummary"></a><a name="en-us_topic_0000001709318818_response_ExecutionPlanSummary"></a><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_ExecutionPlanSummary" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ExecutionPlanSummary</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row10878415204213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="GetExecutionPlanMetadata__p19995101574213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="GetExecutionPlanMetadata__p2995101517427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="GetExecutionPlanMetadata__p1999571510421">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row10878015194220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetExecutionPlanMetadata__p20995141513422">resource_add</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1699591534213">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetExecutionPlanMetadata__p15995131514426">Number of new resources.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1787812151422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetExecutionPlanMetadata__p899551574212">resource_update</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetExecutionPlanMetadata__p10995115154210">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetExecutionPlanMetadata__p17995101517424">Number of updated resources.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row14878815194211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetExecutionPlanMetadata__p999551515429">resource_delete</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetExecutionPlanMetadata__p13996101574213">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetExecutionPlanMetadata__p13996015104217">Number of deleted resources.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row38780155420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetExecutionPlanMetadata__p189961715184218">resource_import</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetExecutionPlanMetadata__p9996161534219">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetExecutionPlanMetadata__p199661594218">Number of imported resources.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p129960155423"><strong id="GetExecutionPlanMetadata__b15996115124218">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_response_CommonErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row888161534212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="GetExecutionPlanMetadata__p209961815134217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="GetExecutionPlanMetadata__p13998171513424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="GetExecutionPlanMetadata__p17998161518424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row688141516427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetExecutionPlanMetadata__p159986155425">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetExecutionPlanMetadata__p79981915194211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetExecutionPlanMetadata__p89981015174217">Response code.</p>
<p id="GetExecutionPlanMetadata__p3998131514426">Minimum: <strong id="GetExecutionPlanMetadata__b1499813157423">11</strong></p>
<p id="GetExecutionPlanMetadata__p119991915144215">Maximum: <strong id="GetExecutionPlanMetadata__b299941517429">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row138811152428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetExecutionPlanMetadata__p49992015134213">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetExecutionPlanMetadata__p19991715154214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1099961554214">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row28813154421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetExecutionPlanMetadata__p10999121515426">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1599912155429">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetExecutionPlanMetadata__p29991815104215">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p20121617421"><strong id="GetExecutionPlanMetadata__b1041654218">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table16884101544210" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row68841015104212"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="GetExecutionPlanMetadata__p1732016154220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="GetExecutionPlanMetadata__p1731616114210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="GetExecutionPlanMetadata__p10311674211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row38841315184219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetExecutionPlanMetadata__p19315164422">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1431616194213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetExecutionPlanMetadata__p83216134219">Response code.</p>
<p id="GetExecutionPlanMetadata__p13916154214">Minimum: <strong id="GetExecutionPlanMetadata__b18391674218">11</strong></p>
<p id="GetExecutionPlanMetadata__p3421610422">Maximum: <strong id="GetExecutionPlanMetadata__b18451654211">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row38840159424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetExecutionPlanMetadata__p19410164429">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetExecutionPlanMetadata__p11414165427">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetExecutionPlanMetadata__p15431619429">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row138843159426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetExecutionPlanMetadata__p1647168427">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1481644217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetExecutionPlanMetadata__p15481684214">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p144816104213"><strong id="GetExecutionPlanMetadata__b12419169428">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table98861215194210" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row1888616159423"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="GetExecutionPlanMetadata__p13591612429">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="GetExecutionPlanMetadata__p185121634213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="GetExecutionPlanMetadata__p767160424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row1188618152428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetExecutionPlanMetadata__p19661618424">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetExecutionPlanMetadata__p261716114213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetExecutionPlanMetadata__p1964164427">Response code.</p>
<p id="GetExecutionPlanMetadata__p86616194215">Minimum: <strong id="GetExecutionPlanMetadata__b56121614210">11</strong></p>
<p id="GetExecutionPlanMetadata__p57616194213">Maximum: <strong id="GetExecutionPlanMetadata__b47816154210">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row138877150420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetExecutionPlanMetadata__p17616184219">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1172164428">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetExecutionPlanMetadata__p67716184213">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1888714159421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetExecutionPlanMetadata__p15715166427">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetExecutionPlanMetadata__p158816154219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetExecutionPlanMetadata__p15881617429">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p188116194211"><strong id="GetExecutionPlanMetadata__b48181654218">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table989013150425" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row1589120154429"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="GetExecutionPlanMetadata__p3818166424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="GetExecutionPlanMetadata__p4815167422">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="GetExecutionPlanMetadata__p88141611421">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row1089118154422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetExecutionPlanMetadata__p14911610423">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetExecutionPlanMetadata__p12919166423">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetExecutionPlanMetadata__p7911612422">Response code.</p>
<p id="GetExecutionPlanMetadata__p109121615420">Minimum: <strong id="GetExecutionPlanMetadata__b7931614211">11</strong></p>
<p id="GetExecutionPlanMetadata__p498168421">Maximum: <strong id="GetExecutionPlanMetadata__b1894167425">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row108911115124214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetExecutionPlanMetadata__p11912166423">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetExecutionPlanMetadata__p8131916194217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetExecutionPlanMetadata__p11391664218">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row289151564219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetExecutionPlanMetadata__p1717916114213">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1117116154210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetExecutionPlanMetadata__p17177160427">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p61716166428"><strong id="GetExecutionPlanMetadata__b1117131614421">Status code: 429</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table6894111510427" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row2894181519429"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.17.2.4.1.1"><p id="GetExecutionPlanMetadata__p1218016114219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.17.2.4.1.2"><p id="GetExecutionPlanMetadata__p91814162423">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.17.2.4.1.3"><p id="GetExecutionPlanMetadata__p1218916164213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row1894161514424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetExecutionPlanMetadata__p61821612424">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetExecutionPlanMetadata__p181815163421">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetExecutionPlanMetadata__p191810164421">Response code.</p>
<p id="GetExecutionPlanMetadata__p818181624218">Minimum: <strong id="GetExecutionPlanMetadata__b418616164214">11</strong></p>
<p id="GetExecutionPlanMetadata__p161811613424">Maximum: <strong id="GetExecutionPlanMetadata__b51961614219">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row78941115154220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetExecutionPlanMetadata__p81918166422">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetExecutionPlanMetadata__p61961620429">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetExecutionPlanMetadata__p20199161426">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row5894171515424"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetExecutionPlanMetadata__p9198168422">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetExecutionPlanMetadata__p161917167421">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetExecutionPlanMetadata__p2019131617425">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetExecutionPlanMetadata__p18191216184215"><strong id="GetExecutionPlanMetadata__b1019111614213">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__table68961215164214" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Response body parameters</caption><thead align="left"><tr id="GetExecutionPlanMetadata__row1889681519426"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.19.2.4.1.1"><p id="GetExecutionPlanMetadata__p119121604213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.19.2.4.1.2"><p id="GetExecutionPlanMetadata__p319131624216">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.19.2.4.1.3"><p id="GetExecutionPlanMetadata__p52014164423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row1789671544212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetExecutionPlanMetadata__p17201216104219">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetExecutionPlanMetadata__p1820131644210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetExecutionPlanMetadata__p620181617422">Response code.</p>
<p id="GetExecutionPlanMetadata__p162031612426">Minimum: <strong id="GetExecutionPlanMetadata__b172081674213">11</strong></p>
<p id="GetExecutionPlanMetadata__p320101613424">Maximum: <strong id="GetExecutionPlanMetadata__b1220516194216">11</strong></p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row589611152429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetExecutionPlanMetadata__p020116164216">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetExecutionPlanMetadata__p112001619421">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetExecutionPlanMetadata__p5201516124218">Response message.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row128960155429"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetExecutionPlanMetadata__p102051619424">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetExecutionPlanMetadata__p16201916184210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetExecutionPlanMetadata__p12204168429">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetExecutionPlanMetadata__section1521111615421"><h4 class="sectiontitle">Example Requests</h4><ul id="GetExecutionPlanMetadata__ul10211716144219"><li id="GetExecutionPlanMetadata__li152151614215">Obtain the metadata of a specified execution plan.<pre class="screen" id="GetExecutionPlanMetadata__screen1821111611425">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan/metadata</pre>
</li><li id="GetExecutionPlanMetadata__li2021171619423">Obtain the metadata of a specified execution plan, with a stack ID and an execution plan ID provided to check whether they match the current stack and execution plan.<pre class="screen" id="GetExecutionPlanMetadata__screen3211164425">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans/my_first_execution_plan/metadata?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2&amp;execution_plan_id=fb5e781e-a27d-46e2-9954-242753857a9f</pre>
</li></ul>
</div>
<div class="section" id="GetExecutionPlanMetadata__section921141611423"><h4 class="sectiontitle">Example Responses</h4><p id="GetExecutionPlanMetadata__p1122111634219"><strong id="GetExecutionPlanMetadata__b8221316124216">Status code: 200</strong></p>
<p id="GetExecutionPlanMetadata__p62216162421">Execution plan metadata obtained.</p>
<pre class="screen" id="GetExecutionPlanMetadata__screen10225165424">{
"stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
"stack_name" : "my_hello_world_stack",
"execution_plan_id" : "ebc0979a-c617-4382-9147-57fc83a634aa",
"execution_plan_name" : "my_first_execution_plan",
"status" : "APPLIED",
"apply_time" : "2023-05-17T11:56:40Z",
"create_time" : "2023-05-16T03:37:24Z",
"summary" : {
"resource_add" : 2
}
}</pre>
</div>
<div class="section" id="GetExecutionPlanMetadata__section12247161420"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetExecutionPlanMetadata__en-us_topic_0000001709318818_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="GetExecutionPlanMetadata__row1390314158424"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="GetExecutionPlanMetadata__p122471634213">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="GetExecutionPlanMetadata__p1124181614212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetExecutionPlanMetadata__row1903101544219"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p324101654212">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p82551644218">Execution plan metadata obtained.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row17903111514212"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p1025016144212">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p15252163420">Invalid request.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row190361512422"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p142521617421">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p425201624218">Authentication failed.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row2090315152421"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p8252016174213">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p102512168421">The user does not have the permission to call this API.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1990317156422"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p112581618425">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><ol id="GetExecutionPlanMetadata__ol425131619429"><li id="GetExecutionPlanMetadata__li6256162424">The execution plan does not exist.</li><li id="GetExecutionPlanMetadata__li926201613421">The stack does not exist.</li></ol>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row1490311157427"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p1626616194214">429</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p13264169429">Too frequent requests.</p>
</td>
</tr>
<tr id="GetExecutionPlanMetadata__row590315152428"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetExecutionPlanMetadata__p8263160429">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetExecutionPlanMetadata__p1126161616423">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Execution Plans</a></div>
</div>
</div>
View Git Blame Copy Permalink