CCE API for v1.23

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>

docs/cce/api-ref/PARAMETERS.txt

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

docs/cce/api-ref/cce_02_0083.html

@@ -0,0 +1,31 @@
+<a name="cce_02_0083"></a><a name="cce_02_0083"></a>
+
+<h1 class="topictitle1">Appendix</h1>
+<div id="body1498621882376"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cce_02_0085.html">Patch Request Method Operation Description</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0086.html">Patch Request Method Operation Example</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0084.html">Status Code</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0250.html">Error Codes</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0341.html">Obtaining a Project ID</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0342.html">Obtaining the Account ID</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0087.html">How to Use ELB in a Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0272.html">API Permissions</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0100.html">Creating a VPC and Subnet</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0101.html">Creating a Key Pair</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cce/api-ref/cce_02_0085.html

@@ -0,0 +1,32 @@
+<a name="cce_02_0085"></a><a name="cce_02_0085"></a>
+
+<h1 class="topictitle1">Patch Request Method Operation Description</h1>
+<div id="body8662426"><p id="cce_02_0085__p57818045">Kubernetes APIs use the HTTP header "Content-Type" to distinguish between patch request method operations.</p>
+<div class="section" id="cce_02_0085__s8aafd6c4a7764494b1ed22d2e4a178bf"><h4 class="sectiontitle">Operation Description</h4><p id="cce_02_0085__p12969758">Currently, three types of patch request method operations are supported:</p>
+<ol id="cce_02_0085__o921247c9b5b5459bbe90e8aa65fbf948"><li id="cce_02_0085__li43917482"><strong id="cce_02_0085__b59713022">JSON Patch, Content-Type: application/json-patch+json</strong><p class="litext" id="cce_02_0085__p546286">According to RFC 6902, JSON patch operations indicate a series of operations performed on resource objects. The following provides an example of the JSON patch operation:</p>
+<pre class="screen" id="cce_02_0085__screen15139080172934">{ 
+     "op": "add", 
+     "path": "/spec/containers/0/image", 
+     "value": "busybox:latest" 
+ }</pre>
+<p class="litext" id="cce_02_0085__p6290207">In the preceding example:</p>
+<ul class="subitemlist" id="cce_02_0085__ul56611863"><li id="cce_02_0085__li39744725">"op" indicates a series of operations performed on resource objects, and it contains the following operations:<p id="cce_02_0085__p27453836153649"><a name="cce_02_0085__li39744725"></a><a name="li39744725"></a>add</p>
+<p id="cce_02_0085__p27472357153649">replace</p>
+<p id="cce_02_0085__p29120671153649">remove (not supported)</p>
+<p id="cce_02_0085__p41602957153649">move (not supported)</p>
+<p id="cce_02_0085__p11675736153649">copy (not supported)</p>
+<p id="cce_02_0085__p32507584153649">test (not supported)</p>
+</li><li id="cce_02_0085__li59424934153635">"path" indicates the path to the to-be-operated resource object.<p id="cce_02_0085__p42176097153633"><a name="cce_02_0085__li59424934153635"></a><a name="li59424934153635"></a>For example, <strong id="cce_02_0085__b62685170153633">/spec/containers/0/image</strong> indicates that the object to be operated is <strong id="cce_02_0085__b8944420153633">spec.containers[0].image</strong>.</p>
+</li><li id="cce_02_0085__li5367678153641">"value" indicates the to-be-modified value.</li></ul>
+</li><li id="cce_02_0085__li45529105"><strong id="cce_02_0085__b7108768">Merge Patch, Content-Type: application/merge-patch+json</strong><p class="litext" id="cce_02_0085__p63978914">According to RFC 7386, merge patch contains some description of a resource object (namely, JSON object). The JSON object is submitted to the server end, and merges with the current object of the server end (that is, replaces the list field of the current resource object) to form a new object.</p>
+</li><li id="cce_02_0085__li14909584"><strong id="cce_02_0085__b67077397">Strategic Merge Patch, Content-Type: application/strategic-merge-patch+json</strong><p id="cce_02_0085__p44169889">Strategic merge patch is used to add legal metadata to API objects, and uses new metadata to determine which list should be merged and which should not. The current metadata is used as the structure labels.</p>
+</li></ol>
+<p id="cce_02_0085__p26961812174213">For more information about the difference between <span class="parmname" id="cce_02_0085__parmname40088177174213"><b>Merge Patch</b></span> and <span class="parmname" id="cce_02_0085__parmname21706447174213"><b>Strategic Merge Patch</b></span>, see <a href="cce_02_0086.html">Patch Request Method Operation Example</a>.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0092.html

@@ -0,0 +1,57 @@
+<a name="cce_02_0092"></a><a name="cce_02_0092"></a>
+
+<h1 class="topictitle1">Cluster Management</h1>
+<div id="body1510711303895"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cce_02_0236.html">Creating a Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0238.html">Reading a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0239.html">Listing Clusters in a Specified Project</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0240.html">Updating a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0241.html">Deleting a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0374.html">Hibernating a Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0375.html">Waking Up a Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0248.html">Obtaining Cluster Certificates</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0359_0.html">Obtaining Cluster Certificates (Deprecated)</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0242.html">Creating a Node</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0243.html">Reading a Specified Node</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0244.html">Listing All Nodes in a Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0245.html">Updating a Specified Node</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0246.html">Deleting a Node</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0247.html">Reading Job Progress</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0347.html">Querying the Access Information of a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0346.html">Modifying the Access Information of a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0354.html">Creating a Node Pool</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0355.html">Querying a Specified Node Pool</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0356.html">Updating a Specified Node Pool</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0269.html">Listing All Node Pools in a Specified Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0357.html">Deleting a Node Pool</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0103.html">APIs</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0100.html

@@ -0,0 +1,19 @@
+<a name="cce_02_0100"></a><a name="cce_02_0100"></a>
+
+<h1 class="topictitle1">Creating a VPC and Subnet</h1>
+<div id="body1515748345548"><div class="section" id="cce_02_0100__en-us_topic_0045969089_section156014348216"><h4 class="sectiontitle">Context</h4><p id="cce_02_0100__en-us_topic_0045969089_p79734714211">To provide a secure and isolated network environment for CCE, create a VPC before creating a cluster.</p>
+<p id="cce_02_0100__en-us_topic_0045969089_p7971347923">If you have already created a VPC, you do not need to create it again.</p>
+</div>
+<div class="section" id="cce_02_0100__en-us_topic_0045969089_section4941460313"><h4 class="sectiontitle">Creating a VPC</h4><ol id="cce_02_0100__en-us_topic_0045969089_ol19422101410317"><li id="cce_02_0100__en-us_topic_0045969089_li184225144316"><span>On the management console, click <strong id="cce_02_0100__en-us_topic_0035200441_b454244915186">Service List</strong>, and choose <span class="menucascade" id="cce_02_0100__en-us_topic_0035200441_menucascade1080773114138"><b><span class="uicontrol" id="cce_02_0100__en-us_topic_0035200441_uicontrol1421800514138">Network</span></b> &gt; <b><span class="uicontrol" id="cce_02_0100__en-us_topic_0035200441_uicontrol6085318214138">Virtual Private Cloud</span></b></span> to launch the VPC console.</span></li><li id="cce_02_0100__en-us_topic_0045969089_li84231414032"><span>On the VPC console, click <strong id="cce_02_0100__b1827614186331">Create VPC</strong>.</span></li><li id="cce_02_0100__li10487137378"><span>The created VPC is displayed in the list. Click its name and obtain the VPC ID, which will be required in <a href="cce_02_0236.html">Creating a Cluster</a>.</span><p><div class="fignone" id="cce_02_0100__fig12864043141413"><span class="figcap"><b>Figure 1 </b>Obtaining the VPC ID</span><br><span><img id="cce_02_0100__image163492731514" src="en-us_image_0233731209.png"></span></div>
+</p></li></ol>
+</div>
+<div class="section" id="cce_02_0100__section18343153916445"><h4 class="sectiontitle">Creating a Subnet</h4><ol id="cce_02_0100__ol03761739144410"><li id="cce_02_0100__li337653904415"><span>On the management console, click <strong id="cce_02_0100__b1040331317396">Service List</strong>, and choose <span class="menucascade" id="cce_02_0100__menucascade1340681310393"><b><span class="uicontrol" id="cce_02_0100__uicontrol1640417131391">Network</span></b> &gt; <b><span class="uicontrol" id="cce_02_0100__uicontrol1140514134399">Virtual Private Cloud</span></b></span> to launch the VPC console.</span></li><li id="cce_02_0100__en-us_topic_0045969216_li1694625817317"><span>In the navigation pane, choose <strong id="cce_02_0100__b53366327141">Subnets</strong>. On the displayed page, click <span class="uicontrol" id="cce_02_0100__en-us_topic_0038483022_uicontrol2834591514844"><b>Create Subnets</b></span>.</span></li><li id="cce_02_0100__li537663919441"><span>After the subnet is created, click its name to obtain the network ID, which will be required in <a href="cce_02_0236.html">Creating a Cluster</a>.</span><p><div class="fignone" id="cce_02_0100__fig10205823121619"><span class="figcap"><b>Figure 2 </b>Obtaining the network ID of a subnet</span><br><span><img id="cce_02_0100__image0192639141618" src="en-us_image_0233732535.png"></span></div>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0101.html

@@ -0,0 +1,17 @@
+<a name="cce_02_0101"></a><a name="cce_02_0101"></a>
+
+<h1 class="topictitle1">Creating a Key Pair</h1>
+<div id="body1515748346669"><div class="section" id="cce_02_0101__en-us_topic_0045969216_section10587321231"><h4 class="sectiontitle">Context</h4><p id="cce_02_0101__en-us_topic_0045969216_p354814445312">Create a key pair before you create a container cluster. Key pairs are used for user identity authentication upon login to a node.</p>
+<p id="cce_02_0101__en-us_topic_0045969216_p65481044531">If you have already created a key pair, you do not need to create it again.</p>
+</div>
+<div class="section" id="cce_02_0101__en-us_topic_0045969216_section39473361038"><h4 class="sectiontitle">Procedure</h4><ol id="cce_02_0101__en-us_topic_0045969216_ol294555818314"><li id="cce_02_0101__en-us_topic_0045969216_li109454583319"><span>On the management console, click <strong id="cce_02_0101__en-us_topic_0038483022_b59459706151832">Service List</strong>, and choose <strong id="cce_02_0101__en-us_topic_0038483022_b55795008164339">Computing</strong> &gt; <span class="uicontrol" id="cce_02_0101__en-us_topic_0038483022_uicontrol892165112141"><b>Elastic Cloud Server</b></span> to launch the ECS console.</span></li><li id="cce_02_0101__en-us_topic_0045969216_li1694625817317"><span>In the navigation pane, choose <span class="uicontrol" id="cce_02_0101__en-us_topic_0038483022_uicontrol169211251161411"><b>Key Pair</b></span>.</span></li><li id="cce_02_0101__en-us_topic_0045969216_li12947115815318"><span>Click <span class="uicontrol" id="cce_02_0101__en-us_topic_0038483022_uicontrol2834591514844"><b>Create Key Pair</b></span>.</span></li><li id="cce_02_0101__en-us_topic_0045969216_li23695520208"><span>Enter a key pair name and click <strong id="cce_02_0101__b122125619214">OK</strong>.</span><p><p id="cce_02_0101__en-us_topic_0045969216_p1094925818314">The key pair name must be 1 to 64 characters long. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
+</p></li><li id="cce_02_0101__en-us_topic_0045969216_li7949358030"><span>In the displayed dialog box, click <span class="uicontrol" id="cce_02_0101__en-us_topic_0038483022_uicontrol392225118142"><b>OK</b></span>.</span><p><p id="cce_02_0101__en-us_topic_0045969216_p177411432143414">A key file in the <strong id="cce_02_0101__b176071524162210">.pem</strong> format is generated and automatically saved to the default directory on your local computer.</p>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0103.html

@@ -0,0 +1,17 @@
+<a name="cce_02_0103"></a><a name="cce_02_0103"></a>
+
+<h1 class="topictitle1">APIs</h1>
+<div id="body1515748345345"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cce_02_0348.html">API Version Query</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0092.html">Cluster Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0320.html">Add-on Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="quota_lifecycle_management.html">Quota Management</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cce/api-ref/cce_02_0271.html

@@ -0,0 +1,30 @@
+<a name="cce_02_0271"></a><a name="cce_02_0271"></a>
+
+<h1 class="topictitle1">How to Obtain Parameters in the API URI</h1>
+<div id="body1533088268262"><div class="section" id="cce_02_0271__section16020367542"><h4 class="sectiontitle">project_id</h4><ol id="cce_02_0271__ol123315489568"><li id="cce_02_0271__li1039304545815"><span>Log in to the CCE console, click the username in the upper right corner, and select <strong id="cce_02_0271__b540381312565">My Credentials</strong>.</span></li><li id="cce_02_0271__li23312482565"><span>On the <strong id="cce_02_0271__b12741349185614">Project</strong><strong id="cce_02_0271__b1750041474712">s</strong> tab page, obtain the project ID of the corresponding region.</span><p><div class="fignone" id="cce_02_0271__fig161112910194"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="cce_02_0271__image511159141915" src="en-us_image_0203982493.png" title="Click to enlarge" class="imgResize"></span></div>
+</p></li></ol>
+</div>
+<div class="section" id="cce_02_0271__section159011367564"><h4 class="sectiontitle">cluster_id</h4><ol id="cce_02_0271__ol1515319226320"><li id="cce_02_0271__li13311434932"><span>Log in to the CCE console, and choose <strong id="cce_02_0271__b464411965716">Resource Management</strong> &gt; <strong id="cce_02_0271__b6191238155719">Clusters</strong> from the navigation pane.</span></li><li id="cce_02_0271__li6153192210318"><span>Click the name of the created cluster. The cluster details page is displayed. Obtain the cluster ID.</span><p><div class="fignone" id="cce_02_0271__fig1148731210177"><span class="figcap"><b>Figure 2 </b>Obtaining the cluster ID</span><br><span><img id="cce_02_0271__image1657918403187" src="en-us_image_0233732613.png"></span></div>
+</p></li></ol>
+</div>
+<div class="section" id="cce_02_0271__section38161013195615"><h4 class="sectiontitle">node_id</h4><ol id="cce_02_0271__ol18696153964"><li id="cce_02_0271__li11696731068"><span>Log in to the CCE console, and choose <strong id="cce_02_0271__b470516411010">Resource Management</strong> &gt; <strong id="cce_02_0271__b9158191019010">Nodes</strong> from the navigation pane.</span></li><li id="cce_02_0271__li128261161877"><span>Click the node name to go to the node details page and obtain the node ID.</span><p><div class="fignone" id="cce_02_0271__fig975912216193"><span class="figcap"><b>Figure 3 </b>Obtaining the node ID</span><br><span><img id="cce_02_0271__image115111613494" src="en-us_image_0279177365.png" title="Click to enlarge" class="imgResize"></span></div>
+</p></li></ol>
+</div>
+<div class="section" id="cce_02_0271__section36041618185611"><h4 class="sectiontitle">job_id</h4><ol id="cce_02_0271__ol157391011153720"><li id="cce_02_0271__li1873941113377"><span>Log in to the CCE console, and choose <strong id="cce_02_0271__b1512818592003">Resource Management</strong> &gt; <strong id="cce_02_0271__b095017361016">Clusters</strong> or choose <strong id="cce_02_0271__b1736316310217">Resource Management</strong> &gt; <strong id="cce_02_0271__b105656611216">Nodes</strong> from the navigation pane.</span></li><li id="cce_02_0271__li473991113716"><span>For example, on the <strong id="cce_02_0271__b17240150352">Clusters</strong> page, click the status of the cluster that is being created. The cluster creation job details page is displayed.</span></li><li id="cce_02_0271__li35171345122913"><span>Obtain the job ID.</span><p><p id="cce_02_0271__p1866165772912">If you are using Google Chrome, press <strong id="cce_02_0271__b11908183816715">F12</strong>. On the pane displayed on the right, click the <strong id="cce_02_0271__b163531511171015">Network</strong> tab. Enter <strong id="cce_02_0271__b14159172971017">jobs</strong> in the <strong id="cce_02_0271__b144024321109">Filter</strong> text box to filter the job list. Select a job from the list on the left and click <strong id="cce_02_0271__b15411026191111">Preview</strong>. The UID field indicates the UID of the job.</p>
+<div class="fignone" id="cce_02_0271__fig49321312222"><span class="figcap"><b>Figure 4 </b>Obtaining the job ID</span><br><span><img id="cce_02_0271__image3938131224" src="en-us_image_0203982464.png" title="Click to enlarge" class="imgResize"></span></div>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+
+
+<script language="JavaScript">
+<!--
+image_size('.imgResize');
+var msg_imageMax = "view original image";
+var msg_imageClose = "close";
+//--></script>

docs/cce/api-ref/cce_02_0320.html

@@ -0,0 +1,25 @@
+<a name="cce_02_0320"></a><a name="cce_02_0320"></a>
+
+<h1 class="topictitle1">Add-on Management</h1>
+<div id="body1595231617722"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cce_02_0322.html">Installing an Add-on Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0321.html">Reading Add-on Templates</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0323.html">Updating an Add-on Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0324.html">Deleting an Add-on Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0325.html">Reading an Add-on Instance</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0326.html">Listing Add-on Instances</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0103.html">APIs</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0340.html

@@ -0,0 +1,12 @@
+<a name="cce_02_0340"></a><a name="cce_02_0340"></a>
+
+<h1 class="topictitle1">Kubernetes APIs</h1>
+<div id="body1562744391454"><p id="cce_02_0340__p8060118"></p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="kubernetesapi.html">Overview</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cce/api-ref/cce_02_0341.html

@@ -0,0 +1,50 @@
+<a name="cce_02_0341"></a><a name="cce_02_0341"></a>
+
+<h1 class="topictitle1">Obtaining a Project ID</h1>
+<div id="body1563873350768"><div class="section" id="cce_02_0341__section1691341861315"><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="cce_02_0341__p996711364120">You can obtain the project ID by calling the API <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845625.html" target="_blank" rel="noopener noreferrer">used to query project information based on the specified criteria</a>.</p>
+<p id="cce_02_0341__p177571552165618">The API used to obtain a project ID is <strong id="cce_02_0341__b79632047347">GET https://</strong><em id="cce_02_0341__i1196416473412">{Endpoint}</em><strong id="cce_02_0341__b79669471643">/v3/projects</strong>, where <em id="cce_02_0341__i596713471441">{Endpoint}</em> indicates the IAM endpoint. You can obtain the IAM endpoint from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
+<p id="cce_02_0341__p1461198134114">The following is an example response. The value of <strong id="cce_02_0341__b011212141351">id</strong> in the <strong id="cce_02_0341__b811317141755">projects</strong> field is the project ID.</p>
+<pre class="screen" id="cce_02_0341__screen676419149446">{
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "xxxxxxxx",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}</pre>
+</div>
+<div class="section" id="cce_02_0341__section14547182915611"><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><p id="cce_02_0341__p8112855194115">A project ID is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
+<ol id="cce_02_0341__ol18261426154413"><li id="cce_02_0341__li13261162614443"><span>Log in to the management console.</span></li><li id="cce_02_0341__li15262182617448"><span>Click the username and choose <strong id="cce_02_0341__b44121123226">My Credential</strong><strong id="cce_02_0341__b15819624184212">s</strong> from the drop-down list.</span><p><p id="cce_02_0341__p136772519449">On the <strong id="cce_02_0341__b12195162342215">My Credentials</strong> page, view project IDs in the project list.</p>
+<div class="p" id="cce_02_0341__p1189841611813"><div class="fignone" id="cce_02_0341__fig555610358190"><span class="figcap"><b>Figure 1 </b>Obtaining the Project ID</span><br><span><img id="cce_02_0341__image35566355192" src="en-us_image_0203982368.png" title="Click to enlarge" class="imgResize"></span></div>
+</div>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+
+
+<script language="JavaScript">
+<!--
+image_size('.imgResize');
+var msg_imageMax = "view original image";
+var msg_imageClose = "close";
+//--></script>

docs/cce/api-ref/cce_02_0342.html

@@ -0,0 +1,21 @@
+<a name="cce_02_0342"></a><a name="cce_02_0342"></a>
+
+<h1 class="topictitle1">Obtaining the Account ID</h1>
+<div id="body1563873350768"><p id="cce_02_0342__p8112855194115">An account ID is required for some URLs when an API is called. To obtain an account ID, perform the following operations:</p>
+<ol id="cce_02_0342__ol03606362380"><li id="cce_02_0342__li73601236123816"><span>Sign up and log in to the management console.</span></li><li id="cce_02_0342__li103601364385"><span>Click the username in the upper right corner and choose <strong id="cce_02_0342__b3388125915217">My Credentials</strong> from the drop-down list.</span><p><p id="cce_02_0342__p136772519449">On the <span class="uicontrol" id="cce_02_0342__uicontrol1278065819254"><b>My Credentials</b></span> page, view account IDs in the project list.</p>
+<div class="fignone" id="cce_02_0342__fig102417619133"><span class="figcap"><b>Figure 1 </b>Obtaining the Account ID</span><br><span><img id="cce_02_0342__image17165494143" src="en-us_image_0233731004.png" title="Click to enlarge" class="imgResize"></span></div>
+</p></li></ol>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0083.html">Appendix</a></div>
+</div>
+</div>
+
+
+<script language="JavaScript">
+<!--
+image_size('.imgResize');
+var msg_imageMax = "view original image";
+var msg_imageClose = "close";
+//--></script>

docs/cce/api-ref/cce_02_0344.html

@@ -0,0 +1,24 @@
+<a name="cce_02_0344"></a><a name="cce_02_0344"></a>
+
+<h1 class="topictitle1">API Usage Guidelines</h1>
+<div id="body1569373330500"><p id="cce_02_0344__p694217218">Cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="cce_02_0344__i8449151122912">https://Endpoint/uri</em>. In the URL, <em id="cce_02_0344__i114521051192914">uri</em> indicates the resource path, that is, the API access path.</p>
+<p id="cce_02_0344__p4816427810259">Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="cce_02_0344__b1025950229154127">Application/json</strong>.</p>
+<ul id="cce_02_0344__ul13319112316819"><li id="cce_02_0344__li43190231280">The URL of APIs described in <a href="cce_02_0092.html">Cluster Management</a> is in the format of <em id="cce_02_0344__i1611453113614">https://Endpoint/uri</em>. In the URL, uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li11319132310812">The URL of Kubernetes-native APIs described in <a href="cce_02_0320.html">Add-on Management</a> and <a href="cce_02_0340.html">Kubernetes APIs</a> is in the format of <strong id="cce_02_0344__b1319152318817">https://{clusterid}.Endpoint/uri</strong>. In the URL, {clusterid} indicates a cluster ID, and uri indicates the resource path, that is, the API access path. Use X-Auth-Token as a header.</li><li id="cce_02_0344__li251551565014">The URL of Kubernetes-native APIs is in the format of <strong id="cce_02_0344__b1760920115129">https://{publicip}:5443/uri</strong>. In the URL, <strong id="cce_02_0344__b166093113127">{publicip}</strong> indicates EIP of the cluster, and <strong id="cce_02_0344__b146096111217">uri</strong> indicates the resource path, that is, the API access path. Use X-Remote-User or Authorization as a header.<div class="p" id="cce_02_0344__p1887502514125">Before using X-Remote-User as a header, obtain the required certificate in advance. Two types of certificates are supported:<ul id="cce_02_0344__ul1498525216115"><li id="cce_02_0344__li594175418416">Self-owned certificate uploaded during cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0028.html" target="_blank" rel="noopener noreferrer">Creating a Cluster</a>.<p id="cce_02_0344__p519555315"><span><img id="cce_02_0344__image20959154315152" src="en-us_image_0000001121602072.png" title="Click to enlarge" class="imgResize"></span></p>
+</li><li id="cce_02_0344__li119868526113">Cluster certificate generated and downloaded after cluster creation. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0175.html" target="_blank" rel="noopener noreferrer">Obtaining a Cluster Certificate</a>.<p id="cce_02_0344__p2297165721520"><span><img id="cce_02_0344__image97354579155" src="en-us_image_0227096557.png" title="Click to enlarge" class="imgResize"></span></p>
+</li></ul>
+</div>
+</li></ul>
+<p id="cce_02_0344__p156196428514">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
+<p id="cce_02_0344__p1928010407415">CCE provides two methods to authenticate requests for calling an API: token and AK/SK. Select an authentication method based on actual requirements. If token-based authentication is used, you can call service APIs by using either of the following methods after obtaining a token:</p>
+<ul id="cce_02_0344__ul4552184012514"><li id="cce_02_0344__li17245131773918">Method 1: Add <strong id="cce_02_0344__b16119186394">X-Auth-Token</strong> to the request header and set <strong id="cce_02_0344__b9161823912">X-Auth-Token: ${token}</strong> with the obtained IAM token.</li><li id="cce_02_0344__li1387183419395">Method 2: Add <strong id="cce_02_0344__b1057022318263">Authorization</strong> to the request header and set <strong id="cce_02_0344__b6248243183920">Authorization: Bearer ${token}</strong> with the obtained IAM token or token from Kubernetes service account.</li><li id="cce_02_0344__li89714112401">Method 3: Add <strong id="cce_02_0344__b43089717408">X-Remote-User</strong> to the request header and set <strong id="cce_02_0344__b5208739122619">X-Remote-User</strong>: <strong id="cce_02_0344__b17930741152615">user</strong> with a valid certificate.</li></ul>
+<div class="note" id="cce_02_0344__note162803401947"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0344__p107403334488">Method 3 requires that the CA root certificate must has been uploaded before you create a cluster on the CCE console. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual2/cce/cce_01_0085.html" target="_blank" rel="noopener noreferrer">Cluster Management Permission Control</a>.</p>
+</div></div>
+</div>
+
+
+<script language="JavaScript">
+<!--
+image_size('.imgResize');
+var msg_imageMax = "view original image";
+var msg_imageClose = "close";
+//--></script>

docs/cce/api-ref/cce_02_0348.html

@@ -0,0 +1,17 @@
+<a name="cce_02_0348"></a><a name="cce_02_0348"></a>
+
+<h1 class="topictitle1">API Version Query</h1>
+<div id="body1569402041070"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cce_02_0349.html">Querying All API Versions</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cce_02_0350.html">Querying Information About API v3</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0103.html">APIs</a></div>
+</div>
+</div>
+

docs/cce/api-ref/cce_02_0350.html

@@ -0,0 +1,74 @@
+<a name="cce_02_0350"></a><a name="cce_02_0350"></a>
+
+<h1 class="topictitle1">Querying Information About API v3</h1>
+<div id="body1569402041071"><div class="section" id="cce_02_0350__se2e066518e534a58a022d07edfbd4a3f"><h4 class="sectiontitle">Function</h4><p id="cce_02_0350__p17356328151612">This API is used to query information about API v3.</p>
+</div>
+<div class="section" id="cce_02_0350__s9ba079db556c4be7998a917fb1004946"><h4 class="sectiontitle">URI</h4><p id="cce_02_0350__p299313459201">GET /v3</p>
+</div>
+<div class="section" id="cce_02_0350__sfa7f4cd949044a198e9f9a0518344e7f"><h4 class="sectiontitle">Request</h4><p id="cce_02_0350__en-us_topic_0102499074_p44582032">N/A</p>
+</div>
+<div class="section" id="cce_02_0350__s2eb2c416e8d344619301671f0baffc10"><h4 class="sectiontitle">Response</h4><p id="cce_02_0350__a39163766c1764404a83f5a8ac99fcdaa"><strong id="cce_02_0350__en-us_topic_0102499074_b2611581026">Response parameters:</strong></p>
+<p id="cce_02_0350__en-us_topic_0102499074_p46145810219"><a href="#cce_02_0350__table986610460219">Table 1</a> describes the response parameters.</p>
+
+<div class="tablenoborder"><a name="cce_02_0350__table986610460219"></a><a name="table986610460219"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0350__table986610460219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response parameters</caption><thead align="left"><tr id="cce_02_0350__row3867846192120"><th align="left" class="cellrowborder" valign="top" width="20.392039203920394%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0350__p1086764618217">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="21.23212321232123%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0350__p10867184611219">Type</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="58.37583758375837%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0350__p08676468210">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="cce_02_0350__row20867124611213"><td class="cellrowborder" valign="top" width="20.392039203920394%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0350__p2086715463216">versions</p>
+</td>
+<td class="cellrowborder" valign="top" width="21.23212321232123%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0350__p178672046192113">Array</p>
+</td>
+<td class="cellrowborder" valign="top" width="58.37583758375837%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0350__p129231114292">API version list.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<p id="cce_02_0350__a5ed7aae83cbb4cc5b8df5ad768328381"><strong id="cce_02_0350__en-us_topic_0102499074_b476113439112">Example response:</strong></p>
+<pre class="screen" id="cce_02_0350__screen19881850105612">{
+    "versions": [
+        {
+            "id": "v3",
+            "links": [
+                {
+                    "href": "https://container.eu-de.***.t-systems.com/v3",
+                    "rel": "self"
+                }
+            ],
+            "min_version": "",
+            "status": "CURRENT",
+            "updated": "2018-09-15T00:00:00Z",
+            "version": ""
+        }
+    ]
+}</pre>
+</div>
+<div class="section" id="cce_02_0350__sf5b489c1f62d4d909a30f683dc319340"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0350__a98afa956aea042c8843852e6d5c16e4e"><a href="#cce_02_0350__t8935d48c19714740abd2e888a39be462">Table 2</a> describes the status code of the API.</p>
+
+<div class="tablenoborder"><a name="cce_02_0350__t8935d48c19714740abd2e888a39be462"></a><a name="t8935d48c19714740abd2e888a39be462"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0350__t8935d48c19714740abd2e888a39be462" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="cce_02_0350__re974d044247140b79c213fc577abe0ae"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0350__a9465a1e476c948e4b40095738594daf3">Status Code</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0350__a88c1c2f27be844b7b79dad7e1a5b06f2">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="cce_02_0350__rb535f7f0f62341f7b636e54ce399b342"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0350__ad1d3b647d2f746cc88b562f3eb1ff493">200</p>
+</td>
+<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0350__a78dc15895d744bb9affa7db6de6e02e5">The query operation is successful.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<p id="cce_02_0350__en-us_topic_0102499074_p347213715512">For details about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0348.html">API Version Query</a></div>
+</div>
+</div>
+