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>
159 lines
12 KiB
HTML
159 lines
12 KiB
HTML
<a name="dli_02_0246"></a><a name="dli_02_0246"></a>
|
|
|
|
<h1 class="topictitle1">Updating a Template</h1>
|
|
<div id="body1575014860437"><div class="section" id="dli_02_0246__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0246__a4deaa8ebc392424e869c47835399ab23">This API is used to update existing templates in DLI.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0246__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0246__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0246__p205261536112616"><a name="dli_02_0246__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>PUT /v1.0/{project_id}/streaming/job-templates/{template_id}</p>
|
|
</li><li id="dli_02_0246__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0246__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0246__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="14.67%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0246__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.15%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0246__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.24%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0246__p106514361337">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.94%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0246__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0246__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="14.67%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0246__p1262440203315">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.15%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0246__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.24%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0246__p1165173611320">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.94%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0246__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>
|
|
<tr id="dli_02_0246__row61115494512"><td class="cellrowborder" valign="top" width="14.67%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0246__p312174910512">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.15%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0246__p1412649155114">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.24%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0246__p156512036039">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.94%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0246__p1112154985112">Template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0246__tcedd9d5bece544898da42c15fe855a72" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0246__r263212cfc24b4f7ab11ba179dc95f8d5"><th align="left" class="cellrowborder" valign="top" width="9.47%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0246__aa71bb56aa6ba48488d66e68a44744488">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.17%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0246__adfb457c202dc4709b315aa6d0a384fdf">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0246__a07ad11538b854ab4997a0c69b2fa1ff5">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="72.36%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0246__a27603242143846be8ed4173686b0b27b">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0246__rab514ea502754f9d88a6ca5cd27e6f9b"><td class="cellrowborder" valign="top" width="9.47%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0246__a4e36e26cea1148349f5b1d99665ec74c">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0246__a3f01c30693ef41f9ab8913a733a8dcae">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0246__a4c806296e81547638d0ed294d9a3ca63">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0246__ace897a9e7d9d47a1895664dd49e10fe5">Template name. Length range: 0 to 57 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0246__rd59ae95756ea47c28d7aa24b2a057881"><td class="cellrowborder" valign="top" width="9.47%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0246__a71daee1cc06048ae818e104254c9166d">desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0246__a3db6910eff34455caa5af7c1be07ff39">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0246__a3b4b1f2ddd81469dbc22dc9de316fc9b">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0246__a4de8fb2d168546a9adf40df6d59ce095">Template description. Length range: 0 to 512 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0246__rc32461e6ae584faebd86e6a27d35ad52"><td class="cellrowborder" valign="top" width="9.47%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0246__a78edaa1801254949b38999fa2b76cb9b">sql_body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.17%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0246__aa5ebc166527543019d7799ddf643663f">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0246__ad6a32cc0ba694cea9fe5f132dd482a0b">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="72.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0246__a6311275524c844f4aa133f8f5818d0c0">Stream SQL statement, which includes at least the following three parts: source, query, and sink. Length range: 0 to 1024 x 1024 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0246__t5995d65f65ba4ebca8606202112b407e" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0246__ra7acea51e4b4437e917d21fe99f130a3"><th align="left" class="cellrowborder" valign="top" width="11.57%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0246__a5af940f2267747ef871c67c86a0be82e">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.290000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0246__abcfbd3a651704d539626f3a41cc744f5">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.82%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0246__a2351d8d266444ad3ad1c09540d6d81cc">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.32%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0246__af7ea6a3f59844bdf99d51e90d570be4c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0246__rca1bdb55f4dc497ca8fee7537232f274"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0246__p9195173335611">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.290000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0246__p3195193395617">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.82%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0246__p519511333561">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.32%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0246__p1735945175611">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0246__parmvalue125132055317"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0246__r3900d023a26e45dea9a0ad9dd60d8ab1"><td class="cellrowborder" valign="top" width="11.57%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0246__p16195933125618">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.290000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0246__p519563365613">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.82%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0246__p10195173316566">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.32%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0246__p163902053195610">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0246__p153701832104815">Update job template information, including the template name, template description, and template SQL statements.</p>
|
|
<pre class="screen" id="dli_02_0246__sabcf8723ba2d4d3c912b17feda88f427">{
|
|
"name": "simple_stream_sql",
|
|
"desc": "Example of quick start",
|
|
"sql_body": "select * from source_table"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__section2085442416414"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0246__s6d0d234a671f4e618d1a2b5e746cff26">{
|
|
"is_success": "true",
|
|
"message": "The template is updated successfully.",
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0246__acef1445366354016b2ed90921927a555"><a href="#dli_02_0246__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0246__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0246__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0246__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0246__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_0246__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0246__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0246__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0246__af86844c7bb364c48b6300df1af164af2">A template is updated successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0246__row1391284310379"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0246__p1591294310378">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0246__p1691211432373">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0246__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0246__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>
|
|
|