vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_06_0006.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

146 lines
10 KiB
HTML
Raw Blame History

<a name="nosql_06_0006"></a><a name="nosql_06_0006"></a>
<h1 class="topictitle1">Modifying Parameters of a Specified Instance</h1>
<div id="body12686712181517"><div class="section" id="nosql_06_0006__section968681217152"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0006__p16687412171516">This API is used to modify parameters of a specified instance.</p>
</div>
<div class="section" id="nosql_06_0006__section9749104794719"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0006__p75701734811">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_06_0006__p182191618484">For configuration item <strong id="nosql_06_0006__b032714505249">values</strong>, you can enter system-defined parameters that allow for modification.</p>
<p id="nosql_06_0006__p4123918154817">This API is an asynchronous API. A successful response does not indicate that the parameters are successfully modified.</p>
</div>
<div class="section" id="nosql_06_0006__section18698412111518"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0006__p14699161261515">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__table77018120151" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0006__row127001912121512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0006__p2702191220154">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_0006__p2702151201520">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_0006__p17703121220156">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_0006__p770491271517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0006__row170013127150"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0006__p157061912191514">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0006__p1370761271515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0006__p6708131231519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0006__p8709212181512">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_0006__row6700141211157"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0006__p6709171291513">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0006__p127101712151516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0006__p1571131218154">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0006__p12712131213152">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0006__section97131012151512"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0006__row37146127153"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0006__p7715111221511">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_0006__p571611231514">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_0006__p571716123153">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_0006__p14718131291514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0006__row371421212152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0006__p137191412131519">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_0006__p177191612161516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0006__p157205128159">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0006__p19722812131514">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__request_UpdateInstanceConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0006__row1372371261517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0006__p5724151231518">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_0006__p12725121213155">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_0006__p37261912141516">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_0006__p47272127150">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0006__row5723111215153"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0006__p11728612141512">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0006__p1572919126152">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0006__p4729161291518">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0006__p173041221513">Parameter values defined by users based on a default parameter template.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0006__section1673115128151"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0006__p3732181212153"><strong id="nosql_06_0006__b10446175972813">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0006__response_UpdateInstanceConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0006__row2733612191517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0006__p15735612101516">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_0006__p137361712191511">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_0006__p11737111281512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0006__row273301211519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0006__p5738812191517">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0006__p1573913123153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0006__p4739121211510">ID of the asynchronous task for modifying instance parameters.</p>
</td>
</tr>
<tr id="nosql_06_0006__row9733171214158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0006__p374012124153">restart_required</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0006__p16741201281513">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0006__p174211271510">Whether the instance needs to be restarted. The value can be:</p>
<ul id="nosql_06_0006__ul57431212101516"><li id="nosql_06_0006__li474301213152"><strong id="nosql_06_0006__b868882712919">true</strong>, indicating that the instance needs to be restarted.</li><li id="nosql_06_0006__li1174441214154"><strong id="nosql_06_0006__b168944016297">false</strong>, indicating that the instance does not need to be restarted.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0006__section1674591231512"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0006__ul67481912151510"><li id="nosql_06_0006__li818514336266">URI example<pre class="screen" id="nosql_06_0006__screen71861133152618">PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations</pre>
</li><li id="nosql_06_0006__li775421215159">Modifying Parameters of a Specified Instance<pre class="screen" id="nosql_06_0006__screen2755151218156">{
"values" : {
"request_timeout_in_ms" : "10000"
}
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0006__section1975821216158"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0006__p27591412151520"><strong id="nosql_06_0006__b123911289300">Status code: 200</strong></p>
<p id="nosql_06_0006__p0760161201512">Success</p>
<pre class="screen" id="nosql_06_0006__screen11761912151510">{
"job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
"restart_required" : false
}</pre>
</div>
<div class="section" id="nosql_06_0006__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0006__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0006__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0006__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