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

682 lines
56 KiB
HTML
Raw Blame History

<a name="CreateStack"></a><a name="CreateStack"></a>
<h1 class="topictitle1">Creating a Stack</h1>
<div id="body8662426"><div class="section" id="CreateStack__section14871314152116"><h4 class="sectiontitle">Function</h4><p id="CreateStack__p28718147213">CreateStack creates a stack.</p>
<ul id="CreateStack__ul98781414215"><li id="CreateStack__li687514202115">If template, vars, and other information are not included in the request, an empty stack will be created and stack_id will be returned.</li><li id="CreateStack__li188716142218">If template, vars, and other information are included in the request, a stack will be created and stack_id and deployment_id will be returned.</li></ul>
</div>
<div class="section" id="CreateStack__section20871414202113"><h4 class="sectiontitle">URI</h4><p id="CreateStack__p19889142212">POST /v1/{project_id}/stacks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table188614162111" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateStack__row168810140218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateStack__p688111417219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateStack__p5897141217">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateStack__p2892148214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateStack__p1189121416212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row288161417215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateStack__p789121417210">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateStack__p58981422110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateStack__p9891714162110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateStack__p1389414152117">A project ID is obtained by calling an API or from the console.</p>
<p id="CreateStack__p68981416215">Minimum: <strong id="CreateStack__b989181412112">3</strong></p>
<p id="CreateStack__p28941432113">Maximum: <strong id="CreateStack__b1489141472116">64</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateStack__section490121482114"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateStack__row79051412216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateStack__p17901414172120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateStack__p190514122119">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateStack__p1590111414219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateStack__p1991111442119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row9902145213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateStack__p8913141218">Client-Request-Id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateStack__p209117146211">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateStack__p169113145212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateStack__p1191161415214">A unique request ID is specified by a user to locate a request. UUID is recommended.</p>
<p id="CreateStack__p179191415212">Minimum: <strong id="CreateStack__b5913146213">36</strong></p>
<p id="CreateStack__p1391141419215">Maximum: <strong id="CreateStack__b691181414218">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_request_CreateStackRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateStack__row14911714112116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateStack__p2921014142116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateStack__p7931114112116">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateStack__p9935148218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateStack__p9931414172120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row1391314192119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p1993161417213">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p7938140214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p139391432112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p99371422113">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="CreateStack__p99351417211">Minimum: <strong id="CreateStack__b4931114142114">1</strong></p>
<p id="CreateStack__p7931914172115">Maximum: <strong id="CreateStack__b29315143211">128</strong></p>
</td>
</tr>
<tr id="CreateStack__row109221482112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p1393514162116">agencies</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p1393111482117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p693614122116">Array of <a href="#CreateStack__en-us_topic_0000001709318802_request_Agency">Agency</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p1931114172115">Agency information.</p>
<p id="CreateStack__p1594171410211">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="CreateStack__p119451418214">Array Length: <strong id="CreateStack__b394121410219">0 - 10</strong></p>
</td>
</tr>
<tr id="CreateStack__row169216148213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p494191413210">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p59431402111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p79414148216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p169481472113">Description of a stack. It can be used by customers to identify their own stacks.</p>
<p id="CreateStack__p18941214162119">Minimum: <strong id="CreateStack__b09421416213">0</strong></p>
<p id="CreateStack__p109414142218">Maximum: <strong id="CreateStack__b1694151410211">1024</strong></p>
</td>
</tr>
<tr id="CreateStack__row1292121422115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p16947145218">enable_deletion_protection</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p494614142120">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p194151419218">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p694191410214">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="CreateStack__p169412143215"><em id="CreateStack__i29461462114">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="CreateStack__row59210142213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p179417149212">enable_auto_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p594181432115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p18941714122111">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p994161418216">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="CreateStack__p294201432111"><em id="CreateStack__i1195101410219">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="CreateStack__i1895131452113">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="CreateStack__row129241472110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p495141452118">template_body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p89571412114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p8951314202112">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p2095171462115">HCL template. It describes the target status of a resource. RFS compares the differences between the statuses of this template and the current remote resources.</p>
<p id="CreateStack__p1195161411218">Either template_body or template_uri must be specified but they both cannot be specified together.</p>
<p id="CreateStack__p119531420217"><em id="CreateStack__i19951214152115">In the CreateStack API, template_body and template_uri are optional.</em></p>
<p id="CreateStack__p1195314162115"><strong id="CreateStack__b109591412120">Note:</strong></p>
<ul id="CreateStack__ul109519145219"><li id="CreateStack__li795121411215">template_body cannot contain any sensitive information. RFS directly uses, logs, displays, and stores the corresponding template_body in plaintext. If the information is sensitive, you are advised to use vars_structure to change the information to a variable and set the encryption field to enable encrypted transmission.</li></ul>
<p id="CreateStack__p1395121412214">Minimum: <strong id="CreateStack__b1595111492112">0</strong></p>
<p id="CreateStack__p16951514102115">Maximum: <strong id="CreateStack__b17951414132116">51200</strong></p>
</td>
</tr>
<tr id="CreateStack__row199211413219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p2095171415210">template_uri</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p99510145212">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p89561413212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p109531452118">OBS address of an HCL template. The template describes the target status of a resource. RFS compares the differences between the statuses of this template and the current remote resources.</p>
<p id="CreateStack__p8956144214">The OBS address allows mutual access to regions of the same type. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.</p>
<p id="CreateStack__p15951714142118">The corresponding file must be a tf file or a zip package.</p>
<p id="CreateStack__p2095101415219">A pure .tf file must end with .tf or .tf.json and comply with the HCL syntax.</p>
<p id="CreateStack__p1196714182113">Currently, only the .zip package is supported. The file name extension must be .zip. The decompressed file cannot contain the .tfvars file and must be encoded in UTF8 format (the .tf.json file cannot contain the BOM header). The .zip package supports a maximum of 100 subfiles.</p>
<p id="CreateStack__p14961714102115">Either template_body or template_uri must be specified.</p>
<p id="CreateStack__p15964148212"><em id="CreateStack__i189631442110">In the CreateStack API, template_body and template_uri are optional.</em></p>
<p id="CreateStack__p209631422116"><strong id="CreateStack__b19961314132111">Note</strong>:</p>
<ul id="CreateStack__ul596314152120"><li id="CreateStack__li1696201420217">The template file corresponds to template_uri cannot contain any sensitive information. RFS directly uses, logs, displays, and stores the content of the template file in plaintext. If the information is sensitive, you are advised to use vars_structure to change the information to a variable and set the encryption field to enable encrypted transmission.</li><li id="CreateStack__li79611412116">If the template file corresponding to template_uri is of zip type, the length of the internal file or folder name must not exceed 255 bytes, the length of the deepest path must not exceed 2048 bytes, and the size of the zip package must not exceed 1MB.</li></ul>
<p id="CreateStack__p149651420218">Minimum: <strong id="CreateStack__b1896171482115">0</strong></p>
<p id="CreateStack__p1396111411215">Maximum: <strong id="CreateStack__b129631422113">2048</strong></p>
</td>
</tr>
<tr id="CreateStack__row19921214152111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p1096141416216">vars_body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p18963145211">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p1996214142116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p13963144219">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="CreateStack__ul1296181415213"><li id="CreateStack__li11961314142110">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="CreateStack__li1896614102118">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="CreateStack__li1696214152117">If vars_body is too large, you can use vars_uri.</li><li id="CreateStack__li396171414211">If the content in vars is simple strings, you can use var_structure.</li><li id="CreateStack__li99619141218">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="CreateStack__p129741422111">Minimum: <strong id="CreateStack__b1297414142119">0</strong></p>
<p id="CreateStack__p1097171414218">Maximum: <strong id="CreateStack__b397171416213">51200</strong></p>
</td>
</tr>
<tr id="CreateStack__row1292121416219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p14971714112113">vars_structure</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p597131419218">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p89781414215">Array of <a href="#CreateStack__en-us_topic_0000001709318802_request_VarsStructure">VarsStructure</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p2971214102111">HCL variable structure. Transferring variables is supported by the HCL template. The same template can use different variables for different purposes.</p>
<ul id="CreateStack__ul139719149213"><li id="CreateStack__li1197171410211">var_structure allows string variables.</li><li id="CreateStack__li997114182120">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="CreateStack__li497191410214">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="CreateStack__li497114132114">If vars_structure is too large, you can use vars_uri.</li><li id="CreateStack__li49741432115">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="CreateStack__p18971314182117">Array Length: <strong id="CreateStack__b1597914172114">0 - 100</strong></p>
</td>
</tr>
<tr id="CreateStack__row692151452116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateStack__p159741416211">vars_uri</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateStack__p797171472110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateStack__p697414102119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateStack__p209801414213">OBS address of the HCL variable file. Transferring variables is supported by the HCL template. The same template can use different variables for different purposes.</p>
<p id="CreateStack__p8982014132112">The OBS address allows mutual access to regions of the same type. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.</p>
<ul id="CreateStack__ul119891442115"><li id="CreateStack__li159891422117">RFS supports vars_structure, vars_body, and vars_uri. If they declare the same variable, error code 400 will be reported.</li><li id="CreateStack__li1298161442120">The content in vars_uri uses the tfvars format of HCL. You can save the content in .tfvars to a file, upload the file to OBS, and transfer the pre-signed URL of OBS to vars_uri.</li><li id="CreateStack__li1798171415214">vars_uri 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="CreateStack__p169851417210">Minimum: <strong id="CreateStack__b698151492117">0</strong></p>
<p id="CreateStack__p17981414152113">Maximum: <strong id="CreateStack__b15981814202116">2048</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateStack__en-us_topic_0000001709318802_request_Agency"></a><a name="en-us_topic_0000001709318802_request_Agency"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_request_Agency" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Agency</caption><thead align="left"><tr id="CreateStack__row1598214192112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateStack__p10984142212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateStack__p99861432117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateStack__p398414132116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateStack__p1699121482115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row209851415217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateStack__p1399101422113">provider_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateStack__p699181462119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateStack__p199951422114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateStack__p1399414152117">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="CreateStack__p59921412213">Minimum: <strong id="CreateStack__b18991114152116">1</strong></p>
<p id="CreateStack__p139916145211">Maximum: <strong id="CreateStack__b9991014182113">128</strong></p>
</td>
</tr>
<tr id="CreateStack__row29831472112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateStack__p149991482119">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateStack__p16991144219">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateStack__p699151422118">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateStack__p179931417215">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="CreateStack__p899131452118">Minimum: <strong id="CreateStack__b1299514132117">1</strong></p>
<p id="CreateStack__p11991414182120">Maximum: <strong id="CreateStack__b129971415215">64</strong></p>
</td>
</tr>
<tr id="CreateStack__row169871472113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateStack__p1599214132111">agency_urn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateStack__p1799131413217">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateStack__p3995148210">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateStack__p09981419213">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>
<div class="tablenoborder"><a name="CreateStack__en-us_topic_0000001709318802_request_VarsStructure"></a><a name="en-us_topic_0000001709318802_request_VarsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_request_VarsStructure" frame="border" border="1" rules="all"><caption><b>Table 5 </b>VarsStructure</caption><thead align="left"><tr id="CreateStack__row151006142219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateStack__p210041432119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateStack__p15100151414213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateStack__p5100114172118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateStack__p151002149211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row91001514192112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateStack__p51003144219">var_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateStack__p41001414132112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateStack__p610111149219">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateStack__p310121452118">Variable name.</p>
<p id="CreateStack__p7101191452120">Minimum: <strong id="CreateStack__b1010111146217">1</strong></p>
<p id="CreateStack__p71011714112110">Maximum: <strong id="CreateStack__b710118142219">32</strong></p>
</td>
</tr>
<tr id="CreateStack__row141008148216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateStack__p410131412210">var_value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateStack__p1210151422118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateStack__p6101414142119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateStack__p11011314122112">Variable value.</p>
<p id="CreateStack__p1310115146217">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="CreateStack__p2101214122119">For different types or complex structures, you can use vars_uri or vars_body.</p>
<p id="CreateStack__p7101101422111">Minimum: <strong id="CreateStack__b11011614182119">0</strong></p>
<p id="CreateStack__p171011914142115">Maximum: <strong id="CreateStack__b19101161412112">2048</strong></p>
</td>
</tr>
<tr id="CreateStack__row8100121422116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateStack__p12101414102111">encryption</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateStack__p20101151413216">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateStack__p91011614182111"><a href="#CreateStack__en-us_topic_0000001709318802_request_EncryptionStructure">EncryptionStructure</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateStack__p121011014182117">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="CreateStack__en-us_topic_0000001709318802_request_EncryptionStructure"></a><a name="en-us_topic_0000001709318802_request_EncryptionStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_request_EncryptionStructure" frame="border" border="1" rules="all"><caption><b>Table 6 </b>EncryptionStructure</caption><thead align="left"><tr id="CreateStack__row161021414152115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="CreateStack__p3102314152116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="CreateStack__p510251418213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="CreateStack__p1610281452113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="CreateStack__p11102151413219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row1010213146214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateStack__p1710291482119">kms</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateStack__p31025147219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateStack__p21021314152113"><a href="#CreateStack__en-us_topic_0000001709318802_request_KmsStructure">KmsStructure</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateStack__p191023143212">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="CreateStack__p0103141472118"><strong id="CreateStack__b1010311413216">Note:</strong></p>
<ul id="CreateStack__ul17103131402119"><li id="CreateStack__li1110381410215">The agency you specify for RFS should have the operation permissions on the specified key ID.</li><li id="CreateStack__li114707491874">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="CreateStack__li1810311482119">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="CreateStack__en-us_topic_0000001709318802_request_KmsStructure"></a><a name="en-us_topic_0000001709318802_request_KmsStructure"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_request_KmsStructure" frame="border" border="1" rules="all"><caption><b>Table 7 </b>KmsStructure</caption><thead align="left"><tr id="CreateStack__row16103714102110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="CreateStack__p16103201452112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="CreateStack__p4103191412213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="CreateStack__p81036147215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="CreateStack__p11041714182113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row710381419216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateStack__p18104161492114">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateStack__p121043146210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateStack__p1710418147213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateStack__p41041914182119">KMS key ID is used by RFS during decryption. Generally, the key ID is that used for encryption.</p>
<p id="CreateStack__p1710461432113">Minimum: <strong id="CreateStack__b14104171492117">36</strong></p>
<p id="CreateStack__p1710441419218">Maximum: <strong id="CreateStack__b1310451422113">36</strong></p>
</td>
</tr>
<tr id="CreateStack__row12103121418210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="CreateStack__p1110401472119">cipher_text</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="CreateStack__p8254131482120">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="CreateStack__p92542144218">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="CreateStack__p202541148217">Ciphertext of data encryption key.</p>
<p id="CreateStack__p2025401492113">Minimum: <strong id="CreateStack__b1825418141219">2</strong></p>
<p id="CreateStack__p62541114112119">Maximum: <strong id="CreateStack__b825419142211">2048</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateStack__section0254151418212"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateStack__p132551414202116"><strong id="CreateStack__b11255814122120">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_response_CreateStackResponseBody" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row31057145211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateStack__p6255101452112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateStack__p132551614162110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateStack__p12255171410217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row20105614172119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateStack__p725591410215">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateStack__p14255514132113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateStack__p1425518146213">Unique stack ID.</p>
<p id="CreateStack__p172551414142116">It is a UUID generated by RFS when a stack is created.</p>
<p id="CreateStack__p12255514102112">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="CreateStack__p425514145215">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="CreateStack__p52551814112114">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="CreateStack__p425581415217">Minimum: <strong id="CreateStack__b12255141418213">36</strong></p>
<p id="CreateStack__p0255101422117">Maximum: <strong id="CreateStack__b22551514192114">36</strong></p>
</td>
</tr>
<tr id="CreateStack__row2105714112118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateStack__p125551432116">deployment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateStack__p14255181412214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateStack__p6255314102113">Deployment ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p825511147218"><strong id="CreateStack__b12255121482110">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_response_CommonErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row141066141219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="CreateStack__p16255814192111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="CreateStack__p142556146212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="CreateStack__p6255121452120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row4106314162117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateStack__p19255414132110">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateStack__p925541416218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateStack__p152551314122110">Response code.</p>
<p id="CreateStack__p142551514172111">Minimum: <strong id="CreateStack__b16255614112110">11</strong></p>
<p id="CreateStack__p0255714162115">Maximum: <strong id="CreateStack__b925561472118">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row181066144210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateStack__p725561422119">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateStack__p7255014142110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateStack__p1025520148216">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row1810691419219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateStack__p14255214112112">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateStack__p112551314132114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateStack__p10256171418215">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p16256141410214"><strong id="CreateStack__b72561814162117">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table61079142217" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row310713149215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="CreateStack__p82561114112111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="CreateStack__p72561314202118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="CreateStack__p19256191412117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row10107181482112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateStack__p425611413214">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateStack__p132566146212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateStack__p1925617145217">Response code.</p>
<p id="CreateStack__p725601411213">Minimum: <strong id="CreateStack__b625631415219">11</strong></p>
<p id="CreateStack__p1225611148211">Maximum: <strong id="CreateStack__b15256101482112">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row19107171410213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateStack__p1425601411212">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateStack__p152562140218">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateStack__p12561314182112">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row11107614102113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateStack__p172561814192117">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateStack__p1825641472119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateStack__p725681410213">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p192561814102111"><strong id="CreateStack__b102561714162118">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table310851415218" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row010810147217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="CreateStack__p18256131472115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="CreateStack__p1325641472119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="CreateStack__p1825651492113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row191081214102120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateStack__p182561514142119">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateStack__p14256131415214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateStack__p13256171462116">Response code.</p>
<p id="CreateStack__p7256151472119">Minimum: <strong id="CreateStack__b142561014132114">11</strong></p>
<p id="CreateStack__p19256114182112">Maximum: <strong id="CreateStack__b18256101417215">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row151081314132117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateStack__p19256121422118">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateStack__p5256014162117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateStack__p1325661420215">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row21081014172110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateStack__p2256111412217">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateStack__p18256414192118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateStack__p12256614162114">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p5256814102113"><strong id="CreateStack__b182561614122111">Status code: 409</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table1109171452116" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row1611071442115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="CreateStack__p52571814202114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="CreateStack__p22571614142118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="CreateStack__p13257714172113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row2110131419211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateStack__p025720144213">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateStack__p4257214112112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateStack__p9257114192111">Response code.</p>
<p id="CreateStack__p192571614172116">Minimum: <strong id="CreateStack__b142571714172116">11</strong></p>
<p id="CreateStack__p42571114122118">Maximum: <strong id="CreateStack__b122570146212">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row311013148217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateStack__p112575147216">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateStack__p8257101492117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateStack__p02571814152119">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row19110161422110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateStack__p15257131412114">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateStack__p62571714172113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateStack__p1525715147211">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p1325716143216"><strong id="CreateStack__b32571714162118">Status code: 429</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table4111101422113" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row14111414132116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="CreateStack__p1625731472118">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="CreateStack__p1825751492113">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="CreateStack__p125751410219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row5111121452119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateStack__p1325701482117">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateStack__p42571214182110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateStack__p825712145218">Response code.</p>
<p id="CreateStack__p42571514152113">Minimum: <strong id="CreateStack__b16257214122111">11</strong></p>
<p id="CreateStack__p42571514132110">Maximum: <strong id="CreateStack__b32571714122111">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row711131442118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateStack__p8257914142113">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateStack__p122571114202112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateStack__p15257191410218">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row1211191410213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateStack__p112574145211">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateStack__p0257714132115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateStack__p19257141432114">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateStack__p12257181442111"><strong id="CreateStack__b1525701402118">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__table1511220148211" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Response body parameters</caption><thead align="left"><tr id="CreateStack__row31121514172112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="CreateStack__p625720148210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="CreateStack__p1425751432112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="CreateStack__p9257151419213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row111221414217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="CreateStack__p162578147214">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="CreateStack__p7257151413219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="CreateStack__p2257714132111">Response code.</p>
<p id="CreateStack__p2025711416216">Minimum: <strong id="CreateStack__b14257914102111">11</strong></p>
<p id="CreateStack__p192578146217">Maximum: <strong id="CreateStack__b18257181462114">11</strong></p>
</td>
</tr>
<tr id="CreateStack__row4112814102116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="CreateStack__p11257131412217">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="CreateStack__p14257151414212">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="CreateStack__p525711419218">Response message.</p>
</td>
</tr>
<tr id="CreateStack__row711214141214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="CreateStack__p17257181417212">encoded_authorization_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="CreateStack__p18257141410215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="CreateStack__p6257191422111">The message contains information about unauthorized requests.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateStack__section192583143211"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateStack__ul10258414112115"><li id="CreateStack__li1225891414213">Create a stack.<pre class="screen" id="CreateStack__screen1225818148218">POST https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks
{
"stack_name" : "my_first_stack",
"description" : "my first stack"
}</pre>
</li><li id="CreateStack__li17258161418212">Create a stack using an agency.<pre class="screen" id="CreateStack__screen112588145215">POST https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks
{
"stack_name" : "my_second_stack",
"description" : "my second stack",
"agencies" : [ {
"provider_name" : "opentelekomcloud",
"agency_name" : "my_agency"
} ]
}</pre>
</li><li id="CreateStack__li8258121482112">Create and deploy a stack using a template.<pre class="screen" id="CreateStack__screen16258514102118">{
"stack_name" : "my_fourth_stack",
"template_body" : "terraform {\n required_providers {\n opentelekomcloud = {\n source = \"opentelekomcloud/provider/opentelekomcloud\"\n version = \"1.35.13\"\n }\n }\n}\nprovider \"opentelekomcloud\"{\n insecure = true\n cloud = \"{cloud_name}\"\n region = \"{region}\"\n endpoints = {\n iam = \"{iam_endpoint}\",\n }\n}\n\nresource \"opentelekomcloud_vpc_v1\" \"vpc\" {\n cidr = \"172.16.0.0/16\"\n name = \"my_vpc\"\n}",
"description" : "my third stack"
}</pre>
</li></ul>
</div>
<div class="section" id="CreateStack__section132582143218"><h4 class="sectiontitle">Example Responses</h4><p id="CreateStack__p5258181452112"><strong id="CreateStack__b2025861492115">Status code: 201</strong></p>
<p id="CreateStack__p725881410214">Stack created.</p>
<pre class="screen" id="CreateStack__screen1625881414216">{
"stack_id" : "ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2"
}</pre>
</div>
<div class="section" id="CreateStack__section1425871422119"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateStack__en-us_topic_0000001709318802_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateStack__row12115171462111"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateStack__p4258314102110">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateStack__p12258191462116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateStack__row3115121419210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p725811472111">201</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p9258614122120">Stack created.</p>
</td>
</tr>
<tr id="CreateStack__row011541411215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p825816149215">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p10258191418212">Invalid request.</p>
</td>
</tr>
<tr id="CreateStack__row18115714112120"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p142583149211">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p62581814112120">Authentication failed.</p>
</td>
</tr>
<tr id="CreateStack__row911521418216"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p5258014162116">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><ol id="CreateStack__ol112581214182114"><li id="CreateStack__li0258101432112">The user does not have the permission to call this API.</li><li id="CreateStack__li142581514132117">Too many stacks.</li></ol>
</td>
</tr>
<tr id="CreateStack__row9115014132114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p3258201419218">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p4258171413217">Request conflict. Another stack with the same name already exists.</p>
</td>
</tr>
<tr id="CreateStack__row191151143211"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p6258161432117">429</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p17258151413213">Too frequent requests.</p>
</td>
</tr>
<tr id="CreateStack__row811511146218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateStack__p6258111452113">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateStack__p1825915149217">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