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_0036"></a><a name="rds_08_0036"></a>
|
|
|
|
<h1 class="topictitle1">Querying MSDTC Hosts</h1>
|
|
<div id="body0000002474556228"><div class="section" id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p52780252141331">This API is used to query MSDTC hosts.</p>
|
|
<ul id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_ul12259155218373"><li id="rds_08_0036__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_0036__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_0036__en-us_topic_0000002496892257_section1213231413285"><h4 class="sectiontitle">Constraints</h4><p id="rds_08_0036__p1620010163718">This API is available only for RDS for SQL Server.</p>
|
|
</div>
|
|
<div class="section" id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_ul16391217184115"><li id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li363951734111">URI format<p id="rds_08_0036__en-us_topic_0145282471_p1363971724110"><a name="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li363951734111"></a><a name="en-us_topic_0271461297_en-us_topic_0145282472_li363951734111"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/msdtc/hosts?offset={offset}&limit={limit}</p>
|
|
</li></ul>
|
|
<ul id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_ul49831254144655"><li id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0036__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_0036__en-us_topic_0271461297_en-us_topic_0145282472_row60083059"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.3.3.1.1.2.5.1.1"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p34889605"><strong id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_b2315523124611">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.55%" id="mcps1.3.3.3.1.1.2.5.1.2"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p7485743"><strong id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_b5795923184610">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.13%" id="mcps1.3.3.3.1.1.2.5.1.3"><p id="rds_08_0036__p875120385134"><strong id="rds_08_0036__b7751183891311">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.160000000000004%" id="mcps1.3.3.3.1.1.2.5.1.4"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p2365466"><strong id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_b314612241460">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_row57385070"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.13%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="rds_08_0036__p14625317612">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.160000000000004%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_08_0036__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_0036__en-us_topic_0271461297_en-us_topic_0145282472_row2864326155157"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.13%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="rds_08_0036__p13625615610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.160000000000004%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0036__row1197694061114"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="rds_08_0036__p161463213617">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="rds_08_0036__p1314622115615">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.13%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="rds_08_0036__p71465211764">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.160000000000004%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="rds_08_0036__p12501184214333">Index offset. The query starts from the next piece of data indexed by this parameter.</p>
|
|
<p id="rds_08_0036__p6152162703711">The value must be a non-negative number.</p>
|
|
<p id="rds_08_0036__p34651093715">The default value is <strong id="rds_08_0036__b122463133015">0</strong>, indicating that the query starts from the first data record.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0036__row1333084116112"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="rds_08_0036__p114610212069">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.55%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="rds_08_0036__p101466211263">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.13%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="rds_08_0036__p1214610211767">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.160000000000004%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="rds_08_0036__p8445142711377">Number of records to be queried.</p>
|
|
<p id="rds_08_0036__en-us_topic_0291571266_p14921123723811">The value ranges from 1 to 100.</p>
|
|
<p id="rds_08_0036__p72931151193516">The default value is <strong id="rds_08_0036__b86393404544">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_section3074340117316"><h4 class="sectiontitle">Request example</h4><ul id="rds_08_0036__ul1183180183717"><li id="rds_08_0036__li1283110163719">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0036__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_08_0036__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_08_0036__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_08_0036__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_08_0036__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_08_0036__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0036__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_08_0036__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_08_0036__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_08_0036__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_08_0036__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_08_0036__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>
|
|
</li><li id="rds_08_0036__li8442171664711">URI example<p id="rds_08_0036__p194421816104715"><a name="rds_08_0036__li8442171664711"></a><a name="li8442171664711"></a>GET https://rds.eu-de.otc.t-systems.com/v3/054b93101a00d3a02fe3c01fb31462ac/instances/8ef19e30cbf44c79b63c7e6b2168a400in04/msdtc/hosts</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_ul12573920"><li id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_row9230088"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p9439626"><strong id="rds_08_0036__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.5.2.1.1.2.4.1.2"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p26412257"><strong id="rds_08_0036__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.5.2.1.1.2.4.1.3"><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p59018101"><strong id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_b168961264489">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_row15736877"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_08_0036__p3819428371">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_08_0036__p1060814518710">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p48259009">Total number of hosts.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0036__row8645128201817"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_08_0036__p14819228379">hosts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_08_0036__p155561441573">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_08_0036__p22531532685">Host list.</p>
|
|
<p id="rds_08_0036__p1090317121690">For details, see <a href="#rds_08_0036__table944417166471">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_08_0036__table944417166471"></a><a name="table944417166471"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_08_0036__table944417166471" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Hosts element structure description</caption><thead align="left"><tr id="rds_08_0036__row64446166478"><th align="left" class="cellrowborder" valign="top" width="23.97239723972397%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="rds_08_0036__p644461664718"><strong id="rds_08_0036__b1827385012310">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.022702270227022%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="rds_08_0036__p14441716164711"><strong id="rds_08_0036__b1010292202411">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.004900490049%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="rds_08_0036__p044418169477"><strong id="rds_08_0036__b940911235245">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_08_0036__row5444181644712"><td class="cellrowborder" valign="top" width="23.97239723972397%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_08_0036__p102550539914">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.022702270227022%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_08_0036__p152551053498">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.004900490049%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_08_0036__p1825514531990">Host ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0036__row115094455920"><td class="cellrowborder" valign="top" width="23.97239723972397%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_08_0036__p82553531694">host</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.022702270227022%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_08_0036__p18255653492">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.004900490049%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_08_0036__p126264225400">Host address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_08_0036__row20445111614713"><td class="cellrowborder" valign="top" width="23.97239723972397%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_08_0036__p62551953397">host_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.022702270227022%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_08_0036__p6255185312919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.004900490049%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_08_0036__p107020243409">Host name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_ul16665627"><li id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li15772917">Example normal response<pre class="screen" id="rds_08_0036__screen203531528763">{
|
|
"total_count" : 1,
|
|
"hosts" : [ {
|
|
"id" : "527dd9ca-cc2c-4bac-8707-f9b4f55343f4",
|
|
"host" : "192.168.0.90",
|
|
"host_name" : "MSSQL-00E5FB7A"
|
|
} ]
|
|
}</pre>
|
|
</li><li id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_li166335861110">Abnormal response<p id="rds_08_0036__en-us_topic_0271461297_en-us_topic_0145282472_p28475059"><a name="rds_08_0036__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_0036__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_08_0036__ul1411813317716"><li id="rds_08_0036__en-us_topic_0110967248_li58581622171411">Normal<p id="rds_08_0036__en-us_topic_0110967248_p1040982941020"><a name="rds_08_0036__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="rds_08_0036__li192946421272">Abnormal<p id="rds_08_0036__en-us_topic_0224329858_p0723374409"><a name="rds_08_0036__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_0036__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="rds_08_0036__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>
|
|
|