forked from docs/doc-exports
Wang , Deng Ke
daee48595f
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>
340 lines
19 KiB
HTML
340 lines
19 KiB
HTML
<a name="dds_instance_specification"></a><a name="dds_instance_specification"></a>
|
|
|
|
<h1 class="topictitle1">Querying All DB Instance Specifications</h1>
|
|
<div id="body32010697"><div class="section" id="dds_instance_specification__section36902586"><h4 class="sectiontitle">Function</h4><p id="dds_instance_specification__p11850755183110">This API is used to query all DB instance specifications in a specified region.</p>
|
|
</div>
|
|
<div class="section" id="dds_instance_specification__section63687823"><h4 class="sectiontitle">URI</h4><ul id="dds_instance_specification__ul38552084"><li id="dds_instance_specification__li11424440">URI format<p id="dds_instance_specification__p27600572154519"><a name="dds_instance_specification__li11424440"></a><a name="li11424440"></a>GET /v3/{project_id}/flavors?region={region}&engine_name={engine_name}</p>
|
|
</li><li id="dds_instance_specification__li52964449">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_instance_specification__table6918001" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_instance_specification__row17531178"><th align="left" class="cellrowborder" valign="top" width="22.05%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_instance_specification__p10739296"><strong id="dds_instance_specification__b842352706102328_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.700000000000003%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_instance_specification__p64576684"><strong id="dds_instance_specification__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.24999999999999%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_instance_specification__p63328883"><strong id="dds_instance_specification__b34664267318">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_instance_specification__row29365919"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_instance_specification__p29829272">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_instance_specification__p251973">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.24999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_instance_specification__p20409871">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row41144153615"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_instance_specification__p192021597362">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_instance_specification__p4209591362">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.24999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_instance_specification__p122138933613">Specifies the region where the DB instance exists.</p>
|
|
<p id="dds_instance_specification__p721579193612">Valid value:</p>
|
|
<p id="dds_instance_specification__p1021569163610">The value cannot be empty. For details about how to obtain this parameter value, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row13206254366"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_instance_specification__p18235698361">engine_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_instance_specification__p172387953613">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.24999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_instance_specification__p72411394361">Specifies the database type. The value is <strong id="dds_instance_specification__b138937353234">DDS-Community</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_instance_specification__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_instance_specification__ul20834188172515"><li id="dds_instance_specification__li53289967172515">Request header<div class="note" id="dds_instance_specification__note669618285418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_instance_specification__p13170345415">The value of <strong id="dds_instance_specification__b84235270672922">region</strong> in the following is used as an example.</p>
|
|
</div></div>
|
|
<pre class="codeblock" id="dds_instance_specification__codeblock1161517517584"><strong id="dds_instance_specification__b16325195592611">GET </strong><strong id="dds_instance_specification__b12325115542619"><em id="dds_instance_specification__i5475191044215">https://DDS endpoint</em></strong><strong id="dds_instance_specification__b1325455132611">/v3/375d8d8fad1f43039e23d3b6c0f60a19/flavors?region=</strong><strong id="dds_instance_specification__b7325255162620"><em id="dds_instance_specification__i12213111219294">aaa</em></strong><strong id="dds_instance_specification__b93252552261">&engine_name=DDS-Community</strong></pre>
|
|
</li><li id="dds_instance_specification__li12917299410">Request body<p id="dds_instance_specification__p86441538184114"><a name="dds_instance_specification__li12917299410"></a><a name="li12917299410"></a>N/A</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_instance_specification__section58440016"><h4 class="sectiontitle">Responses</h4><ul id="dds_instance_specification__ul26059286"><li id="dds_instance_specification__li33206990">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_instance_specification__table30427456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_instance_specification__row47542385"><th align="left" class="cellrowborder" valign="top" width="21.68%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_instance_specification__p25727981"><strong id="dds_instance_specification__b842352706102328_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.689999999999998%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_instance_specification__p3591713"><strong id="dds_instance_specification__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.629999999999995%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_instance_specification__p22493366"><strong id="dds_instance_specification__b3231103353117">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_instance_specification__row10023380"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_instance_specification__p6587426">flavors</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.689999999999998%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_instance_specification__p16243522134212">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.629999999999995%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_instance_specification__p17946858">Indicates the DB instance specifications information list. For more information, see <a href="#dds_instance_specification__table64140254">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_instance_specification__table64140254"></a><a name="table64140254"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_instance_specification__table64140254" frame="border" border="1" rules="all"><caption><b>Table 3 </b>flavors field data structure description</caption><thead align="left"><tr id="dds_instance_specification__row21591473"><th align="left" class="cellrowborder" valign="top" width="21.87%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_instance_specification__p4078883"><strong id="dds_instance_specification__b842352706102328_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.700000000000003%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_instance_specification__p61954093"><strong id="dds_instance_specification__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.43%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_instance_specification__p2775334615440"><strong id="dds_instance_specification__b16503133419315">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_instance_specification__row144161918155712"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p1841691815718">engine_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p3416518155719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p736191365818">Indicates the engine name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row15504321112612"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p1517492872610">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p617452810260">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p1717472872612">Indicates the node type. DDS contains the following types of nodes:</p>
|
|
<ul id="dds_instance_specification__ul7598411874"><li id="dds_instance_specification__li195981011715">mongos</li><li id="dds_instance_specification__li205985115714">shard</li><li id="dds_instance_specification__li15981811771">config</li><li id="dds_instance_specification__li13598111879">replica</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row23483667"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p141542054152620">vcpus</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p0154115418263">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p1415417549268">Number of vCPUs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row4039073"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p11541554132615">ram</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p18154125472620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p2015414545264">Indicates the memory size in gigabyte (GB).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row51398059195617"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p131548547269">spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p615410548268">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p81541954102614">Indicates the resource specifications code.</p>
|
|
<p id="dds_instance_specification__p182201831133114">Example: dds.mongodb.s2.xlarge.4.shard</p>
|
|
<div class="note" id="dds_instance_specification__note91791257947"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="dds_instance_specification__ul152321261558"><li id="dds_instance_specification__li1499115331310"><strong id="dds_instance_specification__b1811298320">dds.mongodb</strong>: indicates the DDS service.</li><li id="dds_instance_specification__li96834473714"><strong id="dds_instance_specification__b10613300">s2.xlarge.4</strong>: indicates the performance specification, which is high memory.</li><li id="dds_instance_specification__li1423210614514"><strong id="dds_instance_specification__b17574134273013">shard</strong>: indicates the node type.</li></ul>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_instance_specification__row1648065712261"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_instance_specification__p83951322710">az_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.700000000000003%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_instance_specification__p964875794315">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_instance_specification__p1639517318272">Indicates the status of specifications in an AZ. Its value can be any of the following:</p>
|
|
<ul id="dds_instance_specification__ul7598411874"><li id="dds_instance_specification__li195981011715">normal: indicates that the specifications are on sale.</li><li id="dds_instance_specification__li205985115714">unsupported: indicates that the DB instance specifications are not supported.</li><li id="dds_instance_specification__li15981811771">sellout: indicates the specifications are sold out.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<div class="note" id="dds_instance_specification__note1577672413164"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_instance_specification__p277742411614">The value of <strong id="dds_instance_specification__b16922151233113">az_status</strong> is used as an example.</p>
|
|
</div></div>
|
|
<ul id="dds_instance_specification__ul20875522"><li id="dds_instance_specification__li175691239122813">Response example<pre class="codeblock" id="dds_instance_specification__codeblock920155611292">{
|
|
"flavors": [
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "mongos",
|
|
"vcpus": "1",
|
|
"ram": "4",
|
|
"spec_code": "dds.mongodb.s2.medium.4.mongos",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "mongos",
|
|
"vcpus": "2",
|
|
"ram": "8",
|
|
"spec_code": "dds.mongodb.s2.large.4.mongos",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "mongos",
|
|
"vcpus": "4",
|
|
"ram": "16",
|
|
"spec_code": "dds.mongodb.s2.xlarge.4.mongos",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "mongos",
|
|
"vcpus": "8",
|
|
"ram": "32",
|
|
"spec_code": "dds.mongodb.s2.2xlarge.4.mongos",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "mongos",
|
|
"vcpus": "16",
|
|
"ram": "64",
|
|
"spec_code": "dds.mongodb.s2.4xlarge.4.mongos",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "shard",
|
|
"vcpus": "1",
|
|
"ram": "4",
|
|
"spec_code": "dds.mongodb.s2.medium.4.shard",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "shard",
|
|
"vcpus": "2",
|
|
"ram": "8",
|
|
"spec_code": "dds.mongodb.s2.large.4.shard",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "shard",
|
|
"vcpus": "4",
|
|
"ram": "16",
|
|
"spec_code": "dds.mongodb.s2.xlarge.4.shard",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "shard",
|
|
"vcpus": "8",
|
|
"ram": "32",
|
|
"spec_code": "dds.mongodb.s2.2xlarge.4.shard",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "shard",
|
|
"vcpus": "16",
|
|
"ram": "64",
|
|
"spec_code": "dds.mongodb.s2.4xlarge.4.shard",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "config",
|
|
"vcpus": "2",
|
|
"ram": "4",
|
|
"spec_code": "dds.mongodb.s2.large.2.config",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "replica",
|
|
"vcpus": "1",
|
|
"ram": "4",
|
|
"spec_code": "dds.mongodb.s2.medium.4.repset",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "replica",
|
|
"vcpus": "2",
|
|
"ram": "8",
|
|
"spec_code": "dds.mongodb.s2.large.4.repset",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "replica",
|
|
"vcpus": "4",
|
|
"ram": "16",
|
|
"spec_code": "dds.mongodb.s2.xlarge.4.repset",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "replica",
|
|
"vcpus": "8",
|
|
"ram": "32",
|
|
"spec_code": "dds.mongodb.s2.2xlarge.4.repset",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
},
|
|
{
|
|
"engine_name": "DDS-Community",
|
|
"type": "replica",
|
|
"vcpus": "16",
|
|
"ram": "64",
|
|
"spec_code": "dds.mongodb.s2.4xlarge.4.repset",
|
|
"az_status": [
|
|
"eu-de-01": "normal",
|
|
"eu-de-02": "normal",
|
|
"eu-de-03": "normal"
|
|
]
|
|
}
|
|
]
|
|
} </pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_instance_specification__section5382712154838"><h4 class="sectiontitle"><strong id="dds_instance_specification__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_instance_specification__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_instance_specification__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_instance_specification__dds_api_0018_p20466124120334">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">API Description</a></div>
|
|
</div>
|
|
</div>
|
|
|