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>
219 lines
17 KiB
HTML
219 lines
17 KiB
HTML
<a name="dds_api_0088"></a><a name="dds_api_0088"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Parameter Templates</h1>
|
|
<div id="body0000001803212092"><div class="section" id="dds_api_0088__section43822836102534"><h4 class="sectiontitle">Description</h4><p id="dds_api_0088__p59988804102534">This API is used to obtain parameter templates, including all databases' default parameter templates and user-created parameter templates.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0088__section1239972118494"><h4 class="sectiontitle">Restrictions</h4><p id="dds_api_0088__p1055024010241">This API applies only to DDS Community Edition.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0088__section3028329102534"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0088__ul43968097102534"><li id="dds_api_0088__li60168558102534">URI format<p id="dds_api_0088__p66392350144331"><a name="dds_api_0088__li60168558102534"></a><a name="li60168558102534"></a>GET https://{Endpoint}/v3/{project_id}/configurations</p>
|
|
</li></ul>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0088__table14964145062418" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0088__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_0088__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_0088__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_0088__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_0088__en-us_topic_0000001444290078_p50330890103714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0088__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_0088__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_0088__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_0088__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_0088__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__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_0088__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_0088__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_0088__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_0088__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0088__table128231546162" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="dds_api_0088__row190518462613"><th align="left" class="cellrowborder" valign="top" width="22.697730226977303%" id="mcps1.3.5.2.5.1.1"><p id="dds_api_0088__p990584613611">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.528247175282473%" id="mcps1.3.5.2.5.1.2"><p id="dds_api_0088__p8905946761">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.3985601439856%" id="mcps1.3.5.2.5.1.3"><p id="dds_api_0088__p867423017565">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.37546245375462%" id="mcps1.3.5.2.5.1.4"><p id="dds_api_0088__p1190513465617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0088__row1906846369"><td class="cellrowborder" valign="top" width="22.697730226977303%" headers="mcps1.3.5.2.5.1.1 "><p id="dds_api_0088__p49067465615">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.528247175282473%" headers="mcps1.3.5.2.5.1.2 "><p id="dds_api_0088__p1390619461565">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.3985601439856%" headers="mcps1.3.5.2.5.1.3 "><p id="dds_api_0088__p6674730175612">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.37546245375462%" headers="mcps1.3.5.2.5.1.4 "><p id="dds_api_0088__p0906746667">The index position. If <strong id="dds_api_0088__b99962281287">offset</strong> is set to <em id="dds_api_0088__i599717289816">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="dds_api_0088__b4998142814817">0</strong> by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row99061469613"><td class="cellrowborder" valign="top" width="22.697730226977303%" headers="mcps1.3.5.2.5.1.1 "><p id="dds_api_0088__p5906124616617">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.528247175282473%" headers="mcps1.3.5.2.5.1.2 "><p id="dds_api_0088__p119062461863">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.3985601439856%" headers="mcps1.3.5.2.5.1.3 "><p id="dds_api_0088__p136744309565">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.37546245375462%" headers="mcps1.3.5.2.5.1.4 "><p id="dds_api_0088__p49063469611">Number of records displayed on each page. The default value is 100.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="dds_api_0088__section539814130256"><h4 class="sectiontitle">Requests</h4><p id="dds_api_0088__p98619332019">None</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0088__section40814386102534"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0088__ul17630940102534"><li id="dds_api_0088__li24460734102534">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0088__table18820018102534" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_0088__row31964513102534"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.7.2.1.1.2.4.1.1"><p id="dds_api_0088__p38988735102534">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.82%" id="mcps1.3.7.2.1.1.2.4.1.2"><p id="dds_api_0088__p3970933102534">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.7.2.1.1.2.4.1.3"><p id="dds_api_0088__p53210156102534">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0088__row42606123197"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.7.2.1.1.2.4.1.1 "><p id="dds_api_0088__p129325366120">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.7.2.1.1.2.4.1.2 "><p id="dds_api_0088__p09322361128">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.7.2.1.1.2.4.1.3 "><p id="dds_api_0088__p693216368127">The total number of queried records.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row10266102582712"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.7.2.1.1.2.4.1.1 "><p id="dds_api_0088__p2057010018342">quota</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.7.2.1.1.2.4.1.2 "><p id="dds_api_0088__p857012013345">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.7.2.1.1.2.4.1.3 "><p id="dds_api_0088__p1570150113411">Maximum number of custom parameter templates that can be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row15055371102534"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.7.2.1.1.2.4.1.1 "><p id="dds_api_0088__p11525563102534">configurations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.7.2.1.1.2.4.1.2 "><p id="dds_api_0088__p61155428102534">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.7.2.1.1.2.4.1.3 "><p id="dds_api_0088__p22021397102534">The parameter template list. For details, see <a href="#dds_api_0088__table11320215139">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0088__table11320215139"></a><a name="table11320215139"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0088__table11320215139" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure description of the configurations field</caption><thead align="left"><tr id="dds_api_0088__row18113192161319"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.7.2.1.2.2.4.1.1"><p id="dds_api_0088__p811372131320">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.7.2.1.2.2.4.1.2"><p id="dds_api_0088__p81131227138">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.7.2.1.2.2.4.1.3"><p id="dds_api_0088__p31134231317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0088__row131132281317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p1411318291315">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p811362181317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p16113152131316">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row611319220139"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p711311213133">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p111138201313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p1211310231316">Parameter template name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row171136218130"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p61133251311">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p161131328136">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p10113102151312">Parameter template description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row15113172181313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p4113202161314">datastore_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p161133220137">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p161131271318">Database version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row2113112101313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p2113123139">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p1011342141317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p9113122161314">Database type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row868193505411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p117715108576">node_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p168535115418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p42472579564">Node type of the parameter template.</p>
|
|
<ul id="dds_api_0088__ul376682316576"><li id="dds_api_0088__li19766182315713"><strong id="dds_api_0088__b19820202111205">mongos</strong>: the mongos node type.</li><li id="dds_api_0088__li12652617583"><strong id="dds_api_0088__b1194210114211">shard</strong>: the shard node type.</li><li id="dds_api_0088__li15554920581"><strong id="dds_api_0088__b230010442118">config</strong>: the config node type.</li><li id="dds_api_0088__li451701835812"><strong id="dds_api_0088__b07149672110">replica</strong>: the replica set type.</li><li id="dds_api_0088__li7671152615816"><strong id="dds_api_0088__b280814142120">single</strong> the single node type.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row181136221312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p1511319217137">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p201131217131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p198731432151318">Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0088__p21141026136"><strong id="dds_api_0088__b9565183851312">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0088__b125661638181310">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row2114427134"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p7114827130">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p12114729132">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p1466713146">Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0088__p411492131312"><strong id="dds_api_0088__b85550529132">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0088__b955685271313">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0088__row19114152161318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.1 "><p id="dds_api_0088__p141147221319">user_defined</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.7.2.1.2.2.4.1.2 "><p id="dds_api_0088__p1411412213137">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.7.2.1.2.2.4.1.3 "><p id="dds_api_0088__p311410261319">Indicates whether the parameter template is created by users.</p>
|
|
<ul id="dds_api_0088__ul1211416211138"><li id="dds_api_0088__li171142251314"><strong id="dds_api_0088__b1197719391331">false</strong>: The parameter template is a default parameter template.</li><li id="dds_api_0088__li7114421134"><strong id="dds_api_0088__b1897413412035">true</strong>: The parameter template is a custom template.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0088__ul20016014102534"><li id="dds_api_0088__li45926399102534">Response example<pre class="codeblock" id="dds_api_0088__codeblock972890162119">{
|
|
"total_count" : 1,
|
|
"quota" : 100,
|
|
"configurations" : [ {
|
|
"id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr01",
|
|
"name" : "test1",
|
|
"description" : "",
|
|
"datastore_name" : "mongos",
|
|
"node_type":"shard",
|
|
"datastore_version" : "4.0",
|
|
"created" : "2017-01-01T10:00:00",
|
|
"updated" : "2017-01-01T10:00:00",
|
|
"user_defined" : true
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0088__section12691841557"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0088__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0088__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_0088__section826914414514"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0088__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>
|
|
|