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

648 lines
57 KiB
HTML
Raw Blame History

<a name="GetStackMetadata"></a><a name="GetStackMetadata"></a>
<h1 class="topictitle1">Obtaining Stack Metadata</h1>
<div id="body8662426"><div class="section" id="GetStackMetadata__section1279751392115"><h4 class="sectiontitle">Function</h4><p id="GetStackMetadata__p107971513112115">GetStackMetadata</p>
<p id="GetStackMetadata__p179713137215">This API obtains the metadata of a stack, including the stack ID, stack name, stack description, creation time, update time, stack status, and agency. You can obtain details by referring to GetStackMetadataResponseBody.</p>
<p id="GetStackMetadata__p179716139213">If a stack is in a non-final state (The state ends with IN_PROGRESS. Details are shown in the following description.), its metadata is in a transition phase, which may be a state before or after deployment. The metadata of the stack is in a state after deployment only when the stack is in a final state (ending with <em id="GetStackMetadata__i9797141342114">COMPLETE</em> or <em id="GetStackMetadata__i15797141310214">FAILED</em>).</p>
<p id="GetStackMetadata__p1797613142112">The non-final states may include:</p>
<ul id="GetStackMetadata__ul107977134214"><li id="GetStackMetadata__li1479751322115">DEPLOYMENT_IN_PROGRESS</li><li id="GetStackMetadata__li579821311214">ROLLBACK_IN_PROGRESS</li><li id="GetStackMetadata__li7798213102111">DELETION_IN_PROGRESS</li></ul>
<p id="GetStackMetadata__p20798131352111">The final states may include:</p>
<ul id="GetStackMetadata__ul67981613162112"><li id="GetStackMetadata__li19798161318219">CREATION_COMPLETE</li><li id="GetStackMetadata__li679881372111">DEPLOYMENT_FAILED</li><li id="GetStackMetadata__li127982138214">DEPLOYMENT_COMPLETE</li><li id="GetStackMetadata__li1679813132214">ROLLBACK_FAILED</li><li id="GetStackMetadata__li10798013162116">ROLLBACK_COMPLETE</li><li id="GetStackMetadata__li197981313182113">DELETION_FAILED</li></ul>
</div>
<div class="section" id="GetStackMetadata__section14798201316217"><h4 class="sectiontitle">URI</h4><p id="GetStackMetadata__p1679921313218">GET /v1/{project_id}/stacks/{stack_name}/metadata</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table207991613152114" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="GetStackMetadata__row1679911314215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="GetStackMetadata__p2079914136214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="GetStackMetadata__p57991213102115">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="GetStackMetadata__p18799141332112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="GetStackMetadata__p1979961319213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row20799101342115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetStackMetadata__p168004131210">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetStackMetadata__p158005134213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetStackMetadata__p1280051310219">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetStackMetadata__p1880031322110">A project ID is obtained by calling an API or from the console.</p>
<p id="GetStackMetadata__p1880071352114">Minimum: <strong id="GetStackMetadata__b9800151392113">3</strong></p>
<p id="GetStackMetadata__p28004135215">Maximum: <strong id="GetStackMetadata__b1180021332117">64</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row12799113112110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetStackMetadata__p48007139211">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetStackMetadata__p1480061322114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetStackMetadata__p128007135217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetStackMetadata__p680014134217">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="GetStackMetadata__p2080031382114">Minimum: <strong id="GetStackMetadata__b1080061310211">1</strong></p>
<p id="GetStackMetadata__p1580021312119">Maximum: <strong id="GetStackMetadata__b7801141311213">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table1980116138214" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="GetStackMetadata__row880117134213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="GetStackMetadata__p4801171318218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="GetStackMetadata__p12801181362117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="GetStackMetadata__p19801613112112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="GetStackMetadata__p480121372118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row16801111310212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="GetStackMetadata__p380131332110">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="GetStackMetadata__p58011513162110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="GetStackMetadata__p480281316211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="GetStackMetadata__p118021913122115">Unique stack ID.</p>
<p id="GetStackMetadata__p11802201317212">It is a UUID generated by RFS when a stack is created.</p>
<p id="GetStackMetadata__p4802513122110">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="GetStackMetadata__p11802713112112">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="GetStackMetadata__p11802121362119">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="GetStackMetadata__p1380211133219">Minimum: <strong id="GetStackMetadata__b5802713112119">36</strong></p>
<p id="GetStackMetadata__p1580216136210">Maximum: <strong id="GetStackMetadata__b138024133217">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetStackMetadata__section18803141372115"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="GetStackMetadata__row7803151352113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="GetStackMetadata__p780316131215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="GetStackMetadata__p1803913102120">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="GetStackMetadata__p2080481319217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="GetStackMetadata__p580431318215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row280311332111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="GetStackMetadata__p7804111342112">Client-Request-Id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="GetStackMetadata__p88041313192112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="GetStackMetadata__p11804141342111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="GetStackMetadata__p280431314212">A unique request ID is specified by a user to locate a request. UUID is recommended.</p>
<p id="GetStackMetadata__p2080418136213">Minimum: <strong id="GetStackMetadata__b480412133213">36</strong></p>
<p id="GetStackMetadata__p1804191392120">Maximum: <strong id="GetStackMetadata__b7804713122110">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetStackMetadata__section3804181315219"><h4 class="sectiontitle">Response Parameters</h4><p id="GetStackMetadata__p18804171316215"><strong id="GetStackMetadata__b128046137212">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_GetStackMetadataResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row158051013162111"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="GetStackMetadata__p580519131216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="GetStackMetadata__p78062136215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="GetStackMetadata__p08062132215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row118051113202114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p38066132214">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p1180631342112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p5806181332117">Unique stack ID.</p>
<p id="GetStackMetadata__p380661312214">It is a UUID generated by RFS when a stack is created.</p>
<p id="GetStackMetadata__p15806513162119">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="GetStackMetadata__p208061713122110">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="GetStackMetadata__p5806111352116">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="GetStackMetadata__p208061213122116">Minimum: <strong id="GetStackMetadata__b4806513132110">36</strong></p>
<p id="GetStackMetadata__p080691352117">Maximum: <strong id="GetStackMetadata__b3806101312117">36</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row6805513172120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p1280681311219">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p480615136210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p3806213112114">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="GetStackMetadata__p2080751311219">Minimum: <strong id="GetStackMetadata__b4807111320216">1</strong></p>
<p id="GetStackMetadata__p980761352115">Maximum: <strong id="GetStackMetadata__b18072134217">128</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row18805111302113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p78071013122118">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p6807131362114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p118079132214">Description of a stack. It can be used by customers to identify their own stacks.</p>
<p id="GetStackMetadata__p18807101382117">Minimum: <strong id="GetStackMetadata__b48072133217">0</strong></p>
<p id="GetStackMetadata__p380711382112">Maximum: <strong id="GetStackMetadata__b480771382110">1024</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row180591362118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p188071513192119">vars_structure</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p1680761372113">Array of <a href="#GetStackMetadata__en-us_topic_0000001709159306_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="GetStackMetadata__p138071713152111">HCL variable structure. Transferring variables is supported by the HCL template. The same template can use different variables for different purposes.</p>
<ul id="GetStackMetadata__ul88071713152112"><li id="GetStackMetadata__li1080711135214">var_structure allows string variables.</li><li id="GetStackMetadata__li1807171312116">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="GetStackMetadata__li1808181332115">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="GetStackMetadata__li88081013112117">If vars_structure is too large, you can use vars_uri.</li><li id="GetStackMetadata__li1780821332120">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="GetStackMetadata__p880813131212">Array Length: <strong id="GetStackMetadata__b98081813182111">0 - 100</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row580516133216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p1380801392115">vars_body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p108088132213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p118081913172112">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="GetStackMetadata__ul19808613102110"><li id="GetStackMetadata__li16808101322111">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="GetStackMetadata__li380815136214">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="GetStackMetadata__li8808131342118">If vars_body is too large, you can use vars_uri.</li><li id="GetStackMetadata__li148081413102110">If the content in vars is simple strings, you can use var_structure.</li><li id="GetStackMetadata__li4808313182110">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="GetStackMetadata__p1080811130212">Minimum: <strong id="GetStackMetadata__b2809213112117">0</strong></p>
<p id="GetStackMetadata__p58091713142120">Maximum: <strong id="GetStackMetadata__b98091513192110">51200</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row58051613132114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p13809181392119">enable_deletion_protection</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p1680916137215">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p1280961362116">Deletion protection flag. If this variable is not assigned, the default value is false, indicating that deletion protection is disabled by default. (After deletion protection is enabled, stacks cannot be deleted.)</p>
<p id="GetStackMetadata__p3809171362115"><em id="GetStackMetadata__i48091213112116">In the UpdateStack API, if this variable is not assigned in the RequestBody, the deletion protection attribute of the stack will not be updated.</em></p>
</td>
</tr>
<tr id="GetStackMetadata__row480531312219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p13809313162116">enable_auto_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p88091913162114">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p3809131382112">Auto-rollback flag. If this variable is not assigned, the default value is false, indicating that auto-rollback is disabled by default. (After auto-rollback is enabled, if the deployment fails, the stack is automatically rolled back and returns to the previous stable status.)</p>
<p id="GetStackMetadata__p080961322116"><em id="GetStackMetadata__i48092130217">In the UpdateStack API, if this variable is not assigned in the RequestBody, the auto-rollback attribute of the stack will not be updated.</em> <em id="GetStackMetadata__i880951342118">This property is mutually exclusive with the import resources using templates feature, which does not allow the deployment of templates containing imported resources if the stack's auto-rollback is set to true.</em></p>
</td>
</tr>
<tr id="GetStackMetadata__row4805913152114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p148091813162114">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p480961317211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p1280991372117">Status of a stack. * CREATION_COMPLETE indicates an empty stack has been created and no deployment is performed. * DEPLOYMENT_IN_PROGRESS indicates the stack deployment is in progress. * DEPLOYMENT_FAILED indicates the deployment fails. You can obtain the error information summary from status_message. To obtain event details, you can call ListStackEvents. * DEPLOYMENT_COMPLETE indicates the deployment completed. * ROLLBACK_IN_PROGRESS indicates the deployment failed and the rollback is in progress. * ROLLBACK_FAILED indicates the rollback failed. You can obtain the error information summary from status_message. To obtain event details, you can call ListStackEvents. * ROLLBACK_COMPLETE indicates the rollback completed. * DELETION_IN_PROGRESS indicates the deletion is in progress. * DELETION_FAILED indicates the deletion failed. You can obtain the error information summary from status_message. To obtain event details, you can call ListStackEvents.</p>
<p id="GetStackMetadata__p8810813162119">Enumeration values:</p>
<ul id="GetStackMetadata__ul16810161319214"><li id="GetStackMetadata__li178101313122111"><strong id="GetStackMetadata__b1481071322118">CREATION_COMPLETE</strong></li><li id="GetStackMetadata__li1681021332117"><strong id="GetStackMetadata__b1881081382118">DEPLOYMENT_IN_PROGRESS</strong></li><li id="GetStackMetadata__li1681019133216"><strong id="GetStackMetadata__b188101313132111">DEPLOYMENT_FAILED</strong></li><li id="GetStackMetadata__li15810191352116"><strong id="GetStackMetadata__b881071314217">DEPLOYMENT_COMPLETE</strong></li><li id="GetStackMetadata__li68101113122116"><strong id="GetStackMetadata__b4810111318215">ROLLBACK_IN_PROGRESS</strong></li><li id="GetStackMetadata__li1081061382112"><strong id="GetStackMetadata__b1381051372113">ROLLBACK_FAILED</strong></li><li id="GetStackMetadata__li481091362110"><strong id="GetStackMetadata__b18810313132111">ROLLBACK_COMPLETE</strong></li><li id="GetStackMetadata__li12810913162114"><strong id="GetStackMetadata__b1081001342116">DELETION_IN_PROGRESS</strong></li><li id="GetStackMetadata__li68100136218"><strong id="GetStackMetadata__b781011312119">DELETION_FAILED</strong></li></ul>
</td>
</tr>
<tr id="GetStackMetadata__row18051813112114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p188101513172117">agencies</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p1981111392112">Array of <a href="#GetStackMetadata__en-us_topic_0000001709159306_response_Agency">Agency</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p98117133217">Agency information.</p>
<p id="GetStackMetadata__p19811813122120">RFS uses an agency only in requests that involve resource operations, such as creating a stack (triggering deployment), creating an execution plan, deploying a stack, and deleting a stack. In addition, the agency applies only to resource operations performed by the provider bound to the agency. If the permissions provided by the agency are insufficient, operations on related resources may fail.</p>
<p id="GetStackMetadata__p8811131310210">Array Length: <strong id="GetStackMetadata__b28119133214">0 - 10</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row8805111312218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p1881131314216">status_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p118112132218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p6811171322110">If a stack is in a failure state (ending with FAILED), a brief error information summary is displayed for debugging.</p>
</td>
</tr>
<tr id="GetStackMetadata__row138051513102113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p1381171302114">vars_uri_content</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p1781111137218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p1581118134214">File content corresponding to vars_uri.</p>
</td>
</tr>
<tr id="GetStackMetadata__row18805111312110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p78111713172116">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p7812181352111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p12812713162116">Creation time of a stack. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
</td>
</tr>
<tr id="GetStackMetadata__row12805191319213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackMetadata__p681261314219">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackMetadata__p4812121312118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackMetadata__p3812161322116">Update time of a stack (applied to the metadata update and deployment). The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetStackMetadata__en-us_topic_0000001709159306_response_VarsStructure"></a><a name="en-us_topic_0000001709159306_response_VarsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_VarsStructure" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VarsStructure</caption><thead align="left"><tr id="GetStackMetadata__row6812131382113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="GetStackMetadata__p178139134214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="GetStackMetadata__p1181351320217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="GetStackMetadata__p7813313192114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row58121513132110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetStackMetadata__p12813151318210">var_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetStackMetadata__p3813111317210">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="GetStackMetadata__p14813313122112">Variable name.</p>
<p id="GetStackMetadata__p781391316212">Minimum: <strong id="GetStackMetadata__b1481314131212">1</strong></p>
<p id="GetStackMetadata__p15813131312119">Maximum: <strong id="GetStackMetadata__b8813213142119">32</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row1081214132212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetStackMetadata__p08136131213">var_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetStackMetadata__p1581321382113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="GetStackMetadata__p38131513142113">Variable value.</p>
<p id="GetStackMetadata__p0813161316219">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="GetStackMetadata__p681314139211">For different types or complex structures, you can use vars_uri or vars_body.</p>
<p id="GetStackMetadata__p1281419139216">Minimum: <strong id="GetStackMetadata__b1481413134212">0</strong></p>
<p id="GetStackMetadata__p7814013182110">Maximum: <strong id="GetStackMetadata__b28141913152117">2048</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row28121913122112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="GetStackMetadata__p381419134216">encryption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="GetStackMetadata__p1981451312114"><a href="#GetStackMetadata__en-us_topic_0000001709159306_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="GetStackMetadata__p1581441352116">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="GetStackMetadata__en-us_topic_0000001709159306_response_EncryptionStructure"></a><a name="en-us_topic_0000001709159306_response_EncryptionStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_EncryptionStructure" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EncryptionStructure</caption><thead align="left"><tr id="GetStackMetadata__row1681471316211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="GetStackMetadata__p88141135213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="GetStackMetadata__p11814191315214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="GetStackMetadata__p1781415134214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row7814613182112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="GetStackMetadata__p178151113152118">kms</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="GetStackMetadata__p38158135215"><a href="#GetStackMetadata__en-us_topic_0000001709159306_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="GetStackMetadata__p3815191342119">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="GetStackMetadata__p2815413102115"><strong id="GetStackMetadata__b5815181392118">Note:</strong></p>
<ul id="GetStackMetadata__ul9815101302114"><li id="GetStackMetadata__li98151913182116">The agency you specify for RFS should have the operation permissions on the specified key ID.</li><li id="GetStackMetadata__li184637175105">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="GetStackMetadata__li88151813142111">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="GetStackMetadata__en-us_topic_0000001709159306_response_KmsStructure"></a><a name="en-us_topic_0000001709159306_response_KmsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_KmsStructure" frame="border" border="1" rules="all"><caption><b>Table 7 </b>KmsStructure</caption><thead align="left"><tr id="GetStackMetadata__row12815201311218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="GetStackMetadata__p981611133215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="GetStackMetadata__p78168135211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="GetStackMetadata__p118166137215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row11815191322119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="GetStackMetadata__p1816121314215">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="GetStackMetadata__p168162136212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="GetStackMetadata__p138161613192110">KMS key ID is used by RFS during decryption. Generally, the key ID is that used for encryption.</p>
<p id="GetStackMetadata__p208161913192112">Minimum: <strong id="GetStackMetadata__b481610135214">36</strong></p>
<p id="GetStackMetadata__p381681313218">Maximum: <strong id="GetStackMetadata__b10816191392116">36</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row18815213122116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="GetStackMetadata__p1381671392113">cipher_text</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="GetStackMetadata__p3816713112118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="GetStackMetadata__p2081601312219">Ciphertext of data encryption key.</p>
<p id="GetStackMetadata__p14816913202113">Minimum: <strong id="GetStackMetadata__b1981617130214">2</strong></p>
<p id="GetStackMetadata__p68176135212">Maximum: <strong id="GetStackMetadata__b5817131313218">2048</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="GetStackMetadata__en-us_topic_0000001709159306_response_Agency"></a><a name="en-us_topic_0000001709159306_response_Agency"></a><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_Agency" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Agency</caption><thead align="left"><tr id="GetStackMetadata__row10817413172117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="GetStackMetadata__p129271139211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="GetStackMetadata__p892871302117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="GetStackMetadata__p149281413172110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row68171213102115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackMetadata__p592812131214">provider_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackMetadata__p792821332114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackMetadata__p7928191311215">Name of the provider used by a user. If the provider_name value given by the user is duplicate, 400 is returned.</p>
<p id="GetStackMetadata__p1092801362118">Minimum: <strong id="GetStackMetadata__b7928151311212">1</strong></p>
<p id="GetStackMetadata__p1292891319211">Maximum: <strong id="GetStackMetadata__b1692891352114">128</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row128178137211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackMetadata__p15928121313212">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackMetadata__p139281413152116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackMetadata__p16928121313213">IAM agency used by the corresponding provider. RFS uses this agency to access and create resources of the provider. Either agency_name or agency_urn must be specified.</p>
<p id="GetStackMetadata__p1092801362113">Minimum: <strong id="GetStackMetadata__b17928713152117">1</strong></p>
<p id="GetStackMetadata__p4928121362113">Maximum: <strong id="GetStackMetadata__b59281713172117">64</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row17817513142113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackMetadata__p13928141318217">agency_urn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackMetadata__p592820133216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackMetadata__p1692891342118">Agency URN When a user defines an agency, either agency_name or agency_urn must be specified. You are advised to set agency_urn when using the trust agency. agency_name can only receive common agency names. If agency_name is set to a trust agency name, template deployment will fail.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p192831313214"><strong id="GetStackMetadata__b79281136214">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_response_CommonErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row4819513162118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="GetStackMetadata__p169281513162120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="GetStackMetadata__p179284139211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="GetStackMetadata__p18928713132118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row1481931318218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackMetadata__p16928131322117">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackMetadata__p11928191372115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackMetadata__p9928191318215">Response code.</p>
<p id="GetStackMetadata__p8928913132112">Minimum: <strong id="GetStackMetadata__b1392861317215">11</strong></p>
<p id="GetStackMetadata__p129284135218">Maximum: <strong id="GetStackMetadata__b99281213162112">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row1781951311215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackMetadata__p12928013142112">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackMetadata__p692871314214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackMetadata__p149282013112115">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row981991315217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackMetadata__p17928513112110">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackMetadata__p16928171318213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackMetadata__p1292861362115">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p17928151342112"><strong id="GetStackMetadata__b1928713152114">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table1782013133218" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row18820813112114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="GetStackMetadata__p792911313211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="GetStackMetadata__p89291013102117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="GetStackMetadata__p16929313162114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row10820313132117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackMetadata__p18929191318218">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackMetadata__p109291613152119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackMetadata__p792981322111">Response code.</p>
<p id="GetStackMetadata__p992951302110">Minimum: <strong id="GetStackMetadata__b13929113182114">11</strong></p>
<p id="GetStackMetadata__p3929813132120">Maximum: <strong id="GetStackMetadata__b1792971314213">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row10820121312213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackMetadata__p49291113182112">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackMetadata__p1892917132214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackMetadata__p492918138219">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row2820613192118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackMetadata__p9929181382112">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackMetadata__p1792918132211">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackMetadata__p1992921310217">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p592911134218"><strong id="GetStackMetadata__b13929613182116">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table8821121310213" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row12822813142115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="GetStackMetadata__p4929713142114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="GetStackMetadata__p189290138218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="GetStackMetadata__p89295136219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row1682291372113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackMetadata__p99292133218">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackMetadata__p5929413112119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackMetadata__p9929313172110">Response code.</p>
<p id="GetStackMetadata__p16929161312111">Minimum: <strong id="GetStackMetadata__b19294139210">11</strong></p>
<p id="GetStackMetadata__p0929213142115">Maximum: <strong id="GetStackMetadata__b392951392111">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row11822121318215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackMetadata__p149297137217">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackMetadata__p179291613112113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackMetadata__p0929101310218">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row17822213112119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackMetadata__p59291513142111">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackMetadata__p1929131312215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackMetadata__p99291513152111">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p9929513122116"><strong id="GetStackMetadata__b3929141352112">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table78234136213" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row1882317137218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="GetStackMetadata__p17929181362110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="GetStackMetadata__p592920135211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="GetStackMetadata__p1792911319219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row12823213152111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackMetadata__p17929121316212">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackMetadata__p2092921314217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackMetadata__p392991352110">Response code.</p>
<p id="GetStackMetadata__p29291013122111">Minimum: <strong id="GetStackMetadata__b692916132212">11</strong></p>
<p id="GetStackMetadata__p3929191312114">Maximum: <strong id="GetStackMetadata__b7929201314214">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row582310136217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackMetadata__p29293138218">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackMetadata__p59292138212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackMetadata__p139291713152110">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row6823151310214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackMetadata__p1692916139216">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackMetadata__p092919130216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackMetadata__p092911314218">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p129299138213"><strong id="GetStackMetadata__b9929313112115">Status code: 429</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table15824191320219" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row11824151312213"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.17.2.4.1.1"><p id="GetStackMetadata__p1929171332112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.17.2.4.1.2"><p id="GetStackMetadata__p692941313214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.17.2.4.1.3"><p id="GetStackMetadata__p179295139211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row15824813132114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetStackMetadata__p189292138215">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetStackMetadata__p1492971320218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetStackMetadata__p11929713152113">Response code.</p>
<p id="GetStackMetadata__p14929131362112">Minimum: <strong id="GetStackMetadata__b592981382114">11</strong></p>
<p id="GetStackMetadata__p14929313112113">Maximum: <strong id="GetStackMetadata__b18929713172111">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row1882431362113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetStackMetadata__p19929191332111">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetStackMetadata__p179294139212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetStackMetadata__p792901332110">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row382461312219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.1 "><p id="GetStackMetadata__p19929201310213">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.17.2.4.1.2 "><p id="GetStackMetadata__p592920132218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.17.2.4.1.3 "><p id="GetStackMetadata__p17929313192117">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="GetStackMetadata__p209308137217"><strong id="GetStackMetadata__b99301613182117">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__table5825313142116" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Response body parameters</caption><thead align="left"><tr id="GetStackMetadata__row158251613122112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.19.2.4.1.1"><p id="GetStackMetadata__p893020132215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.19.2.4.1.2"><p id="GetStackMetadata__p12930113132111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.19.2.4.1.3"><p id="GetStackMetadata__p0930101382115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row6825171313217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetStackMetadata__p13930161342111">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetStackMetadata__p1693017136215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetStackMetadata__p15930111312110">Response code.</p>
<p id="GetStackMetadata__p10930813162118">Minimum: <strong id="GetStackMetadata__b99306134211">11</strong></p>
<p id="GetStackMetadata__p129304138211">Maximum: <strong id="GetStackMetadata__b18930131319210">11</strong></p>
</td>
</tr>
<tr id="GetStackMetadata__row19826713132111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetStackMetadata__p119301513152117">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetStackMetadata__p10930101352119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetStackMetadata__p1893001352114">Response message.</p>
</td>
</tr>
<tr id="GetStackMetadata__row15826121362114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.1 "><p id="GetStackMetadata__p1193081311217">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.19.2.4.1.2 "><p id="GetStackMetadata__p1393061313212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.19.2.4.1.3 "><p id="GetStackMetadata__p493014134219">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="GetStackMetadata__section593051316213"><h4 class="sectiontitle">Example Requests</h4><ul id="GetStackMetadata__ul18930101362119"><li id="GetStackMetadata__li179302137218">Obtain stack metadata.<pre class="screen" id="GetStackMetadata__screen17930101317213">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/metadata</pre>
</li><li id="GetStackMetadata__li1393011135218">Obtain stack metadata, with a stack ID provided to check whether the stack ID matches the current stack.<pre class="screen" id="GetStackMetadata__screen2093017136212">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/metadata?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2</pre>
</li></ul>
</div>
<div class="section" id="GetStackMetadata__section1093041322111"><h4 class="sectiontitle">Example Responses</h4><p id="GetStackMetadata__p15930313192118"><strong id="GetStackMetadata__b159308131219">Status code: 200</strong></p>
<p id="GetStackMetadata__p1593071362120">Stack metadata obtained.</p>
<pre class="screen" id="GetStackMetadata__screen11930713132114">{
"stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
"stack_name" : "my_hello_world_stack",
"description" : "my hello world stack",
"enable_deletion_protection" : false,
"enable_auto_rollback" : false,
"status" : "DEPLOYMENT_COMPLETE",
"agencies" : [ {
"agency_name" : "rf_admin_trust",
"provider_name" : "opentelekomcloud"
} ],
"create_time" : "2023-03-16T03:28:20Z",
"update_time" : "2023-05-24T08:56:10Z"
}</pre>
</div>
<div class="section" id="GetStackMetadata__section293071319215"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackMetadata__en-us_topic_0000001709159306_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="GetStackMetadata__row782851318219"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="GetStackMetadata__p15930171311217">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="GetStackMetadata__p179309137217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="GetStackMetadata__row10828101332114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p179301813192117">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p16930201302117">Stack metadata obtained.</p>
</td>
</tr>
<tr id="GetStackMetadata__row19828171310214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p2093051319211">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p7930141332116">Invalid request.</p>
</td>
</tr>
<tr id="GetStackMetadata__row17828121316214"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p3930191310215">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p11930201319214">Authentication failed.</p>
</td>
</tr>
<tr id="GetStackMetadata__row9828813152111"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p14930141312116">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p1093031312213">The user does not have the permission to call this API.</p>
</td>
</tr>
<tr id="GetStackMetadata__row12828513152114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p693081302117">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p99301513142120">The stack does not exist.</p>
</td>
</tr>
<tr id="GetStackMetadata__row98288134218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p2093018138214">429</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p1193015135215">Too frequent requests.</p>
</td>
</tr>
<tr id="GetStackMetadata__row15828313192112"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackMetadata__p1930101372113">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackMetadata__p693081382114">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_300000000.html">Stacks</a></div>
</div>
</div>
View Git Blame Copy Permalink