vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0190.html
Su, Xiaomeng 57a0d535be dli_api_0910_version_api 
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>
2023-10-16 22:01:57 +00:00

434 lines
32 KiB
HTML
Raw Blame History

<a name="dli_02_0190"></a><a name="dli_02_0190"></a>
<h1 class="topictitle1">Querying an Enhanced Datasource Connection List</h1>
<div id="body1565767253378"><div class="section" id="dli_02_0190__section13287428103611"><h4 class="sectiontitle">Function</h4><p id="dli_02_0190__p1798441817329">This API is used to query the list of created enhanced datasource connections.</p>
</div>
<div class="section" id="dli_02_0190__section52924285361"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0190__ul1547562815364"><li id="dli_02_0190__li1847520284363">URI format<p id="dli_02_0190__p8475152813362"><a name="dli_02_0190__li1847520284363"></a><a name="li1847520284363"></a>GET /v2.0/{project_id}/datasource/enhanced-connections</p>
</li><li id="dli_02_0190__li1047502816366">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table18299172853614" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0190__row947592853614"><th align="left" class="cellrowborder" valign="top" width="15.920000000000002%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0190__p1347513282368">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.99%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0190__p74757287366">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.64%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0190__p1505195572116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.45%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0190__p1475182833610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row16475152833619"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0190__p1547552803615">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0190__p19475828123613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0190__p1150520553215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60.45%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0190__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>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table17321336944" frame="border" border="1" rules="all"><caption><b>Table 2 </b>query parameter description</caption><thead align="left"><tr id="dli_02_0190__row137325361248"><th align="left" class="cellrowborder" valign="top" width="15.920000000000002%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0190__p1473211361542">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.99%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0190__p1273212361341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.819999999999999%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0190__p59909554240">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.269999999999996%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0190__p17321936748">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row16733153610415"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0190__p573316363419">limit</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0190__p1173316361147">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0190__p12990185515244">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.269999999999996%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0190__p10733163613411">The maximum number of connections to be queried. The default value is <strong id="dli_02_0190__b6844122414714">100</strong>. If <span class="parmname" id="dli_02_0190__parmname072713373716"><b>limit</b></span> is set to <strong id="dli_02_0190__b751017321570">0</strong>, all datasource connections are returned.</p>
</td>
</tr>
<tr id="dli_02_0190__row1373323619413"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0190__p18733936749">offset</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0190__p1733036447">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0190__p14990155572419">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.269999999999996%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0190__p147338361413">The offset of the query result. The default value is <strong id="dli_02_0190__b19785027172515">0</strong>. Note that the connections are sorted by creation time.</p>
</td>
</tr>
<tr id="dli_02_0190__row1473318361843"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0190__p15734736047">status</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0190__p3734836541">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0190__p399105510241">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.269999999999996%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0190__p6734203611418">Connection status. The options are as follows:</p>
<ul id="dli_02_0190__ul1473453617418"><li id="dli_02_0190__li167341736345">Active: The connection has been activated.</li><li id="dli_02_0190__li2073418361448">DELETED: The connection has been deleted.</li></ul>
<div class="note" id="dli_02_0190__note19734113619415"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0190__p157346361941">The connection status is case insensitive.</p>
</div></div>
</td>
</tr>
<tr id="dli_02_0190__row6734193616416"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0190__p147341036047">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0190__p1473423619411">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0190__p16991185522411">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.269999999999996%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0190__p117341336943">Connection name</p>
</td>
</tr>
<tr id="dli_02_0190__row11182104111242"><td class="cellrowborder" valign="top" width="15.920000000000002%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0190__p1218316419249">tags</p>
</td>
<td class="cellrowborder" valign="top" width="11.99%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0190__p6183134182411">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.819999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0190__p1699135522412">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.269999999999996%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0190__p0690917152614">List of tag names. The value is <strong id="dli_02_0190__b20409135016519">k=v</strong> for a single tag. Multiple tags are separated by commas (,). Example: <strong id="dli_02_0190__b1279755195115">tag1=v1,tag2=v2</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="dli_02_0190__note1747115339241"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0190__p54751633202418">The following is an example of the URL containing the <strong id="dli_02_0190__b13581105295117">query</strong> parameter:</p>
<p id="dli_02_0190__p162955019243">GET /v2.0/{project_id}/datasource/enhanced-connections?limit=<i><span class="varname" id="dli_02_0190__varname20491266257">{limit}</span></i>&amp;offset=<i><span class="varname" id="dli_02_0190__varname6841031112516">{offset}</span></i>&amp;status=<i><span class="varname" id="dli_02_0190__varname89334415253">{status}</span></i>&amp;name=<i><span class="varname" id="dli_02_0190__varname391164816258">{name}</span></i></p>
</div></div>
</li></ul>
</div>
<div class="section" id="dli_02_0190__section1831452873613"><h4 class="sectiontitle">Request</h4><p id="dli_02_0190__p101321458183211">None</p>
</div>
<div class="section" id="dli_02_0190__section134515287360"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table8348112818368" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0190__row11478132863610"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0190__p04782028173616">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.13%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0190__p1157145614816">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.61%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0190__p34781128193612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.26%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0190__p1347917286364">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row18479182813362"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0190__p392161273513">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="10.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0190__p5571185618487">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0190__p18921161219357">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.26%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0190__p12921712163514">Indicates whether the request is successfully executed. Value <strong id="dli_02_0190__b1693220175558">true</strong> indicates that the request is successfully executed.</p>
</td>
</tr>
<tr id="dli_02_0190__row14946145019340"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0190__p692141213515">message</p>
</td>
<td class="cellrowborder" valign="top" width="10.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0190__p35712567489">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0190__p6921012133518">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.26%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0190__p1921161214351">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
</td>
</tr>
<tr id="dli_02_0190__row516595513410"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0190__p392131218357">connections</p>
</td>
<td class="cellrowborder" valign="top" width="10.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0190__p5571125644812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0190__p492121263516">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="53.26%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0190__p13921181216356">Datasource connection information list. For details, see <a href="#dli_02_0190__table252911713480">Table 4</a>.</p>
</td>
</tr>
<tr id="dli_02_0190__row15882121220217"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0190__p1132863713315">count</p>
</td>
<td class="cellrowborder" valign="top" width="10.13%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0190__p3571956164814">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0190__p23287371937">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.26%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0190__p183286371238">Number of returned datasource connections.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0190__table252911713480"></a><a name="table252911713480"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table252911713480" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0190__b12873225185218">connections</strong> parameters</caption><thead align="left"><tr id="dli_02_0190__row145301317194816"><th align="left" class="cellrowborder" valign="top" width="21.31786821317868%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0190__p13530141774815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.498650134986503%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0190__p1810522411493">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.768223177682234%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0190__p55301017164810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.41525847415259%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0190__p953031720484">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row11325133161917"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p13887724132113">id</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p7105124194914">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p128873240215">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p4887324102110">Connection ID. Identifies the UUID of a datasource connection.</p>
</td>
</tr>
<tr id="dli_02_0190__row127038355479"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p1588772472117">name</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p3105152474913">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p1088715246216">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p12887132482113">User-defined connection name.</p>
</td>
</tr>
<tr id="dli_02_0190__row19638124013193"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p18876241211">status</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p710512414492">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p138871024112112">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p121716565343">Connection status. The options are as follows:</p>
<ul id="dli_02_0190__ul172719221353"><li id="dli_02_0190__li72713223353">Active: The connection has been activated.</li><li id="dli_02_0190__li3272222351">DELETED: The connection has been deleted.</li></ul>
</td>
</tr>
<tr id="dli_02_0190__row19639104016191"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p14901162017492">available_queue_info</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p710610242493">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p490172018491">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p69011020174911">For details about how to create a datasource connection for each queue, see <a href="#dli_02_0190__table9559942155012">Table 5</a>.</p>
</td>
</tr>
<tr id="dli_02_0190__row028593792014"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p00741174913">dest_vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p14106142414499">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p12015419499">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p1603412496">The VPC ID of the connected service. </p>
</td>
</tr>
<tr id="dli_02_0190__row1978546145010"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p3134111617507">dest_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p18106624174919">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p1913520169503">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p713516162500">Subnet ID of the connected service. </p>
</td>
</tr>
<tr id="dli_02_0190__row29917347393"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p89111148603">isPrivis</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p191116481018">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p169110481805">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p1028403963">Whether the project permissions have been granted for the enhanced datasource connection. If the datasource connection has the permissions, the value of this field is <strong id="dli_02_0190__b1030713534211">false</strong>. Otherwise, the value is <strong id="dli_02_0190__b34913157429">true</strong>.</p>
</td>
</tr>
<tr id="dli_02_0190__row112851837172015"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p178891324162118">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p310792474916">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p7889162416214">Long</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p188891524202119">Time when a link is created. The time is converted to a UTC timestamp.</p>
</td>
</tr>
<tr id="dli_02_0190__row131236161719"><td class="cellrowborder" valign="top" width="21.31786821317868%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0190__p13143661714">hosts</p>
</td>
<td class="cellrowborder" valign="top" width="13.498650134986503%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0190__p11077244494">No</p>
</td>
<td class="cellrowborder" valign="top" width="17.768223177682234%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0190__p12311336151718">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="47.41525847415259%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0190__p1228216154115">User-defined host information. For details, see <a href="#dli_02_0190__table6991727151310">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0190__table9559942155012"></a><a name="table9559942155012"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table9559942155012" frame="border" border="1" rules="all"><caption><b>Table 5 </b>available_queue_info parameter description</caption><thead align="left"><tr id="dli_02_0190__row18672164215014"><th align="left" class="cellrowborder" valign="top" width="17.21%" id="mcps1.3.4.4.2.5.1.1"><p id="dli_02_0190__p10672842125018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.41%" id="mcps1.3.4.4.2.5.1.2"><p id="dli_02_0190__p040135682712">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.64%" id="mcps1.3.4.4.2.5.1.3"><p id="dli_02_0190__p1167254235019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.74%" id="mcps1.3.4.4.2.5.1.4"><p id="dli_02_0190__p167254255015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row1667224212505"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0190__p767212427500">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0190__p340165612712">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0190__p467214245015">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.74%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0190__p6672114213505">ID of a datasource connection.</p>
</td>
</tr>
<tr id="dli_02_0190__row126721421503"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0190__p1267264216500">status</p>
</td>
<td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0190__p13416563278">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0190__p6672174265017">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.74%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0190__p167294210507">Connection status. For details about the status code, see <a href="#dli_02_0190__table13946174752513">Table 7</a>.</p>
</td>
</tr>
<tr id="dli_02_0190__row76738424502"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0190__p10673124216507">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0190__p124155616271">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0190__p9673142155011">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.74%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0190__p136731942135015">Name of a queue.</p>
</td>
</tr>
<tr id="dli_02_0190__row367334225010"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0190__p7673174213507">err_msg</p>
</td>
<td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0190__p194113561271">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0190__p176739423506">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.74%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0190__p17673164235011">Detailed error message when the status is <strong id="dli_02_0190__b35671340155918">FAILED</strong>.</p>
</td>
</tr>
<tr id="dli_02_0190__row26735428509"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0190__p4673174285010">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="11.41%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0190__p124111565277">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.64%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0190__p196732421506">Long</p>
</td>
<td class="cellrowborder" valign="top" width="58.74%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0190__p126731142135012">Time when the available queue list was updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0190__table6991727151310"></a><a name="table6991727151310"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table6991727151310" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="dli_02_0190__b5174314582">hosts</strong> parameters</caption><thead align="left"><tr id="dli_02_0190__row159942715132"><th align="left" class="cellrowborder" valign="top" width="12.46%" id="mcps1.3.4.5.2.5.1.1"><p id="dli_02_0190__p1999162711134">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.49%" id="mcps1.3.4.5.2.5.1.2"><p id="dli_02_0190__p1935512220284">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.98%" id="mcps1.3.4.5.2.5.1.3"><p id="dli_02_0190__p101006279131">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.07%" id="mcps1.3.4.5.2.5.1.4"><p id="dli_02_0190__p1210019278137">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row9100162701310"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dli_02_0190__p31002272131">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.49%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dli_02_0190__p83551322122816">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dli_02_0190__p91001127191314">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.07%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dli_02_0190__p7100427171315">Custom host name</p>
</td>
</tr>
<tr id="dli_02_0190__row17100192717138"><td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dli_02_0190__p19100182711311">ip</p>
</td>
<td class="cellrowborder" valign="top" width="11.49%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dli_02_0190__p1035513227289">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dli_02_0190__p10100227101313">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.07%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dli_02_0190__p181004273132">IPv4 address of the host</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dli_02_0190__table13946174752513"></a><a name="table13946174752513"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__table13946174752513" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Connection status</caption><thead align="left"><tr id="dli_02_0190__row1994634702518"><th align="left" class="cellrowborder" valign="top" width="22.672267226722674%" id="mcps1.3.4.6.2.4.1.1"><p id="dli_02_0190__p4609112117266">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.662766276627664%" id="mcps1.3.4.6.2.4.1.2"><p id="dli_02_0190__p146091921172617">Definition</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.66496649664967%" id="mcps1.3.4.6.2.4.1.3"><p id="dli_02_0190__p7609192132613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__row20946164712252"><td class="cellrowborder" valign="top" width="22.672267226722674%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dli_02_0190__p1460915210264">CREATING</p>
</td>
<td class="cellrowborder" valign="top" width="27.662766276627664%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dli_02_0190__p6609112119268">Creating</p>
</td>
<td class="cellrowborder" valign="top" width="49.66496649664967%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dli_02_0190__p136091821192618">The datasource connection is being created.</p>
</td>
</tr>
<tr id="dli_02_0190__row494612478259"><td class="cellrowborder" valign="top" width="22.672267226722674%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dli_02_0190__p166098217269">ACTIVE</p>
</td>
<td class="cellrowborder" valign="top" width="27.662766276627664%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dli_02_0190__p1960902152610">Active</p>
</td>
<td class="cellrowborder" valign="top" width="49.66496649664967%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dli_02_0190__p17609192112617">The datasource connection has been created, and the connection to the destination address is normal.</p>
</td>
</tr>
<tr id="dli_02_0190__row1294694782513"><td class="cellrowborder" valign="top" width="22.672267226722674%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dli_02_0190__p160952172619">FAILED</p>
</td>
<td class="cellrowborder" valign="top" width="27.662766276627664%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dli_02_0190__p16096213265">Failed</p>
</td>
<td class="cellrowborder" valign="top" width="49.66496649664967%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dli_02_0190__p1660911214266">Failed to create a datasource connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0190__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0190__p6101181617111">None</p>
</div>
<div class="section" id="dli_02_0190__section910624615450"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0190__screen587751511378">{
"is_success": true,
"message": "",
"count": 1,
"connections": [
{
"name": "withvpc",
"id": "4c693ecc-bab8-4113-a838-129cedc9a563",
"available_queue_info": [
{
"status": "ACTIVE",
"name": "resource_mode_1",
"peer_id": "d2ae6628-fa37-4e04-806d-c59c497492d1",
"err_msg": "",
"update_time": 1566889577861
}
],
"dest_vpc_id": "22094d8f-c310-4621-913d-4c4d655d8495",
"dest_network_id": "78f2562a-36e4-4b39-95b9-f5aab22e1281",
"isPrivis": true,
"create_time": 1566888011125,
"status": "ACTIVE"
}
]
}</pre>
</div>
<div class="section" id="dli_02_0190__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0190__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0190__tb12870f1c5f24b27abd55ca24264af36">Table 8</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0190__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0190__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Status codes</caption><thead align="left"><tr id="dli_02_0190__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0190__ab49d21f312644072a331f43e92baf853">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_0190__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0190__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0190__a3153e07b3a9749adba92599fe6628fbf">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0190__p104431642124811">The query is successful.</p>
</td>
</tr>
<tr id="dli_02_0190__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0190__p184941532219">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0190__p2049413539219">Request error.</p>
</td>
</tr>
<tr id="dli_02_0190__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0190__p5537171216249">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0190__p953813124249">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0190__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0190__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_0186.html">APIs Related to Enhanced Datasource Connections</a></div>
</div>
</div>
View Git Blame Copy Permalink