forked from docs/doc-exports
Li, Qiao
dfe65b9551
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
197 lines
16 KiB
HTML
197 lines
16 KiB
HTML
<a name="kms_02_0048"></a><a name="kms_02_0048"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body1537950037584"><div class="section" id="kms_02_0048__en-us_topic_0133150653_section27849192112353"><h4 class="sectiontitle">Function</h4><p id="kms_02_0048__en-us_topic_0133150653_p45386342112449">This API is used to query the API versions.</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0048__en-us_topic_0133150653_section35184599112353"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0048__en-us_topic_0133150653_ul31380276112353"><li id="kms_02_0048__en-us_topic_0133150653_li13987034112353">URI format<p id="kms_02_0048__en-us_topic_0133150653_p58774446112353"><a name="kms_02_0048__en-us_topic_0133150653_li13987034112353"></a><a name="en-us_topic_0133150653_li13987034112353"></a>GET /</p>
|
|
</li><li id="kms_02_0048__en-us_topic_0133150653_li59207969112353">Parameter description<p id="kms_02_0048__en-us_topic_0133150653_p1026511384435"><a name="kms_02_0048__en-us_topic_0133150653_li59207969112353"></a><a name="en-us_topic_0133150653_li59207969112353"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0048__en-us_topic_0133150653_section12625030112353"><h4 class="sectiontitle">Requests</h4><p id="kms_02_0048__en-us_topic_0133150653_p2857052711259">None</p>
|
|
</div>
|
|
<div class="section" id="kms_02_0048__en-us_topic_0133150653_section15686020"><h4 class="sectiontitle">Responses</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0048__en-us_topic_0133150653_table5856932152840" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0048__en-us_topic_0133150653_row5206426152840"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0048__en-us_topic_0133150653_p1577110425210">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0048__en-us_topic_0133150653_p167751142326">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.3"><p id="kms_02_0048__en-us_topic_0133150653_p157711420214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="kms_02_0048__en-us_topic_0133150653_p1877644212217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0048__en-us_topic_0133150653_row25652894105355"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p128251240121912">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p158251400193">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p882504017190">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p17826740121915">Version object list. For details, see <a href="#kms_02_0048__en-us_topic_0133150653_table95441953481">Table 2</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0048__en-us_topic_0133150653_table95441953481"></a><a name="en-us_topic_0133150653_table95441953481"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0048__en-us_topic_0133150653_table95441953481" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="kms_02_0048__en-us_topic_0133150653_b175552569271">versions</strong> field description</caption><thead align="left"><tr id="kms_02_0048__en-us_topic_0133150653_row115453539811"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0048__en-us_topic_0133150653_p15458531386">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0048__en-us_topic_0133150653_p3545453286">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.3"><p id="kms_02_0048__en-us_topic_0133150653_p1754512534812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="kms_02_0048__en-us_topic_0133150653_p854518537818">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0048__en-us_topic_0133150653_row195458536817"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p1554518531488">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p5545253783">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p1954565314813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p254513531784">Version number, for example, <span class="parmvalue" id="kms_02_0048__en-us_topic_0133150653_parmvalue354510531086"><b>v1.0</b></span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row15545253689"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p1454515538812">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p85458532818">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p954514531084">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p145464537810">JSON object. For details, see <a href="#kms_02_0048__en-us_topic_0133150653_table525011561381">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row95461853187"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p85461253489">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p954620531681">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p1854612531682">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p75472531982">If the APIs of this version support microversions, the supported maximum microversion is returned. If the microversion is not supported, empty character string is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row135471953984"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p154712531489">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p654718531887">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p165472533814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p155474531683">Version status. Valid values are as follows:</p>
|
|
<ul id="kms_02_0048__en-us_topic_0133150653_ul165471353081"><li id="kms_02_0048__en-us_topic_0133150653_li1954717538813"><strong id="kms_02_0048__en-us_topic_0133150653_b842352706115252">CURRENT</strong>: widely used version</li><li id="kms_02_0048__en-us_topic_0133150653_li55470531585"><strong id="kms_02_0048__en-us_topic_0133150653_b04965131196">SUPPORTED</strong>: earlier version which is still supported</li><li id="kms_02_0048__en-us_topic_0133150653_li185472538810"><strong id="kms_02_0048__en-us_topic_0133150653_b842352706115458">DEPRECATED</strong>: deprecated version which may be deleted later</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row25474538818"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p1454719536816">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p105478535815">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p754765319816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p454775318810">Version release time, which must be UTC time. For example, the release time of v1 is 2014-06-28T12:20:21Z.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row65471053388"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p9547253685">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p354710531189">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p554745319813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p65471653187">If the APIs of this version support microversions, the supported minimum microversion is returned. If the microversion is not supported, empty character string is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="kms_02_0048__en-us_topic_0133150653_table525011561381"></a><a name="en-us_topic_0133150653_table525011561381"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0048__en-us_topic_0133150653_table525011561381" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="kms_02_0048__en-us_topic_0133150653_b48213422288">links</strong> field description</caption><thead align="left"><tr id="kms_02_0048__en-us_topic_0133150653_row132503561082"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.1"><p id="kms_02_0048__en-us_topic_0133150653_p1625015615811">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.4.2.5.1.2"><p id="kms_02_0048__en-us_topic_0133150653_p125113569815">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.3"><p id="kms_02_0048__en-us_topic_0133150653_p925105618816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.5.1.4"><p id="kms_02_0048__en-us_topic_0133150653_p1325155614816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0048__en-us_topic_0133150653_row202512562089"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p1425115564818">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p92512056884">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p62518561389">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p12511566810">API URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kms_02_0048__en-us_topic_0133150653_row142511456987"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_p2251165613814">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_p62522566811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_p2252145610820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0048__en-us_topic_0133150653_p225212561985">The default value is <strong id="kms_02_0048__en-us_topic_0133150653_b555016171571">self</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kms_02_0048__en-us_topic_0133150653_section12491816289"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0048__en-us_topic_0133150653_p1846911715317">The following describes how to query the version information.</p>
|
|
<ul id="kms_02_0048__en-us_topic_0133150653_ul1265415512511"><li id="kms_02_0048__en-us_topic_0133150653_li87821355103110">Example request<p id="kms_02_0048__en-us_topic_0133150653_p1415949325"><a name="kms_02_0048__en-us_topic_0133150653_li87821355103110"></a><a name="en-us_topic_0133150653_li87821355103110"></a>None</p>
|
|
</li><li id="kms_02_0048__en-us_topic_0133150653_li1084181562520">Example response<pre class="screen" id="kms_02_0048__en-us_topic_0133150653_screen16841515162512">{
|
|
"versions":
|
|
[
|
|
{
|
|
"id":"v1.0",
|
|
"links":
|
|
[
|
|
{
|
|
|
|
"href":"https://kms.eu-de.otc.t-systems.com/v1.0/",
|
|
"rel":"self"
|
|
}
|
|
],
|
|
"min_version":"",
|
|
"status":"CURRENT",
|
|
"version":"",
|
|
"updated":"2018-09-05T08:18:05Z"
|
|
}
|
|
]
|
|
}</pre>
|
|
<p id="kms_02_0048__en-us_topic_0133150653_p132609182811">or</p>
|
|
<pre class="screen" id="kms_02_0048__en-us_topic_0133150653_screen22601115284">{
|
|
"error": {
|
|
"error_code": "KMS.XXXX",
|
|
"error_msg": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="kms_02_0048__en-us_topic_0133150653_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 4</a> lists the normal status code returned by the response.
|
|
<div class="tablenoborder"><a name="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_row9746163"><th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.6.2.2.2.4.1.1"><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p57545694203043">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.28%" id="mcps1.3.6.2.2.2.4.1.2"><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p4531342288">Status</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.6.2.2.2.4.1.3"><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p30689603203043">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_row48621261"><td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.6.2.2.2.4.1.1 "><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_en-us_topic_0079615001_p46008046">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.28%" headers="mcps1.3.6.2.2.2.4.1.2 "><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p7538425819">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.6.2.2.2.4.1.3 "><p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="kms_02_0048__en-us_topic_0133150653_en-us_topic_0112992294_p5626181018551">Exception status code. For details, see <a href="kms_02_0301.html#kms_02_0301">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kms_02_0011.html">CMK Management</a></div>
|
|
</div>
|
|
</div>
|
|
|