vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_06_0005.html
Ru, Li Yi 37b97ffc06 geminidb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-07-04 11:26:33 +00:00

143 lines
10 KiB
HTML
Raw Blame History

<a name="nosql_06_0005"></a><a name="nosql_06_0005"></a>
<h1 class="topictitle1">Applying a Parameter Template</h1>
<div id="body48542055141011"><div class="section" id="nosql_06_0005__section885418552109"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0005__p2854155531018">This API is used to apply a parameter template to one or more instances.</p>
</div>
<div class="section" id="nosql_06_0005__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0005__p12792357124410">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_06_0005__p13736514459">This API is an asynchronous API. A successful response does not indicate that the parameter template is successfully applied.</p>
</div>
<div class="section" id="nosql_06_0005__section48594558107"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0005__p08591955101013">PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__table1986265591018" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0005__row386065551019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0005__p4862175571012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_06_0005__p8862175513103">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_06_0005__p13863195514107">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_06_0005__p786365510105">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0005__row10861135511016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0005__p17863185512101">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0005__p58642555105">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0005__p1864655151016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0005__p16864155511107">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="nosql_06_0005__row786185501016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0005__p2865125531018">config_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0005__p148651555106">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0005__p1865155591014">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0005__p17865175515109">Parameter template ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0005__section188661455121016"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0005__row1866205521017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0005__p98671855151016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0005__p686715581017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0005__p186815556104">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0005__p586845501013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0005__row158661455131017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0005__p186811553105">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0005__p486845518107">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0005__p6869185511100">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0005__p18869205510103">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__request_ApplyConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0005__row1786975541020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0005__p98701155121016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_06_0005__p1487095512107">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_06_0005__p887165518107">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_06_0005__p12871105541018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0005__row686914553103"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0005__p487145519104">instance_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0005__p087112556103">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0005__p17872955101020">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0005__p1787214556103">Instance IDs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0005__section168721755111014"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0005__p587319557101"><strong id="nosql_06_0005__b12293193191519">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0005__response_ApplyConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0005__row1587375581017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0005__p14874125515107">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_06_0005__p19874105515105">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_06_0005__p20875145511104">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0005__row18737554100"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0005__p187575517109">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0005__p1687685551016">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0005__p6876135511102">ID of the asynchronous task that applies the parameter template.</p>
</td>
</tr>
<tr id="nosql_06_0005__row7873125513100"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0005__p28761455101012">success</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0005__p4877105519100">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0005__p12877135510109">Whether the task for applying the parameter template is successfully submitted. The value can be:</p>
<ul id="nosql_06_0005__ul887711553108"><li id="nosql_06_0005__li1987765571016"><strong id="nosql_06_0005__b914862372311">true</strong>, indicating the task is successfully submitted.</li><li id="nosql_06_0005__li17877955171018"><strong id="nosql_06_0005__b2016916295234">false</strong>, indicating the task fails to be submitted.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0005__section1187817553101"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0005__ul1878355151012"><li id="nosql_06_0005__li3797195210233">URI example<pre class="screen" id="nosql_06_0005__screen11797145282313">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply</pre>
</li><li id="nosql_06_0005__li38791655151014">Applying a Parameter Template<pre class="screen" id="nosql_06_0005__screen138802552102">{
"instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0005__section5880355111018"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0005__p4881855131019"><strong id="nosql_06_0005__b12572258182313">Status code: 200</strong></p>
<p id="nosql_06_0005__p168812558109">Success</p>
<pre class="screen" id="nosql_06_0005__screen288145501013">{
"job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
"success" : true
}</pre>
</div>
<div class="section" id="nosql_06_0005__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0005__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0005__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0005__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Parameter Templates</a></div>
</div>
</div>
View Git Blame Copy Permalink