forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
217 lines
18 KiB
HTML
217 lines
18 KiB
HTML
<a name="rds_11_0010"></a><a name="rds_11_0010"></a>
|
|
|
|
<h1 class="topictitle1">Querying Extensions</h1>
|
|
<div id="body0000002462591357"><div class="section" id="rds_11_0010__section1199461810230"><h4 class="sectiontitle">Function</h4><p id="rds_11_0010__p13231319142310">This API is used to obtain extension information of a specified database.</p>
|
|
<ul id="rds_11_0010__ul10163594121"><li id="rds_11_0010__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_11_0010__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section7996151810239"><h4 class="sectiontitle">Constraints</h4><p id="rds_11_0010__p1557717533283">This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.</p>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section18129193419"><h4 class="sectiontitle">URI</h4><ul id="rds_11_0010__ul16391217184115"><li id="rds_11_0010__li363951734111">URI format<p id="rds_11_0010__p1363971724110"><a name="rds_11_0010__li363951734111"></a><a name="li363951734111"></a>GET https://{<em id="rds_11_0010__i13588511191717">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit}</p>
|
|
</li></ul>
|
|
<ul id="rds_11_0010__ul49831254144655"><li id="rds_11_0010__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0010__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_11_0010__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.59%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_11_0010__p34889605"><strong id="rds_11_0010__b107701798176">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.25%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_11_0010__p7485743"><strong id="rds_11_0010__b13191195431515">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.160000000000004%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_11_0010__p2365466"><strong id="rds_11_0010__b19170857171516">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0010__row57385070"><td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_11_0010__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_11_0010__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.160000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_11_0010__en-us_topic_0285677743_en-us_topic_0144420999_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_11_0010__en-us_topic_0285677743_en-us_topic_0144420999_p27281110194">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row2864326155157"><td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_11_0010__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_11_0010__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.160000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_11_0010__en-us_topic_0285677743_en-us_topic_0144420999_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row319662210368"><td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_11_0010__p17557028193618">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_11_0010__p8256102023715">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.160000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_11_0010__p9444527133717">The name of the specific database created inside the RDS instance. This is the logical database name, not the RDS instance identifier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row126331836153819"><td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_11_0010__p755719289366">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_11_0010__p92561201379">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.160000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_11_0010__p12501184214333">Index offset. The query starts from the next piece of data indexed by this parameter.</p>
|
|
<p id="rds_11_0010__p6152162703711">The value must be a non-negative number.</p>
|
|
<p id="rds_11_0010__p34651093715">The default value is <strong id="rds_11_0010__b122463133015">0</strong>, indicating that the query starts from the first data record.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row169211837163817"><td class="cellrowborder" valign="top" width="21.59%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_11_0010__p1055711286362">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_11_0010__p725712016377">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.160000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_11_0010__p8445142711377">Number of records to be queried.</p>
|
|
<p id="rds_11_0010__en-us_topic_0291571266_p14921123723811">The value ranges from 1 (inclusive) to 100 (inclusive).</p>
|
|
<p id="rds_11_0010__p72931151193516">The default value is <strong id="rds_11_0010__b86393404544">100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_11_0010__ul1183180183717"><li id="rds_11_0010__li1283110163719">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0010__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_11_0010__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_11_0010__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_11_0010__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_11_0010__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_11_0010__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0010__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_11_0010__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_11_0010__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_11_0010__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_11_0010__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_11_0010__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_11_0010__ul1819353718351"><li id="rds_11_0010__li36602022360">URI example<p id="rds_11_0010__p5661221360"><a name="rds_11_0010__li36602022360"></a><a name="li36602022360"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions?database_name=db1</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_11_0010__ul12573920"><li id="rds_11_0010__li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0010__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_11_0010__row9230088"><th align="left" class="cellrowborder" valign="top" width="30.883088308830885%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_11_0010__p9439626"><strong id="rds_11_0010__b1871520248192">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.233023302330235%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_11_0010__p26412257"><strong id="rds_11_0010__b2098021742119">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.88388838883888%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_11_0010__p59018101"><strong id="rds_11_0010__b16426119192114">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0010__row15736877"><td class="cellrowborder" valign="top" width="30.883088308830885%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0010__p169391233143811">extensions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0010__p2081819101314">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.88388838883888%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0010__p48259009">Extension list. For details, see <a href="#rds_11_0010__table1457984914368">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row85522057153911"><td class="cellrowborder" valign="top" width="30.883088308830885%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_11_0010__p18939163312384">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_11_0010__p7552175723911">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.88388838883888%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_11_0010__p1655275733913">Total number of extensions.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_11_0010__table1457984914368"></a><a name="table1457984914368"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0010__table1457984914368" frame="border" border="1" rules="all"><caption><b>Table 4 </b>extensions element structure description</caption><thead align="left"><tr id="rds_11_0010__row7589124919365"><th align="left" class="cellrowborder" valign="top" width="30.683068306830684%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="rds_11_0010__p6590349173618"><strong id="rds_11_0010__b14407237141917">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.233023302330235%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="rds_11_0010__p459111499361"><strong id="rds_11_0010__b3826731112218">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.083908390839085%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="rds_11_0010__p559314917360"><strong id="rds_11_0010__b943453322210">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0010__row16594849183618"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p117721741163919">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p1726405012397">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p153025563339">Extension name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row141542372397"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p107727415393">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p14264950123911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p6131259173312">The name of the specific database created inside the RDS instance. This is the logical database name, not the RDS instance identifier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row1190185813486"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p3772104163918">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p1226419500392">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p826425015396">Extension version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row8284113810212"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p255018411024">version_update</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p1550841725">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p79631964341">New version that the extension can be upgraded to. If the value of this parameter is different from that of <strong id="rds_11_0010__b48635547529">version</strong>, the extension can be upgraded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row424153534019"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p577211410392">shared_preload_libraries</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p1026475023916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p568679163413">Dependent preloaded library.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row0322174116404"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p377264113919">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p5265115093917">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p17265145013918">Whether the extension has been created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row1022315467401"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p197721941153919">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p102654506392">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p156415193414">Extension description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0010__row26374387280"><td class="cellrowborder" valign="top" width="30.683068306830684%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_11_0010__p56371738202813">enable_install</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.233023302330235%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_11_0010__p26371038142811">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.083908390839085%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_11_0010__p863753818284">Whether the extension can be installed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_11_0010__ul16665627"><li id="rds_11_0010__li15772917">Example normal response<pre class="screen" id="rds_11_0010__screen95345445540">{
|
|
"extensions" : [ {
|
|
"name" : "pg_cron",
|
|
"database_name" : "db1",
|
|
"version" : "1.0",
|
|
"version_update" : "1.0",
|
|
"shared_preload_libraries" : "pg_cron",
|
|
"created" : false,
|
|
"enable_install": false,
|
|
"description" : "pg_cron access method - signature file based index"
|
|
} ],
|
|
"total_count" : 1
|
|
}</pre>
|
|
</li><li id="rds_11_0010__li3577205319311">Abnormal response<p id="rds_11_0010__p46896054"><a name="rds_11_0010__li3577205319311"></a><a name="li3577205319311"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_11_0010__en-us_topic_0032347778_ul7858132212142"><li id="rds_11_0010__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_11_0010__en-us_topic_0032347778_p1040982941020"><a name="rds_11_0010__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_11_0010__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_11_0010__en-us_topic_0032347778_p0723374409"><a name="rds_11_0010__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0010__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_11_0010__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_11_0025.html">Extension Management (RDS for PostgreSQL)</a></div>
|
|
</div>
|
|
</div>
|
|
|