doc-exports/docs/geminidb/api-ref/nosql_instance_specification.html
Ru, Li Yi 37b97ffc06 geminidb_api
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>
2024-07-04 11:26:33 +00:00

261 lines
20 KiB
HTML

<a name="nosql_instance_specification"></a><a name="nosql_instance_specification"></a>
<h1 class="topictitle1">Querying Instance Specifications</h1>
<div id="body536902671116"><div class="section" id="nosql_instance_specification__section7369132614113"><h4 class="sectiontitle">Function</h4><p id="nosql_instance_specification__p8370102611119">This API is used to query all instance specifications under a specified condition.</p>
</div>
<div class="section" id="nosql_instance_specification__section103701926111110"><h4 class="sectiontitle">Constraints</h4><p id="nosql_instance_specification__p637122620112">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_instance_specification__section43761226171115"><h4 class="sectiontitle">URI</h4><p id="nosql_instance_specification__p13376152616113">GET https://{Endpoint}/v3.1/{project_id}/flavors</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_instance_specification__table113781226161119" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_instance_specification__row337752614116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_instance_specification__p137819261117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_instance_specification__p137922615117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_instance_specification__p15379142617115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_instance_specification__p1638013265112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_instance_specification__row33771626191118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_instance_specification__p93808268119">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_instance_specification__p538011268118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_instance_specification__p5381526121119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_instance_specification__p18381152612114">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_instance_specification__table83831926121117" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="nosql_instance_specification__row1038292681116"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="nosql_instance_specification__p143831926151116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="nosql_instance_specification__p23833269114">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="nosql_instance_specification__p3384126111115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="nosql_instance_specification__p1538416261114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_instance_specification__row53821126151119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_instance_specification__p8385926121114">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_instance_specification__p143852265112">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_instance_specification__p133861726141116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_instance_specification__p4386172691116">Database type. The value can be:</p>
<ul id="nosql_instance_specification__ul4386192661114"><li id="nosql_instance_specification__li193861026141118"><strong id="nosql_instance_specification__b177191410142513">cassandra</strong>, indicating that the instances are of the <span id="nosql_instance_specification__text9237134011710">GeminiDB Cassandra</span> type.</li><li id="nosql_instance_specification__li16388192661116">If this parameter is not transferred, the default value is <strong id="nosql_instance_specification__b5703105718284">cassandra</strong>.</li></ul>
</td>
</tr>
<tr id="nosql_instance_specification__row53821326131119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_instance_specification__p1838952631110">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_instance_specification__p1138916264117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_instance_specification__p16390172671116">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_instance_specification__p1139011262111">Index offset.</p>
<ul id="nosql_instance_specification__ul11390326191116"><li id="nosql_instance_specification__li9391026201112">If <strong id="nosql_instance_specification__b14467195319447">offset</strong> is set to <em id="nosql_instance_specification__i546810535443">N</em>, the resource query starts from the N+1 piece of data. If <strong id="nosql_instance_specification__b124681153124411">action</strong> is set to <strong id="nosql_instance_specification__b446865304413">filter</strong>, <strong id="nosql_instance_specification__b446855316446">offset</strong> is <strong id="nosql_instance_specification__b114681253174410">0</strong> by default, indicating that the query starts from the first piece of data.</li><li id="nosql_instance_specification__li16391192601116">The <strong id="nosql_instance_specification__b85121815111719">offset</strong> value must be a number but cannot be a negative number.</li></ul>
</td>
</tr>
<tr id="nosql_instance_specification__row2382112601111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_instance_specification__p3391926151119">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_instance_specification__p10392152681117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_instance_specification__p139217269110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_instance_specification__p183938269118">Maximum of specifications that can be queried</p>
<ul id="nosql_instance_specification__ul5393202661120"><li id="nosql_instance_specification__li173931266116">The value ranges from <strong id="nosql_instance_specification__b59331047113313">1</strong> to <strong id="nosql_instance_specification__b6392164913312">100</strong>.</li><li id="nosql_instance_specification__li3393162616117">If this parameter is not transferred, the first 100 pieces of specification information is queried by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_instance_specification__section0394102614119"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_instance_specification__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_instance_specification__row2394426131110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_instance_specification__p19395626191117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_instance_specification__p239612619117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_instance_specification__p3396132621112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_instance_specification__p133971026181111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_instance_specification__row939522615110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_instance_specification__p1139710267115">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_instance_specification__p19397112616113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_instance_specification__p1039813262113">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_instance_specification__p4398182619111">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_instance_specification__section173991726151116"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_instance_specification__p54011265117"><strong id="nosql_instance_specification__b34721068341">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_instance_specification__response_ListFlavorsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_instance_specification__row19401142621112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_instance_specification__p114041326141115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_instance_specification__p1340592617110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_instance_specification__p1040622661119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_instance_specification__row18402122610114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_instance_specification__p24061026191111">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_instance_specification__p1740715267118">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_instance_specification__p940742615113">Total number of records</p>
</td>
</tr>
<tr id="nosql_instance_specification__row144021726191117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_instance_specification__p18407926161118">flavors</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_instance_specification__p1840872617113">Array of <a href="#nosql_instance_specification__response_Flavors">Flavors</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_instance_specification__p12409626141117">Instance specifications</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_instance_specification__response_Flavors"></a><a name="response_Flavors"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_instance_specification__response_Flavors" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Flavors</caption><thead align="left"><tr id="nosql_instance_specification__row741012614118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_instance_specification__p6411526111112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_instance_specification__p164121926121119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_instance_specification__p441292616112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_instance_specification__row184101426171111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p20413326131119">engine_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p24131226181116">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p1741322631117"><span id="nosql_instance_specification__text1312316012166">API</span> name.</p>
</td>
</tr>
<tr id="nosql_instance_specification__row74101726111112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p74147265115">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p1741632613119">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p14162269115"><span id="nosql_instance_specification__text3893491167">API</span> version.</p>
</td>
</tr>
<tr id="nosql_instance_specification__row11410026171114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p0416132613113">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p541752651117">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p84186269115">Number of vCPUs</p>
</td>
</tr>
<tr id="nosql_instance_specification__row12410182621115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p2418226201119">ram</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p15419112620118">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p94191326191117">Memory size in megabytes (MB)</p>
</td>
</tr>
<tr id="nosql_instance_specification__row3410122619110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p1419122616119">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p134202262115">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p18420132641114">Resource specification code.</p>
<p id="nosql_instance_specification__p1842052641116">Example: <strong id="nosql_instance_specification__b282575911346">geminidb.cassandra.8xlarge.4</strong></p>
<div class="note" id="nosql_instance_specification__note942182611115"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="nosql_instance_specification__ul042242621110"><li id="nosql_instance_specification__li1542242611116"><strong id="nosql_instance_specification__b19134162333513">geminidb.cassandra</strong> indicates the instance is a GeminiDB Cassandra instance.</li><li id="nosql_instance_specification__li442252612111"><strong id="nosql_instance_specification__b13995182533516">8xlarge.4</strong> indicates node specifications.</li></ul>
</div></div>
</td>
</tr>
<tr id="nosql_instance_specification__row144104266112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p11422192631116">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p12423526201111">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p164231226201110">ID of the AZ that supports the specifications</p>
<div class="note" id="nosql_instance_specification__note20424326171116"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="nosql_instance_specification__p8925161617316">This parameter has been discarded. Do not use it.</p>
</div></div>
</td>
</tr>
<tr id="nosql_instance_specification__row141042651116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_instance_specification__p14251626171118">az_status</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_instance_specification__p19425162631111">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_instance_specification__p1142532661114">The status of specifications in an AZ. The value can be:</p>
<ul id="nosql_instance_specification__ul104267262111"><li id="nosql_instance_specification__li84268263113"><strong id="nosql_instance_specification__b37272542361">normal</strong>, indicating that the specifications are on sale.</li><li id="nosql_instance_specification__li124260265113"><strong id="nosql_instance_specification__b108610571369">unsupported</strong>, indicating that the specifications are not supported.</li><li id="nosql_instance_specification__li24271226101116"><strong id="nosql_instance_specification__b1529012114378">sellout</strong>, indicating that the specifications are sold out.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_instance_specification__section843092614116"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_instance_specification__p121241643172216">URI example<pre class="screen" id="nosql_instance_specification__screen1092719409310">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&amp;offset=0&amp;limit=10</pre>
</div>
</div>
<div class="section" id="nosql_instance_specification__section174331726101119"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_instance_specification__p64332026151113"><strong id="nosql_instance_specification__b4882985365">Status code: 200</strong></p>
<p id="nosql_instance_specification__p443322611112">Success</p>
<pre class="screen" id="nosql_instance_specification__screen15436192614116">{
"total_count" : 4,
"flavors" : [ {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "4",
"ram" : "16",
"spec_code" : "geminidb.cassandra.xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "unsupported"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "8",
"ram" : "32",
"spec_code" : "geminidb.cassandra.2xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "unsupported",
"az2" : "normal"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "16",
"ram" : "64",
"spec_code" : "geminidb.cassandra.4xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "sellout"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "32",
"ram" : "128",
"spec_code" : "geminidb.cassandra.8xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "normal"
}
} ]
}</pre>
</div>
<div class="section" id="nosql_instance_specification__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_instance_specification__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_instance_specification__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_instance_specification__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Versions and Specifications</a></div>
</div>
</div>