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>
175 lines
14 KiB
HTML
175 lines
14 KiB
HTML
<a name="dds_api_0039"></a><a name="dds_api_0039"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Database Disk Type</h1>
|
|
<div id="body1592791164606"><div class="section" id="dds_api_0039__section4284989"><h4 class="sectiontitle">Function</h4><p id="dds_api_0039__p198023412214">This API is used to query the database disk type in the current region.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0039__section38564907"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0039__ul13194498"><li id="dds_api_0039__li51641620">URI format<p id="dds_api_0039__p112110202496"><a name="dds_api_0039__li51641620"></a><a name="li51641620"></a>GET https://{Endpoint}/v3/{project_id}/storage-type?engine_name={engine_name}</p>
|
|
</li><li id="dds_api_0039__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0039__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0039__row46529701"><th align="left" class="cellrowborder" valign="top" width="27.262726272627262%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0039__p10809459"><strong id="dds_api_0039__b1677934111337">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.062806280628067%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0039__p3150961"><strong id="dds_api_0039__b146896421338">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.67446744674467%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0039__p2775334615440"><strong id="dds_api_0039__b673984314336">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0039__row3925534"><td class="cellrowborder" valign="top" width="27.262726272627262%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0039__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.062806280628067%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0039__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.67446744674467%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0039__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row179931716442"><td class="cellrowborder" valign="top" width="27.262726272627262%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0039__p189938161143">engine_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.062806280628067%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0039__p1599311164412">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.67446744674467%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0039__p5672691058">Specifies the database type.</p>
|
|
<p id="dds_api_0039__p5468164172818">The value is <strong id="dds_api_0039__b101198559215">DDS-Community</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0039__section181881229653"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0039__ul191761051104911"><li id="dds_api_0039__li2176751114917">Example request<p id="dds_api_0039__p1758419541492"><a name="dds_api_0039__li2176751114917"></a><a name="li2176751114917"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/storage-type?engine_name=DDS-Community</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0039__section122851381265"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0039__ul6360982062"><li id="dds_api_0039__li1436011810610">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0039__table42911683614" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0039__row17360198567"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0039__p1036078667"><strong id="dds_api_0039__b891194113414">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.560000000000002%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0039__p1536015818616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.93%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0039__p036019811617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0039__row11360980618"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0039__p2360881564">storage_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.560000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0039__p0360128862">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0039__p143601182619">Indicates the database disk information list. For more information, see <a href="#dds_api_0039__table1029958863">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row173601781963"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0039__p5360118863">dss_pool_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.560000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0039__p17360389619">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.93%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0039__p63601881462">Indicates the dss_pool specifications information list. For more information, see <a href="#dds_api_0039__table9305198166">Table 4</a>.</p>
|
|
<div class="note" id="dds_api_0039__note184714533615"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0039__p11848115113615">Only Dedicated Cloud (DeC) users are supported.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0039__table1029958863"></a><a name="table1029958863"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0039__table1029958863" frame="border" border="1" rules="all"><caption><b>Table 3 </b>storage_type field data structure description</caption><thead align="left"><tr id="dds_api_0039__row83601381667"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0039__p173601487618"><strong id="dds_api_0039__b12114184194214">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.26262626262626%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0039__p12360283614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.484848484848484%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0039__p143601881569">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0039__row12360158562"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0039__p19360481963">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.26262626262626%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0039__p17360158262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0039__p8360158462">Indicates the storage type. Its value can be:</p>
|
|
<p id="dds_api_0039__p12298720113710"><strong id="dds_api_0039__b15678162615427">ULTRAHIGH</strong>: indicates the SSD type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row13360208466"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0039__p163601281065">az_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.26262626262626%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0039__p536098760">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0039__p1436008366">Indicates the status of specifications in an AZ. Its value can be any of the following:</p>
|
|
<ul id="dds_api_0039__ul16360481667"><li id="dds_api_0039__li17360198168"><strong id="dds_api_0039__b11948553174218">normal</strong>: indicates that the specifications are on sale.</li><li id="dds_api_0039__li15360881363"><strong id="dds_api_0039__b1847344154318">unsupported</strong>: The disk type is not supported.</li><li id="dds_api_0039__li1436013810619"><strong id="dds_api_0039__b52211358134218">sellout</strong>: indicates the specifications are sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0039__table9305198166"></a><a name="table9305198166"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0039__table9305198166" frame="border" border="1" rules="all"><caption><b>Table 4 </b>dss_pool_info field data structure description</caption><thead align="left"><tr id="dds_api_0039__row6361198668"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0039__p10361981862"><strong id="dds_api_0039__b1033610236431">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.242624262426244%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0039__p11361118267">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.5048504850485%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0039__p143616819611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0039__row33612812611"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0039__p8361987616">az_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.242624262426244%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0039__p103611819615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5048504850485%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0039__p1069210415287">Indicates the name of the AZ where the dss_pool is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row936128462"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0039__p13361681968">free_capacity_gb</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.242624262426244%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0039__p5361108965">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5048504850485%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0039__p51261744162810">Indicates the available capacity of DSS.</p>
|
|
<p id="dds_api_0039__p1682105913289">Unit: GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row1236148461"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0039__p123618818617">dss_pool_volume_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.242624262426244%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0039__p6361680611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5048504850485%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0039__p26091445142814">Indicates the disk type of DSS storage pool.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row9361168163"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0039__p153611181620">dss_pool_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.242624262426244%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0039__p336112814614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5048504850485%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0039__p274044772815">Indicates the DSS pool ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0039__row19361681768"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0039__p9361208362">dss_pool_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.242624262426244%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0039__p14361881062">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5048504850485%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0039__p02245903715">Indicates the dss_pool status. Its value can be any of the following:</p>
|
|
<ul id="dds_api_0039__ul182914203814"><li id="dds_api_0039__li782913273818"><strong id="dds_api_0039__b1395012414476">available</strong></li><li id="dds_api_0039__li6585145163816"><strong id="dds_api_0039__b1639215551471">deploying</strong></li><li id="dds_api_0039__li1826614853819"><strong id="dds_api_0039__b84911417487">enlarging</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="dds_api_0039__note1728517811615"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0039__p113617817616">The value of <strong id="dds_api_0039__b963618138487">az_status</strong> is used as an example.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="dds_api_0039__ul1536115816610"><li id="dds_api_0039__li17361581265">Response example<pre class="codeblock" id="dds_api_0039__codeblock4689112511717">{
|
|
"storage_type": [
|
|
{
|
|
"name": "ULTRAHIGH",
|
|
"az_status": {
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "unsupported"
|
|
}
|
|
}
|
|
],
|
|
"dsspool_info": []
|
|
}</pre>
|
|
</li></ul>
|
|
|
|
</div>
|
|
<div class="section" id="dds_api_0039__section173141381568"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0039__en-us_topic_0000001387505349_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0039__en-us_topic_0000001387505349_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0039__section13153813619"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0039__p113611989617">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_description.html">APIs V3.0 (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|