lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

TMS API 0805 Version

Browse Source 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
This commit is contained in:
Wei, Hongmin 2024-08-26 08:53:04 +00:00 committed by zuul
parent da6ca4fb3c
commit 83590bf1cd
8 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tms/api-ref/ALL_META.TXT.json
View File

@ -61,7 +61,7 @@
"node_id":"en-us_topic_0133313256.xml",
"product_code":"tms",
"code":"4",
"des":"This API is used to query the versions of all TMS APIs.GET /Example requestParameter descriptionParameters in the responseNameTypeDescriptionversionsArraySpecifies all AP",
"des":"This API is used to query the versions of all TMS APIs.GET /Example requestYou can obtain the TMS endpoints from Regions and Endpoints.Parameter descriptionParameters in ",
"doc_type":"api",
"kw":"Querying the API Versions,Querying the API Version,API Reference",
"search_title":"",

2
docs/tms/api-ref/CLASS.TXT.json
View File

@ -27,7 +27,7 @@
"code":"3"
},
{
"desc":"This API is used to query the versions of all TMS APIs.GET /Example requestParameter descriptionParameters in the responseNameTypeDescriptionversionsArraySpecifies all AP",
"desc":"This API is used to query the versions of all TMS APIs.GET /Example requestYou can obtain the TMS endpoints from Regions and Endpoints.Parameter descriptionParameters in ",
"product_code":"tms",
"title":"Querying the API Versions",
"uri":"en-us_topic_0133313256.html",

2
docs/tms/api-ref/ListProviders.html
View File

@ -285,7 +285,7 @@
},
{
"provider": "nosql",
"provider_i18n_display_name": "GaussDBNoSQL",
"provider_i18n_display_name": "geminidb",
"resource_types": [
{
"global": false,

0
docs/tms/api-ref/en-us_image_0000001508295281.png → docs/tms/api-ref/en-us_image_0000001884958205.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

6
docs/tms/api-ref/en-us_topic_0056765936.html
View File

@ -92,7 +92,7 @@
<p id="en-us_topic_0056765936__p61309029151611">Its default value is <strong id="en-us_topic_0056765936__b67084326151611">update_time</strong>.</p>
<p id="en-us_topic_0056765936__p50024018222837">You can choose only one of the three values and based on the value of <strong id="en-us_topic_0056765936__b842352706144716">order_method</strong> to sort the remaining two default fields.</p>
<p id="en-us_topic_0056765936__p6032547810755">For example:</p>
<ul id="en-us_topic_0056765936__ul4769660110812"><li id="en-us_topic_0056765936__li5287192010812">If <strong id="en-us_topic_0056765936__b842352706145014">order_field</strong> is set to <strong id="en-us_topic_0056765936__b842352706145022">update_time</strong>, both <strong id="en-us_topic_0056765936__b842352706145046">key</strong> and <strong id="en-us_topic_0056765936__b842352706145049">value</strong> are sorted in the ascending order.</li><li id="en-us_topic_0056765936__li695065410812">If <strong id="en-us_topic_0056765936__b118265127514518">order_field</strong> is set to <strong id="en-us_topic_0056765936__b8457024314518">key</strong>, <strong id="en-us_topic_0056765936__b842352706145220">update_time</strong> is sorted in the descending order, and <strong id="en-us_topic_0056765936__b842352706145227">value</strong> is sorted in the ascending order.</li><li id="en-us_topic_0056765936__li5849709310812">If <strong id="en-us_topic_0056765936__b1860012469">order_field</strong> is set to <strong id="en-us_topic_0056765936__b2020459462">value</strong>, <strong id="en-us_topic_0056765936__b84235270614533">update_time</strong> is sorted in the descending order, and <strong id="en-us_topic_0056765936__b84235270614537">key</strong> is sorted in the ascending order.</li><li id="en-us_topic_0056765936__li3455001510812">If <strong id="en-us_topic_0056765936__b988046015922">order_field</strong> is not specified, its default value <strong id="en-us_topic_0056765936__b66377750151114">update_time</strong> is taken. In this case, <strong id="en-us_topic_0056765936__b6211983515922">key</strong> and <strong id="en-us_topic_0056765936__b2220761115922">value</strong> are sorted in the ascending order.</li></ul>
<ul id="en-us_topic_0056765936__ul4769660110812"><li id="en-us_topic_0056765936__li5287192010812">If <strong id="en-us_topic_0056765936__b842352706145014">order_field</strong> is set to <strong id="en-us_topic_0056765936__b842352706145022">update_time</strong>, both <strong id="en-us_topic_0056765936__b842352706145046">key</strong> and <strong id="en-us_topic_0056765936__b842352706145049">value</strong> are sorted in the ascending order.</li><li id="en-us_topic_0056765936__li695065410812">If <strong id="en-us_topic_0056765936__b118265127514518">order_field</strong> is set to <strong id="en-us_topic_0056765936__b8457024314518">key</strong>, <strong id="en-us_topic_0056765936__b842352706145220">update_time</strong> is sorted in the descending order, and <strong id="en-us_topic_0056765936__b842352706145227">value</strong> is sorted in the ascending order.</li><li id="en-us_topic_0056765936__li5849709310812">If <strong id="en-us_topic_0056765936__b258418516">order_field</strong> is set to <strong id="en-us_topic_0056765936__b1357332325">value</strong>, <strong id="en-us_topic_0056765936__b84235270614533">update_time</strong> is sorted in the descending order, and <strong id="en-us_topic_0056765936__b84235270614537">key</strong> is sorted in the ascending order.</li><li id="en-us_topic_0056765936__li3455001510812">If <strong id="en-us_topic_0056765936__b988046015922">order_field</strong> is not specified, its default value <strong id="en-us_topic_0056765936__b66377750151114">update_time</strong> is taken. In this case, <strong id="en-us_topic_0056765936__b6211983515922">key</strong> and <strong id="en-us_topic_0056765936__b2220761115922">value</strong> are sorted in the ascending order.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0056765936__row2229804318465"><td class="cellrowborder" valign="top" width="15.89%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0056765936__p31639816184658">order_method</p>
@ -153,9 +153,9 @@
</li><li id="en-us_topic_0056765936__en-us_topic_0056765543_li48826322"><strong id="en-us_topic_0056765936__b842352706143643">tags</strong> field description
<div class="tablenoborder"><a name="en-us_topic_0056765936__en-us_topic_0056765543_table36783718"></a><a name="en-us_topic_0056765543_table36783718"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056765936__en-us_topic_0056765543_table36783718" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Fields</caption><thead align="left"><tr id="en-us_topic_0056765936__en-us_topic_0056765543_row33607346"><th align="left" class="cellrowborder" valign="top" width="23.799999999999997%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="en-us_topic_0056765936__en-us_topic_0056765543_p37840511"><strong id="en-us_topic_0056765936__b15845101465213">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.09%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="en-us_topic_0056765936__en-us_topic_0056765543_p45182569"><strong id="en-us_topic_0056765936__b710181544">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="28.09%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="en-us_topic_0056765936__en-us_topic_0056765543_p45182569"><strong id="en-us_topic_0056765936__b2138880190">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.11%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="en-us_topic_0056765936__en-us_topic_0056765543_p35909463"><strong id="en-us_topic_0056765936__b1487471004">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="48.11%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="en-us_topic_0056765936__en-us_topic_0056765543_p35909463"><strong id="en-us_topic_0056765936__b1205716697">Description</strong></p>
</th>
</tr>
</thead>

10
docs/tms/api-ref/en-us_topic_0057939858.html
View File

@ -8,7 +8,13 @@
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057939858__row20481281597"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p15487284911">2023-11-17</p>
<tbody><tr id="en-us_topic_0057939858__row584210173519"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p4508161615215">2024-08-01</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p115080161320">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p19771731069">Updated the service name, GaussDB NoSQL, to GeminiDB in <a href="ListProviders.html">Querying Services Supported by TMS</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row20481281597"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p15487284911">2023-11-17</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p1438916364915">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p614111741012">Modified the example request for the API <a href="ListTagValues.html">Query Tag Values</a>.</p>
@ -71,7 +77,7 @@
<tr id="en-us_topic_0057939858__row26765346153715"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p2115412153739">2018-03-30</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p1681331785118">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p1533211317522">Modified the requirements for <strong id="en-us_topic_0057939858__b1256226343">Key</strong> and <strong id="en-us_topic_0057939858__b2098123721">Value</strong>.</p>
<p id="en-us_topic_0057939858__p1533211317522">Modified the requirements for <strong id="en-us_topic_0057939858__b1752978154">Key</strong> and <strong id="en-us_topic_0057939858__b525599087">Value</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row176894911336"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p906717511336">2018-03-16</p>

6
docs/tms/api-ref/en-us_topic_0126416752.html
View File

@ -2,10 +2,10 @@
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body1558334636207"><div class="section" id="en-us_topic_0126416752__en-us_topic_0121673684_section1876711368114"><h4 class="sectiontitle">Scenarios</h4><p id="en-us_topic_0126416752__en-us_topic_0121673684_p177063681115">A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:</p>
<ul id="en-us_topic_0126416752__en-us_topic_0121673684_ul2770123611111"><li id="en-us_topic_0126416752__en-us_topic_0121673684_li157701436141116"><a href="#en-us_topic_0126416752__en-us_topic_0121673684_section86806471133">Obtain the Project ID by Calling an API</a></li><li id="en-us_topic_0126416752__en-us_topic_0121673684_li07701836121118"><a href="#en-us_topic_0126416752__en-us_topic_0121673684_section32975495318">Obtain the Project ID from the Console</a></li></ul>
<ul id="en-us_topic_0126416752__en-us_topic_0121673684_ul2770123611111"><li id="en-us_topic_0126416752__en-us_topic_0121673684_li157701436141116"><a href="#en-us_topic_0126416752__en-us_topic_0121673684_section86806471133">Obtain the Project ID by Calling an API</a>.</li><li id="en-us_topic_0126416752__en-us_topic_0121673684_li07701836121118"><a href="#en-us_topic_0126416752__en-us_topic_0121673684_section32975495318">Obtain a Project ID from the Console</a>.</li></ul>
</div>
<div class="section" id="en-us_topic_0126416752__en-us_topic_0121673684_section86806471133"><a name="en-us_topic_0126416752__en-us_topic_0121673684_section86806471133"></a><a name="en-us_topic_0121673684_section86806471133"></a><h4 class="sectiontitle">Obtain the Project ID by Calling an API</h4><p id="en-us_topic_0126416752__en-us_topic_0121673684_p31183326524">You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.</p>
<p id="en-us_topic_0126416752__en-us_topic_0121673684_p857314915139">The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/additional/endpoints.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. </p>
<p id="en-us_topic_0126416752__en-us_topic_0121673684_p857314915139">The API for obtaining a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/additional/endpoints.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. </p>
<p id="en-us_topic_0126416752__en-us_topic_0121673684_p3770181514218">The following is an example response. The value of <strong id="en-us_topic_0126416752__en-us_topic_0121673684_b842352706123544">id</strong> is the project ID.</p>
<pre class="screen" id="en-us_topic_0126416752__en-us_topic_0121673684_screen14199113161316">{
"projects": [
@ -32,7 +32,7 @@
}</pre>
</div>
<div class="section" id="en-us_topic_0126416752__en-us_topic_0121673684_section32975495318"><a name="en-us_topic_0126416752__en-us_topic_0121673684_section32975495318"></a><a name="en-us_topic_0121673684_section32975495318"></a><h4 class="sectiontitle">Obtain a Project ID from the Console</h4><div class="p" id="en-us_topic_0126416752__en-us_topic_0121673684_p1356864351018">A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:<ol id="en-us_topic_0126416752__en-us_topic_0121673684_ol7453556171010"><li id="en-us_topic_0126416752__en-us_topic_0121673684_li645315621018">Log in to the management console.</li><li id="en-us_topic_0126416752__en-us_topic_0121673684_li142001547118">Click the username and select <strong id="en-us_topic_0126416752__en-us_topic_0121673684_b10350181718117">My Credentials</strong> from the drop-down list.<p id="en-us_topic_0126416752__en-us_topic_0121673684_p13639183110119">On the <strong id="en-us_topic_0126416752__en-us_topic_0121673684_b19682129101113">My Credentials</strong> page, view project IDs in the project list.</p>
<div class="fignone" id="en-us_topic_0126416752__en-us_topic_0121673684_fig12841949131317"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="en-us_topic_0126416752__en-us_topic_0121673684_image1184449141315" src="en-us_image_0000001508295281.png"></span></div>
<div class="fignone" id="en-us_topic_0126416752__en-us_topic_0121673684_fig12841949131317"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="en-us_topic_0126416752__en-us_topic_0121673684_image1184449141315" src="en-us_image_0000001884958205.png"></span></div>
<p id="en-us_topic_0126416752__en-us_topic_0121673684_p55531521415">In multi-project scenarios, expand the region, and obtain your sub-project ID from the <strong id="en-us_topic_0126416752__en-us_topic_0121673684_b314916613146">Project ID</strong> column.</p>
</li></ol>
</div>

5
docs/tms/api-ref/en-us_topic_0133313256.html
View File

@ -8,7 +8,8 @@
<div class="section" id="en-us_topic_0133313256__section147311515172315"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0133313256__p917934022818">Example request</p>
<pre class="codeblock" id="en-us_topic_0133313256__codeblock19975123462912"><strong id="en-us_topic_0133313256__b370414152417">GET https://{</strong><em id="en-us_topic_0133313256__i15531261245">TMS endpoint</em><strong id="en-us_topic_0133313256__b083313104242">}/</strong></pre>
</div>
<div class="note" id="en-us_topic_0133313256__note616233420511"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"></div></div>
<div class="note" id="en-us_topic_0133313256__note616233420511"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0133313256__p168511643245">You can obtain the TMS endpoints from <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div></div>
<div class="section" id="en-us_topic_0133313256__section11732141562320"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0133313256__ul9810161236"><li id="en-us_topic_0133313256__li9851617238">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313256__table17740171518233" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the response</caption><thead align="left"><tr id="en-us_topic_0133313256__row8871619238"><th align="left" class="cellrowborder" valign="top" width="19.848015198480155%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="en-us_topic_0133313256__p28141692310">Name</p>
</th>
@ -86,7 +87,7 @@
</tbody>
</table>
</div>
</li><li id="en-us_topic_0133313256__li20961615235"><strong id="en-us_topic_0133313256__b49834808">Links</strong> field description
</li><li id="en-us_topic_0133313256__li20961615235"><strong id="en-us_topic_0133313256__b1295779883">Links</strong> field description
<div class="tablenoborder"><a name="en-us_topic_0133313256__table87796151239"></a><a name="table87796151239"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0133313256__table87796151239" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0133313256__row10941619231"><th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.5.2.3.2.2.4.1.1"><p id="en-us_topic_0133313256__p591816112316">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.87%" id="mcps1.3.5.2.3.2.2.4.1.2"><p id="en-us_topic_0133313256__p7915161233">Type</p>