vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/gaussdb_mysql/api-ref/SetGaussMySqlProxyWeight.html
Hasko, Vladimir c1056e5100 Recreating PR 
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-07-11 13:57:29 +00:00

245 lines
18 KiB
HTML
Raw Permalink Blame History

<a name="SetGaussMySqlProxyWeight"></a><a name="SetGaussMySqlProxyWeight"></a>
<h1 class="topictitle1">Assigning Read Weights</h1>
<div id="body8662426"><div class="section" id="SetGaussMySqlProxyWeight__section1334882844911"><h4 class="sectiontitle">Function</h4><p id="SetGaussMySqlProxyWeight__p123481528134912">This API is used to assign read weights for nodes. Being using this API:</p>
<ul id="SetGaussMySqlProxyWeight__ul15431748144314"><li id="SetGaussMySqlProxyWeight__li15543848174310">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="SetGaussMySqlProxyWeight__li1854318482437">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section1634882814910"><h4 class="sectiontitle">URI</h4><p id="SetGaussMySqlProxyWeight__p1034811286492">PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/weight</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__table0349628184917" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row4349828204917"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="SetGaussMySqlProxyWeight__p1234952894915">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="SetGaussMySqlProxyWeight__p33499283499">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="SetGaussMySqlProxyWeight__p1634942884919">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="SetGaussMySqlProxyWeight__p7350428184912">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row7349102810496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p935002815492">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p1335072816498">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p435072814915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p1435022817498">Project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row11349228144919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p6350202874910">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p183501428124919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p235032818492">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p1635011281497">DB instance ID, which is compliant with the UUID format.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row17349112884919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p4351102818492">proxy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p133511128164914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p173511289490">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p16351828194917">Database proxy ID, which is compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section3351162894911"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row103511328154914"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="SetGaussMySqlProxyWeight__p113521828104918">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="SetGaussMySqlProxyWeight__p123521128124916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="SetGaussMySqlProxyWeight__p1535242812492">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="SetGaussMySqlProxyWeight__p2035262812493">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row43512280495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p03528281499">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p335282864913">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p15352228114916">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p035312864910">User token.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row735113285498"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p635312281498">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p335382884919">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p16353142864919">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p7353122844912">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_request_TaurusModifyProxyWeightRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row18353192814497"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="SetGaussMySqlProxyWeight__p18354182817493">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="SetGaussMySqlProxyWeight__p1635416285494">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="SetGaussMySqlProxyWeight__p63549283493">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="SetGaussMySqlProxyWeight__p193548280496">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row1535322834913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p0354122811493">master_weight</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p4354172816499">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p193549285495">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p23551628184912">Weight of the primary node.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row735352813499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p1235532811496">readonly_nodes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p0355628134913">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p113551288493">Array of <a href="#SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_request_TaurusModifyProxyWeightReadonlyNode">TaurusModifyProxyWeightReadonlyNode</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p173555284497">Weight information of the read replicas.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_request_TaurusModifyProxyWeightReadonlyNode"></a><a name="en-us_topic_0000001362641517_request_TaurusModifyProxyWeightReadonlyNode"></a><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_request_TaurusModifyProxyWeightReadonlyNode" frame="border" border="1" rules="all"><caption><b>Table 4 </b>TaurusModifyProxyWeightReadonlyNode</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row1935511284493"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="SetGaussMySqlProxyWeight__p17356128154916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="SetGaussMySqlProxyWeight__p1735612884914">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="SetGaussMySqlProxyWeight__p1235642854915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="SetGaussMySqlProxyWeight__p33563286490">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row11355102814912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p1735682894916">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p203561728184920">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p1035622815493">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p33572283494">Read replica ID.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row1235522814495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="SetGaussMySqlProxyWeight__p5357928184916">weight</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="SetGaussMySqlProxyWeight__p12357028174913">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="SetGaussMySqlProxyWeight__p15357122824913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="SetGaussMySqlProxyWeight__p20357152894915">Weight of the read replica.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section33579284496"><h4 class="sectiontitle">Response Parameters</h4><p id="SetGaussMySqlProxyWeight__p3357528114920"><strong id="SetGaussMySqlProxyWeight__b435732814499">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row735822815498"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="SetGaussMySqlProxyWeight__p12358112812496">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="SetGaussMySqlProxyWeight__p14358202834918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="SetGaussMySqlProxyWeight__p2035822894911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row935872824912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="SetGaussMySqlProxyWeight__p173582282496">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="SetGaussMySqlProxyWeight__p4358728124915">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="SetGaussMySqlProxyWeight__p235922815491">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="SetGaussMySqlProxyWeight__p133591228124917"><strong id="SetGaussMySqlProxyWeight__b173592289491">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__en-us_topic_0000001362641517_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row14359228174918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="SetGaussMySqlProxyWeight__p163592285498">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="SetGaussMySqlProxyWeight__p19359152854911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="SetGaussMySqlProxyWeight__p11360628144915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row123591728114915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="SetGaussMySqlProxyWeight__p1336082844919">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="SetGaussMySqlProxyWeight__p336017281499">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="SetGaussMySqlProxyWeight__p13607289495">Error code.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row193593287493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="SetGaussMySqlProxyWeight__p12360182819494">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="SetGaussMySqlProxyWeight__p2360102812495">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="SetGaussMySqlProxyWeight__p1036019284497">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="SetGaussMySqlProxyWeight__p136022812495"><strong id="SetGaussMySqlProxyWeight__b18360132884914">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="SetGaussMySqlProxyWeight__table636082810492" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="SetGaussMySqlProxyWeight__row1736119283498"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="SetGaussMySqlProxyWeight__p20361112854914">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="SetGaussMySqlProxyWeight__p9361428114914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="SetGaussMySqlProxyWeight__p7361928134912">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="SetGaussMySqlProxyWeight__row4361172813498"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="SetGaussMySqlProxyWeight__p1936118281491">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="SetGaussMySqlProxyWeight__p33614280497">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="SetGaussMySqlProxyWeight__p636292812493">Error code.</p>
</td>
</tr>
<tr id="SetGaussMySqlProxyWeight__row153611828144913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="SetGaussMySqlProxyWeight__p203621928104910">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="SetGaussMySqlProxyWeight__p1336222804919">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="SetGaussMySqlProxyWeight__p63624281498">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section0362162874919"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="SetGaussMySqlProxyWeight__screen836215288495">
PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/weight
{
"master_weight" : 100
}</pre>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section1336312288496"><h4 class="sectiontitle">Example Response</h4><p id="SetGaussMySqlProxyWeight__p6363172820494"><strong id="SetGaussMySqlProxyWeight__b17363182874917">Status code: 200</strong></p>
<p id="SetGaussMySqlProxyWeight__p5363182815494">Success.</p>
<pre class="screen" id="SetGaussMySqlProxyWeight__screen336322811495">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87c11411890"
}</pre>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="SetGaussMySqlProxyWeight__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="SetGaussMySqlProxyWeight__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="SetGaussMySqlProxyWeight__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="topic_300000006.html">Database Proxy</a></div>
</div>
</div>
View Git Blame Copy Permalink