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>
96 lines
8.7 KiB
HTML
96 lines
8.7 KiB
HTML
<a name="en-us_topic_0032348281"></a><a name="en-us_topic_0032348281"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Detailed Information of a Specified DB Instance</h1>
|
|
<div id="body1467019492675"><div class="section" id="en-us_topic_0032348281__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0032348281__p3631239417316">This API is used to obtain detailed information of a specified DB instance.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032348281__section5837609817316"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0032348281__ul3084351717316"><li id="en-us_topic_0032348281__li915620217316">URI format<p id="en-us_topic_0032348281__p1529696117316"><a name="en-us_topic_0032348281__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/instances/{instanceId}</p>
|
|
<p id="en-us_topic_0032348281__p26774831154556">Method: GET</p>
|
|
</li><li id="en-us_topic_0032348281__li345492117316">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348281__table3109429217316" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032348281__row2968870717316"><th align="left" class="cellrowborder" valign="top" width="21.83%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0032348281__p5597508117316"><strong id="en-us_topic_0032348281__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.169999999999998%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0032348281__p3768771917316"><strong id="en-us_topic_0032348281__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0032348281__p3280643817316"><strong id="en-us_topic_0032348281__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032348281__row4007585417316"><td class="cellrowborder" valign="top" width="21.83%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032348281__p2491872617316">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.169999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032348281__p515090217316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032348281__p47611098163611">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032348281__row6402048317316"><td class="cellrowborder" valign="top" width="21.83%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0032348281__p1827664817316">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.169999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0032348281__p401350517316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0032348281__p7417132564016">Specifies the primary node ID of the DB instance.</p>
|
|
<div class="note" id="en-us_topic_0032348281__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032348281__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032348281__section3074340117316"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0032348281__p718753317316">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032348281__section6468780017316"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0032348281__ul522046217316"><li id="en-us_topic_0032348281__li4698416317316">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0032348281__table2020428417316" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0032348281__row3428628317316"><th align="left" class="cellrowborder" valign="top" width="21.98%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0032348281__p2572551517316"><strong id="en-us_topic_0032348281__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.589999999999996%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0032348281__p339198017316"><strong id="en-us_topic_0032348281__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.43%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0032348281__p631496517316"><strong id="en-us_topic_0032348281__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0032348281__row4175019117316"><td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032348281__p2632233817316">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032348281__p5173461317316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032348281__p71201322697">Indicates the primary node ID of the DB instance.</p>
|
|
<div class="note" id="en-us_topic_0032348281__note1412012221797"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0032348281__p141206221195">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032348281__row254286717316"><td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032348281__p464564917316">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032348281__p4075325517316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032348281__p1267935817316">Indicates the DB instance status.</p>
|
|
<div class="p" id="en-us_topic_0032348281__p620854315015">Value:<ul id="en-us_topic_0032348281__ul3066104695748"><li id="en-us_topic_0032348281__li1772543895748">If the value is <strong id="en-us_topic_0032348281__b84235270616547_1">BUILD</strong>, the instance is being created.</li><li id="en-us_topic_0032348281__li6405079395748">If the value is <strong id="en-us_topic_0032348281__b842352706165415">ACTIVE</strong>, the instance is normal.</li><li id="en-us_topic_0032348281__li1394818495748">If the value is <strong id="en-us_topic_0032348281__b842352706165427">FAILED</strong>, the instance is abnormal.</li><li id="en-us_topic_0032348281__li6638702395748">If the value is <strong id="en-us_topic_0032348281__b84235270616547_3">MODIFYING</strong>, the instance is being scaled up.</li><li id="en-us_topic_0032348281__li5726501795748">If the value is <strong id="en-us_topic_0032348281__b84235270616547_5">REBOOTING</strong>, the instance is being rebooted.</li><li id="en-us_topic_0032348281__li2770932595748">If the value is <strong id="en-us_topic_0032348281__b84235270616547_7">RESTORING</strong>, the instance is being restored.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0032348281__row4700536117316"><td class="cellrowborder" valign="top" width="21.98%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0032348281__p4933790017316">instanceName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.589999999999996%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0032348281__p3694693917316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0032348281__p3991207117316">Indicates the created DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0032348281__ul3039014217316"><li id="en-us_topic_0032348281__li507582917316">Response example<pre class="codeblock" id="en-us_topic_0032348281__codeblock14770700171717">{
|
|
"instance": {
|
|
"instanceId": "252f11f1-2912-4c06-be55-1999bde659c5",
|
|
"status": "BUILD",
|
|
"instanceName": "rds-instance-test01"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0032348281__section4885744117316"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0032348281__p6513863517316">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_0016.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|