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

css api 20240704 version

Browse Source 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com>
Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
This commit is contained in:
Zheng, Xiu 2024-07-22 17:01:37 +00:00 committed by zuul
parent ca9677b121
commit 3fa966049f
19 changed files with 128 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/css/api-ref/ALL_META.TXT.json
View File

@ -78,7 +78,9 @@
{
"documenttype":"api",
"prodname":"css",
"opensource":"true"
"opensource":"true",
"operation_id":"AddIndependentNode",
"version":"v1"
}
],
"title":"Supported Cluster Versions",
@ -106,8 +108,8 @@
"githuburl":""
},
{
"uri":"iam_01_0023.html",
"node_id":"iam_01_0023.xml",
"uri":"css_03_0137.html",
"node_id":"css_03_0137.xml",
"product_code":"css",
"code":"6",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
@ -127,8 +129,8 @@
"githuburl":""
},
{
"uri":"iam_02_0008.html",
"node_id":"iam_02_0008.xml",
"uri":"css_03_0138.html",
"node_id":"css_03_0138.xml",
"product_code":"css",
"code":"7",
"des":"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",
@ -148,8 +150,8 @@
"githuburl":""
},
{
"uri":"iam_02_0510.html",
"node_id":"iam_02_0510.xml",
"uri":"css_03_0139.html",
"node_id":"css_03_0139.xml",
"product_code":"css",
"code":"8",
"des":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ",
@ -169,8 +171,8 @@
"githuburl":""
},
{
"uri":"iam_02_0511.html",
"node_id":"iam_02_0511.xml",
"uri":"css_03_0140.html",
"node_id":"css_03_0140.xml",
"product_code":"css",
"code":"9",
"des":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
@ -1357,7 +1359,9 @@
{
"documenttype":"api",
"prodname":"css",
"opensource":"true"
"opensource":"true",
"operation_id":"AddIndependentNode",
"version":"v1"
}
],
"title":"Modifying Basic Configurations of a Cluster Snapshot",

2
docs/css/api-ref/AddIndependentNode.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Adding Master and Client Nodes</h1>
<div id="body0000001926438181"><div class="section" id="AddIndependentNode__section880755564414"><h4 class="sectiontitle">Function</h4><p id="AddIndependentNode__p880925584417">This API is used to add master and client nodes to a cluster.</p>
</div>
<div class="section" id="AddIndependentNode__section58091055154418"><h4 class="sectiontitle">Calling Method</h4><p id="AddIndependentNode__p1781013558444">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="AddIndependentNode__section58091055154418"><h4 class="sectiontitle">Calling Method</h4><p id="AddIndependentNode__p1781013558444">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="AddIndependentNode__section13810355104417"><h4 class="sectiontitle">URI</h4><p id="AddIndependentNode__p19811955174411">POST /v1.0/{project_id}/clusters/{cluster_id}/type/{type}/independent</p>

8
docs/css/api-ref/CLASS.TXT.json
View File

@ -48,7 +48,7 @@
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"css",
"title":"Calling APIs",
"uri":"iam_01_0023.html",
"uri":"css_03_0137.html",
"doc_type":"api",
"p_code":"",
"code":"6"
@ -57,7 +57,7 @@
"desc":"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",
"product_code":"css",
"title":"Making an API Request",
"uri":"iam_02_0008.html",
"uri":"css_03_0138.html",
"doc_type":"api",
"p_code":"6",
"code":"7"
@ -66,7 +66,7 @@
"desc":"CSS supports token authentication.The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API.A ",
"product_code":"css",
"title":"Authentication",
"uri":"iam_02_0510.html",
"uri":"css_03_0139.html",
"doc_type":"api",
"p_code":"6",
"code":"8"
@ -75,7 +75,7 @@
"desc":"After sending a request, you will receive a response containing the status code, response header, and response body.A status code is a group of digits, ranging from 1xx t",
"product_code":"css",
"title":"Returned Values",
"uri":"iam_02_0511.html",
"uri":"css_03_0140.html",
"doc_type":"api",
"p_code":"6",
"code":"9"

2
docs/css/api-ref/ListImages.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Obtaining a Target Image ID</h1>
<div id="body0000001880399332"><div class="section" id="ListImages__section105709354618"><h4 class="sectiontitle">Function</h4><p id="ListImages__p2572630461">This API is used to obtain the ID of an image that can be upgraded in the current cluster.</p>
</div>
<div class="section" id="ListImages__section157473124611"><h4 class="sectiontitle">Calling Method</h4><p id="ListImages__p657617334613">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="ListImages__section157473124611"><h4 class="sectiontitle">Calling Method</h4><p id="ListImages__p657617334613">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ListImages__section65781315468"><h4 class="sectiontitle">URI</h4><p id="ListImages__p16580163104616">GET /v1.0/{project_id}/clusters/{cluster_id}/target/{upgrade_type}/images</p>

2
docs/css/api-ref/ResetPassword.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Changing a Password</h1>
<div id="body0000001926672489"><div class="section" id="ResetPassword__section5288748579"><h4 class="sectiontitle">Function</h4><p id="ResetPassword__p32884412572">This API is used to change the password of a cluster.</p>
</div>
<div class="section" id="ResetPassword__section42899415579"><h4 class="sectiontitle">Calling Method</h4><p id="ResetPassword__p132897415573">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="ResetPassword__section42899415579"><h4 class="sectiontitle">Calling Method</h4><p id="ResetPassword__p132897415573">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="ResetPassword__section92908475711"><h4 class="sectiontitle">URI</h4><p id="ResetPassword__p029018417570">POST /v1.0/{project_id}/clusters/{cluster_id}/password/reset</p>

2
docs/css/api-ref/RetryUpgradeTask.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Retrying a Failed Upgrade Task</h1>
<div id="body0000001926518557"><div class="section" id="RetryUpgradeTask__section743956154417"><h4 class="sectiontitle">Function</h4><p id="RetryUpgradeTask__p34305644417">The upgrade takes a long time and the upgrade may fail due to network problems. You can use this API to retry a task or terminate the impact of a task.</p>
</div>
<div class="section" id="RetryUpgradeTask__section10441256194413"><h4 class="sectiontitle">Calling Method</h4><p id="RetryUpgradeTask__p1645956124410">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="RetryUpgradeTask__section10441256194413"><h4 class="sectiontitle">Calling Method</h4><p id="RetryUpgradeTask__p1645956124410">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="RetryUpgradeTask__section104685614448"><h4 class="sectiontitle">URI</h4><p id="RetryUpgradeTask__p54785634415">PUT /v1.0/{project_id}/clusters/{cluster_id}/upgrade/{action_id}/retry</p>

2
docs/css/api-ref/UpgradeCore.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Upgrading a Cluster Kernel</h1>
<div id="body0000001926438177"><div class="section" id="UpgradeCore__section141770310460"><h4 class="sectiontitle">Function</h4><p id="UpgradeCore__p317820384611">This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.</p>
</div>
<div class="section" id="UpgradeCore__section161801532466"><h4 class="sectiontitle">Calling Method</h4><p id="UpgradeCore__p161826364612">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="UpgradeCore__section161801532466"><h4 class="sectiontitle">Calling Method</h4><p id="UpgradeCore__p161826364612">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="UpgradeCore__section61831732466"><h4 class="sectiontitle">URI</h4><p id="UpgradeCore__p181856317468">POST /v1.0/{project_id}/clusters/{cluster_id}/inst-type/{inst_type}/image/upgrade</p>

2
docs/css/api-ref/UpgradeDetail.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Obtaining Upgrade Details</h1>
<div id="body0000001880559224"><div class="section" id="UpgradeDetail__section494793164615"><h4 class="sectiontitle">Function</h4><p id="UpgradeDetail__p095013310465">The upgrade takes a long time. You can call this API to check the upgrade progress on a node.</p>
</div>
<div class="section" id="UpgradeDetail__section129527354619"><h4 class="sectiontitle">Calling Method</h4><p id="UpgradeDetail__p11954153174619">For details, see <a href="iam_01_0023.html">Calling APIs</a>.</p>
<div class="section" id="UpgradeDetail__section129527354619"><h4 class="sectiontitle">Calling Method</h4><p id="UpgradeDetail__p11954153174619">For details, see <a href="css_03_0137.html">Calling APIs</a>.</p>
</div>
<div class="section" id="UpgradeDetail__section795619313469"><h4 class="sectiontitle">URI</h4><p id="UpgradeDetail__p1795817311466">GET /v1.0/{project_id}/clusters/{cluster_id}/upgrade/detail</p>

14
docs/css/api-ref/css_03_0019.html
View File

@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0019__p211481414566">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0019__p8114151414568">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0019__p8114151414568">Project ID. For details about how to obtain a project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
</tbody>
@ -179,7 +179,7 @@
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1656713138562"></a><a name="table1656713138562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1656713138562" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0019__b954308271">instance</strong> field description</caption><thead align="left"><tr id="css_03_0019__row311410146564"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.5.2.5.1.1"><p id="css_03_0019__p13114121413566">Parameter</p>
<div class="tablenoborder"><a name="css_03_0019__table1656713138562"></a><a name="table1656713138562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1656713138562" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="css_03_0019__b1365506179">instance</strong> field description</caption><thead align="left"><tr id="css_03_0019__row311410146564"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.3.5.2.5.1.1"><p id="css_03_0019__p13114121413566">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.5.2.5.1.2"><p id="css_03_0019__p6114161410569">Mandatory</p>
</th>
@ -233,7 +233,7 @@
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table11567131335613"></a><a name="table11567131335613"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table11567131335613" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="css_03_0019__b1205882372">volume</strong> field description</caption><thead align="left"><tr id="css_03_0019__row4114101435619"><th align="left" class="cellrowborder" valign="top" width="15.559999999999999%" id="mcps1.3.3.6.2.5.1.1"><p id="css_03_0019__p1511401416567">Parameter</p>
<div class="tablenoborder"><a name="css_03_0019__table11567131335613"></a><a name="table11567131335613"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table11567131335613" frame="border" border="1" rules="all"><caption><b>Table 5 </b><strong id="css_03_0019__b1919334071">volume</strong> field description</caption><thead align="left"><tr id="css_03_0019__row4114101435619"><th align="left" class="cellrowborder" valign="top" width="15.559999999999999%" id="mcps1.3.3.6.2.5.1.1"><p id="css_03_0019__p1511401416567">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.44%" id="mcps1.3.3.6.2.5.1.2"><p id="css_03_0019__p311471413563">Mandatory</p>
</th>
@ -268,7 +268,7 @@
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1959831319562"></a><a name="table1959831319562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1959831319562" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="css_03_0019__b1426838219">nics</strong> field description</caption><thead align="left"><tr id="css_03_0019__row411461445618"><th align="left" class="cellrowborder" valign="top" width="15.049999999999999%" id="mcps1.3.3.7.2.5.1.1"><p id="css_03_0019__p9114101414569">Parameter</p>
<div class="tablenoborder"><a name="css_03_0019__table1959831319562"></a><a name="table1959831319562"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1959831319562" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="css_03_0019__b171797216">nics</strong> field description</caption><thead align="left"><tr id="css_03_0019__row411461445618"><th align="left" class="cellrowborder" valign="top" width="15.049999999999999%" id="mcps1.3.3.7.2.5.1.1"><p id="css_03_0019__p9114101414569">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.45%" id="mcps1.3.3.7.2.5.1.2"><p id="css_03_0019__p011461445616">Mandatory</p>
</th>
@ -309,7 +309,7 @@
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table1121072510499"></a><a name="table1121072510499"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1121072510499" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="css_03_0019__b950783689">datastore</strong> field description</caption><thead align="left"><tr id="css_03_0019__row9210132514499"><th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.3.8.2.5.1.1"><p id="css_03_0019__p257003611426">Parameter</p>
<div class="tablenoborder"><a name="css_03_0019__table1121072510499"></a><a name="table1121072510499"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table1121072510499" frame="border" border="1" rules="all"><caption><b>Table 7 </b><strong id="css_03_0019__b644076390">datastore</strong> field description</caption><thead align="left"><tr id="css_03_0019__row9210132514499"><th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.3.8.2.5.1.1"><p id="css_03_0019__p257003611426">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.659999999999998%" id="mcps1.3.3.8.2.5.1.2"><p id="css_03_0019__p1057073612420">Mandatory</p>
</th>
@ -334,7 +334,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.32%" headers="mcps1.3.3.8.2.5.1.3 "><p id="css_03_0019__p24274612517">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.17%" headers="mcps1.3.3.8.2.5.1.4 "><p id="css_03_0019__p194276622512">Cluster type. The default value is <strong id="css_03_0019__b53898421169">Elasticsearch</strong>. Currently, the value can only be <strong id="css_03_0019__b9606194511169">Elasticsearch</strong>.</p>
<td class="cellrowborder" valign="top" width="57.17%" headers="mcps1.3.3.8.2.5.1.4 "><p id="css_03_0019__p194276622512">Engine type. Elasticsearch and OpenSearch are supported.</p>
</td>
</tr>
</tbody>
@ -498,7 +498,7 @@
</table>
</div>
<div class="tablenoborder"><a name="css_03_0019__table2614813135615"></a><a name="table2614813135615"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table2614813135615" frame="border" border="1" rules="all"><caption><b>Table 12 </b><strong id="css_03_0019__b1830360181">cluster</strong> field description</caption><thead align="left"><tr id="css_03_0019__row1611419143569"><th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0019__p10114141412569">Parameter</p>
<div class="tablenoborder"><a name="css_03_0019__table2614813135615"></a><a name="table2614813135615"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0019__table2614813135615" frame="border" border="1" rules="all"><caption><b>Table 12 </b><strong id="css_03_0019__b1177258769">cluster</strong> field description</caption><thead align="left"><tr id="css_03_0019__row1611419143569"><th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.4.4.2.4.1.1"><p id="css_03_0019__p10114141412569">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.782878287828783%" id="mcps1.3.4.4.2.4.1.2"><p id="css_03_0019__p111141014195619">Type</p>
</th>

4
docs/css/api-ref/css_03_0024.html
View File

@ -60,12 +60,12 @@
</tr>
<tr id="css_03_0024__row1664961015213"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p1764918106213">2022-07-28</p>
</td>
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul26129118570"><li id="css_03_0024__li5612151125716">Combined "Common Request Parameters" and "Common Response Parameters" into <a href="iam_01_0023.html">Calling APIs</a>.</li><li id="css_03_0024__li142323512574">Added cluster version 7.10.2.</li></ul>
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul26129118570"><li id="css_03_0024__li5612151125716">Combined "Common Request Parameters" and "Common Response Parameters" into <a href="css_03_0137.html">Calling APIs</a>.</li><li id="css_03_0024__li142323512574">Added cluster version 7.10.2.</li></ul>
</td>
</tr>
<tr id="css_03_0024__row6818133117347"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.1.1.3.1.1 "><p id="css_03_0024__p6818531133419">2022-06-30</p>
</td>
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul436719111371"><li id="css_03_0024__li1936831123712">Optimized API calling methods:<ul id="css_03_0024__ul1736813112374"><li id="css_03_0024__li193681914376"><a href="iam_01_0023.html">Calling APIs</a></li></ul>
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.1.1.3.1.2 "><ul id="css_03_0024__ul436719111371"><li id="css_03_0024__li1936831123712">Optimized API calling methods:<ul id="css_03_0024__ul1736813112374"><li id="css_03_0024__li193681914376"><a href="css_03_0137.html">Calling APIs</a></li></ul>
</li><li id="css_03_0024__li336815163710">Optimized common contents:<ul id="css_03_0024__ul93681112375"><li id="css_03_0024__li1736819133710"><a href="css_03_0056.html">Supported Cluster Versions</a></li><li id="css_03_0024__li1736811183710"><a href="css_03_0071.html">Obtaining a Project ID and Name</a></li></ul>
</li><li id="css_03_0024__li1760713210414">Updated error code ID.</li></ul>
</td>

2
docs/css/api-ref/css_03_0062.html
View File

@ -8,7 +8,7 @@
<div class="section" id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_section101152312311"><h4 class="sectiontitle">Involved APIs</h4><p id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_p208391848152419">If you use a token for authentication, you must obtain the token and add <strong id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_b93839580536">X-Auth-Token</strong> to the request header of the API when making an API call.</p>
<ul id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_ul18839104814240"><li id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_li48397486241">API for obtaining tokens from IAM</li><li id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_li1583954822419">API for creating CSS clusters</li></ul>
</div>
<div class="section" id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_section84735913247"><h4 class="sectiontitle">Procedure</h4><ol id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_ol17437102653012"><li id="css_03_0062__en-us_topic_0171174235_li1265543762911"><a name="css_03_0062__en-us_topic_0171174235_li1265543762911"></a><a name="en-us_topic_0171174235_li1265543762911"></a>Obtain the token. Send <strong id="css_03_0062__b245372905916">POST https://</strong><strong id="css_03_0062__b73441112826">IAM</strong><strong id="css_03_0062__b545314299599"><em id="css_03_0062__i1334010121129"> endpoint</em></strong><strong id="css_03_0062__b245442935917">/v3/auth/tokens</strong>.<p id="css_03_0062__p175004152139">Obtain the token by following instructions in <a href="iam_02_0510.html">Authentication</a>.</p>
<div class="section" id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_section84735913247"><h4 class="sectiontitle">Procedure</h4><ol id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_ol17437102653012"><li id="css_03_0062__en-us_topic_0171174235_li1265543762911"><a name="css_03_0062__en-us_topic_0171174235_li1265543762911"></a><a name="en-us_topic_0171174235_li1265543762911"></a>Obtain the token. Send <strong id="css_03_0062__b245372905916">POST https://</strong><strong id="css_03_0062__b73441112826">IAM</strong><strong id="css_03_0062__b545314299599"><em id="css_03_0062__i1334010121129"> endpoint</em></strong><strong id="css_03_0062__b245442935917">/v3/auth/tokens</strong>.<p id="css_03_0062__p175004152139">Obtain the token by following instructions in <a href="css_03_0139.html">Authentication</a>.</p>
<p id="css_03_0062__p67561824152">The value of <span class="parmname" id="css_03_0062__en-us_topic_0000001134543542_en-us_topic_0000001096804707_en-us_topic_0000001127381857_en-us_topic_0000001096804707_en-us_topic_0000001096752971_parmname33391418185012"><b>X-Subject-Token</b></span> in the response header is the user token.</p>
</li><li id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_li207811546133015">Add <strong id="css_03_0062__b982017561818">Content-type</strong> and <strong id="css_03_0062__b41544017912">X-Auth-Token</strong> to the request header.<ul id="css_03_0062__ul20175151465914"><li id="css_03_0062__en-us_topic_0168405763_li972916419595"><strong id="css_03_0062__b11379203722218">Content-Type</strong>: specifies the request body type or format. Its default value is <span class="parmvalue" id="css_03_0062__parmvalue11380837142210"><b>application/json</b></span>.</li><li id="css_03_0062__en-us_topic_0168405763_li1642421012595"><strong id="css_03_0062__b3399819694">X-Auth-Token</strong>: Enter the user token obtained in <a href="#css_03_0062__en-us_topic_0171174235_li1265543762911">1</a>.</li></ul>
</li><li id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_li17564135310303">Send a cluster creation request and specify the following parameters in the request body:<pre class="screen" id="css_03_0062__en-us_topic_0171174235_en-us_topic_0111418639_screen336756143714">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters

6
docs/css/api-ref/css_03_0065.html
View File

@ -16,13 +16,13 @@
<th align="left" class="cellrowborder" valign="top" width="36.92630736926308%" id="mcps1.3.6.3.5.2.2.6.1.2"><p id="css_03_0065__p10623336113913">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.788121187881213%" id="mcps1.3.6.3.5.2.2.6.1.3"><p id="css_03_0065__p126231636123915">Action</p>
<p id="css_03_0065__p262383612390"> </p>
<p id="css_03_0065__p262383612390"> </p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.348865113488651%" id="mcps1.3.6.3.5.2.2.6.1.4"><p id="css_03_0065__p18623153603910">IAM Project</p>
<p id="css_03_0065__p06241336113920">(Project)</p>
<p id="css_03_0065__p06241336113920"> </p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.90830916908309%" id="mcps1.3.6.3.5.2.2.6.1.5"><p id="css_03_0065__p1962423611391">Enterprise Project</p>
<p id="css_03_0065__p18624143613399">(Enterprise Project)</p>
<p id="css_03_0065__p18624143613399"> </p>
</th>
</tr>
</thead>

2
docs/css/api-ref/css_03_0081.html
View File

@ -57,7 +57,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.70872912708729%" headers="mcps1.3.4.2.2.5.1.2 "><p id="css_03_0081__p4684162143813">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.538046195380463%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0081__p1368482133813">Array of <a href="#css_03_0081__table2440821133810">tag</a> objects</p>
<td class="cellrowborder" valign="top" width="19.538046195380463%" headers="mcps1.3.4.2.2.5.1.3 "><p id="css_03_0081__p1368482133813">Array of <a href="#css_03_0081__table2440821133810">tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.85471452854714%" headers="mcps1.3.4.2.2.5.1.4 "><p id="css_03_0081__p26842219386">Tag list</p>
</td>

2
docs/css/api-ref/css_03_0134.html
View File

@ -133,7 +133,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="css_03_0134__p176792135557">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="css_03_0134__p1368010136553">Task execution status.</p>
<ul id="css_03_0134__ul1668011312553"><li id="css_03_0134__li368018131554"><strong id="css_03_0134__b57831239171014">150</strong>: The task is not executed.</li><li id="css_03_0134__li156801133555"><strong id="css_03_0134__b3761643191114">200</strong>: The task has been executed.</li><li id="css_03_0134__li868031325511"><strong id="css_03_0134__b898125910119">300</strong>: The task has been sent.</li></ul>
<ul id="css_03_0134__ul1668011312553"><li id="css_03_0134__li368018131554"><strong id="css_03_0134__b57831239171014">150</strong>: Disabled</li><li id="css_03_0134__li156801133555"><strong id="css_03_0134__b3761643191114">200</strong>: Enabled</li><li id="css_03_0134__li868031325511"><strong id="css_03_0134__b898125910119">300</strong>: Sent</li></ul>
</td>
</tr>
<tr id="css_03_0134__row1467581312553"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="css_03_0134__p1568111133558">summary</p>

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

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

100
docs/css/api-ref/iam_02_0008.html → docs/css/api-ref/css_03_0138.html
View File

File diff suppressed because it is too large Load Diff

20
docs/css/api-ref/iam_02_0510.html → docs/css/api-ref/css_03_0139.html
View File

@ -1,12 +1,12 @@
<a name="iam_02_0510"></a><a name="iam_02_0510"></a>
<a name="css_03_0139"></a><a name="css_03_0139"></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 id="body8662426"><p id="css_03_0139__en-us_topic_0170917208_en-us_topic_0168405764_p26613555143846">CSS supports token authentication.</p>
<div class="section" id="css_03_0139__en-us_topic_0170917208_section34951335121613"><h4 class="sectiontitle">Authentication Using Tokens</h4><div class="note" id="css_03_0139__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="css_03_0139__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">{
<p id="css_03_0139__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="css_03_0139__en-us_topic_0170917208_p4938113918117">The API for obtaining a token is <strong id="css_03_0139__b13479185920382">POST https://</strong><em id="css_03_0139__i1697042173911">{IAM endpoint}</em><strong id="css_03_0139__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="css_03_0139__en-us_topic_0170917208_screen84049561000">{
"auth": {
"identity": {
"methods": [
@ -29,15 +29,15 @@
}
}
}</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
<p id="css_03_0139__en-us_topic_0170917208_p175512042712">After a token is obtained, the <strong id="css_03_0139__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="css_03_0139__en-us_topic_0170917208_b9389950329581">ABCDEFJ....</strong>, <strong id="css_03_0139__en-us_topic_0170917208_b18594742059581">X-Auth-Token: ABCDEFJ....</strong> can be added to a request as follows:</p>
<pre class="screen" id="css_03_0139__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>
<strong id="css_03_0139__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 class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0137.html">Calling APIs</a></div>
</div>
</div>

28
docs/css/api-ref/iam_02_0511.html → docs/css/api-ref/css_03_0140.html
View File

@ -1,17 +1,17 @@
<a name="iam_02_0511"></a><a name="iam_02_0511"></a>
<a name="css_03_0140"></a><a name="css_03_0140"></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 id="body8662426"><div class="section" id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0140__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="css_03_0140__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="css_03_0140__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_0000001554710113.png"></span></div>
<div class="section" id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_section7804143005810"><h4 class="sectiontitle">Response Header</h4><p id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_p384320471837">A response header corresponds to a request header, for example, <span class="parmvalue" id="css_03_0140__en-us_topic_0170917209_parmvalue946210448619"><b>Content-Type</b></span>.</p>
<p id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_p4430113619484"><a href="#css_03_0140__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="css_03_0140__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="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511"><a name="css_03_0140__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="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_image48651610135113" src="en-us_image_0000001554710113.png"></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">{
<div class="section" id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_section034615592583"><h4 class="sectiontitle">Response Body</h4><p id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_p133921631940">A response body is generally returned in a structured format, corresponding to the <strong id="css_03_0140__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="css_03_0140__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="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_screen65818201917">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
@ -23,17 +23,17 @@
{
"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">{
<p id="css_03_0140__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="css_03_0140__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>
<p id="css_03_0140__en-us_topic_0170917209_en-us_topic_0168405765_p1589911464018">In the preceding information, <strong id="css_03_0140__en-us_topic_0170917209_b54237551882">error_code</strong> is an error code, and <strong id="css_03_0140__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 class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0137.html">Calling APIs</a></div>
</div>
</div>

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

@ -1,15 +0,0 @@
<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>