forked from docs/doc-exports
Ying, Jiayu
14be087a3b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Ying, Jiayu <jiayuying1@huawei.com> Co-committed-by: Ying, Jiayu <jiayuying1@huawei.com>
200 lines
16 KiB
HTML
200 lines
16 KiB
HTML
<a name="en-us_topic_0168602247"></a><a name="en-us_topic_0168602247"></a>
|
|
|
|
<h1 class="topictitle1">Querying All API Versions</h1>
|
|
<div id="body8662426"><div class="section" id="en-us_topic_0168602247__s0466135c97cb4142aa7983923c915d8c"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0168602247__en-us_topic_0133095426_p65561530">This API is used to query all API versions supported by Cloud Trace Service (CTS).</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0168602247__s04b7f4492f314198a774428f35becda2"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0168602247__en-us_topic_0133095426_p48490504">GET /</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0168602247__s84cceca358f247f69eb175807e7c2b50"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0168602247__en-us_topic_0133095426_p45638969">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0168602247__s4d7d5e00cc9b4d6f976ccc3966242889"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0168602247__en-us_topic_0133095426_ul5769005"><li id="en-us_topic_0168602247__l75fcc8cc4c5c4fb7ae2eed3137111abf">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0168602247__tdf4d7268413c469c8221c4c5926fe87b" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the response</caption><thead align="left"><tr id="en-us_topic_0168602247__rb45363afc3d24211ae09d1b4af288a9e"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="en-us_topic_0168602247__af9d1be9b0c1645e283baee0922d5fbbb"><strong id="en-us_topic_0168602247__b842352706115119">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="en-us_topic_0168602247__en-us_topic_0133095426_p543845610355"><strong id="en-us_topic_0168602247__b842352706115121">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="en-us_topic_0168602247__a7823bd85d602486b879247d4b661d7f4"><strong id="en-us_topic_0168602247__b842352706115123">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="en-us_topic_0168602247__en-us_topic_0133095426_p244212561357"><strong id="en-us_topic_0168602247__b842352706115259">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0168602247__r0ee0073f6e834f00bc77358f6f8635f5"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__a017cdab0a98d4851a49f5135cbad69d4">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__acf0769f0413e439a8a183199f0d16ee2">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p444855610353">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p344911569354">List of all API versions</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__rd47d209edd3149f699432eab07df3f16"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__ac4b145b2e58942c68d8499e88414cd81">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__aaa9adc4b7c9145baabc697348da646ad">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__afae482155c0f41eab8beac94febc051f">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p045585620357">Version ID (version number), for example, v1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__r3bc50bee8f97476eb366ad2cda969e5b"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__a16441b8ffb7f4804b29d4766778d611f">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__aa042642075e24ae2948962aa8b28bd44">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p346325618353">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p746525619351">API URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__row7534410111710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__p16283354130">href</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__p139117297139">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__p13242332181317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__p2269104581219">Reference address of the current API version</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__row1811287181710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__p2139956101218">rel</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__p1994102917139">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__p824653211138">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__p513917563125">Relationship between the current API version and the referenced address</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__rbefb89827eb64c9fb76fa47e3518c25b"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__a197887174b37427aad0aa150e112bb4b">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p164706561359">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__a49d2c8dda562477299d3a087fabf6226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__afddf4ef447a0492e81251f2729d202ba">If microversions are supported by the APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__rd0382ea7e2f34bbba313199943f81b84"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p647516561358">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p447812565352">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__ac470d0351b0f417cb9cffaf0e28cd2d8">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__a3a9174449f8a4c4dabee175ef0b37b72">Version status. The value will be one of the following:</p>
|
|
<p id="en-us_topic_0168602247__a148dcf9e966342c6a2c2d53bbac49302"><strong id="en-us_topic_0168602247__b842352706192132">CURRENT</strong>: The version is the primary version.</p>
|
|
<p id="en-us_topic_0168602247__a5aac1a3bc7ed443ba67d3e5f4ef29988"><strong id="en-us_topic_0168602247__b842352706192150">SUPPORTED</strong>: The version is an old version, but it is still supported.</p>
|
|
<p id="en-us_topic_0168602247__a991e9ae8d16945a3adc86afb88dc1506"><strong id="en-us_topic_0168602247__b84235270619220">DEPRECATED</strong>: The version is a deprecated version, which may be deleted later.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__r3c318a216dc0482fa1dcac024fbc8bad"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__ab707aa5fa1ef4643b3075fa7353ead56">updated</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__a12638c03d03b43048ab2cb123ec124fe">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__a79d47501d5a944f48081dcd67c7cb965">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__a36c320ed10984a5ebbcd1d90837c783a">Version release time, which is the Coordinated Universal time (UTC). For example, the release time of v1 is <strong id="en-us_topic_0168602247__b89132541467">2014-06-28T12:20:21Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__r21e88a93e3be48adb4a7c5ca9946016e"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="en-us_topic_0168602247__abc5e00a197f74a12acb4c32212df9941">min_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p14966566355">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="en-us_topic_0168602247__aa592cf71536548969efa4aaf4bf26d89">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="en-us_topic_0168602247__p49124565543">If microversions are supported by the APIs of the given version, the minimum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0168602247__en-us_topic_0133095426_li51921052">Example response<pre class="screen" id="en-us_topic_0168602247__s564d8b4011274ba5a332c1baebe8905f">{
|
|
"version": [
|
|
{
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"href": "https://<em id="en-us_topic_0168602247__a83e73d53b5254169bc55c921bf5ca827">x.x.x.x</em>/v1.0/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "CURRENT",
|
|
"updated": "2018-09-30T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
{
|
|
"id": "v2.0",
|
|
"links": [
|
|
{
|
|
"href": "https://<em id="en-us_topic_0168602247__i152867575538">x.x.x.x</em>/v2.0/",
|
|
"rel": "self"
|
|
}
|
|
],
|
|
"min_version": "",
|
|
"status": "SUPPORTED",
|
|
"updated": "2018-09-30T00:00:00Z",
|
|
"version": ""
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0168602247__sa0e69c95829e4ac2954f1b2a8545ccf7"><h4 class="sectiontitle">Returned Value</h4><ul id="en-us_topic_0168602247__en-us_topic_0133095426_ul20226985"><li id="en-us_topic_0168602247__en-us_topic_0133095426_li47825138">Normal<p id="en-us_topic_0168602247__en-us_topic_0133095426_p27773061"><a name="en-us_topic_0168602247__en-us_topic_0133095426_li47825138"></a><a name="en-us_topic_0133095426_li47825138"></a>200</p>
|
|
</li><li id="en-us_topic_0168602247__en-us_topic_0133095426_li48630964">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0168602247__en-us_topic_0133095426_table46793998" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Return code for failed requests</caption><thead align="left"><tr id="en-us_topic_0168602247__en-us_topic_0133095426_row65573909"><th align="left" class="cellrowborder" valign="top" width="61.839999999999996%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="en-us_topic_0168602247__en-us_topic_0133095426_p9886408"><strong id="en-us_topic_0168602247__b842352706112815">Returned Value</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.16%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="en-us_topic_0168602247__en-us_topic_0133095426_p62601592"><strong id="en-us_topic_0168602247__b1953006328">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0168602247__en-us_topic_0133095426_row37564172"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p22799085">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p44643603">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row66248115"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p64497130">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p42202994">The authentication information is not provided or is incorrect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row44282627"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p30123063">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p15114764">The request was forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__row097836141618"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__p6738773164846">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__p8969753164846">The server failed to find the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row1815156"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p12809933">408 Request Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p10309404">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row25675773"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p66471715">429 Too Many Requests</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p5281111">The number of requests exceeded the upper limit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row47530006"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p24725298">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p39567352">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0168602247__en-us_topic_0133095426_row20561848"><td class="cellrowborder" valign="top" width="61.839999999999996%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="en-us_topic_0168602247__en-us_topic_0133095426_p54897010">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.16%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="en-us_topic_0168602247__ae8051cac98af4c3a813d03ca7a40dc7c">The service is currently unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0168602231.html">API Version Management</a></div>
|
|
</div>
|
|
</div>
|
|
|