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

Add css docs

Browse Source 
Reviewed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
This commit is contained in:
gtema 2022-10-19 13:04:46 +00:00 committed by zuul
parent 7821fdbd24
commit 72909318a9
240 changed files with 13056 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

422
docs/css/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

380
docs/css/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/css/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

15
docs/css/api-ref/css_03_0001.html Normal file
View File

@ -0,0 +1,15 @@
<a name="css_03_0001"></a><a name="css_03_0001"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="css_03_0051.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0053.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0056.html">Supported Cluster Versions</a></strong><br>
</li>
</ul>
</div>

29
docs/css/api-ref/css_03_0008.html Normal file
View File

@ -0,0 +1,29 @@
<a name="css_03_0008"></a><a name="css_03_0008"></a>
<h1 class="topictitle1">Cluster Management APIs</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="css_03_0019.html">Creating a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0018.html">Querying the List of Clusters</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0026.html">Querying Cluster Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0020.html">Deleting a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0021.html">Restarting a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0025.html">Scaling Out a Cluster with only Common Nodes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0038.html">Scaling Out a Cluster with Special Nodes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0023.html">Obtaining the List of Instance Flavors</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0050.html">Downloading a Certificate File</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0077.html">Tag Management APIs</a></strong><br>
</li>
</ul>
</div>

27
docs/css/api-ref/css_03_0010.html Normal file
View File

@ -0,0 +1,27 @@
<a name="css_03_0010"></a><a name="css_03_0010"></a>
<h1 class="topictitle1">Snapshot Management APIs</h1>
<div id="body1532159474777"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="css_03_0037.html">(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0030.html">Modifying Basic Configurations of a Cluster Snapshot</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0031.html">Setting the Automatic Snapshot Creation Policy</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0032.html">Querying the Automatic Snapshot Creation Policy for a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0033.html">Manually Creating a Snapshot</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0034.html">Querying the List of Snapshots</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0035.html">Restoring a Snapshot</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0036.html">Deleting a Snapshot</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0039.html">Disabling the Snapshot Function</a></strong><br>
</li>
</ul>
</div>

527
docs/css/api-ref/css_03_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

588
docs/css/api-ref/css_03_0019.html Normal file
View File

File diff suppressed because it is too large Load Diff

93
docs/css/api-ref/css_03_0020.html Normal file
View File

@ -0,0 +1,93 @@
<a name="css_03_0020"></a><a name="css_03_0020"></a>
<h1 class="topictitle1">Deleting a Cluster</h1>
<div id="body1502957786212"><div class="section" id="css_03_0020__section13509138115714"><h4 class="sectiontitle">Function</h4><p id="css_03_0020__p21141114175617">This API is used to delete a cluster. All resources, including customer data, of the deleted cluster will be released. For data security reasons, create a snapshot for the cluster that you want to delete.</p>
</div>
<div class="section" id="css_03_0020__section156291613195618"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0020__screen1695846201113">DELETE /v1.0/{project_id}/clusters/{cluster_id}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0020__table26299133563" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0020__row1511414148567"><th align="left" class="cellrowborder" valign="top" width="20.419999999999998%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0020__p201141114115617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.1%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0020__p611491415563">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0020__p13114714165613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.809999999999995%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0020__p81148146567">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0020__row7114141416564"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0020__p6114111455616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.1%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0020__p91143149562">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0020__p111451435614">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0020__p16114201416568">Project ID. </p>
</td>
</tr>
<tr id="css_03_0020__row1911421445610"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0020__p12114214115615">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.1%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0020__p31141614165612">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0020__p111142014165613">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0020__p7114191425620">ID of the cluster to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0020__section264581355617"><h4 class="sectiontitle">Request</h4><p id="css_03_0020__p7448195711281">None</p>
</div>
<div class="section" id="css_03_0020__section5645161395611"><h4 class="sectiontitle">Response</h4><p id="css_03_0020__p148122311115">None</p>
</div>
<div class="section" id="css_03_0020__section11872121315298"><h4 class="sectiontitle">Examples</h4><p id="css_03_0020__p1395111417297">Delete the cluster whose ID is <strong id="css_03_0020__b181671652143112">2a197c4d-5467-4003-931d-83ec49939cf</strong>.</p>
<p id="css_03_0020__p11141714195619">Example request</p>
<pre class="screen" id="css_03_0020__screen1114161418566">DELETE /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/2a197c4d-5467-4003-931d-83ec49939cf</pre>
<p id="css_03_0020__p155352197123">Example response</p>
<p id="css_03_0020__p1636011131682">The return value is empty.</p>
</div>
<div class="section" id="css_03_0020__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0020__p46921709171"><a href="#css_03_0020__table12321369178">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0020__table12321369178"></a><a name="table12321369178"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0020__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0020__css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0020__css_03_0018_p14560134151414">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.04%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0020__css_03_0018_p5563194141411">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0020__css_03_0018_p256616411143">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0020__css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__css_03_0018_p1957004131410">400</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__css_03_0018_p165731141171419">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__css_03_0018_p65778413148">Invalid request.</p>
<p id="css_03_0020__css_03_0018_p1557974171415">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0020__css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__css_03_0018_p75841441191410">404</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__css_03_0018_p258716416142">NotFound</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
<p id="css_03_0020__css_03_0018_p14590164151410">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0020__css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0020__css_03_0018_p13595164131416">200</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0020__css_03_0018_p9598741131416">OK</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0020__css_03_0018_p659994115146">The request is processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>

114
docs/css/api-ref/css_03_0021.html Normal file
View File

File diff suppressed because it is too large Load Diff

241
docs/css/api-ref/css_03_0023.html Normal file
View File

File diff suppressed because it is too large Load Diff

164
docs/css/api-ref/css_03_0024.html Normal file
View File

File diff suppressed because it is too large Load Diff

146
docs/css/api-ref/css_03_0025.html Normal file
View File

File diff suppressed because it is too large Load Diff

414
docs/css/api-ref/css_03_0026.html Normal file
View File

File diff suppressed because it is too large Load Diff

144
docs/css/api-ref/css_03_0030.html Normal file
View File

File diff suppressed because it is too large Load Diff

146
docs/css/api-ref/css_03_0031.html Normal file
View File

File diff suppressed because it is too large Load Diff

162
docs/css/api-ref/css_03_0032.html Normal file
View File

File diff suppressed because it is too large Load Diff

210
docs/css/api-ref/css_03_0033.html Normal file
View File

File diff suppressed because it is too large Load Diff

350
docs/css/api-ref/css_03_0034.html Normal file
View File

File diff suppressed because it is too large Load Diff

158
docs/css/api-ref/css_03_0035.html Normal file
View File

File diff suppressed because it is too large Load Diff

99
docs/css/api-ref/css_03_0036.html Normal file
View File

@ -0,0 +1,99 @@
<a name="css_03_0036"></a><a name="css_03_0036"></a>
<h1 class="topictitle1">Deleting a Snapshot</h1>
<div id="body1522117927446"><div class="section" id="css_03_0036__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0036__p544153317914">This API is used to delete a snapshot.</p>
</div>
<div class="section" id="css_03_0036__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0036__screen1695846201113">DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0036__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0036__row4445336913"><th align="left" class="cellrowborder" valign="top" width="16.31313131313131%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0036__p54417338910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.98989898989899%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0036__p1644733693">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.88888888888889%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0036__p11441233696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.80808080808081%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0036__p124403319916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0036__row94414331098"><td class="cellrowborder" valign="top" width="16.31313131313131%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0036__p0441331398">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.98989898989899%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0036__p9444331997">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.88888888888889%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0036__p144412334919">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.80808080808081%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0036__p18449331896">Project ID. </p>
</td>
</tr>
<tr id="css_03_0036__row14453320917"><td class="cellrowborder" valign="top" width="16.31313131313131%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0036__p2044193314920">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.98989898989899%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0036__p24410331398">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.88888888888889%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0036__p844133316918">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.80808080808081%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0036__p13441833493">ID of the cluster to which the snapshot belongs.</p>
</td>
</tr>
<tr id="css_03_0036__row47771537173715"><td class="cellrowborder" valign="top" width="16.31313131313131%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0036__p27779371378">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.98989898989899%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0036__p5777203719370">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.88888888888889%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0036__p177771737153713">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.80808080808081%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0036__p77771237103718">ID of the snapshot to be deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0036__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0036__p330115212466">None</p>
</div>
<div class="section" id="css_03_0036__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0036__p421062843210">None</p>
</div>
<div class="section" id="css_03_0036__section271817020477"><h4 class="sectiontitle">Examples</h4><p id="css_03_0036__p64419337911">Example request</p>
<pre class="screen" id="css_03_0036__screen7841540829">DELETE /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/29a2254e-947f-4463-b65a-5f0b17515fae</pre>
</div>
<div class="section" id="css_03_0036__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0036__p184016093313"><a href="#css_03_0036__table1130545163319">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0036__table1130545163319"></a><a name="table1130545163319"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0036__table1130545163319" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0036__row43061959330"><th align="left" class="cellrowborder" valign="top" width="19.44194419441944%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0036__en-us_topic_0122640420_p51562446">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.502550255025504%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0036__en-us_topic_0122640420_p15808580">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.055505550555054%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0036__en-us_topic_0122640420_p5426640">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0036__row10306135113317"><td class="cellrowborder" valign="top" width="19.44194419441944%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0036__p430655133316">200</p>
</td>
<td class="cellrowborder" valign="top" width="25.502550255025504%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0036__p134136431055">OK</p>
</td>
<td class="cellrowborder" valign="top" width="55.055505550555054%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0036__p134136431458">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0036__row1830612503310"><td class="cellrowborder" valign="top" width="19.44194419441944%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0036__p1030616563318">400</p>
</td>
<td class="cellrowborder" valign="top" width="25.502550255025504%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0036__en-us_topic_0122640420_p11193990">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="55.055505550555054%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0036__en-us_topic_0122640420_p34297999">Invalid request.</p>
<p id="css_03_0036__en-us_topic_0122640420_p40246543">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0036__row1261264514331"><td class="cellrowborder" valign="top" width="19.44194419441944%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0036__p17612174563314">403</p>
</td>
<td class="cellrowborder" valign="top" width="25.502550255025504%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0036__en-us_topic_0122640420_p50789473">Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="55.055505550555054%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0036__en-us_topic_0122640420_p20306648">The server understood the request, but is refusing to fulfill it.</p>
<p id="css_03_0036__en-us_topic_0122640420_p48542107">The client should not repeat the request without modifications.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0010.html">Snapshot Management APIs</a></div>
</div>
</div>

84
docs/css/api-ref/css_03_0037.html Normal file
View File

@ -0,0 +1,84 @@
<a name="css_03_0037"></a><a name="css_03_0037"></a>
<h1 class="topictitle1">(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot</h1>
<div id="body1533004597644"><div class="note" id="css_03_0037__note6978201320578"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_03_0037__p11979413195717">The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapthos. If you have multiple clusters, an OBS bucket will be created for each cluster via this API during automatic configuration and consume your OBS quota. Too many OBS buckets will be difficult to manage. You are advised to perform operations in <a href="css_03_0030.html">Modifying Basic Configurations of a Cluster Snapshot</a>.</p>
</div></div>
<div class="section" id="css_03_0037__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0037__p21061341164917">This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.</p>
<ul id="css_03_0037__ul1443815755818"><li id="css_03_0037__li1826981220199"><span class="parmname" id="css_03_0037__parmname162861412121915"><b>OBS Bucket</b></span>: Enter the location of the OBS bucket used for storing snapshots.</li><li id="css_03_0037__li145919296198"><span class="parmname" id="css_03_0037__parmname1910460484162930"><b>IAM Agency</b></span>: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.</li></ul>
</div>
<div class="section" id="css_03_0037__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0037__screen1695846201113">POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0037__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0037__row4445336913"><th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0037__p54417338910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.740000000000002%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0037__p1644733693">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.56%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0037__p11441233696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0037__p124403319916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0037__row94414331098"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0037__p0441331398">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0037__p9444331997">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0037__p144412334919">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0037__p18449331896">Project ID.</p>
</td>
</tr>
<tr id="css_03_0037__row14453320917"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0037__p2044193314920">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0037__p24410331398">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0037__p844133316918">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0037__p13441833493">ID of the cluster where snapshots are to be backed up.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0037__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0037__p8754481256">None</p>
</div>
<div class="section" id="css_03_0037__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0037__p13371130193116">None</p>
</div>
<div class="section" id="css_03_0037__section1468819386395"><h4 class="sectiontitle">Examples</h4><p id="css_03_0037__p64419337911">Example request</p>
<pre class="screen" id="css_03_0037__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/auto_setting</pre>
</div>
<div class="section" id="css_03_0037__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0037__p1147144641213"><a href="#css_03_0037__table209491933101317">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0037__table209491933101317"></a><a name="table209491933101317"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0037__table209491933101317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0037__row194918333132"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.1"><p id="css_03_0037__p6531343171310">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.2"><p id="css_03_0037__p16534124318132">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.3"><p id="css_03_0037__p1453710437131">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0037__row09491533111315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0037__p1656994351310">200</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0037__p134136431055">OK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0037__p134136431458">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0037__row1184954102013"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0037__p111841154132019">406</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0037__en-us_topic_0122640420_p19980869">Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0037__en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0010.html">Snapshot Management APIs</a></div>
</div>
</div>

198
docs/css/api-ref/css_03_0038.html Normal file
View File

File diff suppressed because it is too large Load Diff

81
docs/css/api-ref/css_03_0039.html Normal file
View File

@ -0,0 +1,81 @@
<a name="css_03_0039"></a><a name="css_03_0039"></a>
<h1 class="topictitle1">Disabling the Snapshot Function</h1>
<div id="body1533004597651"><div class="section" id="css_03_0039__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0039__p544153317914">This API is used to disable the snapshot function.</p>
</div>
<div class="section" id="css_03_0039__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0039__screen1695846201113">DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0039__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0039__row4445336913"><th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0039__p54417338910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.181818181818183%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0039__p1644733693">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0039__p11441233696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.43434343434344%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0039__p124403319916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0039__row94414331098"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0039__p0441331398">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0039__p9444331997">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0039__p144412334919">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0039__p18449331896">Project ID. </p>
</td>
</tr>
<tr id="css_03_0039__row14453320917"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0039__p2044193314920">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.181818181818183%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0039__p24410331398">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0039__p844133316918">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0039__p13441833493">ID of the cluster to which the snapshot belongs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0039__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0039__p330115212466">None</p>
</div>
<div class="section" id="css_03_0039__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0039__p421062843210">None</p>
</div>
<div class="section" id="css_03_0039__section271817020477"><h4 class="sectiontitle">Examples</h4><p id="css_03_0039__p64419337911">Example request</p>
<pre class="screen" id="css_03_0039__screen7841540829">DELETE /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshots</pre>
</div>
<div class="section" id="css_03_0039__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0039__p2303112120362"><a href="#css_03_0039__table15824192510361">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0039__table15824192510361"></a><a name="table15824192510361"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0039__table15824192510361" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0039__css_03_0037_row194918333132"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0039__css_03_0037_p6531343171310">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0039__css_03_0037_p16534124318132">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0039__css_03_0037_p1453710437131">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0039__css_03_0037_row09491533111315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0039__css_03_0037_p1656994351310">200</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0039__css_03_0037_p134136431055">OK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0039__css_03_0037_p134136431458">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0039__css_03_0037_row1184954102013"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0039__css_03_0037_p111841154132019">406</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0039__css_03_0037_en-us_topic_0122640420_p19980869">Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0039__css_03_0037_en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0010.html">Snapshot Management APIs</a></div>
</div>
</div>

23
docs/css/api-ref/css_03_0040.html Normal file
View File

@ -0,0 +1,23 @@
<a name="css_03_0040"></a><a name="css_03_0040"></a>
<h1 class="topictitle1">Common Parameters</h1>
<div id="body1570527081487"><p id="css_03_0040__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="css_03_0071.html">Obtaining a Project ID and Name</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0073.html">Common Request Parameters</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0074.html">Common Response Parameters</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0075.html">Status Code</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0076.html">Error Code</a></strong><br>
</li>
</ul>
</div>

81
docs/css/api-ref/css_03_0050.html Normal file
View File

@ -0,0 +1,81 @@
<a name="css_03_0050"></a><a name="css_03_0050"></a>
<h1 class="topictitle1">Downloading a Certificate File</h1>
<div id="body1551948818417"><div class="section" id="css_03_0050__section162880126447"><h4 class="sectiontitle">Function</h4><p id="css_03_0050__p19460161254418">This API is used to download the HTTPS certificate file of the server.</p>
</div>
<div class="section" id="css_03_0050__section1928871264412"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0050__screen961365211405">GET /v1.0/dev/cluster/sslCert</pre>
</div>
<div class="section" id="css_03_0050__section6319121215446"><h4 class="sectiontitle">Request</h4><p id="css_03_0050__p13221114358">None</p>
</div>
<div class="section" id="css_03_0050__section769920722712"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0050__table372832271213" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0050__row172822201216"><th align="left" class="cellrowborder" valign="top" width="15.414141414141417%" id="mcps1.3.4.2.2.4.1.1"><p id="css_03_0050__p102799549123">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.797979797979798%" id="mcps1.3.4.2.2.4.1.2"><p id="css_03_0050__p1927965418126">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="72.7878787878788%" id="mcps1.3.4.2.2.4.1.3"><p id="css_03_0050__p8279254121216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0050__row1728172231215"><td class="cellrowborder" valign="top" width="15.414141414141417%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_03_0050__p656312616454">certBase64</p>
</td>
<td class="cellrowborder" valign="top" width="11.797979797979798%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_03_0050__p1527915415128">String</p>
</td>
<td class="cellrowborder" valign="top" width="72.7878787878788%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_03_0050__p027905411219">This string is obtained after the certificate file is transcoded using Base64. You need to run the following command to parse the string into a certificate file. The generated certificate file is saved in the folder where the command to be executed is located. In the following command, <strong id="css_03_0050__b14404525113511">"$certBase64"</strong> indicates the string returned in the response message. The name of the generated certificate file is <strong id="css_03_0050__b1488792415380"><span class="filepath" id="css_03_0050__filepath1680665763813"><b>CloudSearchService.cert</b></span></strong>. You can specify another name for the certificate file, but must use <span class="filepath" id="css_03_0050__filepath198061102394"><b>.cert</b></span> as the suffix of the name.</p>
<p id="css_03_0050__p27325578483"><strong id="css_03_0050__b13625121515355">echo -n "$certBase64" | base64 -d &gt;</strong> <strong id="css_03_0050__b174300615312">CloudSearchService.cert</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0050__section2082663016185"><h4 class="sectiontitle">Examples</h4><p id="css_03_0050__p68184389183">Example request</p>
<pre class="screen" id="css_03_0050__screen3795125161817">GET /v1.0/dev/cluster/sslCert</pre>
<p id="css_03_0050__p4731114161811">Example response</p>
<pre class="screen" id="css_03_0050__screen1151417498189">{ "certBase64":"MIIDnTCCAoWgAwIBAgIEXXdMtTANBgkqhkiG9w0BAQsFADB/MRAwDgYDVQQGEwdHZXJtYW55MQ0wCwYDVQQIEwROb25lMQ0wCwYDVQQHEwROb25lMRkwFwYDVQQKExBPcGVuVGVsZWtvbUNsb3VkMRUwEwYDVQQLEwxEYXRhQW5hbHlzaXMxGzAZBgNVBAMTEkNsb3VkU2VhcmNoU2VydmljZTAeFw0xODExMTcxODE4NDJaFw0xOTAyMTUxODE4NDJaMH8xEDAOBgNVBAYTB0dlcm1hbnkxDTALBgNVBAgTBE5vbmUxDTALBgNVBAcTBE5vbmUxGTAXBgNVBAoTEE9wZW5UZWxla29tQ2xvdWQxFTATBgNVBAsTDERhdGFBbmFseXNpczEbMBkGA1UEAxMSQ2xvdWRTZWFyY2hTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApHai9+LMoFSlWqI+YodGiFLw597Vuoo7gG3qTCs+szQTn3PTZtbnzy7TNWjn8K41mkBgUY16wtkhH1nu6AmhRLpZA+2fwAz34v/tDOYahPq045bk9S/znJXQeWWeux93I15z7OP/XC68IF2AKl2NXjmm9bAD/DsqaLuJpoE77d71862sD6uRCBQYyZoQaHw+eKuL8/+5PjWvG9mS+Rxp0DcLd1waFkyK4BjB5Ae3og4bAivKo7vQHH79fgnuK0SQnNpxlU8xLIGaKsQ0/yeJrTrlfy3vBQmj949SbCzFjvmXgkbv4I0jcT5Ax1P68tlasUUnCqFTjGTbzeT82CeE6QIDAQABoyEwHzAdBgNVHQ4EFgQUPPZLu9ElUzQgKURRwn8HpzIliEcwDQYJKoZIhvcNAQELBQADggEBAI/e/sGbZ1jB3ao7Car2p7rm1Pg8ro1kSy9o+Jug6XjJpkwITKGkhPYugtGuKgL6oiYkdJhqmfrm/1R7phf1qzBgRoWtR7eCBg4uorNaYvTelAjbIoYGL03D1c5K6e1XwRsdqNWT3TwiHZ5CuiVOsjAtvt3OrvF2YtPUOJpbbvdXlnLKaLHoaklcyyMJ+KmUbkd2XFhzlhwj4eOaloL8XQcAk/urYFFNTymJPnNiEXjLAgGCfE/j8rX26WKvPUGmcuuqBiK7Ob+VfnfpnssDQoBtQsN9eUNxkYkg6eua8U6zR3nSPxXpdn+TZo3HHnUp3x0f1Xev49MHKe/aPMJOTYE="
}</pre>
<p id="css_03_0050__p15827125510352">After obtaining the preceding character string, run the following command to obtain the <span class="filepath" id="css_03_0050__filepath1343477103813"><b>CloudSearchService.cert</b></span> certificate file:</p>
<pre class="screen" id="css_03_0050__screen394884993618">echo -n "MIIDnTCCAoWgAwIBAgIEXXdMtTANBgkqhkiG9w0BAQsFADB/MRAwDgYDVQQGEwdHZXJtYW55MQ0wCwYDVQQIEwROb25lMQ0wCwYDVQQHEwROb25lMRkwFwYDVQQKExBPcGVuVGVsZWtvbUNsb3VkMRUwEwYDVQQLEwxEYXRhQW5hbHlzaXMxGzAZBgNVBAMTEkNsb3VkU2VhcmNoU2VydmljZTAeFw0xODExMTcxODE4NDJaFw0xOTAyMTUxODE4NDJaMH8xEDAOBgNVBAYTB0dlcm1hbnkxDTALBgNVBAgTBE5vbmUxDTALBgNVBAcTBE5vbmUxGTAXBgNVBAoTEE9wZW5UZWxla29tQ2xvdWQxFTATBgNVBAsTDERhdGFBbmFseXNpczEbMBkGA1UEAxMSQ2xvdWRTZWFyY2hTZXJ2aWNlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApHai9+LMoFSlWqI+YodGiFLw597Vuoo7gG3qTCs+szQTn3PTZtbnzy7TNWjn8K41mkBgUY16wtkhH1nu6AmhRLpZA+2fwAz34v/tDOYahPq045bk9S/znJXQeWWeux93I15z7OP/XC68IF2AKl2NXjmm9bAD/DsqaLuJpoE77d71862sD6uRCBQYyZoQaHw+eKuL8/+5PjWvG9mS+Rxp0DcLd1waFkyK4BjB5Ae3og4bAivKo7vQHH79fgnuK0SQnNpxlU8xLIGaKsQ0/yeJrTrlfy3vBQmj949SbCzFjvmXgkbv4I0jcT5Ax1P68tlasUUnCqFTjGTbzeT82CeE6QIDAQABoyEwHzAdBgNVHQ4EFgQUPPZLu9ElUzQgKURRwn8HpzIliEcwDQYJKoZIhvcNAQELBQADggEBAI/e/sGbZ1jB3ao7Car2p7rm1Pg8ro1kSy9o+Jug6XjJpkwITKGkhPYugtGuKgL6oiYkdJhqmfrm/1R7phf1qzBgRoWtR7eCBg4uorNaYvTelAjbIoYGL03D1c5K6e1XwRsdqNWT3TwiHZ5CuiVOsjAtvt3OrvF2YtPUOJpbbvdXlnLKaLHoaklcyyMJ+KmUbkd2XFhzlhwj4eOaloL8XQcAk/urYFFNTymJPnNiEXjLAgGCfE/j8rX26WKvPUGmcuuqBiK7Ob+VfnfpnssDQoBtQsN9eUNxkYkg6eua8U6zR3nSPxXpdn+TZo3HHnUp3x0f1Xev49MHKe/aPMJOTYE=" | base64 -d &gt; CloudSearchService.cert</pre>
</div>
<div class="section" id="css_03_0050__section15133145417185"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0050__table12321369178" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0050__css_03_0018_row1972183521418"><th align="left" class="cellrowborder" valign="top" width="15.939999999999998%" id="mcps1.3.6.2.2.4.1.1"><p id="css_03_0050__css_03_0018_p14560134151414">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.04%" id="mcps1.3.6.2.2.4.1.2"><p id="css_03_0050__css_03_0018_p5563194141411">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.02%" id="mcps1.3.6.2.2.4.1.3"><p id="css_03_0050__css_03_0018_p256616411143">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0050__css_03_0018_row129720356144"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="css_03_0050__css_03_0018_p1957004131410">400</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.2.2.4.1.2 "><p id="css_03_0050__css_03_0018_p165731141171419">BadRequest</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.2.2.4.1.3 "><p id="css_03_0050__css_03_0018_p65778413148">Invalid request.</p>
<p id="css_03_0050__css_03_0018_p1557974171415">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0050__css_03_0018_row8972103517147"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="css_03_0050__css_03_0018_p75841441191410">404</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.2.2.4.1.2 "><p id="css_03_0050__css_03_0018_p258716416142">NotFound</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.2.2.4.1.3 "><p id="css_03_0050__css_03_0018_p15589154118141">The requested resource cannot be found.</p>
<p id="css_03_0050__css_03_0018_p14590164151410">The client should not repeat the request without modifications.</p>
</td>
</tr>
<tr id="css_03_0050__css_03_0018_row297223511416"><td class="cellrowborder" valign="top" width="15.939999999999998%" headers="mcps1.3.6.2.2.4.1.1 "><p id="css_03_0050__css_03_0018_p13595164131416">200</p>
</td>
<td class="cellrowborder" valign="top" width="31.04%" headers="mcps1.3.6.2.2.4.1.2 "><p id="css_03_0050__css_03_0018_p9598741131416">OK</p>
</td>
<td class="cellrowborder" valign="top" width="53.02%" headers="mcps1.3.6.2.2.4.1.3 "><p id="css_03_0050__css_03_0018_p659994115146">The request is processed successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>

48
docs/css/api-ref/css_03_0051.html Normal file
View File

@ -0,0 +1,48 @@
<a name="css_03_0051"></a><a name="css_03_0051"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body8662426"><p id="css_03_0051__en-us_topic_0171174222_p5834251484">Welcome to <em id="css_03_0051__i11561123318210">Cloud Search Service API Reference</em>. Cloud Search Service (CSS) provides hosted, distributed search engine services. It is fully compatible with open-source Elasticsearch and supports multi-condition retrieval, statistics, and reporting of structured and unstructured texts.</p>
<p id="css_03_0051__en-us_topic_0171174222_p139661137153019">This document provides CSS API description, syntax, parameters, and examples. <span id="css_03_0051__text1241284316315">CSS</span> provides APIs for cluster management and snapshot management. You can call these APIs to easily create, query, delete, restart, and scale clusters.</p>
<div class="p" id="css_03_0051__p74281523195220">You can search for information you need according to <a href="#css_03_0051__table2042812316524">Table 1</a>.
<div class="tablenoborder"><a name="css_03_0051__table2042812316524"></a><a name="table2042812316524"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0051__table2042812316524" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Overview</caption><thead align="left"><tr id="css_03_0051__row8428523175219"><th align="left" class="cellrowborder" valign="top" width="40.949999999999996%" id="mcps1.3.3.2.2.3.1.1"><p id="css_03_0051__p104287234528">Chapter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.050000000000004%" id="mcps1.3.3.2.2.3.1.2"><p id="css_03_0051__p16428923185214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0051__row1542852315525"><td class="cellrowborder" valign="top" width="40.949999999999996%" headers="mcps1.3.3.2.2.3.1.1 "><p id="css_03_0051__p94281023105212">API Overview</p>
</td>
<td class="cellrowborder" valign="top" width="59.050000000000004%" headers="mcps1.3.3.2.2.3.1.2 "><p id="css_03_0051__p12428152325217">API constituents and list</p>
</td>
</tr>
<tr id="css_03_0051__row74281323195211"><td class="cellrowborder" valign="top" width="40.949999999999996%" headers="mcps1.3.3.2.2.3.1.1 "><p id="css_03_0051__p204281423175219">Environment Preparation</p>
</td>
<td class="cellrowborder" valign="top" width="59.050000000000004%" headers="mcps1.3.3.2.2.3.1.2 "><p id="css_03_0051__p15428923155219">Prerequisites for using the APIs.</p>
</td>
</tr>
<tr id="css_03_0051__row12429723115212"><td class="cellrowborder" valign="top" width="40.949999999999996%" headers="mcps1.3.3.2.2.3.1.1 "><p id="css_03_0051__p14429823185211">API Calling</p>
</td>
<td class="cellrowborder" valign="top" width="59.050000000000004%" headers="mcps1.3.3.2.2.3.1.2 "><p id="css_03_0051__p24291923115219">Representational State Transfer (REST) message bodies, calling methods, and examples</p>
</td>
</tr>
<tr id="css_03_0051__row1442982315217"><td class="cellrowborder" valign="top" width="40.949999999999996%" headers="mcps1.3.3.2.2.3.1.1 "><p id="css_03_0051__p10305103162919">APIs for each module</p>
</td>
<td class="cellrowborder" valign="top" width="59.050000000000004%" headers="mcps1.3.3.2.2.3.1.2 "><p id="css_03_0051__p16429122310521">APIs provided by CSS</p>
</td>
</tr>
<tr id="css_03_0051__row842918239522"><td class="cellrowborder" valign="top" width="40.949999999999996%" headers="mcps1.3.3.2.2.3.1.1 "><p id="css_03_0051__p14429192314524">Common Parameters</p>
</td>
<td class="cellrowborder" valign="top" width="59.050000000000004%" headers="mcps1.3.3.2.2.3.1.2 "><p id="css_03_0051__p5429192311526">Common parameters, status codes, and error codes of CSS APIs</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/css/api-ref/css_03_0053.html Normal file
View File

@ -0,0 +1,11 @@
<a name="css_03_0053"></a><a name="css_03_0053"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body8662426"><p id="css_03_0053__en-us_topic_0171174224_p967712611197">An endpoint is the <strong id="css_03_0053__b173037110291">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/css/api-ref/css_03_0056.html Normal file
View File

@ -0,0 +1,11 @@
<a name="css_03_0056"></a><a name="css_03_0056"></a>
<h1 class="topictitle1">Supported Cluster Versions</h1>
<div id="body8662426"><p id="css_03_0056__p15553102112116">In CSS, Elasticsearch 7.6.2 and 7.9.3 and Kibana 7.6.2 and 7.9.3 are supported.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0001.html">Before You Start</a></div>
</div>
</div>

26
docs/css/api-ref/css_03_0057.html Normal file
View File

@ -0,0 +1,26 @@
<a name="css_03_0057"></a><a name="css_03_0057"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body8662426"><p id="css_03_0057__en-us_topic_0171174227_en-us_topic_0111426203_p11112662153235">The CSS API is a self-developed API that complies with RESTful API design specifications. You can call CSS APIs to implement the CSS functions described in <a href="#css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_table27268632">Table 1</a>.</p>
<div class="tablenoborder"><a name="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_table27268632"></a><a name="en-us_topic_0171174222_en-us_topic_0122640544_table27268632"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_table27268632" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API description</caption><thead align="left"><tr id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_row45712765"><th align="left" class="cellrowborder" valign="top" width="24.41%" id="mcps1.3.2.2.3.1.1"><p id="css_03_0057__en-us_topic_0171174222_p1966618319524">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="75.59%" id="mcps1.3.2.2.3.1.2"><p id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_p27467418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_row10268386"><td class="cellrowborder" valign="top" width="24.41%" headers="mcps1.3.2.2.3.1.1 "><p id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_p60694272">Cluster Management APIs</p>
</td>
<td class="cellrowborder" valign="top" width="75.59%" headers="mcps1.3.2.2.3.1.2 "><p id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_p17288998">You can use cluster management APIs to create clusters, scale out a cluster, view cluster details, and obtain instance specifications.</p>
</td>
</tr>
<tr id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_row15144391"><td class="cellrowborder" valign="top" width="24.41%" headers="mcps1.3.2.2.3.1.1 "><p id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_p41235667">Snapshot Management APIs</p>
</td>
<td class="cellrowborder" valign="top" width="75.59%" headers="mcps1.3.2.2.3.1.2 "><p id="css_03_0057__en-us_topic_0171174222_en-us_topic_0122640544_p51754697">Snapshots can be used to back up and restore data. You can use snapshot management APIs to create, restore, or delete a snapshot.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

47
docs/css/api-ref/css_03_0071.html Normal file
View File

@ -0,0 +1,47 @@
<a name="css_03_0071"></a><a name="css_03_0071"></a>
<h1 class="topictitle1">Obtaining a Project ID and Name</h1>
<div id="body8662426"><p id="css_03_0071__p194391501803">A project ID or project name is required in some API requests. You need to obtain the project ID and name before calling an API.</p>
<div class="section" id="css_03_0071__section05453179582"><h4 class="sectiontitle">Obtaining a Project ID and Name from the Console</h4><ol id="css_03_0071__ol1454591705812"><li id="css_03_0071__li17545201725812">Log in to the console.</li><li id="css_03_0071__li7493103385418">In the upper right corner of the page, click the username and choose <span class="parmname" id="css_03_0071__parmname1463852561418"><b>My Credentials</b></span> from the drop-down list. The <strong id="css_03_0071__b7644132514148">My Credentials</strong> page is displayed.</li><li id="css_03_0071__li15162020201811">In the project list, view the <strong id="css_03_0071__b1936431912218">Project ID</strong> and <strong id="css_03_0071__b944514314213">Project Name</strong>.<div class="fignone" id="css_03_0071__fig267017206014"><span class="figcap"><b>Figure 1 </b>Viewing the project ID and name</span><br><span><img id="css_03_0071__image167013201204" src="en-us_image_0000001261293340.png" title="Click to enlarge" class="imgResize"></span></div>
</li></ol>
</div>
<div class="section" id="css_03_0071__section16546101713583"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="css_03_0071__p175461217105811">The API for obtaining a project ID is <strong id="css_03_0071__b6741121815245">GET https://</strong><em id="css_03_0071__i2509162182418">{iam-endpoint}</em><strong id="css_03_0071__b9837723102418">/v3/projects</strong>. <em id="css_03_0071__i1437102719246">{iam-endpoint}</em> indicates the endpoint of IAM, which can be obtained from <a href="css_03_0053.html">Endpoints</a>.</p>
<div class="p" id="css_03_0071__p10546171713589">The following is an example response. For example, if CSS is deployed in region <span class="parmvalue" id="css_03_0071__parmvalue10857173452320"><b>xxx</b></span>, the value of <strong id="css_03_0071__b79613215336">name</strong> in the response body is <span class="parmvalue" id="css_03_0071__parmvalue941611413236"><b>xxx</b></span>. The value of <strong id="css_03_0071__b466591273411">id</strong> in <span class="parmname" id="css_03_0071__parmname731816204247"><b>projects</b></span> is the project ID.<pre class="screen" id="css_03_0071__screen145460171580">{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14exxxx",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14exxxx",
"name": "xxx", //Project name, the name of the deployment zone.
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897dxxxx"
},
<strong id="css_03_0071__b48671158142017">"id": "a4a5d4098fb4474fa22cd05f897dxxxx",</strong> //Project ID
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</pre>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0040.html">Common Parameters</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

88
docs/css/api-ref/css_03_0073.html Normal file
View File

@ -0,0 +1,88 @@
<a name="css_03_0073"></a><a name="css_03_0073"></a>
<h1 class="topictitle1">Common Request Parameters</h1>
<div id="body1500349170513"><p id="css_03_0073__p101677389562"><a href="#css_03_0073__table181671338175614">Table 1</a> describes the common request parameters.</p>
<div class="tablenoborder"><a name="css_03_0073__table181671338175614"></a><a name="table181671338175614"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0073__table181671338175614" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request headers</caption><thead align="left"><tr id="css_03_0073__row101671738165610"><th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.2.2.4.1.1"><p id="css_03_0073__p71671738165620">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.94%" id="mcps1.3.2.2.4.1.2"><p id="css_03_0073__p14168193875620">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.06%" id="mcps1.3.2.2.4.1.3"><p id="css_03_0073__p18168113813566">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0073__row1116873818569"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p1168338205612">X-Sdk-Date</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p31687389562">This parameter is mandatory for authentication using AK/SK.</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p15168173818564">Time when the request is sent. The time is in the <strong>YYYYMMDD'T'HHMMSS'Z'</strong> format.</p>
<p id="css_03_0073__p816853811560">The value is the current GMT time of the system.</p>
</td>
</tr>
<tr id="css_03_0073__row21686380566"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p1168338115620">Authorization</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p2016933816564">This parameter is mandatory for authentication using AK/SK.</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p3168173815567">Signature authentication information. The value can be obtained from the request signing result.</p>
<p id="css_03_0073__p16168113835612">See <a href="iam_02_0510.html">Authentication</a>.</p>
</td>
</tr>
<tr id="css_03_0073__row131691938145610"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p316953818564">Host</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p01697385565">This parameter is mandatory for authentication using AK/SK.</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p1169113855617">Server domain name and port number of the resource being requested. The value can be obtained from the URL of the service API. The value is <em>hostname[:port]</em>. If the port number is not specified, the default port is used. The default port number for <strong>https</strong> is <strong>443</strong>.</p>
</td>
</tr>
<tr id="css_03_0073__row10169143817564"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p316953815568">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p13169113816568">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p316983816565">MIME type of the request body.</p>
</td>
</tr>
<tr id="css_03_0073__row15169538145616"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p116993805613">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p31694386566">This parameter is mandatory for POST and PUT requests, but must be left blank for GET requests.</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p2169638175614">Length of the request body. The unit is byte.</p>
</td>
</tr>
<tr id="css_03_0073__row1217083825612"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p1817073815612">X-Project-Id</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p19170143817567">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p117033820564">Project ID. This parameter is used to obtain the token for each project.</p>
</td>
</tr>
<tr id="css_03_0073__row21707382565"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p5170638155610">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p5170238175610">No (This parameter is mandatory for authentication using tokens.)</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p1170338125614">User token.</p>
</td>
</tr>
<tr id="css_03_0073__row3170123820569"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p61701381568">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p181708389569">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p8170138145611">Request language. The value is <strong id="css_03_0073__b13743646164514">en-us</strong>.</p>
</td>
</tr>
<tr id="css_03_0073__row118151751165914"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.2.4.1.1 "><p id="css_03_0073__p68621055165911">Accept</p>
</td>
<td class="cellrowborder" valign="top" width="25.94%" headers="mcps1.3.2.2.4.1.2 "><p id="css_03_0073__p1286210558598">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.06%" headers="mcps1.3.2.2.4.1.3 "><p id="css_03_0073__p78621455145910">Type of content that can be received by a client.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0040.html">Common Parameters</a></div>
</div>
</div>

36
docs/css/api-ref/css_03_0074.html Normal file
View File

@ -0,0 +1,36 @@
<a name="css_03_0074"></a><a name="css_03_0074"></a>
<h1 class="topictitle1">Common Response Parameters</h1>
<div id="body1500349170513"><p id="css_03_0074__p2582144916562"><a href="#css_03_0074__table558284916567">Table 1</a> describes common response headers.</p>
<div class="tablenoborder"><a name="css_03_0074__table558284916567"></a><a name="table558284916567"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0074__table558284916567" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common response headers</caption><thead align="left"><tr id="css_03_0074__row75834490564"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.2.2.3.1.1"><p id="css_03_0074__p17583134916568">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.2.2.3.1.2"><p id="css_03_0074__p35832049145613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0074__row458344975611"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.3.1.1 "><p id="css_03_0074__p1458354995620">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.2.3.1.2 "><p id="css_03_0074__p18583184919562">Length of the response body. The unit is byte.</p>
</td>
</tr>
<tr id="css_03_0074__row858364912566"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.3.1.1 "><p id="css_03_0074__p95830499565">Date</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.2.3.1.2 "><p id="css_03_0074__p058374919569">Time when a request response is returned.</p>
</td>
</tr>
<tr id="css_03_0074__row10583749165616"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.2.3.1.1 "><p id="css_03_0074__p19583749115612">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.2.2.3.1.2 "><p id="css_03_0074__p1258324925617">MIME type of the request body.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0040.html">Common Parameters</a></div>
</div>
</div>

329
docs/css/api-ref/css_03_0075.html Normal file
View File

File diff suppressed because it is too large Load Diff

467
docs/css/api-ref/css_03_0076.html Normal file
View File

File diff suppressed because it is too large Load Diff

27
docs/css/api-ref/css_03_0077.html Normal file
View File

@ -0,0 +1,27 @@
<a name="css_03_0077"></a><a name="css_03_0077"></a>
<h1 class="topictitle1">Tag Management APIs</h1>
<div id="body1566786660933"><p id="css_03_0077__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="css_03_0078.html">Querying Tags of a Specified Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0079.html">Querying All Tags</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0083.html">Adding Tags to a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0081.html">Adding or Deleting Cluster Tags in Batches</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="css_03_0082.html">Deleting Specified Cluster Tags</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
</div>
</div>

148
docs/css/api-ref/css_03_0078.html Normal file
View File

File diff suppressed because it is too large Load Diff

145
docs/css/api-ref/css_03_0079.html Normal file
View File

File diff suppressed because it is too large Load Diff

180
docs/css/api-ref/css_03_0081.html Normal file
View File

File diff suppressed because it is too large Load Diff

102
docs/css/api-ref/css_03_0082.html Normal file
View File

File diff suppressed because it is too large Load Diff

131
docs/css/api-ref/css_03_0083.html Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
docs/css/api-ref/en-us_image_0000001261293340.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.3 KiB

BIN
docs/css/api-ref/en-us_image_0000001265939134.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

15
docs/css/api-ref/iam_01_0023.html Normal file
View File

@ -0,0 +1,15 @@
<a name="iam_01_0023"></a><a name="iam_01_0023"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="iam_02_0008.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_02_0510.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="iam_02_0511.html">Returned Values</a></strong><br>
</li>
</ul>
</div>

96
docs/css/api-ref/iam_02_0008.html Normal file
View File

@ -0,0 +1,96 @@
<a name="iam_02_0008"></a><a name="iam_02_0008"></a>
<h1 class="topictitle1">Making an API Request</h1>
<div id="body8662426"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p8141141101615">This section describes the structure of a RESTful API request, and uses the API for Obtaining a User Token as an example to describe how to call an API. A token is a user's access credential, which contains the user identity and permission information. The obtained token is used to authenticate the calling of other APIs.</p>
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section1849899574"><h4 class="sectiontitle">Request URI</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p729531715312">A request URI is in the following format:</p>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p11610193811547"><strong id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_b3129104565416">{URI-scheme}://{<strong id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_b10231116812">Endpoint</strong>}/{resource-path}?{query-string}</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_table442645372610" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request URL</caption><thead align="left"><tr id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_row15427253182617"><th align="left" class="cellrowborder" valign="top" width="18.790000000000003%" id="mcps1.3.2.4.2.3.1.1"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p24271253182614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="81.21000000000001%" id="mcps1.3.2.4.2.3.1.2"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p19427155318264">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_row104278530268"><td class="cellrowborder" valign="top" width="18.790000000000003%" headers="mcps1.3.2.4.2.3.1.1 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p44271053122619">URI-scheme</p>
</td>
<td class="cellrowborder" valign="top" width="81.21000000000001%" headers="mcps1.3.2.4.2.3.1.2 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p11427453192617">Protocol used to transmit requests. All APIs use <strong id="iam_02_0008__en-us_topic_0170917207_b1111310119349">HTTPS</strong>.</p>
</td>
</tr>
<tr id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_row1142745318267"><td class="cellrowborder" valign="top" width="18.790000000000003%" headers="mcps1.3.2.4.2.3.1.1 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1342765311266">Endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="81.21000000000001%" headers="mcps1.3.2.4.2.3.1.2 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p64278534269">Domain name or IP address of the server running the REST service. The endpoint varies between services in different regions. It can be obtained from <a href="css_03_0053.html">Endpoints</a>. </p>
</td>
</tr>
<tr id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_row94271453112615"><td class="cellrowborder" valign="top" width="18.790000000000003%" headers="mcps1.3.2.4.2.3.1.1 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p144271753182618">resource-path</p>
</td>
<td class="cellrowborder" valign="top" width="81.21000000000001%" headers="mcps1.3.2.4.2.3.1.2 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p4427953122617">API access path for performing a specified operation. Obtain the value from the URI of the API. For example, the <strong id="iam_02_0008__en-us_topic_0170917207_b1671914773413">resource-path</strong> of the API for <span class="parmname" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_parmname663013436287"><b>obtaining a user token</b></span> is <span class="parmvalue" id="iam_02_0008__en-us_topic_0170917207_parmvalue11721114710344"><b>/v3/auth/tokens</b></span>.</p>
</td>
</tr>
<tr id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_row1991179192817"><td class="cellrowborder" valign="top" width="18.790000000000003%" headers="mcps1.3.2.4.2.3.1.1 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1091217918289">query-string</p>
</td>
<td class="cellrowborder" valign="top" width="81.21000000000001%" headers="mcps1.3.2.4.2.3.1.2 "><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p79121799283">Query parameter, which is optional. Ensure that a question mark (<span class="parmname" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_parmname5182450132811"><b>?</b></span>) is included before a query parameter that is in the format of "<span class="parmname" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_parmname1718315019284"><b>Parameter name=Parameter value</b></span>". For example, <span class="parmname" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_parmname818314500282"><b>limit=10</b></span> indicates that a maximum of 10 pieces of data is to be viewed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_screen1553450193818"></pre>
<div class="p" id="iam_02_0008__en-us_topic_0170917207_p61551914141610">For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the <strong id="iam_02_0008__en-us_topic_0170917207_b156373055616">resource-path</strong> (<strong id="iam_02_0008__en-us_topic_0170917207_b463770125619">/v3/auth/tokens</strong>) in the URI of the API used to obtain a user token. Then, construct the URI as follows:<pre class="screen" id="iam_02_0008__screen14876158104020">https://&lt;iam-endpoint&gt;/v3/auth/tokens</pre>
</div>
<div class="note" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_note16311253154112"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p163316534416">To simplify the URI display, each API is provided with only a <strong id="iam_02_0008__en-us_topic_0170917207_b316912223363">resource-path</strong> and a request method. This is because the <strong id="iam_02_0008__en-us_topic_0170917207_b17583726163618">URI-scheme</strong> value of all APIs is <strong id="iam_02_0008__en-us_topic_0170917207_b8586826173614">HTTPS</strong>, and the endpoints in a region are the same. Therefore, the two parts are omitted.</p>
</div></div>
</div>
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section580035055419"><h4 class="sectiontitle">Request Methods</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p65661618145510">HTTP-based request methods, which are also called operations or actions, specify the type of operations that you are requesting.</p>
<ul id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_ul11356238151312"><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1835819385137"><strong id="iam_02_0008__en-us_topic_0170917207_b12857113714364">GET</strong>: requests the server to return specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li95631239131310"><strong id="iam_02_0008__en-us_topic_0170917207_b59328463362">PUT</strong>: requests the server to update specified resources.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1554910413138"><strong id="iam_02_0008__en-us_topic_0170917207_b2281114933619">POST</strong>: requests the server to add resources or perform special operations.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li8237114421314"><strong id="iam_02_0008__en-us_topic_0170917207_b54061951103612">DELETE</strong>: requests the server to delete specified resources, for example, an object.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li165331349151317"><strong id="iam_02_0008__en-us_topic_0170917207_b399416532361">HEAD</strong>: requests a server resource header.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li4440175411313"><strong id="iam_02_0008__en-us_topic_0170917207_b09452020375">PATCH</strong>: requests the server to update partial content of a specified resource. If the target resource does not exist, PATCH may create a resource.</li></ul>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p3759142614815">If <strong id="iam_02_0008__b2080910410304">POST</strong> is displayed in the URI of the API for obtaining a user token, the request is as follows:</p>
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_screen1278712381542">
POST https://<em id="iam_02_0008__i8606173611145">{iam-endpoint}</em>/v3/auth/tokens</pre>
</div>
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section1454211155819"><h4 class="sectiontitle">Request Header</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p11811752397">You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add <span class="parmname" id="iam_02_0008__en-us_topic_0170917207_parmname555313733714"><b>Content-Type</b></span> that defines a request body type to request for the authentication information.</p>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1467193205816">Common request headers are as follows:</p>
<ul id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_ul157293410593"><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li972916419595"><strong id="iam_02_0008__en-us_topic_0170917207_b45271744123718">Content-Type</strong>: specifies the request body type or format. This field is mandatory and its default value is <span class="parmvalue" id="iam_02_0008__en-us_topic_0170917207_parmvalue195281444123719"><b>application/json</b></span>.</li><li id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_li1642421012595"><strong id="iam_02_0008__en-us_topic_0170917207_b576882411312">X-Auth-Token</strong>: specifies the user token, which is optional. This field is mandatory for token-based authentication. <strong id="iam_02_0008__b1573516520309">X-Auth-Token</strong> is the value of <strong id="iam_02_0008__b4543355203011">x-subject-token</strong> returned in response to the API used to obtain a user token.<div class="note" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_note13771123325011"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1513412221808">In addition to supporting authentication using tokens, APIs support authentication using the access key ID (AK)/secret access key (SK), which uses SDKs to sign a request. During the signing, the <strong id="iam_02_0008__en-us_topic_0170917207_b4241256143814">Authorization</strong> (signature authentication information) and <strong id="iam_02_0008__en-us_topic_0170917207_b624213569385">X-Sdk-Date</strong> (time when a request is sent) headers are automatically added to the request. For more details, see <a href="iam_02_0510.html">Authentication Using AK/SK</a>.</p>
</div></div>
</li></ul>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p42118461957">The API used to obtain a user token does not require authentication. Therefore, only the <span class="parmname" id="iam_02_0008__parmname17151815123115"><b>Content-Type</b></span> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_screen10131730155612">POST https://<em id="iam_02_0008__i16184129191410">{iam-endpoint}</em>/v3/auth/tokens
Content-Type: application/json</pre>
</div>
<div class="section" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_section14612192315587"><h4 class="sectiontitle">Request Body</h4><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p23132011213">A request body conveys information other than the request header and is generally sent in a structured format defined by the request header field <strong id="iam_02_0008__en-us_topic_0170917207_b1328019465393">Content-Type</strong>. </p>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1847214711331">The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.</p>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p105261225101112">In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="iam_02_0008__i184231741104112">username</em>, <em id="iam_02_0008__i12423164194115">domainname</em>, <em id="iam_02_0008__i1042320419410">********</em> (login password), and <em id="iam_02_0008__i194241041104118">xxxxxxxxxxxxxxxxxx</em> (project ID) with the actual values. To learn how to obtain a project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
<div class="note" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p199011223194814">The <strong id="iam_02_0008__b341143183419">scope</strong> parameter defines the application scope of the token, indicating that the obtained token can access only the resources in the specified project.</p>
</div></div>
<pre class="screen" id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_screen6140617194816">POST https://<em id="iam_02_0008__i1043451812139">{iam-endpoint}</em>/v3/auth/tokens
Content-Type: application/json
{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<em id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_i315217719194"><strong id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_b14500116161919">username</strong></em>", //Username
"password": "<strong id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_b2559181251918"><em id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_i12803128192">********</em></strong>", //Login password
"domain": {
"name": "<em id="iam_02_0008__en-us_topic_0170917207_i1670713181171"><strong id="iam_02_0008__en-us_topic_0170917207_b1332717181715">domainname</strong></em> " //Name of the account to which the user belongs
}
}
}
},
"scope": {
"project": {
"id": "<strong id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_b1261200101711"><em id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_i186128061711">xxxxxxxxxxxxxxxxxx</em></strong>" //Project ID
}
}
}
}</pre>
<p id="iam_02_0008__en-us_topic_0170917207_en-us_topic_0168405763_p1859663401915">If all data required by a request is available, you can send the request to call an API through <a href="https://curl.haxx.se/" target="_blank" rel="noopener noreferrer">curl</a>, <a href="https://www.getpostman.com/" target="_blank" rel="noopener noreferrer">Postman</a>, or coding. For the API of obtaining a user token, <strong id="iam_02_0008__b1973816115516">x-subject-token</strong> in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_01_0023.html">Calling APIs</a></div>
</div>
</div>

43
docs/css/api-ref/iam_02_0510.html Normal file
View File

@ -0,0 +1,43 @@
<a name="iam_02_0510"></a><a name="iam_02_0510"></a>
<h1 class="topictitle1">Authentication</h1>
<div id="body8662426"><p id="iam_02_0510__en-us_topic_0170917208_en-us_topic_0168405764_p26613555143846">CSS supports token authentication.</p>
<div class="section" id="iam_02_0510__en-us_topic_0170917208_section34951335121613"><h4 class="sectiontitle">Authentication Using Tokens</h4><div class="note" id="iam_02_0510__en-us_topic_0170917208_note1449573531616"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="iam_02_0510__en-us_topic_0170917208_p1849553514166">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.</p>
</div></div>
<p id="iam_02_0510__en-us_topic_0170917208_p11495135111617">A token specifies certain permissions in a computer system. Authentication using a token adds the token to a request as its header during API calling to obtain permissions to operate APIs through IAM.</p>
<p id="iam_02_0510__en-us_topic_0170917208_p4938113918117">The API for obtaining a token is <strong id="iam_02_0510__b13479185920382">POST https://</strong><em id="iam_02_0510__i1697042173911">{IAM endpoint}</em><strong id="iam_02_0510__b924711573913">/v3/auth/tokens</strong>. For details about how to obtain IAM endpoints, see <a href="css_03_0053.html">Endpoints</a>.</p>
<pre class="screen" id="iam_02_0510__en-us_topic_0170917208_screen84049561000">{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "username", //Username
"password": "********", //Login password
"domain": {
"name": "domainname" //Name of the account that the user belongs to
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx" //Project name
}
}
}
}</pre>
<p id="iam_02_0510__en-us_topic_0170917208_p175512042712">After a token is obtained, the <strong id="iam_02_0510__en-us_topic_0170917208_b4962111369581">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <strong id="iam_02_0510__en-us_topic_0170917208_b9389950329581">ABCDEFJ....</strong>, <strong id="iam_02_0510__en-us_topic_0170917208_b18594742059581">X-Auth-Token: ABCDEFJ....</strong> can be added to a request as follows:</p>
<pre class="screen" id="iam_02_0510__en-us_topic_0170917208_en-us_topic_0170917208_en-us_topic_0168405764_screen11189101154015">POST https://{endpoint}/v3/auth/projects
Content-Type: application/json
<strong id="iam_02_0510__en-us_topic_0170917208_en-us_topic_0170917208_en-us_topic_0168405764_b172853338430">X-Auth-Token: ABCDEFJ....</strong></pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_01_0023.html">Calling APIs</a></div>
</div>
</div>

46
docs/css/api-ref/iam_02_0511.html Normal file
View File

@ -0,0 +1,46 @@
<a name="iam_02_0511"></a><a name="iam_02_0511"></a>
<h1 class="topictitle1">Returned Values</h1>
<div id="body8662426"><div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p4624111624411">After sending a request, you will receive a response containing the status code, response header, and response body.</p>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="css_03_0075.html">Status Code</a>.</p>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p2861496519">If status code 201 is returned for the calling of the API for obtaining a user token, the request is successful.</p>
</div>
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p384320471837">A response header corresponds to a request header, for example, <span class="parmvalue" id="iam_02_0511__en-us_topic_0170917209_parmvalue946210448619"><b>Content-Type</b></span>.</p>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p4430113619484"><a href="#iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511">Figure 1</a> shows the response header for the API of obtaining a user token, where <span class="parmname" id="iam_02_0511__en-us_topic_0170917209_parmname109780549620"><b>x-subject-token</b></span> is the desired user token. Then, you can use the token to authenticate the calling of other APIs.</p>
<div class="fignone" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"><a name="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><a name="en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header of the response to the request for obtaining a user token</span><br><span><img id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_image48651610135113" src="en-us_image_0000001265939134.png" title="Click to enlarge" class="imgResize"></span></div>
</div>
<div class="section" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p133921631940">A response body is generally returned in a structured format, corresponding to the <strong id="iam_02_0511__en-us_topic_0170917209_b59654378715">Content-Type</strong> in the response header, and is used to transfer content other than the response header.</p>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p157041652367">The following shows part of the response body for the API of obtaining a user token.</p>
<pre class="screen" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_screen65818201917">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "xxx",
......</pre>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p127537375412">If an error occurs during API calling, the system returns an error code and a message to you. The following shows the format of an error response body:</p>
<pre class="screen" id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_screen102091730125513">{
"error_msg": "The format of message is error",
"error_code": "AS.0001"
}</pre>
<p id="iam_02_0511__en-us_topic_0170917209_en-us_topic_0168405765_p1589911464018">In the preceding information, <strong id="iam_02_0511__en-us_topic_0170917209_b54237551882">error_code</strong> is an error code, and <strong id="iam_02_0511__en-us_topic_0170917209_b17424195519816">error_msg</strong> describes the error.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="iam_01_0023.html">Calling APIs</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

1
docs/css/api-ref/public_sys-resources/ExpandCollapse.js Normal file
View File

@ -0,0 +1 @@
var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d<f.length;d++){var e=f[d];if(e.className.indexOf(expandClassName)!=-1||e.className.indexOf(collapseClassName)!=-1||e.className.indexOf(collapseTableClassName)!=-1){if(a=="collapse"){if(e.tagName.toLowerCase()=="table"){e.className=collapseTableClassName}else{e.className=collapseClassName}}else{e.className=expandClassName}}}}function ExpandForHref(f){if(null==f||"#"==f||"###"==f){return}var a=null;try{a=document.getElementById(f)}catch(d){}if(null==a||a.length==0){return}try{var b=a.parentNode;while(b!=null&&b.tagName!="body"){if(b.className==collapseClassName){b.className=expandClassName}b=b.parentNode}}catch(c){}}window.onload=function(){var b=document.getElementsByTagName("div");for(var c=0;c<b.length;c++){var j=b[c];if(j.className.indexOf(expandClassName)!=-1){j.className=collapseClassName}}var d=document.getElementsByTagName("a");try{for(var c=0;c<d.length;c++){var f=d[c];var h=f.getAttribute("href");if(h!=""&&h!=null){href=h;f.addEventListener("click",showHasConref,false)}}}catch(g){}};function showHasConref(){try{if(href!=null&&href!="#"&&href.lastIndexOf("#")>-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}};

BIN
docs/css/api-ref/public_sys-resources/caution_3.0-en-us.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.7 KiB

1
docs/css/api-ref/public_sys-resources/commonltr.css Normal file
View File

File diff suppressed because one or more lines are too long

Some files were not shown because too many files have changed in this diff Show More