forked from docs/doc-exports
378 lines
28 KiB
HTML
378 lines
28 KiB
HTML
<a name="ShowTemplateMetadata"></a><a name="ShowTemplateMetadata"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Template Metadata</h1>
|
|
<div id="body8662426"><div class="section" id="ShowTemplateMetadata__section129985194417"><h4 class="sectiontitle">Function</h4><p id="ShowTemplateMetadata__p159912524415">ShowTemplateMetadata</p>
|
|
<p id="ShowTemplateMetadata__p199955114411">This API obtains the metadata of the current template.</p>
|
|
<p id="ShowTemplateMetadata__p310045104416">To obtain details, you can refer to ShowTemplateMetadataResponseBody. To view all versions of a template, call ListTemplateVersions.</p>
|
|
<ul id="ShowTemplateMetadata__ul610210514415"><li id="ShowTemplateMetadata__li141021857444">template_id is the unique ID of the template. It is a UUID generated by RFS when a template is created. Template names are unique at one specific time, so you can create a template named HelloWorld and another template with the same name after deleting the first one. For parallel development, team members may want to ensure that they are operating the template they created, not one with the same name created by other members after deleting the previous one. To avoid this mismatch, check the ID, since RFS ensures each template has a unique ID that does not change with updates. If the template_id value differs from the current template ID, 400 is returned.</li></ul>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section19102185134411"><h4 class="sectiontitle">Debugging</h4><p id="ShowTemplateMetadata__p141026524414">You can debug this API through automatic authentication in <a href="https://console.huaweicloud.com/apiexplorer/#/openapi/AOS/doc?api=ShowTemplateMetadata" target="_blank" rel="noopener noreferrer">API Explorer</a> or use the SDK sample code generated by API Explorer.</p>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section91036564416"><h4 class="sectiontitle">URI</h4><p id="ShowTemplateMetadata__p16103185184419">GET /v1/{project_id}/templates/{template_name}/metadata</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table210465144417" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row1810310520447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ShowTemplateMetadata__p161054594411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ShowTemplateMetadata__p31051954440">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ShowTemplateMetadata__p21051055447">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ShowTemplateMetadata__p1910510518443">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row171041854448"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowTemplateMetadata__p121068516446">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowTemplateMetadata__p181064554418">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowTemplateMetadata__p111066564410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowTemplateMetadata__p210610584412">Project ID. It can be obtained by calling an API or from the console.</p>
|
|
<p id="ShowTemplateMetadata__p31074584419">Minimum: <strong id="ShowTemplateMetadata__b181076516449">3</strong></p>
|
|
<p id="ShowTemplateMetadata__p21071250448">Maximum: <strong id="ShowTemplateMetadata__b410718518449">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row21043519449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowTemplateMetadata__p7107851446">template_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowTemplateMetadata__p2108452444">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowTemplateMetadata__p810816512442">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowTemplateMetadata__p8108559442">Name of the template to be created.</p>
|
|
<p id="ShowTemplateMetadata__p61082514447">Minimum: <strong id="ShowTemplateMetadata__b2010845144417">1</strong></p>
|
|
<p id="ShowTemplateMetadata__p191091512449">Maximum: <strong id="ShowTemplateMetadata__b91098512444">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table1211410511448" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row11092051448"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ShowTemplateMetadata__p311413514448">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ShowTemplateMetadata__p311419544413">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ShowTemplateMetadata__p121141459447">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ShowTemplateMetadata__p51151554440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row1210925194411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ShowTemplateMetadata__p5115354445">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ShowTemplateMetadata__p11157515446">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ShowTemplateMetadata__p1411515519446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ShowTemplateMetadata__p11159554411">ID of a template. If <strong id="ShowTemplateMetadata__b2011620518440">template_id</strong> exists, the template service checks whether <strong id="ShowTemplateMetadata__b14116155144414">template_id</strong> matches <strong id="ShowTemplateMetadata__b2116853449">template_name</strong>. If not, <strong id="ShowTemplateMetadata__b51161534410">400</strong> is returned.</p>
|
|
<p id="ShowTemplateMetadata__p171169524419">Minimum: <strong id="ShowTemplateMetadata__b1711695104413">36</strong></p>
|
|
<p id="ShowTemplateMetadata__p1811616564410">Maximum: <strong id="ShowTemplateMetadata__b8116658444">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section1611616564411"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__en-us_topic_0000001709318826_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row21161950443"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ShowTemplateMetadata__p21179584416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ShowTemplateMetadata__p611717594417">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ShowTemplateMetadata__p711719594415">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ShowTemplateMetadata__p161181055449">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row1611613513447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ShowTemplateMetadata__p611818511448">Client-Request-Id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ShowTemplateMetadata__p1411812518446">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ShowTemplateMetadata__p1911818584416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ShowTemplateMetadata__p1811810512443">Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended.</p>
|
|
<p id="ShowTemplateMetadata__p2118056446">Minimum: <strong id="ShowTemplateMetadata__b811815513447">36</strong></p>
|
|
<p id="ShowTemplateMetadata__p1011975164420">Maximum: <strong id="ShowTemplateMetadata__b1111914554413">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section16119165164418"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowTemplateMetadata__p161195544411"><strong id="ShowTemplateMetadata__b1911914519449">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__en-us_topic_0000001709318826_response_ShowTemplateMetadataResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row611975104418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ShowTemplateMetadata__p131207514411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ShowTemplateMetadata__p11209524418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ShowTemplateMetadata__p1712017594418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row31197513442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowTemplateMetadata__p1812013512440">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowTemplateMetadata__p1112135114414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowTemplateMetadata__p5121205144418">Unique template ID. It is randomly generated by the template service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row1811965104413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowTemplateMetadata__p12122953442">template_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowTemplateMetadata__p101220584413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowTemplateMetadata__p171232516449">Name of the template to be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row211914515445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowTemplateMetadata__p1612395134412">template_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowTemplateMetadata__p1912417594418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowTemplateMetadata__p11249514447">Template description. It can be used by users to identify their own templates.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row311915144414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowTemplateMetadata__p18126155114418">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowTemplateMetadata__p171263544410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowTemplateMetadata__p18126185134412">Creation time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row31197518445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowTemplateMetadata__p141271450448">update_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowTemplateMetadata__p1512717516449">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowTemplateMetadata__p11278515449">Update time of a template. The format complies with RFC 3339 (YYYY-MM-DDTHH:MM:SSZ), for example, 1970-01-01T00:00:00Z.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p8127653443"><strong id="ShowTemplateMetadata__b8128057445">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__en-us_topic_0000001709318826_response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row11284554418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ShowTemplateMetadata__p1512911513445">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ShowTemplateMetadata__p312910584411">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ShowTemplateMetadata__p161292519449">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row412810584418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowTemplateMetadata__p1412985154415">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowTemplateMetadata__p513012516449">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowTemplateMetadata__p9130165194418">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row7128175134416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowTemplateMetadata__p11130958447">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowTemplateMetadata__p3131115144414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowTemplateMetadata__p1213295114416">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p13132457446"><strong id="ShowTemplateMetadata__b1413213512449">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table1813211584411" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row913211584414"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ShowTemplateMetadata__p111341584415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ShowTemplateMetadata__p1813410554410">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ShowTemplateMetadata__p121344515448">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row21323514448"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowTemplateMetadata__p413465154410">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowTemplateMetadata__p1413545134411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowTemplateMetadata__p2135165164417">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row313216513445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowTemplateMetadata__p101354514419">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowTemplateMetadata__p213520574413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowTemplateMetadata__p151353534413">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p41355524414"><strong id="ShowTemplateMetadata__b151353511447">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table17136125154418" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row51362515447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ShowTemplateMetadata__p013615511443">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ShowTemplateMetadata__p121361852446">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ShowTemplateMetadata__p613665134411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row413610511441"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowTemplateMetadata__p1513710594411">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowTemplateMetadata__p9137105154418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowTemplateMetadata__p3137115144419">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row18136175134413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowTemplateMetadata__p1137135174413">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowTemplateMetadata__p91380514418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowTemplateMetadata__p151381512445">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p7138105124419"><strong id="ShowTemplateMetadata__b17138458445">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table1613815184418" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row713810574418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="ShowTemplateMetadata__p15139185164420">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="ShowTemplateMetadata__p17140175184412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="ShowTemplateMetadata__p61406554417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row41391257449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ShowTemplateMetadata__p201414517449">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ShowTemplateMetadata__p151412053442">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ShowTemplateMetadata__p181411955445">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row51399524414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="ShowTemplateMetadata__p9142115194410">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="ShowTemplateMetadata__p15142125104419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="ShowTemplateMetadata__p2142115184412">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p131436524419"><strong id="ShowTemplateMetadata__b18143135144412">Status code: 429</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table1014395174410" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row131438514415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="ShowTemplateMetadata__p214413544415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="ShowTemplateMetadata__p1614410554417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="ShowTemplateMetadata__p1914416514444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row1414325124412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ShowTemplateMetadata__p91447534413">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ShowTemplateMetadata__p13144165164414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ShowTemplateMetadata__p31441453449">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row161432574417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="ShowTemplateMetadata__p014435114411">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="ShowTemplateMetadata__p1114525174415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="ShowTemplateMetadata__p2145155184420">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowTemplateMetadata__p41451519447"><strong id="ShowTemplateMetadata__b1114517584417">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__table8145451449" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="ShowTemplateMetadata__row2145657448"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="ShowTemplateMetadata__p201464564411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="ShowTemplateMetadata__p214635204417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="ShowTemplateMetadata__p1214616564418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row10145145174415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="ShowTemplateMetadata__p6146185174418">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="ShowTemplateMetadata__p514785194415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="ShowTemplateMetadata__p71478511442">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row11145205154417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="ShowTemplateMetadata__p314715114420">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="ShowTemplateMetadata__p01471450447">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="ShowTemplateMetadata__p171474511448">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section1214718544420"><h4 class="sectiontitle">Example Requests</h4><ul id="ShowTemplateMetadata__ul13148185184411"><li id="ShowTemplateMetadata__li1014855144412">Obtain the metadata of the current template.<pre class="screen" id="ShowTemplateMetadata__screen714819511441">GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata</pre>
|
|
</li><li id="ShowTemplateMetadata__li1514819520448">Obtain the metadata of the current template and check whether the template ID matches the current template.<pre class="screen" id="ShowTemplateMetadata__screen2148252443">GET https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata?template_id=1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section1814845194418"><h4 class="sectiontitle">Example Responses</h4><p id="ShowTemplateMetadata__p414905104414"><strong id="ShowTemplateMetadata__b1014914514418">Status code: 200</strong></p>
|
|
<p id="ShowTemplateMetadata__p8149105174414">Template metadata obtained.</p>
|
|
<pre class="screen" id="ShowTemplateMetadata__screen171492510444">{
|
|
"template_id" : "69f8d5ea-eaa4-4a3b-a96d-bae9230e97c8",
|
|
"template_name" : "my_first_template",
|
|
"template_description" : "Template description",
|
|
"create_time" : "2023-05-09T08:00:00Z",
|
|
"update_time" : "2023-05-09T09:00:00Z"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowTemplateMetadata__section11503514446"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowTemplateMetadata__en-us_topic_0000001709318826_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowTemplateMetadata__row915016515443"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="ShowTemplateMetadata__p141511158440">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="ShowTemplateMetadata__p41518554418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowTemplateMetadata__row31516594412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p171511594415">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p715135184411">Template metadata obtained.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row171511456440"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p3152053446">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p1815218514415">Invalid request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row181518514446"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p21528518449">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p1115212534419">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row21512052445"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p01522524410">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p1815235124413">The user does not have the permission to call this API.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row61511259449"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p81536574416">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p41533534413">The template does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row115111511448"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p2015316519440">429</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p715315515447">Too frequent requests.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowTemplateMetadata__row1151165124411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="ShowTemplateMetadata__p201531050448">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="ShowTemplateMetadata__p9153953444">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Template Management</a></div>
|
|
</div>
|
|
</div>
|
|
|