forked from docs/doc-exports
Wang , Deng Ke
5208dcae7b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
158 lines
12 KiB
HTML
158 lines
12 KiB
HTML
<a name="en-us_topic_0056890259"></a><a name="en-us_topic_0056890259"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Default Parameters of a DB Instance</h1>
|
|
<div id="body1492603082526"><div class="section" id="en-us_topic_0056890259__section21968845102411"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0056890259__p34646014102411">This API is used to obtain default parameters of a specified DB instance.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890259__section43378670102411"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0056890259__ul24011388102411"><li id="en-us_topic_0056890259__li14775908102411">URI format<p id="en-us_topic_0056890259__p65874315102411"><a name="en-us_topic_0056890259__li14775908102411"></a><a name="li14775908102411"></a>PATH: /v1.0/{project_id}/instances/{instanceId}/configuration</p>
|
|
<p id="en-us_topic_0056890259__p55997931102411">Method: GET</p>
|
|
</li><li id="en-us_topic_0056890259__li34219331102411">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890259__table39538525102411" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890259__row38994773102411"><th align="left" class="cellrowborder" valign="top" width="20.68%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0056890259__p4460079102411"><strong id="en-us_topic_0056890259__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.330000000000002%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0056890259__p25722146102411"><strong id="en-us_topic_0056890259__b842352706102346">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0056890259__p3119061102411"><strong id="en-us_topic_0056890259__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890259__row51317360102411"><td class="cellrowborder" valign="top" width="20.68%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890259__p63065500102411">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890259__p8031872102411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890259__p46601925102411">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890259__row16764147102411"><td class="cellrowborder" valign="top" width="20.68%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890259__p15718700102411">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.330000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890259__p65255193102411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890259__p51179299102411">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0056890259__li273646671817">Restrictions<p id="en-us_topic_0056890259__p57152011145532"><a name="en-us_topic_0056890259__li273646671817"></a><a name="li273646671817"></a>Currently, only the DB engines MySQL and PostgreSQL are supported by the API.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890259__section589521102411"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0056890259__p47751269102411">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890259__section27108241102411"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0056890259__ul48283914102411"><li id="en-us_topic_0056890259__li31902050102411">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890259__table18682996102411" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890259__row44628881102411"><th align="left" class="cellrowborder" valign="top" width="21.07210721072107%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0056890259__p58169645102411"><strong id="en-us_topic_0056890259__b281227480">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.05290529052905%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0056890259__p14120772102411"><strong id="en-us_topic_0056890259__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.874987498749874%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0056890259__p2931904102411"><strong id="en-us_topic_0056890259__b1044129591">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890259__row36157705102411"><td class="cellrowborder" valign="top" width="21.07210721072107%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056890259__p43092998102411">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.05290529052905%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056890259__p871968102411">List data structure. For details, see <a href="#en-us_topic_0056890259__table16731081102411">Table 3</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.874987498749874%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056890259__p31685170102411">Indicates the parameter information of the specified DB instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890259__table16731081102411"></a><a name="table16731081102411"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890259__table16731081102411" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instance field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890259__row9353381102411"><th align="left" class="cellrowborder" valign="top" width="21.07%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0056890259__p19426391102411"><strong id="en-us_topic_0056890259__b462833301">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.29%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0056890259__p30033825102411"><strong id="en-us_topic_0056890259__b43067388">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.64%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0056890259__p16820780102411"><strong id="en-us_topic_0056890259__b1503867310">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890259__row20305952102411"><td class="cellrowborder" valign="top" width="21.07%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0056890259__p34169379102411">configuration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.29%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0056890259__p16256352102411">Dictionary data structure. For details, see <a href="#en-us_topic_0056890259__table39720807102411">Table 4</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.64%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0056890259__p41696125102411">Indicates the default parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890259__table39720807102411"></a><a name="table39720807102411"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890259__table39720807102411" frame="border" border="1" rules="all"><caption><b>Table 4 </b>configuration field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890259__row8443733102411"><th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0056890259__p12853805102411"><strong id="en-us_topic_0056890259__b791909733">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.86%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0056890259__p34525269102411"><strong id="en-us_topic_0056890259__b1078079530">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.26%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0056890259__p45083381102411"><strong id="en-us_topic_0056890259__b1545396945">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890259__row27875254102411"><td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0056890259__p43303103102411">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.86%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0056890259__p17890489102411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.26%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0056890259__p48244396202445">Indicates the parameter name. For example, in <strong id="en-us_topic_0056890259__b84235270621563">"max_connections": "10"</strong>, the key is <strong id="en-us_topic_0056890259__b842352706215241">max_connections</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890259__row6100639102411"><td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0056890259__p24389722102411">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.86%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0056890259__p29410470102411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.26%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0056890259__p5120154202445">Indicates the parameter value. For example, in <strong id="en-us_topic_0056890259__b953814020215624">"max_connections": "10"</strong>, the value is <strong id="en-us_topic_0056890259__b842352706215633">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890259__ul33437866102411"><li id="en-us_topic_0056890259__li32505345102411">Response example<pre class="codeblock" id="en-us_topic_0056890259__codeblock484516102447">{
|
|
"instance": {
|
|
"configuration": {
|
|
"basedir": "/usr",
|
|
"connect_timeout": "15",
|
|
"datadir": "/var/lib/mysql",
|
|
"default_storage_engine": "innodb",
|
|
"innodb_buffer_pool_size": "600M",
|
|
"innodb_data_file_path": "ibdata1:10M:autoextend",
|
|
"innodb_file_per_table": "1",
|
|
"innodb_log_buffer_size": "25M",
|
|
"innodb_log_file_size": "50M",
|
|
"innodb_log_files_in_group": "2",
|
|
"join_buffer_size": "1M",
|
|
"key_buffer_size": "200M",
|
|
"local-infile": "0",
|
|
"max_allowed_packet": "4096K",
|
|
"max_connections": "400",
|
|
"max_heap_table_size": "64M",
|
|
"max_user_connections": "400",
|
|
"myisam-recover": "BACKUP",
|
|
"open_files_limit": "2048",
|
|
"pid_file": "/var/run/mysqld/mysqld.pid",
|
|
"port": "3306",
|
|
"query_cache_limit": "1M",
|
|
"query_cache_size": "32M",
|
|
"query_cache_type": "1",
|
|
"read_buffer_size": "512K",
|
|
"read_rnd_buffer_size": "512K",
|
|
"server_id": "334596",
|
|
"skip-external-locking": "1",
|
|
"sort_buffer_size": "1M",
|
|
"table_definition_cache": "1024",
|
|
"table_open_cache": "1024",
|
|
"thread_cache_size": "16",
|
|
"thread_stack": "192K",
|
|
"tmp_table_size": "64M",
|
|
"tmpdir": "/var/tmp",
|
|
"user": "mysql",
|
|
"wait_timeout": "120"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890259__section8839348102411"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0056890259__p44898603102411">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0022.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|