forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
138 lines
10 KiB
HTML
138 lines
10 KiB
HTML
<a name="dli_02_0285"></a><a name="dli_02_0285"></a>
|
|
|
|
<h1 class="topictitle1">Querying Connectivity Test Details of a Specified Address</h1>
|
|
<div id="body1590570240396"><div class="section" id="dli_02_0285__section18998185384911"><h4 class="sectiontitle">Function</h4><p id="dli_02_0285__p342141019132">This API is used to query the connectivity test result after the test is submitted.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0285__en-us_topic_0069077927_ul10082125"><li id="dli_02_0285__en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0285__en-us_topic_0069077927_p11345797"><a name="dli_02_0285__en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0069077927_li23630265"></a>GET /v1.0/{project_id}/queues/{queue_name}/connection-test/{task_id}</p>
|
|
</li><li id="dli_02_0285__li1725612218454">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0285__en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0285__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="16.48%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0285__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0285__en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.58%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0285__p19878136202716">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.699999999999996%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0285__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0285__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0285__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0285__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0285__p138787362275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.699999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0285__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__row1691519137166"><td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0285__p58451326141618">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0285__p138451726171613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0285__p587843682712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.699999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0285__p10845102621613">Name of a queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__row1567913291203"><td class="cellrowborder" valign="top" width="16.48%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0285__p9452135532013">task_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0285__p145216550201">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.58%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0285__p1878536152717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.699999999999996%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0285__p4680152912011">Job ID. You can call <a href="dli_02_0284.html">Creating an Address Connectivity Test Request</a> to obtain the value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0285__p223651915212">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0285__en-us_topic_0069077927_table56638444" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0285__en-us_topic_0069077927_row48911609"><th align="left" class="cellrowborder" valign="top" width="19.79%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0285__ae076f6b3f1bf463b9cc087fc566253d5">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.43%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0285__p12583123083811">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.9%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0285__a59685f4525af4d82a623288ff8ccb0f4">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.88%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0285__en-us_topic_0069077927_p632718127368">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0285__en-us_topic_0069077927_row27919264"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0285__en-us_topic_0069077927_p46867877">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0285__p9584230133817">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0285__en-us_topic_0069077927_p7327597">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0285__en-us_topic_0069077927_p56664447">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0285__parmvalue1187120491519"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__en-us_topic_0069077927_row40217981"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0285__en-us_topic_0069077927_p36431005">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0285__p95842301382">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0285__en-us_topic_0069077927_p49163111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0285__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__row4147126131817"><td class="cellrowborder" valign="top" width="19.79%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0285__p204401415142213">connectivity</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.43%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0285__p1844010153223">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.9%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0285__p16441515152210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.88%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0285__p976382311222">Indicates the connectivity test result.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0285__p534664283414">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0285__screen4559121772114">{
|
|
"is_success": true,
|
|
"message": "Get node connectivity status successfully for addressId:9",
|
|
"connectivity": "REACHABLE"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0285__acef1445366354016b2ed90921927a555"><a href="#dli_02_0285__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 3</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0285__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0285__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0285__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0285__afa33b7f5b0ac4d008ebcf6493f629b24">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0285__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0285__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0285__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0285__p528373855714">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__row1012873412149"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0285__p1912813348145">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0285__p154287617445">Request failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0285__row4217146142917"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0285__p121764615295">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0285__p2218164610295">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0285__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0285__dli_02_0225_p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0193.html">Queue-related APIs (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|