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>
150 lines
11 KiB
HTML
150 lines
11 KiB
HTML
<a name="dli_02_0247"></a><a name="dli_02_0247"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Template</h1>
|
|
<div id="body1575014860443"><div class="section" id="dli_02_0247__s89ff8bc59cba4c3b94dc17e85c8fa1ea"><h4 class="sectiontitle">Function</h4><p id="dli_02_0247__a4deaa8ebc392424e869c47835399ab23">This API is used to delete a template. A template used by jobs can also be deleted.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__sef21e3efc2a44a84a03adad33a1ae006"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0247__uf99c5b2f64a44669a611cae56296b336"><li id="dli_02_0247__l02802a572cd14322a9edb44c392d1063">URI format<p id="dli_02_0247__ab9f59a1049d24cb2a9c51b9ed06e59d4"><a name="dli_02_0247__l02802a572cd14322a9edb44c392d1063"></a><a name="l02802a572cd14322a9edb44c392d1063"></a>DELETE /v1.0/{project_id}/streaming/job-templates/{template_id}</p>
|
|
</li><li id="dli_02_0247__lab001edff5ca4cde843db03812f0979d">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0247__t219b031199884ac1bb9e91158ddc9efb" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0247__r04005eeda24e4db9b06516450d4d56af"><th align="left" class="cellrowborder" valign="top" width="13.55%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0247__a80847df5e5dc448caa46a2ff258fa2c4">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.540000000000001%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0247__af54fc16087b049c98f748c1a2faace17">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0247__p18254195712613">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.67%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0247__a484a3e0ce14846799c727ccbd4075d6c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0247__r8022e11be3f54ad290cf8c848a56a550"><td class="cellrowborder" valign="top" width="13.55%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0247__p1262440203315">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.540000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0247__p1016041415356">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0247__p152543575617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.67%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0247__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_0247__row79821335125911"><td class="cellrowborder" valign="top" width="13.55%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0247__p898383518592">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.540000000000001%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0247__p119842354597">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0247__p1825413571663">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.67%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0247__p12985635105914">Template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__s3afece1037ea4f62aeffb3db49b97f70"><h4 class="sectiontitle">Request</h4><p id="dli_02_0247__p6910174916570">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__se2bf80cdb76541308f69f258ea4b1bd6"><h4 class="sectiontitle">Response</h4><ul id="dli_02_0247__ucd5724a4b1ca4851bd7edaadd574df3d"><li id="dli_02_0247__li18428192411">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0247__tcedd9d5bece544898da42c15fe855a72" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0247__r263212cfc24b4f7ab11ba179dc95f8d5"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dli_02_0247__aa71bb56aa6ba48488d66e68a44744488">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dli_02_0247__adfb457c202dc4709b315aa6d0a384fdf">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dli_02_0247__a07ad11538b854ab4997a0c69b2fa1ff5">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dli_02_0247__a27603242143846be8ed4173686b0b27b">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0247__row1810397210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dli_02_0247__p59431116224">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dli_02_0247__p194315165219">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dli_02_0247__p49448166218">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dli_02_0247__p145695225010">Indicates whether the response is successful. Value <strong id="dli_02_0247__b1442714212553">true</strong> indicates success.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0247__rab514ea502754f9d88a6ca5cd27e6f9b"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dli_02_0247__p79441316729">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dli_02_0247__p1794416161823">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dli_02_0247__p1794421613211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dli_02_0247__p161502030604">Message content.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0247__rd59ae95756ea47c28d7aa24b2a057881"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dli_02_0247__p14944716325">template</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dli_02_0247__p69447168216">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dli_02_0247__p1944516127">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dli_02_0247__p611723615017">Information about the template to be deleted. For details, see <a href="#dli_02_0247__table42271991538">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0247__table42271991538"></a><a name="table42271991538"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0247__table42271991538" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="dli_02_0247__b1175917025618">template</strong> parameters</caption><thead align="left"><tr id="dli_02_0247__row1722829632"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="dli_02_0247__p72284914313">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="dli_02_0247__p12282918320">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="dli_02_0247__p1622829336">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="dli_02_0247__p11228195313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0247__row9230893312"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dli_02_0247__p82306917316">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="dli_02_0247__p92307917318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dli_02_0247__p52301691234">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dli_02_0247__p62301092035">Template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0247__p6101181617111">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__section16638111294713"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0247__s6d0d234a671f4e618d1a2b5e746cff26">{
|
|
"is_success": "true",
|
|
"message": "The template is deleted successfully.",
|
|
"template": {
|
|
"template_id": 2
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__s1b495ba11cd9411c9ad2ee50103334a7"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0247__acef1445366354016b2ed90921927a555"><a href="#dli_02_0247__t43c1f1c0ba344f4cbcb270953d9cca2a">Table 4</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0247__t43c1f1c0ba344f4cbcb270953d9cca2a"></a><a name="t43c1f1c0ba344f4cbcb270953d9cca2a"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0247__t43c1f1c0ba344f4cbcb270953d9cca2a" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0247__r2ad0f008ce2248a1800a3e8b77226a56"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0247__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_0247__af801170b350b4f8ba3b575c7ddb8b13e">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0247__r0b449b1d3b8c498ea3e6cce16c80a14c"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0247__a8c63a97e3bad402ebaead0bd99cad632">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0247__af86844c7bb364c48b6300df1af164af2">A template is deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0247__row116861975417"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0247__p106867764113">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0247__p117012316811">The input parameter is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0247__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0247__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>
|
|
|