vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/en-us_topic_0000001693796125.html
Chen, Junjie a03981f7be DCS API 20230220 Version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-04-22 14:08:39 +00:00

172 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001693796125"></a><a name="EN-US_TOPIC_0000001693796125"></a>
<h1 class="topictitle1">Querying Information of an API Version</h1>
<div id="body0000001693796125"><div class="section" id="EN-US_TOPIC_0000001693796125__section19390540"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001693796125__p50301879">Querying Information of an API Version.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section40297137"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001693796125__p89364301501">URI format</p>
<div class="p" id="EN-US_TOPIC_0000001693796125__p195525020124">GET /{api_version}
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001693796125__table1713182113123" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001693796125__row572082112129"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001693796125__p117213216122">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.38%" id="mcps1.3.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001693796125__p13722182141217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.19%" id="mcps1.3.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001693796125__p18727112115122">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001693796125__row672911211121"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p92913260121">api_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.38%" headers="mcps1.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p20735172151211">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.19%" headers="mcps1.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p34154511106">Target API version.</p>
<p id="EN-US_TOPIC_0000001693796125__p4879155121013">The value can be <strong id="EN-US_TOPIC_0000001693796125__b15295173904515">v1.0</strong> or <strong id="EN-US_TOPIC_0000001693796125__b101571744184511">v2</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section0879165342510"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0000001693796125__p182791576513">Sample:<pre class="screen" id="EN-US_TOPIC_0000001693796125__screen411873912920">GET https://{dcs_endpoint}/v2</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section42842654"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001693796125__table1244631181217" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001693796125__row644717114128"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001693796125__p1044711171210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0000001693796125__p1844716114129">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.79%" id="mcps1.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0000001693796125__p4447510123">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001693796125__row1244711120123"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p1744719113124">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p74479101218">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p1144717181219">List of API versions. For details, see <a href="#EN-US_TOPIC_0000001693796125__table49541177222812">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001693796125__table49541177222812"></a><a name="table49541177222812"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001693796125__table49541177222812" frame="border" border="1" rules="all"><caption><b>Table 3 </b>versions parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001693796125__row31307356222812"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001693796125__p52867918222812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001693796125__p54442989222812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001693796125__p47079504222812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001693796125__row49897554222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p31318845143243">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p53798498143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p17769204972711">The minimum minorversion supported. If the version does not support minorversions, the value is empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row54402779222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p13448319143243">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p31184311191352">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p28790367143243">API version URI. For details, see <a href="#EN-US_TOPIC_0000001693796125__table35183803523">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row23073040222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p50212078143243">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p40646554143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p58524749143243">ID of the API version.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row52652485222812"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p50414043143243">updated</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p57005649143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p16367207143243">The last time when the API version was updated.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row2625553314335"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p35634222143315">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p690833143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p36267691143315">The maximum minorversion supported. If the version does not support minorversions, the value is empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row3428178414338"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p65363382143315">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p59942555143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p25161763143315">API version status. The value can be as follows:</p>
<ul id="EN-US_TOPIC_0000001693796125__ul52099355205"><li id="EN-US_TOPIC_0000001693796125__li112098358203"><strong id="EN-US_TOPIC_0000001693796125__b1574798153720">CURRENT</strong>: DCS custom APIs provide multiple versions. For APIs offering the same functions, you are recommended to use the v2 APIs.</li><li id="EN-US_TOPIC_0000001693796125__li132096355207"><strong id="EN-US_TOPIC_0000001693796125__b10451101513373">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001693796125__table35183803523"></a><a name="table35183803523"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001693796125__table35183803523" frame="border" border="1" rules="all"><caption><b>Table 4 </b>links parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001693796125__row1099838503523"><th align="left" class="cellrowborder" valign="top" width="22.352235223522353%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001693796125__p1845402603523">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.18211821182118%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001693796125__p1838114303523">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.46564656465647%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001693796125__p405534303523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001693796125__row3649809103523"><td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p355541903523">rel</p>
</td>
<td class="cellrowborder" valign="top" width="21.18211821182118%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p1955354003523">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.46564656465647%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p4573756603523">Identifies the semantics of the relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001693796125__row898491303523"><td class="cellrowborder" valign="top" width="22.352235223522353%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001693796125__p5668937803523">href</p>
</td>
<td class="cellrowborder" valign="top" width="21.18211821182118%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001693796125__p2843694403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.46564656465647%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001693796125__p1215177703523">Defines the semantics of the relationship.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section10450444164916"><h4 class="sectiontitle">Sample</h4><pre class="screen" id="EN-US_TOPIC_0000001693796125__screen59436693163550">{
"version": {
"id": "v2",
"links": [{
"href": "self",
"rel": "https://{dcs_endpoint}/v2/"
}],
"min_version": "",
"status": "CURRENT",
"updated": "2016-12-09T00:00:00Z",
"version": ""
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section50039568"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001693796125__table154476557433" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001693796125__row1844885504316"><th align="left" class="cellrowborder" valign="top" width="28.42%" id="mcps1.3.6.2.1.3.1.1"><p id="EN-US_TOPIC_0000001693796125__p244835514433">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.58%" id="mcps1.3.6.2.1.3.1.2"><p id="EN-US_TOPIC_0000001693796125__p4448155154315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001693796125__row9448755114314"><td class="cellrowborder" valign="top" width="28.42%" headers="mcps1.3.6.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001693796125__p1744817559433">200</p>
</td>
<td class="cellrowborder" valign="top" width="71.58%" headers="mcps1.3.6.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001693796125__p64485553437">Normal</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001693796125__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001693796125__en-us_topic_0044524833_p783819215242">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001693875369.html">API Version Query</a></div>
</div>
</div>
View Git Blame Copy Permalink