doc-exports/docs/kms/api-ref/kms_02_0049.html
Li, Qiao dfe65b9551 KMS API 20230817 version.
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>
2024-04-02 13:42:22 +00:00

217 lines
18 KiB
HTML

<a name="kms_02_0049"></a><a name="kms_02_0049"></a>
<h1 class="topictitle1">Querying a Specified API Version</h1>
<div id="body1537950037584"><div class="section" id="kms_02_0049__en-us_topic_0133150654_section27849192112353"><h4 class="sectiontitle">Function</h4><p id="kms_02_0049__en-us_topic_0133150654_p45386342112449">This API is used to query the version of an API.</p>
</div>
<div class="section" id="kms_02_0049__en-us_topic_0133150654_section35184599112353"><h4 class="sectiontitle">URI</h4><ul id="kms_02_0049__en-us_topic_0133150654_ul31380276112353"><li id="kms_02_0049__en-us_topic_0133150654_li13987034112353">URI format<p id="kms_02_0049__en-us_topic_0133150654_p58774446112353"><a name="kms_02_0049__en-us_topic_0133150654_li13987034112353"></a><a name="en-us_topic_0133150654_li13987034112353"></a>GET /{version_id}</p>
</li><li id="kms_02_0049__en-us_topic_0133150654_li59207969112353">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0049__en-us_topic_0133150654_table63109676112353" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="kms_02_0049__en-us_topic_0133150654_row49827042112353"><th align="left" class="cellrowborder" valign="top" width="22.74%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="kms_02_0049__en-us_topic_0133150654_p1577110425210"><strong id="kms_02_0049__en-us_topic_0133150654_b15692163216618">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="kms_02_0049__en-us_topic_0133150654_p167751142326">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.55%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="kms_02_0049__en-us_topic_0133150654_p157711420214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.79%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="kms_02_0049__en-us_topic_0133150654_p1877644212217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0049__en-us_topic_0133150654_row1533688409"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p12534488409">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p9535198184015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p105353804019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.79%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p17984943124012">Version ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="kms_02_0049__en-us_topic_0133150654_section12625030112353"><h4 class="sectiontitle">Requests</h4><p id="kms_02_0049__en-us_topic_0133150654_p2857052711259">None</p>
</div>
<div class="section" id="kms_02_0049__en-us_topic_0133150654_section15686020"><h4 class="sectiontitle">Responses</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0049__en-us_topic_0133150654_table5963155810121" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="kms_02_0049__en-us_topic_0133150654_row14964195819121"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.2.5.1.1"><p id="kms_02_0049__en-us_topic_0133150654_p209641586129"><strong id="kms_02_0049__en-us_topic_0133150654_b743438474">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.2.5.1.2"><p id="kms_02_0049__en-us_topic_0133150654_p10964185816121">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_0049__en-us_topic_0133150654_p7964205821210">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_0049__en-us_topic_0133150654_p1896414586120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0049__en-us_topic_0133150654_row996417582128"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p69642058131212">version</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p1964165811218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p13964185810124">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_0049__en-us_topic_0133150654_p2096565813122">Version information. For details, see <a href="#kms_02_0049__en-us_topic_0133150654_table5856932152840">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="kms_02_0049__en-us_topic_0133150654_table5856932152840"></a><a name="en-us_topic_0133150654_table5856932152840"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0049__en-us_topic_0133150654_table5856932152840" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong>version</strong> field data structure description</caption><thead align="left"><tr id="kms_02_0049__en-us_topic_0133150654_row5206426152840"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="kms_02_0049__en-us_topic_0133150654_p2059315101761"><strong id="kms_02_0049__en-us_topic_0133150654_b1385415364">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.3.2.5.1.2"><p id="kms_02_0049__en-us_topic_0133150654_p6593610867">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_0049__en-us_topic_0133150654_p6593101011614">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_0049__en-us_topic_0133150654_p135931109617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0049__en-us_topic_0133150654_row1168105801813"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p17673853131911">id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p18673753141918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p9673653111917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p8673205341913">Version number, for example, <span class="parmvalue" id="kms_02_0049__en-us_topic_0133150654_parmvalue14343434714"><b>v1.0</b></span></p>
</td>
</tr>
<tr id="kms_02_0049__en-us_topic_0133150654_row5394312194"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p1167305319192">links</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p8673453181912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p10673195361910">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_0049__en-us_topic_0133150654_p96731653201918">JSON object. For details, see <a href="#kms_02_0049__en-us_topic_0133150654_table525011561381">Table 4</a>.</p>
</td>
</tr>
<tr id="kms_02_0049__en-us_topic_0133150654_row1927121716191"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p667314532194">version</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p17673105321917">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p867375310190">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p1067317537197">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_0049__en-us_topic_0133150654_row1327861351913"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p9673185320198">status</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p56732538195">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p9673165315195">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p1267335320191">Version status. Valid values are as follows:</p>
<ul id="kms_02_0049__en-us_topic_0133150654_ul386312155239"><li id="kms_02_0049__en-us_topic_0133150654_li16863201510238"><strong id="kms_02_0049__en-us_topic_0133150654_b744814358717">CURRENT</strong>: widely used version</li><li id="kms_02_0049__en-us_topic_0133150654_li13863181512233"><strong id="kms_02_0049__en-us_topic_0133150654_b842352706115419">SUPPORTED</strong>: earlier version which is still supported</li><li id="kms_02_0049__en-us_topic_0133150654_li986321572310"><strong id="kms_02_0049__en-us_topic_0133150654_b59714208716">DEPRECATED</strong>: deprecated version which may be deleted later</li></ul>
</td>
</tr>
<tr id="kms_02_0049__en-us_topic_0133150654_row45580661911"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p1267355310197">updated</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p0673155313192">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p16673253121920">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p196732531193">Version release time, which must be UTC time. For example, the release time of v1.0 is 2014-06-28T12:20:21Z.</p>
</td>
</tr>
<tr id="kms_02_0049__en-us_topic_0133150654_row14719199199"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p8673553121919">min_version</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.3.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p4673155321911">No</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p4673453111915">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p136732530199">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_0049__en-us_topic_0133150654_table525011561381"></a><a name="en-us_topic_0133150654_table525011561381"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0049__en-us_topic_0133150654_table525011561381" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong>links</strong> field data structure description</caption><thead align="left"><tr id="kms_02_0049__en-us_topic_0133150654_row132503561082"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.1"><p id="kms_02_0049__en-us_topic_0133150654_p1625015615811"><strong id="kms_02_0049__en-us_topic_0133150654_b693792758">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.4.2.5.1.2"><p id="kms_02_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_p1325155614816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0049__en-us_topic_0133150654_row202512562089"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p1425115564818">href</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p92512056884">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p62518561389">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p12511566810">API URL</p>
</td>
</tr>
<tr id="kms_02_0049__en-us_topic_0133150654_row142511456987"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kms_02_0049__en-us_topic_0133150654_p2251165613814">rel</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kms_02_0049__en-us_topic_0133150654_p62522566811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kms_02_0049__en-us_topic_0133150654_p2252145610820">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kms_02_0049__en-us_topic_0133150654_p225212561985">The default value is <strong id="kms_02_0049__en-us_topic_0133150654_b555016171571">self</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="kms_02_0049__en-us_topic_0133150654_section12491816289"><h4 class="sectiontitle">Examples</h4><p id="kms_02_0049__en-us_topic_0133150654_p1846911715317">The following uses the <span class="parmvalue" id="kms_02_0049__en-us_topic_0133150654_parmvalue26021927112613"><b>v1.0</b></span> version as an example.</p>
<ul id="kms_02_0049__en-us_topic_0133150654_ul1265415512511"><li id="kms_02_0049__en-us_topic_0133150654_li87821355103110">Example request<p id="kms_02_0049__en-us_topic_0133150654_p1415949325"><a name="kms_02_0049__en-us_topic_0133150654_li87821355103110"></a><a name="en-us_topic_0133150654_li87821355103110"></a>None</p>
</li><li id="kms_02_0049__en-us_topic_0133150654_li65391920182615">Example response<pre class="screen" id="kms_02_0049__en-us_topic_0133150654_screen7539192016265">{
"version":
{
"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_0049__en-us_topic_0133150654_p132609182811">or</p>
<pre class="screen" id="kms_02_0049__en-us_topic_0133150654_screen22601115284">{
"error": {
"error_code": "KMS.XXXX",
"error_msg": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="kms_02_0049__en-us_topic_0133150654_section3454223421"><h4 class="sectiontitle">Status Codes</h4><div class="p" id="kms_02_0049__en-us_topic_0133150654_en-us_topic_0112992294_en-us_topic_0079615001_p17772351"><a href="#kms_02_0049__en-us_topic_0133150654_en-us_topic_0112992294_en-us_topic_0079615001_table20596071">Table 5</a> lists the normal status code returned by the response.
<div class="tablenoborder"><a name="kms_02_0049__en-us_topic_0133150654_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><a name="en-us_topic_0133150654_en-us_topic_0112992294_en-us_topic_0079615001_table20596071"></a><table cellpadding="4" cellspacing="0" summary="" id="kms_02_0049__en-us_topic_0133150654_en-us_topic_0112992294_en-us_topic_0079615001_table20596071" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="kms_02_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_en-us_topic_0112992294_p30689603203043">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="kms_02_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_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_0049__en-us_topic_0133150654_en-us_topic_0112992294_p1885682315512">Request processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="kms_02_0049__en-us_topic_0133150654_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>