forked from docs/doc-exports
Ru, Li Yi
37b97ffc06
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>
230 lines
17 KiB
HTML
230 lines
17 KiB
HTML
<a name="nosql_06_0007"></a><a name="nosql_06_0007"></a>
|
|
|
|
<h1 class="topictitle1">Querying Instance Parameter Settings</h1>
|
|
<div id="body1932024102010"><div class="section" id="nosql_06_0007__section83315242204"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0007__p5361824152016">This API is used to query instance parameter settings.</p>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0007__p12792357124410">This API supports GeminiDB Cassandra instances.</p>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section669112417204"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0007__p172162414208">GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__table7781724182014" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0007__row37512249200"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0007__p38052418201">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_06_0007__p2835249206">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_06_0007__p9853242202">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_06_0007__p788172402019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_06_0007__row157516241208"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0007__p391122416201">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0007__p17942024142014">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0007__p1896112442019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0007__p18991224172012">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row075192462017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0007__p4102172418204">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0007__p910518248202">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0007__p1810817249209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0007__p131107242201">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section141131124202019"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0007__row141171124112015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0007__p151221224182018">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0007__p6124172462010">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0007__p612772417209">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_06_0007__p5130524122018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_06_0007__row81171224152018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0007__p61321024142014">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0007__p81361424122017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0007__p1613872410203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0007__p914122411208">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section9144102420202"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0007__p314762412208"><strong id="nosql_06_0007__b53023254368">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__response_ShowInstanceConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0007__row8150524192014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0007__p2015482482017">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_06_0007__p315710241203">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_06_0007__p816022472017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_06_0007__row17150182418209"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p101631724122018">datastore_version_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p12166524172019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p12169624132016">Database version name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row515018246205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p1517232411200">datastore_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p19174122415202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p81771224122013">Database name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row1715072414204"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p1418052422018">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p818316246209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p17187224122010">Creation time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
|
|
<p id="nosql_06_0007__p5191224112017"><strong id="nosql_06_0007__b15738852163614">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0007__b5749205243617">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row1715013244203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p9194824162019">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p2019752432015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p16200172415205">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
|
|
<p id="nosql_06_0007__p10205124102015"><strong id="nosql_06_0007__b1943772173719">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0007__b3439102119377">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row17411451195716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p17411125145719">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p6411185195718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p241155195710">Parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row2466948155718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p15466548115717">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p1466134815720">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p119732591511">Instance type. The value can be:</p>
|
|
<p id="nosql_06_0007__p67984319220"><strong id="nosql_06_0007__b148181141329">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0007__text4603113651810">GeminiDB Cassandra</span> cluster type.</p>
|
|
<p id="nosql_06_0007__p11887521222"><strong id="nosql_06_0007__b572293311218">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0007__text1672642991919">GeminiDB Influx</span> cluster type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row41501224172015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0007__p122071424132015">configuration_parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0007__p621018246208">Array of <a href="#nosql_06_0007__response_ConfigurationParameterResult">ConfigurationParameterResult</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0007__p4214324142013">Parameters defined by users based on a default parameter template.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="nosql_06_0007__response_ConfigurationParameterResult"></a><a name="response_ConfigurationParameterResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0007__response_ConfigurationParameterResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ConfigurationParameterResult</caption><thead align="left"><tr id="nosql_06_0007__row1821717240204"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_06_0007__p10222424182014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_06_0007__p5230102417205">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_06_0007__p192325247201">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_06_0007__row82171424192018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p323552442013">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p223832410203">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p11240924102018">Parameter name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row14217162411205"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p192451724162014">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p11248112452016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p122511324122012">Parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row152172024132013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p112531324192013">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p525642492011">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p17260102418203">Whether the instance needs to be restarted. The value can be:</p>
|
|
<ul id="nosql_06_0007__ul1226242412013"><li id="nosql_06_0007__li15263724202010"><strong id="nosql_06_0007__b109251920133814">false</strong>, indicating that the instance does not need to be restarted.</li><li id="nosql_06_0007__li1326692410200"><strong id="nosql_06_0007__b17353112715387">true</strong>, indicating that the instance needs to be restarted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row142171024172011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p182691224182019">readonly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p11272142419203">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p3275524142014">Whether the parameter is read-only. The value can be:</p>
|
|
<ul id="nosql_06_0007__ul027772442018"><li id="nosql_06_0007__li8279142462012"><strong id="nosql_06_0007__b203771848144015">false</strong>, indicating that the parameter is not read-only.</li><li id="nosql_06_0007__li202825240208"><strong id="nosql_06_0007__b33378159412">true</strong>, indicating that the parameter is read-only.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row11217202492014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p11285102411209">value_range</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p9288172492011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p14291192411207">Value range. For example, the value of the Integer type ranges from <strong id="nosql_06_0007__b3698192534117">0</strong> to <strong id="nosql_06_0007__b670022515414">1</strong>, and the value of the Boolean type is <strong id="nosql_06_0007__b157018253419">true</strong> or <strong id="nosql_06_0007__b6702125114117">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row1821782411203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p1294202411209">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p1929610245202">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p11299924202014">Parameter type. The value can be <strong id="nosql_06_0007__b980444344112">string</strong>, <strong id="nosql_06_0007__b2080519432410">integer</strong>, <strong id="nosql_06_0007__b1806154324119">boolean</strong>, <strong id="nosql_06_0007__b780610431416">list</strong>, or <strong id="nosql_06_0007__b280734344112">float</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_06_0007__row17217122432014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0007__p0301202472017">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0007__p1330402419205">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0007__p4308324192012">Parameter description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section131172410205"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0007__p74431203282">URI example<pre class="screen" id="nosql_06_0007__screen1023681116333">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations </pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section15329202420203"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0007__p033217245208"><strong id="nosql_06_0007__b4532817425">Status code: 200</strong></p>
|
|
<p id="nosql_06_0007__p133341124162014">Success</p>
|
|
<pre class="screen" id="nosql_06_0007__screen1334112243207">{
|
|
"datastore_version_name" : "3.11",
|
|
"datastore_name" : "cassandra",
|
|
"created" : "2020-03-21 11:40:44",
|
|
"updated" : "2020-03-21 11:40:44",
|
|
"id": "9ad6bc82146e4043a50c963ab3bf09adpr06",
|
|
"mode": "Cluster",
|
|
"configuration_parameters" : [ {
|
|
"name" : "concurrent_reads",
|
|
"value" : "64",
|
|
"restart_required" : true,
|
|
"readonly" : true,
|
|
"value_range" : "4-512",
|
|
"type" : "integer",
|
|
"description" : "Number of concurrent read threads."
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0007__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="nosql_06_0007__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0007__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Parameter Templates</a></div>
|
|
</div>
|
|
</div>
|
|
|