forked from docs/doc-exports
Qin Ying, Fan
62ab8a5fe2
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
106 lines
8.4 KiB
HTML
106 lines
8.4 KiB
HTML
<a name="en-us_topic_0055025312"></a><a name="en-us_topic_0055025312"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Specified API Version</h1>
|
|
<div id="body1539740810917"><div class="section" id="en-us_topic_0055025312__section109661156152112"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025312__p18437102532211">This API is used to query a specified API version supported by Direct Connect.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025312__section11867232184814"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025312__p27417391367">GET /{api_version}</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025312__section24112512"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025312__p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025312__section15686020"><a name="en-us_topic_0055025312__section15686020"></a><a name="section15686020"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025312__p81037681212"><a href="#en-us_topic_0055025312__table49902238182444">Table 1</a> lists the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0055025312__table49902238182444"></a><a name="table49902238182444"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025312__table49902238182444" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="en-us_topic_0055025312__row27727643182444"><th align="left" class="cellrowborder" valign="top" width="21.529999999999998%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025312__p31346634182444">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.46%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025312__p56049421182444">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.010000000000005%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025312__p50789233182444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0055025312__row39593523182444"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p1326331857">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p183219331352">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p1232103319520">Specifies the version number, for example, <strong id="en-us_topic_0055025312__b842352706151910">v2.0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row64801111182444"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p13233311516">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p932153310512">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p113219331057">Specifies the API URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row314332616201"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p124464144178">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p244781412174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p144471814201718">Specifies the reference address of the current API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row342330162012"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p168331418121713">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p17833131818174">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p118332018191716">Specifies the relationship between the current API version and the referenced address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row20716483182444"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p15325331257">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p19321133251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p93210331152">Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If minor versions are not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row48951951182444"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p19326339519">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p1432193314519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p15331033950">Specifies the version status. Value options are as follows:</p>
|
|
<ul id="en-us_topic_0055025312__ul597114391474"><li id="en-us_topic_0055025312__li3971439173"><strong id="en-us_topic_0055025312__b18684192161414">CURRENT</strong>: indicates a primary version.</li><li id="en-us_topic_0055025312__li55052436714"><strong id="en-us_topic_0055025312__b398355145">SUPPORTED</strong>: indicates an old version that is still supported.</li><li id="en-us_topic_0055025312__li157258466710"><strong id="en-us_topic_0055025312__b3762538121412">DEPRECATED</strong>: indicates a deprecated version that may be deleted later.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row2329187257"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p18331633956">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p15331331459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p133303319510">Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0055025312__row4783956182444"><td class="cellrowborder" valign="top" width="21.529999999999998%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025312__p833333852">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.46%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025312__p7336331759">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.010000000000005%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025312__p1333933458">Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0055025312__section542210409508"><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025312__ul164071549155019"><li id="en-us_topic_0055025312__li2407104935015">Example request<pre class="screen" id="en-us_topic_0055025312__screen145782219814">GET /v2.0</pre>
|
|
</li><li id="en-us_topic_0055025312__li426275618505"><a name="en-us_topic_0055025312__li426275618505"></a><a name="li426275618505"></a>Example response<pre class="screen" id="en-us_topic_0055025312__screen5585769616025">{
|
|
"version": {
|
|
"id": "v2.0",
|
|
"links": [
|
|
{
|
|
"href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"updated": "YYYY-MM-DDTHH:MM:SSZ",
|
|
"status": "CURRENT",
|
|
"version": "",
|
|
"min_version": ""
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025310.html">API Version</a></div>
|
|
</div>
|
|
</div>
|
|
|