vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/bms/api-ref/en-us_topic_0132973804.html
guoyanyan c311ecafe3 bms_api_0510 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
2023-10-11 08:28:11 +00:00

182 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0132973804"></a><a name="EN-US_TOPIC_0132973804"></a>
<h1 class="topictitle1">Querying API Versions</h1>
<div id="body1537927742000"><div class="section" id="EN-US_TOPIC_0132973804__section54478915181842"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0132973804__p40170843">This API is used to query all available API versions of the <span id="EN-US_TOPIC_0132973804__text29522012192119">BMS</span><span id="EN-US_TOPIC_0132973804__text188328176217"></span> service.</p>
</div>
<div class="section" id="EN-US_TOPIC_0132973804__section53791107181842"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0132973804__p53736847103512">GET /</p>
</div>
<div class="section" id="EN-US_TOPIC_0132973804__section39878380181842"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0132973804__ul742255943611"><li id="EN-US_TOPIC_0132973804__li14410836111413">Request parameters<p id="EN-US_TOPIC_0132973804__p151094428144"><a name="EN-US_TOPIC_0132973804__li14410836111413"></a><a name="li14410836111413"></a>None</p>
</li><li id="EN-US_TOPIC_0132973804__li174221859113615">Example request<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0132973804__screen7715121319379"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">GET</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{BMS Endpoint}/</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0132973804__section201868180299"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0132973804__ul59560431"><li id="EN-US_TOPIC_0132973804__li66281838">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0132973804__table59665636" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0132973804__row28755990"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0132973804__p47533853">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0132973804__p25036876">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0132973804__p14721100">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0132973804__row34736162"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0132973804__p1654215818362">versions</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0132973804__p2257160">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0132973804__p48612303">Specifies API versions of the <span id="EN-US_TOPIC_0132973804__text1968202922112">BMS</span><span id="EN-US_TOPIC_0132973804__text165161834172119"></span> service. For details, see <a href="#EN-US_TOPIC_0132973804__table5036780310489">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0132973804__table5036780310489"></a><a name="table5036780310489"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0132973804__table5036780310489" width="90%" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="EN-US_TOPIC_0132973804__b011295285216">versions</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0132973804__r1f3f90a6acc94015acc80b9d6b53f072"><th align="left" class="cellrowborder" valign="top" width="26.75%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0132973804__ad0d15c1370cb450fb7e6011b8baff160">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0132973804__a2273dfb9dd3341b0b5cbf801a0aa70fc">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.949999999999996%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0132973804__a479b45e1fbfc44118151c43b5ecb82f1">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0132973804__rdd24623b54f94a86b0f655ec659180e9"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__ab9c8eb8b964943509fca83cc70a4e489">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a43cc5f338c7e429c861f7dbb2dcb3229">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__a5c153a8f0b8d4f26af1405cdcbcec1cc">Specifies the API version ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__r784e679e20ef42c7b5f0d9caebb3d506"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__af5650be6710143e49d288b78f41a9c9d">links</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__aa41878c3fbc74f52be50c47e0dd26a46">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__a37d79d061a9f47c5beee1f98f4c4611b">Specifies the API URL. For details, see <a href="#EN-US_TOPIC_0132973804__t759e6d15d244474e8f286185ede143fb">Table 2</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__r06fe5129bbc1493289f623afe4a4f1a2"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__p9107111411399">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a89734c8a12d44d69ab229cf5857bdf05">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__p19907734114018">Specifies the earliest micro API version that is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__rac189e8b65c5430eb4503bf1d1bbb4d7"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__ab5c5c2b93a134f18a2455224014556e9">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a2de7247f99c143e09e698f0ef82f62bc">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__a65ce06cd4813480498062e1de2541bd3">Specifies the API version status.</p>
<ul id="EN-US_TOPIC_0132973804__ud3dc362d60f54fc08039ec57e921e5a6"><li id="EN-US_TOPIC_0132973804__lc89f92b4cf2743f586cf48bb5e1933d1"><strong id="EN-US_TOPIC_0132973804__b157852011133314">CURRENT</strong>: indicates a primary version.</li><li id="EN-US_TOPIC_0132973804__lb288548ff6554efab07248d038789b1f"><strong id="EN-US_TOPIC_0132973804__b1770572593318">SUPPORTED</strong>: indicates an earlier version which is still supported.</li><li id="EN-US_TOPIC_0132973804__lb5c451d60e5e417cafd202ef4ca3389f"><strong id="EN-US_TOPIC_0132973804__b164593340338">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__r4dfedc0bd4ff45f2ac05364f99f01708"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__a306f2c2ef05e47f78c5e0fc5440cea3c">updated</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a979f525a997c4d1e8808195ca9d7f53e">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__p1255911034615">Specifies the release date of an API version.</p>
<p id="EN-US_TOPIC_0132973804__p9711133519711">The timestamp format is YYYY-MM-DDTHH:MM:SSZ (ISO 8601), for example, 2018-09-30T00:00:00Z.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__r45a3cc4c3f6943639ac3843c688f6865"><td class="cellrowborder" valign="top" width="26.75%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__a52a9f640ec724f40a4829ddf066e0837">version</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a015154a0e4094475a717b23650fa6cf1">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.949999999999996%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__adefe07f521ca4e0aab9007ea28bebc7d">Specifies the latest micro API version that is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0132973804__t759e6d15d244474e8f286185ede143fb"></a><a name="t759e6d15d244474e8f286185ede143fb"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0132973804__t759e6d15d244474e8f286185ede143fb" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0132973804__b195911619343">links</strong> field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0132973804__rce98b9668cd747c88039421afe5ce935"><th align="left" class="cellrowborder" valign="top" width="26.57%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0132973804__ad9ac3007570a4752b2b2dbc0fb04dadc">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.3%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0132973804__a602246198adf4a79a13bc4317d4c0d4f">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.13%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0132973804__a8cbfa8dcb0b943ff8e789755123fec83">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0132973804__r43de461181294c56b28da56a1f604b09"><td class="cellrowborder" valign="top" width="26.57%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__abc19a41a8f594f1ba6701e10da50a078">href</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__a15ae7b8585d24e48abc6b9bf45636fda">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.13%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__p139393206480">Specifies the API URL.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0132973804__rbd5ec7242fef4c03b21636ac14160d9e"><td class="cellrowborder" valign="top" width="26.57%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0132973804__a18479f6b70b34f29b2b90d754f59282a">rel</p>
</td>
<td class="cellrowborder" valign="top" width="18.3%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0132973804__ae1f14fa2e6a54531aeffd26874fea267">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.13%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0132973804__p115877381483">Specifies the API URL dependency. The value can be:</p>
<ul id="EN-US_TOPIC_0132973804__ul207311644172510"><li id="EN-US_TOPIC_0132973804__en-us_topic_0131326852_li1013032685313"><strong id="EN-US_TOPIC_0132973804__en-us_topic_0131326852_b320113110516">self</strong>: resource link that contains the version number. It is used when immediate tracing is required.</li><li id="EN-US_TOPIC_0132973804__en-us_topic_0131326852_li14448163219533"><strong id="EN-US_TOPIC_0132973804__en-us_topic_0131326852_b84171947711">bookmark</strong>: resource link that can be stored for a long time.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0132973804__li1448374273115">Example response<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0132973804__screen62654542181842"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;versions&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;v1&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;links&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;http://bms.xxx.com/v1/&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;self&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;min_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CURRENT&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;updated&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;2018-09-30T00:00:00Z&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0132973804__section12571834"><h4 class="sectiontitle">Returned Values</h4><div class="p" id="EN-US_TOPIC_0132973804__p193201622141412">Normal values
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0132973804__table753804619176" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0132973804__row10735134615172"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.3.1.1"><p id="EN-US_TOPIC_0132973804__p19735204616177">Returned Values</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.3.1.2"><p id="EN-US_TOPIC_0132973804__p207355465176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0132973804__row1473514621713"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0132973804__p13735144611178">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0132973804__p207351246161711">The request has been successfully processed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0132973804__p47633965">For details about other returned values, see <a href="en-us_topic_0053158690.html">Status Codes</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0132973804__section12157147171520"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0132973804__en-us_topic_0106040941_p10243161417491">See <a href="en-us_topic_0107541808.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0132973615.html">API Version Query</a></div>
</div>
</div>
View Git Blame Copy Permalink