forked from docs/doc-exports
Ru, Li Yi
a6e39ff5b3
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
225 lines
17 KiB
HTML
225 lines
17 KiB
HTML
<a name="dds_api_0089"></a><a name="dds_api_0089"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Details About a Parameter Template</h1>
|
|
<div id="body0000001849930865"><div class="section" id="dds_api_0089__section4850156117316"><h4 class="sectiontitle">Description</h4><p id="dds_api_0089__p3631239417316">This API is used to obtain parameter details of a specified parameter template.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section1239972118494"><h4 class="sectiontitle">Restrictions</h4><p id="dds_api_0089__p19233920413">This API applies only to DDS Community Edition.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0089__ul3084351717316"><li id="dds_api_0089__li915620217316">URI format<p id="dds_api_0089__p27453176141627"><a name="dds_api_0089__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0089__table03619411436" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0089__en-us_topic_0000001444290078_row1936154118319"><th align="left" class="cellrowborder" valign="top" width="19.81801819818018%" id="mcps1.3.4.2.5.1.1"><p id="dds_api_0089__en-us_topic_0000001444290078_p39908856103714">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.127987201279872%" id="mcps1.3.4.2.5.1.2"><p id="dds_api_0089__en-us_topic_0000001444290078_p11391927103714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.928007199280074%" id="mcps1.3.4.2.5.1.3"><p id="dds_api_0089__en-us_topic_0000001444290078_p164691370227">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.12598740125987%" id="mcps1.3.4.2.5.1.4"><p id="dds_api_0089__en-us_topic_0000001444290078_p50330890103714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0089__en-us_topic_0000001444290078_row94099518410"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.4.2.5.1.1 "><p id="dds_api_0089__en-us_topic_0000001444290078_p12641444155011">x-auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.4.2.5.1.2 "><p id="dds_api_0089__en-us_topic_0000001444290078_p201393327416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.4.2.5.1.3 "><p id="dds_api_0089__en-us_topic_0000001444290078_p204090517412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.4.2.5.1.4 "><p id="dds_api_0089__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__en-us_topic_0000001444290078_row10371141739"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.4.2.5.1.1 "><p id="dds_api_0089__en-us_topic_0000001444290078_p12131101217518">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.4.2.5.1.2 "><p id="dds_api_0089__en-us_topic_0000001444290078_p1125163318414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.4.2.5.1.3 "><p id="dds_api_0089__en-us_topic_0000001444290078_p154701279220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.4.2.5.1.4 "><p id="dds_api_0089__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__en-us_topic_0000001444290078_row183715411231"><td class="cellrowborder" valign="top" width="19.81801819818018%" headers="mcps1.3.4.2.5.1.1 "><p id="dds_api_0089__en-us_topic_0000001444290078_p161311712115113">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.127987201279872%" headers="mcps1.3.4.2.5.1.2 "><p id="dds_api_0089__en-us_topic_0000001444290078_p21257332048">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.928007199280074%" headers="mcps1.3.4.2.5.1.3 "><p id="dds_api_0089__en-us_topic_0000001444290078_p174701071226">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.12598740125987%" headers="mcps1.3.4.2.5.1.4 "><p id="dds_api_0089__en-us_topic_0000001444290078_p44083492103714">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section3074340117316"><h4 class="sectiontitle">Requests</h4><p id="dds_api_0089__p8531249202414">None</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0089__ul43449544"><li id="dds_api_0089__li55501577">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0089__table29752153" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_0089__row62070345"><th align="left" class="cellrowborder" valign="top" width="25.81258125812581%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="dds_api_0089__p61642077">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.854085408540854%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="dds_api_0089__p26952341">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="dds_api_0089__p35656026">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0089__row18491959181412"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p08548122141">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p74915914147">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p548542622016">The parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row1449612217152"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p085491261414">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p1349772101513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p1748520266206">Parameter template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row117721152164917"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p178541712121418">datastore_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p127721452134919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p19485326182011">Database version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row1298605617492"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p19854151215145">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p29866565494">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p24851626112012">Database type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row175261239112018"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p14854712131420">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p145262039202012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p3485172682019">The parameter template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row6889727165110"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p4854111251417">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p1588914278512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p144455451489">Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0089__p944517454483"><strong id="dds_api_0089__b1471105017412">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0089__b672125017419">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row18356732175113"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p10356432135120">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p17356832195117">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p4445174518485">Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0089__p1244584514483"><strong id="dds_api_0089__b1179885716412">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0089__b15799657174118">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row2456979"><td class="cellrowborder" valign="top" width="25.81258125812581%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="dds_api_0089__p64797609">parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.854085408540854%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="dds_api_0089__p18625313281">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="dds_api_0089__p22140377">The parameters defined by users based on the default parameter templates.</p>
|
|
<p id="dds_api_0089__p1924911122210">For details, see <a href="#dds_api_0089__table34207804">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0089__table34207804"></a><a name="table34207804"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0089__table34207804" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Data structure description of the parameters field</caption><thead align="left"><tr id="dds_api_0089__row41360766"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.1"><p id="dds_api_0089__p61887768">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.2"><p id="dds_api_0089__p46853302">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.2.1.2.2.4.1.3"><p id="dds_api_0089__p37021121">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0089__row45920800"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p106171951142118">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p11617175117217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p13617205113213">The parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row17338174644719"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p6617145110217">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p461775111217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p0617251182111">The parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row24783327165741"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p1661785113214">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p156171518217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p76171951172113">The parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row1566791035515"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p1861712516215">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p16617751112118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p1520773582210">Parameter type.</p>
|
|
<p id="dds_api_0089__p941910316221">The value can be <strong id="dds_api_0089__b164392913424">integer</strong>, <strong id="dds_api_0089__b1664432912427">string</strong>, <strong id="dds_api_0089__b1564542974213">boolean</strong>, <strong id="dds_api_0089__b664622994213">float</strong>, or <strong id="dds_api_0089__b264742910429">list</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row1554173111516"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p19617145118218">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p146171351162110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p14855154062217">Value range.</p>
|
|
<p id="dds_api_0089__p2617185119219">For example, the value of integer is 0 or 1, and the value of boolean is true or false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row3494747312729"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p6084539712735">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p2953011612735">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p11118911101618">Whether the instance needs to be restarted.</p>
|
|
<ul id="dds_api_0089__ul311225836"><li id="dds_api_0089__li31121254312">If the value is <strong id="dds_api_0089__b2071913472017">true</strong>, restart is required.</li><li id="dds_api_0089__li162585711319">If the value is <strong id="dds_api_0089__b1253235012015">false</strong>, restart is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0089__row4285123593"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="dds_api_0089__p12971285911">readonly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="dds_api_0089__p129012175913">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="dds_api_0089__p142471933586">Whether the parameter is read-only.</p>
|
|
<ul id="dds_api_0089__ul123466117319"><li id="dds_api_0089__li83461111231">If the value is <strong id="dds_api_0089__b172742575014">true</strong>, the parameter is read-only.</li><li id="dds_api_0089__li172942131733">If the value <strong id="dds_api_0089__b1759911587018">false</strong>, the parameter is not read-only.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0089__ul3068848"><li id="dds_api_0089__li27619632">Response example<pre class="codeblock" id="dds_api_0089__codeblock33691334152520">{
|
|
"id": "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
|
|
"name": "paramsGroup-test",
|
|
"description": "",
|
|
"datastore_name": "mongodb",
|
|
"datastore_version": "4.0",
|
|
"created": "2017-01-01T10:00:00",
|
|
"updated": "2017-01-01T10:00:00",
|
|
"parameters": [
|
|
{
|
|
"name": "cursorTimeoutMillis",
|
|
"type": "integer",
|
|
"value": "600000",
|
|
"description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
|
|
"value_range": "600000-1000000",
|
|
"restart_required": false,
|
|
"readonly": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section7839132617517"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0089__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0089__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0089__section15839126352"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0089__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_0085.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|