forked from docs/doc-exports
chenjunjie
63188fad94
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: chenjunjie <chenjunjie@huawei.com> Co-committed-by: chenjunjie <chenjunjie@huawei.com>
472 lines
35 KiB
HTML
472 lines
35 KiB
HTML
<a name="ListConfigTemplates"></a><a name="ListConfigTemplates"></a>
|
|
|
|
<h1 class="topictitle1">Viewing Parameter Templates</h1>
|
|
<div id="body1708331107508"><div class="section" id="ListConfigTemplates__section4529203016481"><h4 class="sectiontitle">Function</h4><p id="ListConfigTemplates__p1352963004815">This API is used to query parameter templates of a tenant, and allows you to specify query criteria.</p>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section7529163015483"><h4 class="sectiontitle">URI</h4><p id="ListConfigTemplates__p17529143014820">GET /v2/{project_id}/config-templates</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table75302306486" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListConfigTemplates__row35291330164819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListConfigTemplates__p14530830124812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListConfigTemplates__p553013013482">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListConfigTemplates__p13530193014488">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListConfigTemplates__p6530830164814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row85299303483"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListConfigTemplates__p105302030154819">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListConfigTemplates__p195309305483">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListConfigTemplates__p9530203084811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListConfigTemplates__p553023019480">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table1853103054813" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListConfigTemplates__row453023054816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListConfigTemplates__p9531430114816">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListConfigTemplates__p175311730144810">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListConfigTemplates__p55311830154819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListConfigTemplates__p25311730154810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row2531133094812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p253123018487">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p1253193013483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p12531153094817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p253163019482">Parameter template name. Fuzzy search is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row12531133014819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p115329309483">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p4532173013481">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p15324306488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p1153212309486">Template type. Options:</p>
|
|
<ul id="ListConfigTemplates__ul175321030174817"><li id="ListConfigTemplates__li1753283084810"><strong id="ListConfigTemplates__b10532103019483">sys</strong>: default template</li><li id="ListConfigTemplates__li25321730104816"><strong id="ListConfigTemplates__b20532133013489">user</strong>: custom template</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row17531143010484"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p95321930134813">engine</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p653215306485">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p135326305482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p15532230154810">Cache engine: Redis.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row4531730164816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p1153313020485">engine_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p1453323018480">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p553323015485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p853363016485">Cache engine version.</p>
|
|
<p id="ListConfigTemplates__p05337307481">If the cache engine is Redis, the version can be 4.0/5.0/6.0/7.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row13531030124815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p75331730154813">cache_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p1453314307481">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p7533530144811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p553373064812">DCS instance type. The value range is as follows:</p>
|
|
<ul id="ListConfigTemplates__ul1533173015489"><li id="ListConfigTemplates__li25333309487"><strong id="ListConfigTemplates__b1753316305480">single</strong>: single-node</li><li id="ListConfigTemplates__li1853353018485"><strong id="ListConfigTemplates__b85331302484">ha</strong>: master/standby</li><li id="ListConfigTemplates__li165333306488"><strong id="ListConfigTemplates__b14534173064812">cluster</strong>: Redis Cluster</li><li id="ListConfigTemplates__li1553483034814"><strong id="ListConfigTemplates__b1853463017486">proxy</strong>: Proxy Cluster</li><li id="ListConfigTemplates__li1753418307485"><strong id="ListConfigTemplates__b185341030124813">ha_rw_split</strong>: read/write splitting</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row65311330174816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p753413014815">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p1253443011488">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p175341730144817">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p20534830154814">Offset, which is the position where the query starts. The value must be greater than or equal to 0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row25319305487"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListConfigTemplates__p13534153016488">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListConfigTemplates__p05341930104816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListConfigTemplates__p18534143010482">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListConfigTemplates__p16534203012485">Number of records displayed on each page. The minimum value is <strong id="ListConfigTemplates__b2534030204820">1</strong>. The maximum value is <strong id="ListConfigTemplates__b053453054811">1000</strong>. If this parameter is not specified, 10 records are displayed on each page by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section11534133084813"><h4 class="sectiontitle">Request Parameters</h4><p id="ListConfigTemplates__p75352030114810">None</p>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section953517305481"><h4 class="sectiontitle">Response Parameters</h4><p id="ListConfigTemplates__p7535173024814"><strong id="ListConfigTemplates__b253533084815">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__response_QueryConfigTemplatesListResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row205354309481"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListConfigTemplates__p55351030164817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListConfigTemplates__p145351330194820">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListConfigTemplates__p1453613014812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row5535930154813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListConfigTemplates__p6536230144820">template_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListConfigTemplates__p1953610300481">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListConfigTemplates__p11536153019481">Number of templates.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row14535930174814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListConfigTemplates__p185365305488">templates</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListConfigTemplates__p653610306483">Array of <a href="#ListConfigTemplates__response_ConfigTemplatesListInfo">ConfigTemplatesListInfo</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListConfigTemplates__p1653653013487">Template details array.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ListConfigTemplates__response_ConfigTemplatesListInfo"></a><a name="response_ConfigTemplatesListInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__response_ConfigTemplatesListInfo" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ConfigTemplatesListInfo</caption><thead align="left"><tr id="ListConfigTemplates__row1053693034814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListConfigTemplates__p153723016489">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListConfigTemplates__p14537930154813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListConfigTemplates__p65374305488">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row15536113084820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p2053710302485">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p65371530184810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p4537930194817">Template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row5536530154812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p18537153012483">cache_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p253763011483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p2538123018482">DCS instance type. The value range is as follows:</p>
|
|
<ul id="ListConfigTemplates__ul453893054812"><li id="ListConfigTemplates__li1953883012488"><strong id="ListConfigTemplates__b95389309486">single</strong>: single-node</li><li id="ListConfigTemplates__li15538143074817"><strong id="ListConfigTemplates__b1253833016489">ha</strong>: master/standby</li><li id="ListConfigTemplates__li853813034815"><strong id="ListConfigTemplates__b125381308483">cluster</strong>: Redis Cluster</li><li id="ListConfigTemplates__li1553814305485"><strong id="ListConfigTemplates__b145381030164810">proxy</strong>: Proxy Cluster</li><li id="ListConfigTemplates__li185381430114818"><strong id="ListConfigTemplates__b953814306485">ha_rw_split</strong>: read/write splitting</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row1536530104818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p15538203012487">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p55381307488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p14538153034817">Template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row3536230204819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p253814307484">engine</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p1539183054817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p6539153044817">Cache engine: Redis.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row253613013488"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p4539153013481">engine_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p12539133054816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p9539183011481">Cache version.</p>
|
|
<p id="ListConfigTemplates__p12539930114816">If the cache engine is Redis, the version can be 3.0/4.0/5.0/6.0/7.0.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row17537530184819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p45394309484">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p15395307481">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p253953044819">Template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row15537630144817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p15539330204810">product_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p1453973084818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p553903004816">Edition.</p>
|
|
<p id="ListConfigTemplates__p253917306483">Only the basic edition is supported. Value: <strong id="ListConfigTemplates__b18540193054816">generic</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row11537530174819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p1054011300486">storage_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p15409307488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p1754033034813">Storage type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row1953753084818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p1554013017487">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p14540530144820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p115401830124819">Template type. Options:</p>
|
|
<ul id="ListConfigTemplates__ul4540103064812"><li id="ListConfigTemplates__li17540530104813"><strong id="ListConfigTemplates__b125409306489">sys</strong>: default template</li><li id="ListConfigTemplates__li154043013488"><strong id="ListConfigTemplates__b254033010482">user</strong>: custom template</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row11537143016488"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListConfigTemplates__p6540143084815">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListConfigTemplates__p2540153064813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListConfigTemplates__p195403301484">Time when the template is created. This parameter is valid only in custom parameter templates. The format is 2023-05-10T11:09:35.802Z.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListConfigTemplates__p9541143074819"><strong id="ListConfigTemplates__b1454193024817">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row1154153019483"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListConfigTemplates__p1054183019482">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListConfigTemplates__p175411130154819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListConfigTemplates__p1954120302489">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row3541103020484"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListConfigTemplates__p19541530114820">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListConfigTemplates__p1654115305481">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListConfigTemplates__p1054117306481">Error information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row1154113303486"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListConfigTemplates__p8542153012482">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListConfigTemplates__p1754223064810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListConfigTemplates__p454273011485">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row254110305487"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListConfigTemplates__p1154213018483">error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListConfigTemplates__p954212302487">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListConfigTemplates__p18542330144811">Extended error information. This parameter is not used currently and is set to null.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListConfigTemplates__p854214301480"><strong id="ListConfigTemplates__b145420305486">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table12542930184814" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row25429302483"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListConfigTemplates__p1654273013486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListConfigTemplates__p654313054813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListConfigTemplates__p1954320306482">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row1354283017484"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListConfigTemplates__p554318301486">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListConfigTemplates__p135431630204816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListConfigTemplates__p135432307488">Error information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row95420302485"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListConfigTemplates__p15431130204820">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListConfigTemplates__p16543113064814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListConfigTemplates__p954323044815">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row19542143014819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListConfigTemplates__p3543133012480">error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListConfigTemplates__p14543173011487">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListConfigTemplates__p654333094811">Extended error information. This parameter is not used currently and is set to null.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListConfigTemplates__p1543103013482"><strong id="ListConfigTemplates__b105438309480">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table1454312301483" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row554418300489"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ListConfigTemplates__p1654453011486">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ListConfigTemplates__p1654483024815">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ListConfigTemplates__p15447307484">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row854443014816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListConfigTemplates__p55441830114816">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListConfigTemplates__p1554483015482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListConfigTemplates__p145441930114818">Error information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row5544133004816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListConfigTemplates__p15441030194816">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListConfigTemplates__p19545143011480">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListConfigTemplates__p16545153084819">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row7544123010481"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListConfigTemplates__p654513014481">error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListConfigTemplates__p105451530134814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListConfigTemplates__p165451130124816">Extended error information. This parameter is not used currently and is set to null.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListConfigTemplates__p454516300482"><strong id="ListConfigTemplates__b7545330144815">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table175455303484" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row1554519304488"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ListConfigTemplates__p354513308487">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ListConfigTemplates__p13545153064812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ListConfigTemplates__p165461030174811">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row1154593018484"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListConfigTemplates__p85468301483">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListConfigTemplates__p754618304489">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListConfigTemplates__p165461230134814">Error information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row654503094811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListConfigTemplates__p19546430124817">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListConfigTemplates__p8546830124813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListConfigTemplates__p35461430104815">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row154583015481"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListConfigTemplates__p3546113015481">error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListConfigTemplates__p3546113084816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListConfigTemplates__p2546830184813">Extended error information. This parameter is not used currently and is set to null.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ListConfigTemplates__p05461330154818"><strong id="ListConfigTemplates__b10546133084811">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__table45464305489" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListConfigTemplates__row16546530184811"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ListConfigTemplates__p4547630114815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ListConfigTemplates__p195471930194813">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ListConfigTemplates__p7547103011482">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row1546163011480"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListConfigTemplates__p7547163084813">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListConfigTemplates__p55472302485">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListConfigTemplates__p654773010481">Error information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row4547030204810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListConfigTemplates__p1654710303484">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListConfigTemplates__p18547730134811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListConfigTemplates__p145471730124819">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row354711303488"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListConfigTemplates__p1854823034813">error_ext_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListConfigTemplates__p1754893034814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListConfigTemplates__p154817300482">Extended error information. This parameter is not used currently and is set to null.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section135481730114813"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListConfigTemplates__screen3548630124817">GET https://{dcs_endpoint}/v2/{project_id}/config-templates?type=sys&engine=Redis&engine_version=5.0&cache_mode=ha&offset=0&limit=10</pre>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section7548103011486"><h4 class="sectiontitle">Example Responses</h4><p id="ListConfigTemplates__p454883054817"><strong id="ListConfigTemplates__b354853016480">Status code: 200</strong></p>
|
|
<p id="ListConfigTemplates__p754863084811">Parameter templates listed.</p>
|
|
<pre class="screen" id="ListConfigTemplates__screen5548193016481">{
|
|
"template_num" : 1,
|
|
"templates" : [ {
|
|
"template_id" : "6",
|
|
"cache_mode" : "single",
|
|
"description" : null,
|
|
"engine" : "Redis",
|
|
"engine_version" : "4.0",
|
|
"name" : "Default-Redis-4.0-single-generic-DRAM",
|
|
"product_type" : "generic",
|
|
"storage_type" : "DRAM",
|
|
"type" : "sys"
|
|
} ]
|
|
}</pre>
|
|
<p id="ListConfigTemplates__p6671130124811"><strong id="ListConfigTemplates__b12671103011480">Status code: 400</strong></p>
|
|
<p id="ListConfigTemplates__p136711830104819">Invalid request.</p>
|
|
<pre class="screen" id="ListConfigTemplates__screen867110306488">{
|
|
"error_code" : "111400063",
|
|
"error_msg" : "Invalid {0} parameter in the request."
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section467113016482"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListConfigTemplates__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListConfigTemplates__row7550173054815"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListConfigTemplates__p1667112308487">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListConfigTemplates__p067153054813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListConfigTemplates__row755063014817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p116712302485">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p567153094815">Parameter templates listed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row155043013482"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p867116308488">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p10671230124813">Invalid request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row175508300486"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p13671430174811">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p467173011483">Invalid authentication information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row9550193019488"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p567114301487">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p2671830124812">Request rejected.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row10550163064812"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p76711530154812">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p767117307483">The requested resource could not be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListConfigTemplates__row555017307484"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListConfigTemplates__p176724308483">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListConfigTemplates__p1667233015482">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListConfigTemplates__section367283012485"><h4 class="sectiontitle">Error Codes</h4><p id="ListConfigTemplates__p196722304484">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="ConfigTemplatesManagement.html">Template Management</a></div>
|
|
</div>
|
|
</div>
|
|
|