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>
256 lines
21 KiB
HTML
256 lines
21 KiB
HTML
<a name="dds_api_0108"></a><a name="dds_api_0108"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Parameters of a Specified DB Instance</h1>
|
|
<div id="body0000001850010917"><div class="section" id="dds_api_0108__section1847881504818"><h4 class="sectiontitle">Description</h4><p id="dds_api_0108__p1573291514816">This API is used to obtain information about parameters of a specified DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0108__section547961515489"><h4 class="sectiontitle">Restrictions</h4><p id="dds_api_0108__p20881202246">This API applies only to DDS Community Edition.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0108__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0108__ul27808384103438"><li id="dds_api_0108__li48948865103438">URI format<p id="dds_api_0108__p1052915415827"><a name="dds_api_0108__li48948865103438"></a><a name="li48948865103438"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0108__section1149610156483"><h4 class="sectiontitle">Requests</h4><p id="dds_api_0108__p11396171212131">Parameter description</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0108__table42529115462" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0108__row1825218114619"><th align="left" class="cellrowborder" valign="top" width="20.99209920992099%" id="mcps1.3.4.3.2.6.1.1"><p id="dds_api_0108__p102524134611">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.991399139913991%" id="mcps1.3.4.3.2.6.1.2"><p id="dds_api_0108__p2025217110467">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.2010201020102%" id="mcps1.3.4.3.2.6.1.3"><p id="dds_api_0108__p9759059174611">IN</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.85128512851285%" id="mcps1.3.4.3.2.6.1.4"><p id="dds_api_0108__p1325311124611">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.964196419641965%" id="mcps1.3.4.3.2.6.1.5"><p id="dds_api_0108__p325310119469">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0108__row12531113468"><td class="cellrowborder" valign="top" width="20.99209920992099%" headers="mcps1.3.4.3.2.6.1.1 "><p id="dds_api_0108__p7136240104613">x-auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.991399139913991%" headers="mcps1.3.4.3.2.6.1.2 "><p id="dds_api_0108__p1913613402468">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2010201020102%" headers="mcps1.3.4.3.2.6.1.3 "><p id="dds_api_0108__p57601259114619">header</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85128512851285%" headers="mcps1.3.4.3.2.6.1.4 "><p id="dds_api_0108__p11136540154618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.964196419641965%" headers="mcps1.3.4.3.2.6.1.5 "><p id="dds_api_0108__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row175171328154811"><td class="cellrowborder" valign="top" width="20.99209920992099%" headers="mcps1.3.4.3.2.6.1.1 "><p id="dds_api_0108__en-us_topic_0121682347_p118689123320">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.991399139913991%" headers="mcps1.3.4.3.2.6.1.2 "><p id="dds_api_0108__en-us_topic_0121682347_p1486815116337">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2010201020102%" headers="mcps1.3.4.3.2.6.1.3 "><p id="dds_api_0108__p198701715143915">header</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85128512851285%" headers="mcps1.3.4.3.2.6.1.4 "><p id="dds_api_0108__en-us_topic_0121682347_p1186841163310">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.964196419641965%" headers="mcps1.3.4.3.2.6.1.5 "><p id="dds_api_0108__p1393017442326">MIME type of the request body. You are advised to use the default value <strong id="dds_api_0108__b181011653152419">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row5273319144613"><td class="cellrowborder" valign="top" width="20.99209920992099%" headers="mcps1.3.4.3.2.6.1.1 "><p id="dds_api_0108__p1113764034611">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.991399139913991%" headers="mcps1.3.4.3.2.6.1.2 "><p id="dds_api_0108__p201371140154617">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2010201020102%" headers="mcps1.3.4.3.2.6.1.3 "><p id="dds_api_0108__p276025916463">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85128512851285%" headers="mcps1.3.4.3.2.6.1.4 "><p id="dds_api_0108__p15137840104613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.964196419641965%" headers="mcps1.3.4.3.2.6.1.5 "><p id="dds_api_0108__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row144441827114613"><td class="cellrowborder" valign="top" width="20.99209920992099%" headers="mcps1.3.4.3.2.6.1.1 "><p id="dds_api_0108__p31371340144619">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.991399139913991%" headers="mcps1.3.4.3.2.6.1.2 "><p id="dds_api_0108__p10137154016462">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.2010201020102%" headers="mcps1.3.4.3.2.6.1.3 "><p id="dds_api_0108__p19760105914611">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85128512851285%" headers="mcps1.3.4.3.2.6.1.4 "><p id="dds_api_0108__p91374403468">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.964196419641965%" headers="mcps1.3.4.3.2.6.1.5 "><p id="dds_api_0108__p15648192316515">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0108__table1881215401284" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="dds_api_0108__row17812940185"><th align="left" class="cellrowborder" valign="top" width="22.697730226977303%" id="mcps1.3.4.4.2.5.1.1"><p id="dds_api_0108__p08126401814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.02819718028197%" id="mcps1.3.4.4.2.5.1.2"><p id="dds_api_0108__p68135401889">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.898610138986104%" id="mcps1.3.4.4.2.5.1.3"><p id="dds_api_0108__p73354501483">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.37546245375462%" id="mcps1.3.4.4.2.5.1.4"><p id="dds_api_0108__p128138401812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0108__row181318401580"><td class="cellrowborder" valign="top" width="22.697730226977303%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dds_api_0108__p1381312401485">entity_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.02819718028197%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dds_api_0108__p12813154013813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.898610138986104%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dds_api_0108__p233565010811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.37546245375462%" headers="mcps1.3.4.4.2.5.1.4 "><ul id="dds_api_0108__ul88131840382"><li id="dds_api_0108__li1881334015816">Instance ID, group ID, or node ID. You can call the API used for querying instances and details to obtain the value. If you do not have an instance, you can call the API used for creating an instance.</li><li id="dds_api_0108__li168135407816">If the DB instance type is cluster and the shard or config parameter template is obtained, the value is the group ID. If the parameter template of the mongos node is obtained, the value is the node ID.</li><li id="dds_api_0108__li8813240688">If the DB instance type is a replica set instance or a single node instance, the value is the instance ID.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dds_api_0108__section1139851116295"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0108__ul1073201510487"><li id="dds_api_0108__li197321415114819">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0108__table11501181513486" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_0108__row3732715134818"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0108__p1273391534817">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0108__p2073318154487">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.54%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0108__p157336154484">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0108__row27561173412"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p5351829112813">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p13522911283">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p173542913285">Instance parameter configuration ID. This parameter can be used only for parameter comparison.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row1484871773619"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p1835429192818">node_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p1536142932810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p183662916283">Node type of the parameter template.</p>
|
|
<ul id="dds_api_0108__ul143613292288"><li id="dds_api_0108__li1836162912289"><strong id="dds_api_0108__b5158119131517">mongos</strong>: the mongos node type.</li><li id="dds_api_0108__li1236102992820"><strong id="dds_api_0108__b724813146156">shard</strong>: the shard node type.</li><li id="dds_api_0108__li636122920281"><strong id="dds_api_0108__b125871717158">config</strong>: the config node type.</li><li id="dds_api_0108__li1736172922814"><strong id="dds_api_0108__b1421117191156">replica</strong>: the replica set type.</li><li id="dds_api_0108__li11366290281"><strong id="dds_api_0108__b119612541514">single</strong>: the single node type.</li><li id="dds_api_0108__li203642982816"><strong id="dds_api_0108__b13909182701520">readonly</strong>: the read replica type.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row12733115174820"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p12795113871414">datastore_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p1479563819143">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p8795143820140">Database version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row17331415104818"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p979563812149">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p1079543815144">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p2795133851414">Database type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row13733111511486"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p879593813142">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p1279513818142">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p1359834220149">Creation time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0108__p47952383145"><strong id="dds_api_0108__b4422411133212">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0108__b14227115324">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row573341516487"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p6795193811411">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p779583841411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p1056514591414">Update time in the "yyyy-MM-ddTHH:mm:ssZ" format.</p>
|
|
<p id="dds_api_0108__p1679503815145"><strong id="dds_api_0108__b34131693217">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0108__b1051416143214">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row1573315159484"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0108__p173321512483">parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0108__p18625313281">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0108__p6733115144811">Indicates the parameters defined by users based on the default parameter templates.</p>
|
|
<p id="dds_api_0108__p10733131564815">For details, see <a href="#dds_api_0108__table5590121518481">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0108__table5590121518481"></a><a name="table5590121518481"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0108__table5590121518481" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure description of the parameters field</caption><thead align="left"><tr id="dds_api_0108__row10733615144820"><th align="left" class="cellrowborder" valign="top" width="23.22%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="dds_api_0108__p1973310153484">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.419999999999998%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="dds_api_0108__p12733101518484">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.36%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="dds_api_0108__p16733615134819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0108__row3733915204811"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p181219116160">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p8812151121614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p1981219112162">The parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row157331715164815"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p198121711166">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p1281311119163">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p1781351101612">Parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row17347159483"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p108132016163">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p48134116168">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p3564131616161">The value range.</p>
|
|
<p id="dds_api_0108__p1381317117167">For example, the value of the Integer type ranges from <strong id="dds_api_0108__b08165534328">0</strong> to <strong id="dds_api_0108__b158180532328">1</strong>, and the value of the Boolean type is <strong id="dds_api_0108__b4819175383214">true</strong> or <strong id="dds_api_0108__b28201153193214">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row11734121534815"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p781318118168">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p78136151614">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p28131110162">Whether the instance needs to be restarted.</p>
|
|
<ul id="dds_api_0108__ul16813151121614"><li id="dds_api_0108__li1881321171616">If the value is <strong id="dds_api_0108__b5226612337">true</strong>, restart is required.</li><li id="dds_api_0108__li168134111164">If the value is <strong id="dds_api_0108__b1236513163313">false</strong>, restart is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row273461512489"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p178134111165">readonly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p198137112165">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p178132111166">Whether the parameter group is read-only.</p>
|
|
<ul id="dds_api_0108__ul181341131620"><li id="dds_api_0108__li0813512165">If the value <strong id="dds_api_0108__b5640452144616">false</strong>, the parameter is not read-only.</li><li id="dds_api_0108__li1781319141611">If the value is <strong id="dds_api_0108__b1623214106338">true</strong>, the parameter is read-only.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row67341915194816"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p681319115169">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p68132151615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p1081318181612">The parameter type. The value can be <strong id="dds_api_0108__b7367181313317">integer</strong>, <strong id="dds_api_0108__b14369101303310">string</strong>, <strong id="dds_api_0108__b437014136331">boolean</strong>, <strong id="dds_api_0108__b2372131316338">float</strong>, or <strong id="dds_api_0108__b73731413193312">list</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0108__row17734101584815"><td class="cellrowborder" valign="top" width="23.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0108__p8813121121612">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.419999999999998%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0108__p188131814164">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.36%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0108__p158132110164">The parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dds_api_0108__ul187340158483"><li id="dds_api_0108__li13734201515484">Response example<pre class="codeblock" id="dds_api_0108__codeblock136628588189">{
|
|
"id" : "5afa71df29ed4378bd7f6fef107daf6fin02",
|
|
"node_type" : "replica",
|
|
"datastore_version" : "4.0",
|
|
"datastore_name" : "mongos",
|
|
"created" : "2017-01-01T10:00:00",
|
|
"updated" : "2017-01-01T10:00:00",
|
|
"parameters" : [ {
|
|
"name" : "cursorTimeoutMillis",
|
|
"value" : "600000",
|
|
"restart_required" : false,
|
|
"readonly" : false,
|
|
"description": "Specify the expiration time of idle cursors. DDS will delete idle cursors.",
|
|
"value_range" : "600000-1000000"
|
|
} ]
|
|
} </pre>
|
|
</li></ul>
|
|
<div class="section" id="dds_api_0108__section116981586518"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0108__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0108__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_0108__section1669825816517"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0108__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>
|
|
|