forked from docs/doc-exports
wangdengke2
1ddaec1a62
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>
180 lines
17 KiB
HTML
180 lines
17 KiB
HTML
<a name="rds_08_0035"></a><a name="rds_08_0035"></a>
|
|
|
|
<h1 class="topictitle1">Adding Host Addresses for MSDTC</h1>
|
|
<div id="body0000002474392904"><div class="section" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p52780252141331">This API is used to add host addresses for Microsoft Distributed Transaction Coordinator (MSDTC).</p>
|
|
<ul id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_ul12259155218373"><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0110967248_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__en-us_topic_0000002496892257_section1213231413285"><h4 class="sectiontitle">Constraints</h4><p id="rds_08_0035__p1620010163718">This API is available only for RDS for SQL Server.</p>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_ul16391217184115"><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li363951734111">URI format<p id="rds_08_0035__en-us_topic_0145282471_p1363971724110"><a name="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li363951734111"></a><a name="en-us_topic_0271461297_en-us_topic_0145282472_li363951734111"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/msdtc/host</p>
|
|
</li></ul>
|
|
<ul id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_ul49831254144655"><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI Parameters</caption><thead align="left"><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p34889605"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b2315523124611">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p7485743"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b5795923184610">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p2365466"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b314612241460">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p71021876102">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_section3074340117316"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0035__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_08_0035__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_08_0035__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="rds_08_0035__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="rds_08_0035__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="rds_08_0035__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0035__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_08_0035__p18511533163317">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_08_0035__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_08_0035__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_08_0035__p35111331332">The content type.</p>
|
|
<p id="rds_08_0035__p1351133311330">The default value is <strong id="rds_08_0035__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0035__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_08_0035__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_08_0035__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_08_0035__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_08_0035__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_08_0035__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row50931783"><th align="left" class="cellrowborder" valign="top" width="16.939999999999998%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p31833731"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b67281643184615">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.709999999999999%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p4991104715573"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b4252204419460">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.54%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p28395444"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b570164415462">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.81%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p18329666"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b13272154511466">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row8363115055317"><td class="cellrowborder" valign="top" width="16.939999999999998%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_08_0035__p15861144151620">hosts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.709999999999999%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_08_0035__p28616411168">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.54%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_08_0035__en-us_topic_0145282471_p18767174561411">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.81%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_08_0035__p14251113531615">Host information.</p>
|
|
<p id="rds_08_0035__en-us_topic_0145282471_p20357195511311">For details on the element structure, see <a href="#rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table1531087569">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table1531087569"></a><a name="en-us_topic_0271461297_en-us_topic_0145282472_table1531087569"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table1531087569" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Hosts data structure description</caption><thead align="left"><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row105768135615"><th align="left" class="cellrowborder" valign="top" width="17.01%" id="mcps1.3.4.4.2.5.1.1"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p85828155618"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b1771126174815">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.64%" id="mcps1.3.4.4.2.5.1.2"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p201041814581"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b105852744813">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.75%" id="mcps1.3.4.4.2.5.1.3"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p176119813563"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b131311286486">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.6%" id="mcps1.3.4.4.2.5.1.4"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p12636825617"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b43573924811">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row14665811567"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_08_0035__p18865143617174">host_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_08_0035__p1865153614178">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_08_0035__p78651836201718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.6%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_08_0035__p1865153641718">Host name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0035__row15398430413"><td class="cellrowborder" valign="top" width="17.01%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_08_0035__p5865936111712">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_08_0035__p386563619174">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.75%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_08_0035__p8865143610172">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.6%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_08_0035__p183982030518">Host IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__section1545264614317"><h4 class="sectiontitle">Request example</h4><p id="rds_08_0035__p1437513041815">Add host addresses for MSDTC.</p>
|
|
<pre class="screen" id="rds_08_0035__screen1228010206177">POST https://rds.eu-de.otc.t-systems.com/v3/054b93101a00d3a02fe3c01fb31462ac/instances/463a6520abc345888850ea5bfb245e4fin04/msdtc/host
|
|
|
|
{
|
|
"hosts" : [ {
|
|
"host_name" : "pc1",
|
|
"ip" : "127.0.0.1"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_ul12573920"><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_table32267243" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row9230088"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p9439626"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b1164772574810">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p26412257"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b16323926134812">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p59018101"><strong id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_b168961264489">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_row15736877"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_08_0035__p0878025191816">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_08_0035__p087862531813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p48259009">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_ul16665627"><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li15772917">Example normal response<pre class="screen" id="rds_08_0035__screen349621419616">{
|
|
"job_id" : "603d87db-9a91-411e-b369-ca4d72007e27"
|
|
}</pre>
|
|
</li><li id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li166335861110">Abnormal response<p id="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_p28475059"><a name="rds_08_0035__en-us_topic_0271461297_en-us_topic_0145282472_li166335861110"></a><a name="en-us_topic_0271461297_en-us_topic_0145282472_li166335861110"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_08_0035__ul1411813317716"><li id="rds_08_0035__en-us_topic_0110967248_li58581622171411">Normal<p id="rds_08_0035__en-us_topic_0110967248_p1040982941020"><a name="rds_08_0035__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>202</p>
|
|
</li><li id="rds_08_0035__li192946421272">Abnormal<p id="rds_08_0035__en-us_topic_0224329858_p0723374409"><a name="rds_08_0035__li192946421272"></a><a name="li192946421272"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0035__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="rds_08_0035__en-us_topic_0224329858_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|