forked from docs/doc-exports
wangdengke2
823df869a9
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>
126 lines
13 KiB
HTML
126 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0000002298790204"></a><a name="EN-US_TOPIC_0000002298790204"></a>
|
|
|
|
<h1 class="topictitle1">Clearing Shard Configuration Data (a V3 API)</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section71971443122216"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p171207573245">This API is used to clear shard configuration data.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section5205164312213"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p13208743102219">Only data of shard configuration tasks in the <strong id="EN-US_TOPIC_0000002298790204__b119162010815">ToBeCleaned</strong> state can be cleared.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section018620371764"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p43571414182418">PUT /v3/{project_id}/instances/{instance_id}/databases/{db_name}/migration/jobs/{job_id}/clean</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_table1126028" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row146686416415"><th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p7669164745"><strong id="EN-US_TOPIC_0000002298790204__b2074367692112745">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.607843137254903%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p0670144643"><strong id="EN-US_TOPIC_0000002298790204__b1008512412114019">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.76470588235294%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p1767016415420"><strong id="EN-US_TOPIC_0000002298790204__b1483815891112927">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.01960784313725%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p0670847413"><strong id="EN-US_TOPIC_0000002298790204__b140251624731337">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row1466994547"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p56703414418">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p96711141345">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p116714411415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p367117413420">Project ID of a tenant in a region</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row166691241344"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p2067211417414">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p186721144412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p067215414410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p467244643">Instance ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row8551322718"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p5551921878">db_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p25528213718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p555282671">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p35521321273">Schema name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row32061117143116"><td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p10206817153118">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.607843137254903%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p280972618319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.76470588235294%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p1780902611319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.01960784313725%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p580952618316">ID of the shard configuration task</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section1703735142515"><h4 class="sectiontitle">Request<span id="EN-US_TOPIC_0000002298790204__ph297829023751"> Parameters</span></h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row1030416437226"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p11308643112210"><strong id="EN-US_TOPIC_0000002298790204__b1171573843112745">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p9310134319223"><strong id="EN-US_TOPIC_0000002298790204__b178967203112927">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p18313144332214"><strong id="EN-US_TOPIC_0000002298790204__b1474707434114019">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p1731614435223"><strong id="EN-US_TOPIC_0000002298790204__b47089105131337">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row11304174332210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p18319184352220">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p183214430225">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p032464332211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p109669374313">User token.</p>
|
|
<p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p163271343192215">You can obtain the token by calling the IAM API used to obtain a user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section12296195852419"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p175211447116">Clearing shard configuration data<pre class="screen" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_screen8878182161411">PUT https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/databases/ddm_db_test/migration/jobs/10501cd3-0c19-498b-9ba4-8935ed447542/clean</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_section71865377618"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_ul141861137968"><li id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_li218617373612">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_table518714374616" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row111871437563"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p151873371064"><strong id="EN-US_TOPIC_0000002298790204__b258365671112745">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p161871371162"><strong id="EN-US_TOPIC_0000002298790204__b1054342472114019">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p1418716371861"><strong id="EN-US_TOPIC_0000002298790204__b9535746031337">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_row8187237362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p1818793714610">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p171871337560">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_p14897475383">ID of the task for clearing shard configuration data</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_li1718716371610">Normal response example<pre class="screen" id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_screen91870371868">{
|
|
"job_id":"xxxxxxxx-5d7e-4e1a-aeb4-9b1e6d0a4999"
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_li15551925175513">Abnormal response<p id="EN-US_TOPIC_0000002298790204__en-us_topic_0000002167894376_p8181342786"><a name="EN-US_TOPIC_0000002298790204__en-us_topic_0000002280164248_li15551925175513"></a><a name="en-us_topic_0000002280164248_li15551925175513"></a>For details, see <a href="ddm_api_01_0059.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__section4778540915440"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>202</p>
|
|
</li><li id="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000002298790204__p81763119262"><a name="EN-US_TOPIC_0000002298790204__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="ddm_api_01_0060.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000002298790204__section67241224201212"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000002298790204__p137251024181213">For details, see <a href="ddm_api_01_0061.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0027.html">Schemas</a></div>
|
|
</div>
|
|
</div>
|
|
|