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

TMS API 0406 version

Browse Source 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@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 2023-06-01 13:39:55 +00:00 committed by zuul
parent 4e8841817b
commit 0513d28744
22 changed files with 538 additions and 306 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/tms/api-ref/.placeholder
View File

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

2
docs/tms/api-ref/en-us_topic_0056283725.html
View File

@ -1,6 +1,6 @@
<a name="en-us_topic_0056283725"></a><a name="en-us_topic_0056283725"></a>
<h1 class="topictitle1">Calling APIs</h1>
<h1 class="topictitle1"> APIs</h1>
<div id="body1558321797625"><p id="en-us_topic_0056283725__en-us_topic_0170091002_p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="en-us_topic_0056283725__en-us_topic_0170091002_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-us_topic_0056283725__en-us_topic_0170091002_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_0056283725__en-us_topic_0170091002_p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="en-us_topic_0056283725__en-us_topic_0170091002_b3082532510259">Application/json</strong>.</p>
<p id="en-us_topic_0056283725__en-us_topic_0170091002_p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>

36
docs/tms/api-ref/en-us_topic_0056765935.html
View File

@ -33,7 +33,7 @@
</td>
<td class="cellrowborder" valign="top" width="16.689999999999998%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0056765935__p65607343193712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.85%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056765935__p4388405218398"><span id="en-us_topic_0056765935__ph14576697179"> List&lt;predefine_tag_re</span><span id="en-us_topic_0056765935__ph280172421714">quest&gt;</span></p>
<td class="cellrowborder" valign="top" width="30.85%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056765935__p4388405218398">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="35.06%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765935__p13529275193712">Specifies the tag list.</p>
<p id="en-us_topic_0056765935__p6301124715121">For details, see <a href="#en-us_topic_0056765935__en-us_topic_0056765542_table46817064">Table 2</a>.</p>
@ -42,35 +42,35 @@
</tbody>
</table>
</div>
</li><li id="en-us_topic_0056765935__en-us_topic_0056765542_li64854219"><span id="en-us_topic_0056765935__ph13194115415173"><strong id="en-us_topic_0056765935__b1720412579174">predefine_tag_re</strong></span><span id="en-us_topic_0056765935__ph1719410549171"><strong id="en-us_topic_0056765935__b17207457111713">quest</strong></span> field description
<div class="tablenoborder"><a name="en-us_topic_0056765935__en-us_topic_0056765542_table46817064"></a><a name="en-us_topic_0056765542_table46817064"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056765935__en-us_topic_0056765542_table46817064" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056765935__en-us_topic_0056765542_row4410728"><th align="left" class="cellrowborder" valign="top" width="19.01980198019802%" id="mcps1.3.3.2.2.3.2.5.1.1"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p21724664"><strong id="en-us_topic_0056765935__b3685747820628">Name</strong></p>
</li><li id="en-us_topic_0056765935__en-us_topic_0056765542_li64854219"><strong id="en-us_topic_0056765935__b842352706143357">tags</strong> field description
<div class="tablenoborder"><a name="en-us_topic_0056765935__en-us_topic_0056765542_table46817064"></a><a name="en-us_topic_0056765542_table46817064"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056765935__en-us_topic_0056765542_table46817064" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056765935__en-us_topic_0056765542_row4410728"><th align="left" class="cellrowborder" valign="top" width="19.01980198019802%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p21724664"><strong id="en-us_topic_0056765935__b3685747820628">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.752475247524753%" id="mcps1.3.3.2.2.3.2.5.1.2"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p14867369"><strong id="en-us_topic_0056765935__b3266572720628">Mandatory</strong></p>
<th align="left" class="cellrowborder" valign="top" width="18.752475247524753%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p14867369"><strong id="en-us_topic_0056765935__b3266572720628">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.871287128712872%" id="mcps1.3.3.2.2.3.2.5.1.3"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p63406242"><strong id="en-us_topic_0056765935__b2867822920628">Type</strong></p>
<th align="left" class="cellrowborder" valign="top" width="21.871287128712872%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p63406242"><strong id="en-us_topic_0056765935__b2867822920628">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.35643564356436%" id="mcps1.3.3.2.2.3.2.5.1.4"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p35632012"><strong id="en-us_topic_0056765935__b4123518320628">Description</strong></p>
<th align="left" class="cellrowborder" valign="top" width="40.35643564356436%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="en-us_topic_0056765935__en-us_topic_0056765542_p35632012"><strong id="en-us_topic_0056765935__b4123518320628">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0056765935__en-us_topic_0056765542_row511887"><td class="cellrowborder" valign="top" width="19.01980198019802%" headers="mcps1.3.3.2.2.3.2.5.1.1 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p41462866">key</p>
<tbody><tr id="en-us_topic_0056765935__en-us_topic_0056765542_row511887"><td class="cellrowborder" valign="top" width="19.01980198019802%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p41462866">key</p>
</td>
<td class="cellrowborder" valign="top" width="18.752475247524753%" headers="mcps1.3.3.2.2.3.2.5.1.2 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p3048957">Yes</p>
<td class="cellrowborder" valign="top" width="18.752475247524753%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p3048957">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.871287128712872%" headers="mcps1.3.3.2.2.3.2.5.1.3 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p45638969">String</p>
<td class="cellrowborder" valign="top" width="21.871287128712872%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p45638969">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.35643564356436%" headers="mcps1.3.3.2.2.3.2.5.1.4 "><p id="en-us_topic_0056765935__p108587120631">Specifies the key.</p>
<p id="en-us_topic_0056765935__p16424462153146">It cannot be left blank and can contain a maximum of 36 Unicode characters. <span id="en-us_topic_0056765935__ph2041410212019">Can contain only digits, letters, hyphens (-), and underscores (_).</span></p>
<td class="cellrowborder" valign="top" width="40.35643564356436%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0056765935__p108587120631">Specifies the key.</p>
<p id="en-us_topic_0056765935__p16424462153146">It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="en-us_topic_0056765935__en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="19.01980198019802%" headers="mcps1.3.3.2.2.3.2.5.1.1 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p44855704">value</p>
<tr id="en-us_topic_0056765935__en-us_topic_0056765542_row51921052"><td class="cellrowborder" valign="top" width="19.01980198019802%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p44855704">value</p>
</td>
<td class="cellrowborder" valign="top" width="18.752475247524753%" headers="mcps1.3.3.2.2.3.2.5.1.2 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p9433441">Yes</p>
<td class="cellrowborder" valign="top" width="18.752475247524753%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p9433441">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.871287128712872%" headers="mcps1.3.3.2.2.3.2.5.1.3 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p25911262">String</p>
<td class="cellrowborder" valign="top" width="21.871287128712872%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="en-us_topic_0056765935__en-us_topic_0056765542_p25911262">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.35643564356436%" headers="mcps1.3.3.2.2.3.2.5.1.4 "><p id="en-us_topic_0056765935__p2486891184110">Specifies the value.</p>
<p id="en-us_topic_0056765935__p10159585153243">Each value contains a maximum of 43 Unicode characters and can be an empty string. <span id="en-us_topic_0056765935__ph114121859915"> Can contain only digits, letters, hyphens (-), and underscores (_).</span></p>
<td class="cellrowborder" valign="top" width="40.35643564356436%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="en-us_topic_0056765935__p2486891184110">Specifies the value.</p>
<p id="en-us_topic_0056765935__p10159585153243">Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
</tbody>
@ -98,9 +98,9 @@
<ul id="en-us_topic_0056765935__en-us_topic_0056765542_ul56608836"><li id="en-us_topic_0056765935__en-us_topic_0056765542_li39717481">Example response<p id="en-us_topic_0056765935__en-us_topic_0056765542_p21913016"><a name="en-us_topic_0056765935__en-us_topic_0056765542_li39717481"></a><a name="en-us_topic_0056765542_li39717481"></a>None</p>
</li></ul>
</div>
<div class="section" id="en-us_topic_0056765935__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0056765935__p145228330242">See <a href="en-us_topic_0130578970.html">Status Code</a>.</p>
<div class="section" id="en-us_topic_0056765935__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0056765935__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
</div>
<div class="section" id="en-us_topic_0056765935__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0056765935__p177044331253">See <a href="en-us_topic_0057939857.html">Error Code Description</a>.</p>
<div class="section" id="en-us_topic_0056765935__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0056765935__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</p>
</div>
</div>
<div>

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

@ -22,7 +22,7 @@
</td>
<td class="cellrowborder" valign="top" width="16.38%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p56516768">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.43%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765936__p4719145472213"><span id="en-us_topic_0056765936__ph1732217418229">Key</span></p>
<td class="cellrowborder" valign="top" width="51.43%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765936__p4719145472213">Specifies the key.</p>
<p id="en-us_topic_0056765936__en-us_topic_0056765543_p14455523">Supports fuzzy search and is case insensitive. If this parameter value contains non-URL-safe characters, it must be URL encoded.</p>
</td>
</tr>
@ -32,7 +32,7 @@
</td>
<td class="cellrowborder" valign="top" width="16.38%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p3095993">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.43%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765936__p5841031235"><span id="en-us_topic_0056765936__ph1844759182217">Value</span></p>
<td class="cellrowborder" valign="top" width="51.43%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765936__p5841031235">Specifies the value.</p>
<p id="en-us_topic_0056765936__en-us_topic_0056765543_p49448848">Supports fuzzy search and is case insensitive. If this parameter value contains non-URL-safe characters, it must be URL encoded.</p>
</td>
</tr>
@ -79,10 +79,10 @@
<td class="cellrowborder" valign="top" width="16.38%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056765936__p40935226184651">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.43%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056765936__p5246838910935">Specifies the sorting method of the <strong id="en-us_topic_0056765936__b479923793315">order_field</strong> field.</p>
<p id="en-us_topic_0056765936__p93153345115">The <span id="en-us_topic_0056765936__ph122614211233">value</span> can be (case sensitive):</p>
<p id="en-us_topic_0056765936__p93153345115">The method can be (case sensitive):</p>
<ul id="en-us_topic_0056765936__ul1952353612116"><li id="en-us_topic_0056765936__li19612638710"><strong id="en-us_topic_0056765936__b5185193514248">asc</strong>: ascending order</li><li id="en-us_topic_0056765936__li1523436715"><strong id="en-us_topic_0056765936__b732944042416">desc</strong>: descending order</li></ul>
<p id="en-us_topic_0056765936__p183581356918">Only one of the preceding <span id="en-us_topic_0056765936__ph196931708245">values</span> can be selected.</p>
<p id="en-us_topic_0056765936__p2169536710933">If this parameter is not <span id="en-us_topic_0056765936__ph1214919244246">transferred</span>, the default value is <strong id="en-us_topic_0056765936__b191910498235">desc</strong>.</p>
<p id="en-us_topic_0056765936__p183581356918">Only one of the preceding sorting methods can be selected.</p>
<p id="en-us_topic_0056765936__p2169536710933">If this parameter is not specified, the default value is <strong id="en-us_topic_0056765936__b191910498235">desc</strong>.</p>
</td>
</tr>
</tbody>
@ -103,7 +103,7 @@
</thead>
<tbody><tr id="en-us_topic_0056765936__en-us_topic_0056765543_row9521066"><td class="cellrowborder" valign="top" width="24.147585241475852%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p33008913">tags</p>
</td>
<td class="cellrowborder" valign="top" width="37.92620737926208%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056765936__p51676625185015"><span id="en-us_topic_0056765936__ph384075502411">List&lt;predefine_tag&gt;</span></p>
<td class="cellrowborder" valign="top" width="37.92620737926208%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0056765936__p51676625185015">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="37.92620737926208%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p11174282">Specifies the tag list.</p>
<p id="en-us_topic_0056765936__p193646415165">For details, see <a href="#en-us_topic_0056765936__en-us_topic_0056765543_table36783718">Table 3</a>.</p>
@ -127,7 +127,7 @@
</tbody>
</table>
</div>
</li><li id="en-us_topic_0056765936__en-us_topic_0056765543_li48826322"><span id="en-us_topic_0056765936__ph13265151810251"><strong id="en-us_topic_0056765936__b64261121132517">predefine_tag</strong></span> field description
</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 3 </b>Parameter description</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__b1279857818">Type</strong></p>
@ -141,7 +141,7 @@
<td class="cellrowborder" valign="top" width="28.09%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p13553869">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.11%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0056765936__p108587120631">Specifies the key.</p>
<p id="en-us_topic_0056765936__p16424462153146">It cannot be left blank and can contain a maximum of 36 Unicode characters. <span id="en-us_topic_0056765936__ph2041410212019">Can contain only digits, letters, hyphens (-), and underscores (_).</span></p>
<p id="en-us_topic_0056765936__p16424462153146">It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="en-us_topic_0056765936__en-us_topic_0056765543_row15767494"><td class="cellrowborder" valign="top" width="23.799999999999997%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p2098632">value</p>
@ -149,7 +149,7 @@
<td class="cellrowborder" valign="top" width="28.09%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="en-us_topic_0056765936__en-us_topic_0056765543_p35771490">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.11%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0056765936__p2486891184110">Specifies the value.</p>
<p id="en-us_topic_0056765936__p10159585153243">Each value contains a maximum of 43 Unicode characters and can be an empty string. <span id="en-us_topic_0056765936__ph114121859915">Can contain only digits, letters, hyphens (-), and underscores (_).</span></p>
<p id="en-us_topic_0056765936__p10159585153243">Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="en-us_topic_0056765936__row13791973185143"><td class="cellrowborder" valign="top" width="23.799999999999997%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0056765936__p20931513185145">update_time</p>
@ -181,9 +181,9 @@
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0056765936__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0056765936__p145228330242">See <a href="en-us_topic_0130578970.html">Status Code</a>.</p>
<div class="section" id="en-us_topic_0056765936__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0056765936__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
</div>
<div class="section" id="en-us_topic_0056765936__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0056765936__p177044331253">See <a href="en-us_topic_0057939857.html">Error Code Description</a>.</p>
<div class="section" id="en-us_topic_0056765936__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0056765936__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</p>
</div>
</div>
<div>

301
docs/tms/api-ref/en-us_topic_0057939857.html
View File

File diff suppressed because it is too large Load Diff

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

@ -8,52 +8,58 @@
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0057939858__row11898015113214"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p12626102143213">2018-11-06</p>
<tbody><tr id="en-us_topic_0057939858__row142551512113117"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p925651273115">2023-04-07</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p1381955703211">This release incorporates the following changes:</p>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p1194172773113">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p1717519485418">Added <a href="en-us_topic_0170638684.html">Permissions Policies and Supported Actions</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row11898015113214"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p12626102143213">2018-11-06</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p1381955703211">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p1668614016334">Accepted in OTC 3.2.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row5863124913479"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p1187515634718">2018-09-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__p183019558247">This release incorporates the following changes:</p>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p183019558247">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p1879356144712">Added APIs for querying version information.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row1320661561216"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p1558382051213">2018-06-15</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p642013116513">This release incorporates the following changes:</p>
<p id="en-us_topic_0057939858__p558652012122">Modified the <span id="en-us_topic_0057939858__ph9178433134211">value</span><span id="en-us_topic_0057939858__ph78736338424"> </span>requirements for <strong id="en-us_topic_0057939858__b808643295185132">Key</strong> and <strong id="en-us_topic_0057939858__b663923714185132">Value</strong>.</p>
<p id="en-us_topic_0057939858__p558652012122">Modified the requirements for <strong id="en-us_topic_0057939858__b808643295185132">Key</strong> and <strong id="en-us_topic_0057939858__b663923714185132">Value</strong>.</p>
</td>
</tr>
<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 changes:</p>
<p id="en-us_topic_0057939858__p1533211317522">Modified the <span id="en-us_topic_0057939858__ph18565235184216">value</span><span id="en-us_topic_0057939858__ph9974153515429"> </span>requirements for <strong id="en-us_topic_0057939858__b1339834477">Key</strong> and <strong id="en-us_topic_0057939858__b1476507467">Value</strong>.</p>
<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__b1558499247">Key</strong> and <strong id="en-us_topic_0057939858__b858363292">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>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p13799142095111">This release incorporates the following changes:</p>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p13799142095111">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p65872269113541">Optimized the descriptions of error codes.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row51831896113235"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p63833887113235">2017-08-29</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p7680192313517">This release incorporates the following changes:</p>
<p id="en-us_topic_0057939858__p573478281217">Optimized the URI parameter description in <span id="en-us_topic_0057939858__ph9322425194317">section</span><span id="en-us_topic_0057939858__ph27432664318"> </span><a href="en-us_topic_0056765935.html">Creating or Deleting Predefined Tags</a>.</p>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p7680192313517">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p573478281217">Optimized the URI parameter description in <a href="en-us_topic_0056765935.html">Creating or Deleting Predefined Tags</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row648633417957"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p5837700817957">2017-07-28</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p65801727105117">This release incorporates the following changes:</p>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p65801727105117">This release incorporates the following change:</p>
<p id="en-us_topic_0057939858__p3091724617957">Modified the sample code.</p>
</td>
</tr>
<tr id="en-us_topic_0057939858__row7106810233912"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p38780724233912">2017-05-26</p>
</td>
<td class="cellrowborder" valign="top" width="77.25999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0057939858__p89561430185118">This release incorporates the following changes:</p>
<ul id="en-us_topic_0057939858__ul1087518350514"><li id="en-us_topic_0057939858__li787511353515">Added <span id="en-us_topic_0057939858__ph18340114110439">section</span><span id="en-us_topic_0057939858__ph1960154164320"> </span><a href="en-us_topic_0060929630.html">Modifying Predefined Tags</a>.</li><li id="en-us_topic_0057939858__li11257738105113">Optimized the descriptions of error codes.</li></ul>
<ul id="en-us_topic_0057939858__ul1087518350514"><li id="en-us_topic_0057939858__li787511353515">Added <a href="en-us_topic_0060929630.html">Modifying Predefined Tags</a>.</li><li id="en-us_topic_0057939858__li11257738105113">Optimized the descriptions of error codes.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0057939858__row930767017154"><td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0057939858__p5153061017154">2017-05-05</p>

74
docs/tms/api-ref/en-us_topic_0060929630.html
View File

File diff suppressed because it is too large Load Diff

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

@ -1,12 +1,43 @@
<a name="en-us_topic_0126416752"></a><a name="en-us_topic_0126416752"></a>
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body1558334636207"><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 Credential</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 Credential</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_0000001369705766.png"></span></div>
<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>
</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_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": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "project_name",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</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>
<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>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0126416865.html">Appendix</a></div>

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

@ -4,14 +4,12 @@
<div id="body1534407627272"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0130578970.html">Status Code</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0130578970.html">Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0057939857.html">Error Code Description</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0057939857.html">Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0126416752.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0186103096.html">Obtaining the Domain-Level Token</a></strong><br>
</li>
</ul>
</div>

4
docs/tms/api-ref/en-us_topic_0130578970.html
View File

@ -1,6 +1,6 @@
<a name="en-us_topic_0130578970"></a><a name="en-us_topic_0130578970"></a>
<h1 class="topictitle1">Status Code</h1>
<h1 class="topictitle1">Status Codes</h1>
<div id="body1536632851147"><ul id="en-us_topic_0130578970__en-us_topic_0121643825_ul153019611201"><li id="en-us_topic_0130578970__en-us_topic_0121643825_li1377176511201">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0130578970__en-us_topic_0121643825_table5683702611201" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0130578970__en-us_topic_0121643825_row5526436211201"><th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.1.1.1.1.3.1.1"><p id="en-us_topic_0130578970__en-us_topic_0121643825_p4722834111201">Returned Value</p>
</th>
@ -50,7 +50,7 @@
</tr>
<tr id="en-us_topic_0130578970__en-us_topic_0121643825_row6385964111201"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.1.2.1.1.3.1.1 "><p id="en-us_topic_0130578970__en-us_topic_0121643825_p524841711201">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.1.2.1.1.3.1.2 "><p id="en-us_topic_0130578970__p20875203183310">You are forbidden to access the requested page.</p>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.1.2.1.1.3.1.2 "><p id="en-us_topic_0130578970__en-us_topic_0121643825_p2246860911201">Access to the requested page is denied.</p>
</td>
</tr>
<tr id="en-us_topic_0130578970__en-us_topic_0121643825_row89089411201"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.1.2.1.1.3.1.1 "><p id="en-us_topic_0130578970__en-us_topic_0121643825_p505359011201">404 Not Found</p>

2
docs/tms/api-ref/en-us_topic_0133313255.html
View File

@ -4,7 +4,7 @@
<div id="body1538032956274"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0133313256.html">Querying All API Versions</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0133313256.html">Querying the API Versions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0133313257.html">Querying Details About a Specified TMS API Version</a></strong><br>
</li>

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

@ -1,6 +1,6 @@
<a name="en-us_topic_0133313256"></a><a name="en-us_topic_0133313256"></a>
<h1 class="topictitle1">Querying <span id="ph43932051105917">All</span> API Versions</h1>
<h1 class="topictitle1">Querying the API Versions</h1>
<div id="body1538032956274"><div class="section" id="en-us_topic_0133313256__section18687215132319"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0133313256__p1161816112319">This API is used to query the versions of all TMS APIs.</p>
</div>
<div class="section" id="en-us_topic_0133313256__section6695141502313"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0133313256__p47416112318">GET /</p>
@ -8,8 +8,7 @@
<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"><p id="en-us_topic_0133313256__p711730125113">Domain-level tokens are required for invoking TMS APIs. For details, see <a href="en-us_topic_0186103096.html">Obtaining the Domain-Level Token</a>.</p>
</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"></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>
@ -66,7 +65,7 @@
<td class="cellrowborder" valign="top" width="21.33%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="en-us_topic_0133313256__p1195169236">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.8%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313256__p5352627314210">Specifies the version status.</p>
<p id="en-us_topic_0133313256__p29448333142119">Possible <span id="en-us_topic_0133313256__ph32851451214">values</span> are as follows:</p>
<p id="en-us_topic_0133313256__p29448333142119">Possible statuses are as follows:</p>
<ul id="en-us_topic_0133313256__ul101632012202419"><li id="en-us_topic_0133313256__li1316311128247"><strong id="en-us_topic_0133313256__b842352706192132">CURRENT</strong>: indicates that the version is the primary version.</li><li id="en-us_topic_0133313256__li2308181532419"><strong id="en-us_topic_0133313256__b842352706192150">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="en-us_topic_0133313256__li187211217142418"><strong id="en-us_topic_0133313256__b8542212327">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
</td>
</tr>
@ -87,7 +86,7 @@
</tbody>
</table>
</div>
</li><li id="en-us_topic_0133313256__li20961615235"><strong id="en-us_topic_0133313256__b731592163">Links</strong> field description
</li><li id="en-us_topic_0133313256__li20961615235"><strong id="en-us_topic_0133313256__b2090353014">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>
@ -133,9 +132,9 @@
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0133313256__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313256__p145228330242">See <a href="en-us_topic_0130578970.html">Status Code</a>.</p>
<div class="section" id="en-us_topic_0133313256__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313256__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
</div>
<div class="section" id="en-us_topic_0133313256__section9414853182510"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313256__p177044331253">See <a href="en-us_topic_0057939857.html">Error Code Description</a>.</p>
<div class="section" id="en-us_topic_0133313256__section9414853182510"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313256__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</p>
<p id="en-us_topic_0133313256__p164816210253"></p>
</div>
</div>

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

@ -88,7 +88,7 @@
</td>
<td class="cellrowborder" valign="top" width="59.23407659234077%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="en-us_topic_0133313257__p41220831142214">Specifies the version status.</p>
<p id="en-us_topic_0133313257__p43374538142233">Possible values are as follows:</p>
<ul id="en-us_topic_0133313257__ul012713412324"><li id="en-us_topic_0133313257__li512714117322"><strong id="en-us_topic_0133313257__b842352706192132">CURRENT</strong>: indicates that the version is the primary version.</li><li id="en-us_topic_0133313257__li4162174311323"><strong id="en-us_topic_0133313257__b842352706192150">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="en-us_topic_0133313257__li1744304515328"><strong id="en-us_topic_0133313257__b10352832594">DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
<ul id="en-us_topic_0133313257__ul012713412324"><li id="en-us_topic_0133313257__li512714117322"><strong id="en-us_topic_0133313257__b842352706192132">CURRENT</strong>: indicates that the version is the primary version.</li><li id="en-us_topic_0133313257__li4162174311323"><strong id="en-us_topic_0133313257__b842352706192150">SUPPORTED</strong>: indicates that the version is an old version, but it is still supported.</li><li id="en-us_topic_0133313257__li1744304515328"><strong>DEPRECATED</strong>: indicates a deprecated version which may be deleted later.</li></ul>
</td>
</tr>
<tr id="en-us_topic_0133313257__row038814361309"><td class="cellrowborder" valign="top" width="18.688131186881314%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="en-us_topic_0133313257__p8388133673018">updated</p>
@ -151,9 +151,9 @@
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0133313257__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313257__p145228330242"><span id="en-us_topic_0133313257__ph1972854718910">For details,</span><span id="en-us_topic_0133313257__ph19923154812912"> </span><span id="en-us_topic_0133313257__ph1381192131019">s</span>ee <a href="en-us_topic_0130578970.html">Status Code</a>.</p>
<div class="section" id="en-us_topic_0133313257__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0133313257__p145228330242">See <a href="en-us_topic_0130578970.html">Status Codes</a>.</p>
</div>
<div class="section" id="en-us_topic_0133313257__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313257__p177044331253"><span id="en-us_topic_0133313257__ph19541115161013">For details,</span><span id="en-us_topic_0133313257__ph1569016610102"> </span><span id="en-us_topic_0133313257__ph1784961914108">s</span>ee <a href="en-us_topic_0057939857.html">Error Code Description</a>.</p>
<div class="section" id="en-us_topic_0133313257__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0133313257__p177044331253">See <a href="en-us_topic_0057939857.html">Error Codes</a>.</p>
</div>
</div>
<div>

13
docs/tms/api-ref/en-us_topic_0170638684.html Normal file
View File

@ -0,0 +1,13 @@
<a name="en-us_topic_0170638684"></a><a name="en-us_topic_0170638684"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<div id="body1558337491937"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0180205868.html">Permissions Policies and Supported Actions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0180205869.html">TMS API Actions</a></strong><br>
</li>
</ul>
</div>

19
docs/tms/api-ref/en-us_topic_0180205868.html Normal file
View File

@ -0,0 +1,19 @@
<a name="en-us_topic_0180205868"></a><a name="en-us_topic_0180205868"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<div id="body1563434985946"><p id="en-us_topic_0180205868__p66891115115">This section describes fine-grained permissions management for your TMS. If your account does not need individual IAM users, then you may skip over this section.</p>
<p id="en-us_topic_0180205868__p66902151110">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions. </p>
<p id="en-us_topic_0180205868__p17469486518">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="en-us_topic_0180205868__note5599912112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0180205868__p3537151010495">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="en-us_topic_0180205868__p96916131117">An account has all of the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query predefined tags using an API, the user must have been granted permissions that allow the <strong id="en-us_topic_0180205868__b02844143419">tms:predefineTags:list</strong> action.</p>
<div class="section" id="en-us_topic_0180205868__section35846112118"><h4 class="sectiontitle">Supported Actions</h4><p id="en-us_topic_0180205868__p1969161141114">Operations supported by a fine-grained policy are specific to APIs. The following are common concepts related to policies:</p>
<ul id="en-us_topic_0180205868__ul16917151113"><li id="en-us_topic_0180205868__li1569141201120">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="en-us_topic_0180205868__li5976133918365">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="en-us_topic_0180205868__li156916118113">Actions: Specific operations that are allowed or denied.</li><li id="en-us_topic_0180205868__li15241911792">Related actions: Actions on which a specific action depends to take effect. When assigning permissions for the action to a user, you also need to assign permissions for the related actions.</li><li id="en-us_topic_0180205868__li126916113113">IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be used and take effect in both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. Administrators can check whether an action supports IAM projects or enterprise projects in the action list. "√" indicates that the action supports the project and "×" indicates that the action does not support the project. </li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0170638684.html">Permissions Policies and Supported Actions</a></div>
</div>
</div>

103
docs/tms/api-ref/en-us_topic_0180205869.html Normal file
View File

File diff suppressed because it is too large Load Diff

36
docs/tms/api-ref/en-us_topic_0186103096.html
View File

@ -1,36 +0,0 @@
<a name="en-us_topic_0186103096"></a><a name="en-us_topic_0186103096"></a>
<h1 class="topictitle1">Obtaining the Domain-Level Token</h1>
<div id="body1565832775460"><pre class="screen" id="en-us_topic_0186103096__screen6140617194816">
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<em id="en-us_topic_0186103096__en-us_topic_0121682347_i315217719194"><strong id="en-us_topic_0186103096__en-us_topic_0121682347_b14500116161919">username</strong></em>",
"password": "<strong id="en-us_topic_0186103096__en-us_topic_0121682347_b2559181251918"><em id="en-us_topic_0186103096__en-us_topic_0121682347_i12803128192">********</em></strong>",
"domain": {
"name": "<em id="en-us_topic_0186103096__en-us_topic_0121682347_i1560271681911"><strong id="en-us_topic_0186103096__en-us_topic_0121682347_b17173191614194">domainname</strong></em>"
}
}
}
},
"scope": {
"domain": {
"id": "<strong id="en-us_topic_0186103096__en-us_topic_0121682347_b1261200101711"><em id="en-us_topic_0186103096__en-us_topic_0121682347_i186128061711">xxxxxxxxxxxxxxxxxx</em></strong>"
}
}
}
}</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0126416865.html">Appendix</a></div>
</div>
</div>

BIN
docs/tms/api-ref/public_sys-resources/icon-arrowdn.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 68 B

After

Width:  |  Height:  |  Size: 1.8 KiB

BIN
docs/tms/api-ref/public_sys-resources/icon-arrowrt.gif
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 70 B

After

Width:  |  Height:  |  Size: 1.8 KiB