yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
14cbe517527a516f7d70b121f4bf6f28273b6dcc
doc-exports/docs/taurusdb/api-ref/UpdateInstanceConfigurations.html
wangdengke2 ee9f8aa0b6 taurusdb_api 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-10-30 15:48:33 +00:00

211 lines
16 KiB
HTML
Raw Blame History

<a name="UpdateInstanceConfigurations"></a><a name="UpdateInstanceConfigurations"></a>
<h1 class="topictitle1">Modifying Parameters of a Specified Instance</h1>
<div id="body0000002391969793"><div class="section" id="UpdateInstanceConfigurations__section1315124054319"><h4 class="sectiontitle">Function</h4><p id="UpdateInstanceConfigurations__p1152154014434">This API is used to modify parameters of a specified instance. Before calling this API:</p>
<ul id="UpdateInstanceConfigurations__ul924420236520"><li id="UpdateInstanceConfigurations__gaussdb_04_0001_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="UpdateInstanceConfigurations__gaussdb_04_0001_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="UpdateInstanceConfigurations__section1715344016439"><h4 class="sectiontitle">URI</h4><p id="UpdateInstanceConfigurations__p14153114012438">PUT /v3/{project_id}/instances/{instance_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__table17135171922513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row013461992512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateInstanceConfigurations__p8135161915254">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateInstanceConfigurations__p113621916257">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateInstanceConfigurations__p17136201992515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateInstanceConfigurations__p1613671982511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row1913421914254"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateInstanceConfigurations__p11443574517">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateInstanceConfigurations__p16441856454">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateInstanceConfigurations__p3441855459">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateInstanceConfigurations__p18830181310462">Project ID of a tenant in a region.</p>
<p id="UpdateInstanceConfigurations__p118301913154617">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="UpdateInstanceConfigurations__row5135131913258"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateInstanceConfigurations__p1313812195257">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateInstanceConfigurations__p16139119182520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateInstanceConfigurations__p161391319172516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateInstanceConfigurations__p18782229202115">Instance ID, which uniquely identifies an instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateInstanceConfigurations__section115917403438"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row1160154074315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateInstanceConfigurations__p1616111407435">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateInstanceConfigurations__p716114019431">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateInstanceConfigurations__p1161340134318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateInstanceConfigurations__p1516210402434">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row1483204311243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateInstanceConfigurations__p4284114710242">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateInstanceConfigurations__p428494711247">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateInstanceConfigurations__p102841647152420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateInstanceConfigurations__p15832443152410">User token.</p>
</td>
</tr>
<tr id="UpdateInstanceConfigurations__row1239491795010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateInstanceConfigurations__p15219192555010">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateInstanceConfigurations__p5219125125014">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateInstanceConfigurations__p1821932545017">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateInstanceConfigurations__p109805581457">Content type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__request_UpdateInstanceConfigurationsRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row16168134044318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateInstanceConfigurations__p9169240124319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateInstanceConfigurations__p2169740134316">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateInstanceConfigurations__p517094016431">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateInstanceConfigurations__p1717114020434">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row216811403437"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateInstanceConfigurations__p2172104094315">parameter_values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateInstanceConfigurations__p16173940184318">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateInstanceConfigurations__p9173740174315">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateInstanceConfigurations__p3985185818518">Mapping between parameter names and parameter values. You can specify parameter values based on a default parameter template. If this parameter is not specified, the original parameter information is retained.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateInstanceConfigurations__section1317474044312"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateInstanceConfigurations__p101751240134317"><strong id="UpdateInstanceConfigurations__b11480162995911">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__response_UpdateInstanceConfigurationsResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row1617511407433"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateInstanceConfigurations__p1817614016438">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateInstanceConfigurations__p19176144018439">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdateInstanceConfigurations__p4177134074310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row21751640124310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateInstanceConfigurations__p217774094318">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateInstanceConfigurations__p181771840114311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateInstanceConfigurations__p1698615586512">ID of the task for modifying parameters of a specified instance.</p>
</td>
</tr>
<tr id="UpdateInstanceConfigurations__row81752040204319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateInstanceConfigurations__p1017818405435">restart_required</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateInstanceConfigurations__p61781240124320">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateInstanceConfigurations__p69861458454">Whether a reboot is required.</p>
<ul id="UpdateInstanceConfigurations__ul598635819519"><li id="UpdateInstanceConfigurations__li198614581652"><p id="UpdateInstanceConfigurations__p398615810510"><a name="UpdateInstanceConfigurations__li198614581652"></a><a name="li198614581652"></a><strong id="UpdateInstanceConfigurations__b1386125045915">true</strong>: yes</p>
</li><li id="UpdateInstanceConfigurations__li119867581251"><p id="UpdateInstanceConfigurations__p119861458258"><a name="UpdateInstanceConfigurations__li119867581251"></a><a name="li119867581251"></a><strong id="UpdateInstanceConfigurations__b556085535912">false</strong>: no</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateInstanceConfigurations__p15180164010434"><strong id="UpdateInstanceConfigurations__b790585775918">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row5180940124314"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdateInstanceConfigurations__p11811740114319">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdateInstanceConfigurations__p4182204064311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdateInstanceConfigurations__p1518219409432">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row9180440134310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateInstanceConfigurations__p10182104018435">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateInstanceConfigurations__p81831640174320">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateInstanceConfigurations__p518344004313">Error code.</p>
</td>
</tr>
<tr id="UpdateInstanceConfigurations__row918064010438"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateInstanceConfigurations__p161866409437">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateInstanceConfigurations__p1918614400436">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateInstanceConfigurations__p14187124010434">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateInstanceConfigurations__p7187154094315"><strong id="UpdateInstanceConfigurations__b1635247602">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateInstanceConfigurations__table91877406437" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateInstanceConfigurations__row191871840144312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdateInstanceConfigurations__p141884409438">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdateInstanceConfigurations__p51881540134318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdateInstanceConfigurations__p618974015430">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateInstanceConfigurations__row6187194034310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateInstanceConfigurations__p218904004320">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateInstanceConfigurations__p10189134014437">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateInstanceConfigurations__p4190140164316">Error code.</p>
</td>
</tr>
<tr id="UpdateInstanceConfigurations__row131881840104314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateInstanceConfigurations__p5190104020438">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateInstanceConfigurations__p2190164014435">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateInstanceConfigurations__p131911840184310">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateInstanceConfigurations__section31914408434"><h4 class="sectiontitle">Example Request</h4><p id="UpdateInstanceConfigurations__p4191134017439">Modifying parameters of a specified instance</p>
<pre class="screen" id="UpdateInstanceConfigurations__screen119212404439">
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/3ef58db3986540d19f95151309368d34in07/configurations
{
"parameter_values" : {
"max_user_connections" : "100"
}
}</pre>
</div>
<div class="section" id="UpdateInstanceConfigurations__section41931040124316"><h4 class="sectiontitle">Example Response</h4><p id="UpdateInstanceConfigurations__p919484014314"><strong id="UpdateInstanceConfigurations__b1718773410596">Status code: 200</strong></p>
<p id="UpdateInstanceConfigurations__p1319494044313">Success.</p>
<pre class="screen" id="UpdateInstanceConfigurations__screen5194124094319">{
"job_id" : "e5d698a9-d8db-47d2-bf75-3c9018f72b6f",
"restart_required" : false
}</pre>
</div>
<div class="section" id="UpdateInstanceConfigurations__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="UpdateInstanceConfigurations__gaussdb_04_0011_p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="UpdateInstanceConfigurations__section71023308817"><h4 class="sectiontitle">Error Code</h4><p id="UpdateInstanceConfigurations__gaussdb_04_0011_p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0008.html">Parameter Template Management</a></div>
</div>
</div>
View Git Blame Copy Permalink