forked from docs/doc-exports
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>
306 lines
22 KiB
HTML
306 lines
22 KiB
HTML
<a name="dli_02_0248"></a><a name="dli_02_0248"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Template List</h1>
|
|
<div id="body1575014860450"><div class="section" id="dli_02_0248__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0248__p37659034416">This API is used to query the job template list. Currently, only custom templates can be queried.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0248__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0248__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0248__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0248__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>GET /v1.0/{project_id}/streaming/job-templates</p>
|
|
</li><li id="dli_02_0248__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0248__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0248__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="15.370000000000001%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0248__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.88%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0248__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.299999999999999%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0248__p43572411284">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.45%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0248__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="15.370000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0248__p1262440203315">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0248__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0248__p1357441681">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.45%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0248__p1768719515356">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_0248__table8282740262" frame="border" border="1" rules="all"><caption><b>Table 2 </b>query parameter description</caption><thead align="left"><tr id="dli_02_0248__row162839401166"><th align="left" class="cellrowborder" valign="top" width="10.209999999999999%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0248__p528318401865">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.31%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0248__p32831940067">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.59%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0248__p42837401367">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.89%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0248__p32834402613">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__row599218180714"><td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0248__p1628494019613">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0248__p028412408615">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.59%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0248__p82848405616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.89%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0248__p128434010615">Template name. Fuzzy query by name is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row13756725810"><td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0248__p197566215820">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0248__p175618218813">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.59%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0248__p1775613216813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.89%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0248__p157564211810">List of tag names. The value is <strong id="dli_02_0248__b426883119188">k=v</strong> for a single tag. Multiple tags are separated by commas (,). Example: <strong id="dli_02_0248__b14227143011916">tag1=v1,tag2=v2</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row2283154014613"><td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0248__p9283104018612">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0248__p11283194013612">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.59%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0248__p18283240862">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.89%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0248__p32833402617">Job offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row1628312401563"><td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0248__p112831240968">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0248__p182831407612">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.59%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0248__p5283740961">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.89%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0248__p5283540968">Number of returned data records. The default value is <strong id="dli_02_0248__b65771019122218">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row6284154019617"><td class="cellrowborder" valign="top" width="10.209999999999999%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0248__p1528419406615">order</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.31%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0248__p62842409615">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.59%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0248__p42843402064">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.89%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0248__p112841740663">Sorting style of the query results.</p>
|
|
<ul id="dli_02_0248__ul22846409618"><li id="dli_02_0248__li20284134013611"><strong id="dli_02_0248__b1655626115814">asc</strong>: The query results are displayed in ascending order.</li><li id="dli_02_0248__li12849405619"><strong id="dli_02_0248__b3738108195814">desc</strong>: The query results are displayed in the descending order.</li></ul>
|
|
<p id="dli_02_0248__p1528416401860">The default value is <span class="parmvalue" id="dli_02_0248__parmvalue3117164571916"><b>desc</b></span>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4><p id="dli_02_0248__p156001244181218">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0248__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0248__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0248__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0248__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0248__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0248__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__row1957883413418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0248__p462774311347">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0248__p1362714436347">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0248__p362724373411">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0248__p14754144833511">Indicates whether the request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row6539041473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0248__p662744353420">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0248__p0627164320345">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0248__p962784333417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0248__p69496565355">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row13540124872"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0248__p1627543163420">template_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0248__p15627743183418">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0248__p962711439342">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0248__p312429113615">Information about the template list. For details, see <a href="#dli_02_0248__table1412212663613">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0248__table1412212663613"></a><a name="table1412212663613"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0248__table1412212663613" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0248__b3116011596">template_list</strong> parameters</caption><thead align="left"><tr id="dli_02_0248__row1012212261366"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0248__p181226264361">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0248__p8123152633614">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0248__p212312617369">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0248__p101231026123614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__row10123202673614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0248__p86661619113718">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0248__p1766611993715">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0248__p56661019193720">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0248__p11318181718387">Total number of templates.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row512314263360"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0248__p146665197378">templates</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0248__p666631919373">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0248__p1666611993712">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0248__p182866252386">Detailed information about a template. For details, see <a href="#dli_02_0248__table14542153611387">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0248__table14542153611387"></a><a name="table14542153611387"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0248__table14542153611387" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="dli_02_0248__b12681161617595">templates</strong> parameters</caption><thead align="left"><tr id="dli_02_0248__row12542133603816"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.5.1.1"><p id="dli_02_0248__p18542143683815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.5.1.2"><p id="dli_02_0248__p2542163663812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.5.1.3"><p id="dli_02_0248__p18542736143817">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.4.2.5.1.4"><p id="dli_02_0248__p1154314367381">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__row105431536153813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p142547017408">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p825470194015">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p11254702400">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p32542018402">Template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row16543103623817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p11553141912406">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p8553191917405">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p155531919134012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p15531419114010">Template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row12543173673816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p19553161912402">desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p355311193408">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p19553919134015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p1055314199409">Template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row6546173663818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p14546636123811">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p4546183620381">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p1054683603810">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p12546103653812">Time when the template is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row15465367388"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p10546736143814">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p7546836203818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p4546183611385">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p16546103612382">Time when the template is updated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row115461736173816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p155474369381">sql_body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p2547936153812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p145472036133819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p454719363388">Stream SQL statement. Contains at least the <strong id="dli_02_0248__b9857163816114">source</strong>, <strong id="dli_02_0248__b826916416113">query</strong>, and <strong id="dli_02_0248__b79481043213">sink</strong> parts.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row17483123952413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0248__p154838398248">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0248__p3483123917242">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0248__p248323932413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0248__p19483173972413">Job template type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0248__p6101181617111">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__section1445135571617"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0248__s6d0d234a671f4e618d1a2b5e746cff26">{
|
|
"is_success": "true",
|
|
"message": "The template list is obtained successfully.",
|
|
"template_list": {
|
|
"total_count": 2,
|
|
"templates": [
|
|
{
|
|
"template_id": 2,
|
|
"name": "updatetest",
|
|
"desc": "Example of quick start",
|
|
"create_time": 1578748092000,
|
|
"update_time": 1578748092000,
|
|
"sql_body": "select * from source_table",
|
|
"job_type": "flink_sql_job"
|
|
},
|
|
{
|
|
"template_id": 1,
|
|
"name": "we",
|
|
"desc": "qwe",
|
|
"create_time": 1577951045000,
|
|
"update_time": 1577951045000,
|
|
"sql_body": ""
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0248__acef1445366354016b2ed90921927a555"><a href="#dli_02_0248__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 6</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0248__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0248__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status codes</caption><thead align="left"><tr id="dli_02_0248__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0248__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_0248__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0248__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0248__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0248__af86844c7bb364c48b6300df1af164af2">Template list query succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0248__row116861975417"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0248__p106867764113">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0248__p3686872412">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0248__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0248__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_0244.html">APIs Related to Flink Job Templates</a></div>
|
|
</div>
|
|
</div>
|
|
|