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

206 lines
15 KiB
HTML
Raw Permalink Blame History

<a name="ExpandGaussMySqlProxy"></a><a name="ExpandGaussMySqlProxy"></a>
<h1 class="topictitle1">Adding Database Proxy Nodes</h1>
<div id="body0000001128200922"><div class="section" id="ExpandGaussMySqlProxy__section61759636"><h4 class="sectiontitle">Function</h4><p id="ExpandGaussMySqlProxy__p33831530">This API is used to add database proxy nodes.</p>
<ul id="ExpandGaussMySqlProxy__ul924420236520"><li id="ExpandGaussMySqlProxy__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ExpandGaussMySqlProxy__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li><li id="ExpandGaussMySqlProxy__li9388195110359">Database proxy is unavailable for DB instances in a DeC.</li></ul>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section1452019438719"><h4 class="sectiontitle">URI</h4><p id="ExpandGaussMySqlProxy__p1520154314715">POST /v3/{project_id}/instances/{instance_id}/proxy/enlarge</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__table155210439716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row1052012431716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ExpandGaussMySqlProxy__p8521143575">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ExpandGaussMySqlProxy__p125212043579">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ExpandGaussMySqlProxy__p55211743477">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ExpandGaussMySqlProxy__p352110431478">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row175202431779"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p155211436713">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p1521743275">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p185211343771">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p204573418817">Project ID of a tenant in a region.</p>
<p id="ExpandGaussMySqlProxy__p14451434086">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ExpandGaussMySqlProxy__row752074310711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p185227431071">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p752211431275">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p155224431170">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p352264319711">DB instance ID, which is compliant with the UUID format.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section652214315712"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row185238431171"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ExpandGaussMySqlProxy__p752315437718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ExpandGaussMySqlProxy__p75241431677">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ExpandGaussMySqlProxy__p155241443575">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ExpandGaussMySqlProxy__p12524194310718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row152310432075"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p752410431672">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p155241643576">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p3524104312717">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p1524943875">User token.</p>
</td>
</tr>
<tr id="ExpandGaussMySqlProxy__row1752384311713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p1852412431718">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p12524174311713">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p1952419431273">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p1952516431877">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__request_EnlargeProxyRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row1452516433719"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ExpandGaussMySqlProxy__p652520439716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ExpandGaussMySqlProxy__p652514311711">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ExpandGaussMySqlProxy__p1852513439712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ExpandGaussMySqlProxy__p15256433716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row05253432073"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p1052610436715">node_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p252674318720">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p105265431373">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p15261743775">The number of proxy nodes to be added. The value is an integer from 1 to 30. Restrictions: The total number of proxy nodes for an instance is no more than 32.</p>
</td>
</tr>
<tr id="ExpandGaussMySqlProxy__row85257431174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExpandGaussMySqlProxy__p5526154317716">proxy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExpandGaussMySqlProxy__p952617430712">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExpandGaussMySqlProxy__p7526114310715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExpandGaussMySqlProxy__p1552617437717">ID of the proxy instance. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, you must configure this parameter.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section35261843270"><h4 class="sectiontitle">Response Parameters</h4><p id="ExpandGaussMySqlProxy__p45262433715"><strong id="ExpandGaussMySqlProxy__b4129557322349">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row052717431713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ExpandGaussMySqlProxy__p145271431876">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ExpandGaussMySqlProxy__p185279431872">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ExpandGaussMySqlProxy__p18527124316713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row25271043571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ExpandGaussMySqlProxy__p552710434710">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ExpandGaussMySqlProxy__p195278432076">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ExpandGaussMySqlProxy__p1252720430717">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExpandGaussMySqlProxy__p6527124316715"><strong id="ExpandGaussMySqlProxy__b9218778525249">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row1852817433718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ExpandGaussMySqlProxy__p652814431174">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ExpandGaussMySqlProxy__p1852884310710">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ExpandGaussMySqlProxy__p4528543675">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row55281943673"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ExpandGaussMySqlProxy__p1052811431472">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ExpandGaussMySqlProxy__p95283431878">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ExpandGaussMySqlProxy__p10528154316718">Error code.</p>
</td>
</tr>
<tr id="ExpandGaussMySqlProxy__row2528164311710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ExpandGaussMySqlProxy__p19529114314715">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ExpandGaussMySqlProxy__p1652913431072">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ExpandGaussMySqlProxy__p11529243179">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ExpandGaussMySqlProxy__p952944314713"><strong id="ExpandGaussMySqlProxy__b1529114313716">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandGaussMySqlProxy__table752994313713" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ExpandGaussMySqlProxy__row16529543778"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ExpandGaussMySqlProxy__p11529194311712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ExpandGaussMySqlProxy__p12529343374">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ExpandGaussMySqlProxy__p753014431172">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandGaussMySqlProxy__row7529114310714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ExpandGaussMySqlProxy__p453012431575">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ExpandGaussMySqlProxy__p165307431276">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ExpandGaussMySqlProxy__p11530154311715">Error code.</p>
</td>
</tr>
<tr id="ExpandGaussMySqlProxy__row452911432077"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ExpandGaussMySqlProxy__p14530143272">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ExpandGaussMySqlProxy__p10530144318720">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ExpandGaussMySqlProxy__p10530843976">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section10530543470"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="ExpandGaussMySqlProxy__screen7530154314713">
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/enlarge
{
"node_num" : 2,
"proxy_id" : "151c14381ac14ecfb9703a745b992677po01"
}</pre>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section1753111436716"><h4 class="sectiontitle">Example Response</h4><p id="ExpandGaussMySqlProxy__p16531114310713"><strong id="ExpandGaussMySqlProxy__b2667733342349">Status code: 201</strong></p>
<p id="ExpandGaussMySqlProxy__p453114314719">Success.</p>
<pre class="screen" id="ExpandGaussMySqlProxy__screen453118431175">{
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}</pre>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="ExpandGaussMySqlProxy__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="ExpandGaussMySqlProxy__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="ExpandGaussMySqlProxy__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