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_0000001645635650.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

164 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001645635650"></a><a name="EN-US_TOPIC_0000001645635650"></a>
<h1 class="topictitle1">Querying the List of API Versions</h1>
<div id="body0000001645635650"><div class="section" id="EN-US_TOPIC_0000001645635650__section19390540"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001645635650__p50301879">This API is used to query the list of API versions.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001645635650__section40297137"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001645635650__p17927185120368">URI format</p>
<p id="EN-US_TOPIC_0000001645635650__p37390672">GET /</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001645635650__section27129916"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0000001645635650__p8243397374">Sample:<pre class="screen" id="EN-US_TOPIC_0000001645635650__screen411873912920">GET https://{dcs_endpoint}/</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001645635650__section42842654"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001645635650__table1244631181217" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001645635650__row644717114128"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001645635650__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_0000001645635650__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_0000001645635650__p4447510123">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001645635650__row1244711120123"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p1744719113124">versions</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p74479101218">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p1144717181219">List of API versions. For details, see <a href="#EN-US_TOPIC_0000001645635650__table49541177222812">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001645635650__table49541177222812"></a><a name="table49541177222812"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001645635650__table49541177222812" frame="border" border="1" rules="all"><caption><b>Table 2 </b>versions parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001645635650__row31307356222812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001645635650__p52867918222812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001645635650__p54442989222812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.79%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001645635650__p47079504222812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001645635650__row49897554222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p31318845143243">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p53798498143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p46434022143243">The minimum minorversion supported. If the version does not support minorversions, the value is empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row54402779222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p13448319143243">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p3173993219137">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p28790367143243">API version URI. For details, see <a href="#EN-US_TOPIC_0000001645635650__table35183803523">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row23073040222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p50212078143243">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p40646554143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p58524749143243">ID of the API version.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row52652485222812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p50414043143243">updated</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p57005649143243">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p16367207143243">The last time when the API version was updated.</p>
<p id="EN-US_TOPIC_0000001645635650__p2841328201815">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row2625553314335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p35634222143315">version</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p690833143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p36267691143315">The maximum minorversion supported. If the version does not support minorversions, the value is empty.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row3428178414338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p65363382143315">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p59942555143315">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.79%" headers="mcps1.3.4.3.2.4.1.3 "><div class="p" id="EN-US_TOPIC_0000001645635650__p25161763143315">API version status. The value can be as follows:<ul id="EN-US_TOPIC_0000001645635650__ul52099355205"><li id="EN-US_TOPIC_0000001645635650__li112098358203"><strong id="EN-US_TOPIC_0000001645635650__b1655719132811">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_0000001645635650__li132096355207"><strong id="EN-US_TOPIC_0000001645635650__b128760351284">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</li></ul>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001645635650__table35183803523"></a><a name="table35183803523"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001645635650__table35183803523" frame="border" border="1" rules="all"><caption><b>Table 3 </b>links parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001645635650__row1099838503523"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001645635650__p1845402603523">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001645635650__p1838114303523">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.65%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001645635650__p405534303523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001645635650__row3649809103523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p355541903523">rel</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p1955354003523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p4573756603523">Identifies the semantics of the relationship.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001645635650__row898491303523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001645635650__p5668937803523">href</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001645635650__p2843694403523">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001645635650__p1215177703523">Defines the semantics of the relationship.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001645635650__section4348105243915"><h4 class="sectiontitle">Sample</h4><pre class="screen" id="EN-US_TOPIC_0000001645635650__screen25455828224845">{
"versions": [{
"id": "v1.0",
"links": [{
"href": "self",
"rel": "https://{dcs_endpoint}/v1.0/"
}],
"min_version": "",
"status": "DEPRECATED",
"updated": "2016-12-09T00:00:00Z",
"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_0000001645635650__section50039568"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001645635650__table154476557433" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001645635650__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_0000001645635650__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_0000001645635650__p4448155154315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001645635650__row9448755114314"><td class="cellrowborder" valign="top" width="28.42%" headers="mcps1.3.6.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001645635650__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_0000001645635650__p64485553437">Normal</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001645635650__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0000001645635650__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