CCI API initial upload

Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>

docs/cci/api-ref/PARAMETERS.txt

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

docs/cci/api-ref/cci_02_0003.html

@@ -0,0 +1,57 @@
+<a name="cci_02_0003"></a><a name="cci_02_0003"></a>
+
+<h1 class="topictitle1">Authentication</h1>
+<div id="body8662426"><div class="p" id="cci_02_0003__en-us_topic_0121671869_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:<ul id="cci_02_0003__en-us_topic_0121671869_ul38195410143846"><li id="cci_02_0003__en-us_topic_0121671869_li61384639143846">AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.</li><li id="cci_02_0003__en-us_topic_0121671869_li8214375143846">Token authentication: Requests are authenticated using tokens.</li></ul>
+</div>
+<div class="section" id="cci_02_0003__en-us_topic_0121671869_section5887143815518"><h4 class="sectiontitle">AK/SK Authentication</h4><div class="note" id="cci_02_0003__en-us_topic_0121671869_note26801820183918"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cci_02_0003__en-us_topic_0121671869_p12680102053918">AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.</p>
+</div></div>
+<p id="cci_02_0003__en-us_topic_0121671869_p171211559122516">In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.</p>
+<ul id="cci_02_0003__en-us_topic_0121671869_ul9783543561"><li id="cci_02_0003__en-us_topic_0121671869_li8787541560">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</li><li id="cci_02_0003__en-us_topic_0121671869_li47917548569">SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</li></ul>
+<p id="cci_02_0003__en-us_topic_0121671869_p1866949103516">In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK. </p>
+<div class="note" id="cci_02_0003__en-us_topic_0121671869_note1225618420315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cci_02_0003__en-us_topic_0121671869_p1325674263111">The signing SDK is only used for signing requests and is different from the SDKs provided by services.</p>
+</div></div>
+</div>
+<div class="section" id="cci_02_0003__en-us_topic_0121671869_section2417768214391"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="cci_02_0003__en-us_topic_0121671869_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cci_02_0003__en-us_topic_0121671869_p1254514271026">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
+</div></div>
+<p id="cci_02_0003__en-us_topic_0121671869_p24084172174">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining User Token</a> API.</p>
+<p id="cci_02_0003__en-us_topic_0121671869_p18703477214">IMS is a project-level service. When you call the API, set <strong id="cci_02_0003__en-us_topic_0121671869_b1442622113014">auth.scope</strong> in the request body to <strong id="cci_02_0003__en-us_topic_0121671869_b9433321123019">project</strong>.</p>
+<p id="cci_02_0003__en-us_topic_0121671869_p5296182518188"></p>
+<pre class="screen" id="cci_02_0003__en-us_topic_0121671869_screen1830175615316">{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "<em id="cci_02_0003__en-us_topic_0121671869_i315217719194"><strong id="cci_02_0003__en-us_topic_0121671869_b14500116161919">username</strong></em>",   // IAM user name
+                    "password": <em id="cci_02_0003__en-us_topic_0121671869_i15727114912154"><strong id="cci_02_0003__en-us_topic_0121671869_b87274494151">$ADMIN_PASS</strong></em>,  //IAM user password. You are advised to store it in ciphertext in the configuration file or an environment variable and decrypt it when needed to ensure security.
+                    "domain": {
+                        "name": "<em id="cci_02_0003__en-us_topic_0121671869_i1560271681911"><strong id="cci_02_0003__en-us_topic_0121671869_b17173191614194">domainname</strong></em>"  // Name of the domain to which the IAM user belongs
+                    }
+                }
+            }
+        },
+        <strong id="cci_02_0003__en-us_topic_0121671869_b28781733191612">"scope": {</strong>
+            <strong id="cci_02_0003__en-us_topic_0121671869_b18664134414161">"project": {</strong>
+                <strong id="cci_02_0003__en-us_topic_0121671869_b145484513165">"name": "<em id="cci_02_0003__en-us_topic_0121671869_i4548165119166">xxxxxxxx</em>"</strong>    // Project name
+            <strong id="cci_02_0003__en-us_topic_0121671869_b5551165531613">}</strong>
+        <strong id="cci_02_0003__en-us_topic_0121671869_b18740155861611">}</strong>
+    }
+}</pre>
+<p id="cci_02_0003__en-us_topic_0121671869_p9691122114266">After a token is obtained, the <strong id="cci_02_0003__en-us_topic_0121671869_b147976273481">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 <span class="parmvalue" id="cci_02_0003__en-us_topic_0121671869_parmvalue36546471362"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="cci_02_0003__en-us_topic_0121671869_parmvalue10655144717611"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
+<div class="codecoloring" codetype="Java" id="cci_02_0003__en-us_topic_0121671869_screen11189101154015"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{endpoint}}/v3/auth/projects</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span><span class="w"> </span><span class="n">application</span><span class="o">/</span><span class="n">json</span>
+<span class="n">X</span><span class="o">-</span><span class="n">Auth</span><span class="o">-</span><span class="n">Token</span><span class="p">:</span><span class="w"> </span><span class="n">ABCDEFJ</span><span class="p">....</span>
+</pre></div></td></tr></table></div>
+</div>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0009.html">Calling APIs</a></div>
+</div>
+</div>
+

docs/cci/api-ref/cci_02_0009.html

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

docs/cci/api-ref/cci_02_0011.html

@@ -0,0 +1,85 @@
+<a name="cci_02_0011"></a><a name="cci_02_0011"></a>
+
+<h1 class="topictitle1">Getting Started</h1>
+<div id="body1509018940525"><div class="section" id="cci_02_0011__section142673304107"><h4 class="sectiontitle">Overview</h4><p id="cci_02_0011__p1188213511416">You can call APIs to create a pod. An Nginx image is used as an example to show how you can create a pod.</p>
+<p id="cci_02_0011__p299212244251">The Nginx image is from the open-source image center, and the container uses 1 vCPU and 2 GiB of memory.</p>
+<p id="cci_02_0011__p17275144331218">For details about how to call APIs, see <a href="cci_02_0009.html">Calling APIs</a>.</p>
+</div>
+<div class="section" id="cci_02_0011__section114621034191316"><h4 class="sectiontitle">Procedure</h4><ol id="cci_02_0011__ol1847673481313"><li id="cci_02_0011__li19475133411130">Call the API described in <a href="createCciV2Namespace.html">Creating a Namespace</a> to create a namespace.</li><li id="cci_02_0011__li164755345132">Call the API described in <a href="createYangtseV2NamespacedNetwork.html">Creating a Network</a> to create a network, and associate the network with a VPC and subnet.</li><li id="cci_02_0011__li147613491318">Call the API described in <a href="createCciV2NamespacedPod.html">Creating a Pod</a> to create an Nginx pod.</li></ol>
+</div>
+<div class="section" id="cci_02_0011__section680742610404"><h4 class="sectiontitle">Creating an Nginx Pod</h4><ol id="cci_02_0011__ol2092913277172"><li id="cci_02_0011__li92724315583"><span>Call the API described in <a href="createCciV2Namespace.html">Creating a Namespace</a> to create a namespace.</span><p><pre class="screen" id="cci_02_0011__screen17329324121211">{
+  "apiVersion": "cci/v2",
+  "kind": "Namespace",
+  "metadata": {
+    "name": "namespace-test"
+  }
+}</pre>
+<p id="cci_02_0011__p1030175113357">You must specify the following parameters:</p>
+<ul id="cci_02_0011__ul4612528173616"><li id="cci_02_0011__li761212813368"><strong id="cci_02_0011__b13796184222">name</strong>: namespace name.</li></ul>
+</p></li><li id="cci_02_0011__li793342619596"><span>Call the API described in <a href="createYangtseV2NamespacedNetwork.html">Creating a Network</a> to create a network, and associate the network with a VPC and subnet.</span><p><pre class="screen" id="cci_02_0011__screen117365151516">{
+  "apiVersion": "yangtse/v2",
+  "kind": "Network",
+  "metadata": {
+    "annotations": {
+      "yangtse.io/domain-id": "51ed88507a244b6eb36270c0250fcc96",
+      "yangtse.io/project-id": "a81f079abca74e83b47af9a586048b24"
+    },
+    "name": "test-network",
+    "namespace": "namespace-test"
+  },
+  "spec": {
+    "networkType": "underlay_neutron",
+    "securityGroups": [
+      "470b6a8f-612e-4284-a788-c6900ac32fce"
+    ],
+    "subnets": [
+      {
+        "subnetID": "c6dd31e3-d217-4b31-bb60-eb30322c75b8"
+      }
+    ]
+  }
+}</pre>
+<p id="cci_02_0011__p1991516010460">You must specify the following parameters:</p>
+<ul id="cci_02_0011__ul1521851864612"><li id="cci_02_0011__li1421841820464"><strong id="cci_02_0011__b133251752102519">name</strong>: name of a network object.</li><li id="cci_02_0011__li10958181914465"><strong id="cci_02_0011__b181961551804">securityGroups</strong>: security group ID, which can be obtained on the <strong id="cci_02_0011__b3936119917"></strong><strong id="cci_02_0011__b693619191116"></strong><strong id="cci_02_0011__b1268491142219">Security Groups</strong> page.</li><li id="cci_02_0011__li2689143044612"><strong id="cci_02_0011__b638811419286">yangtse.io/domain-id</strong>: account ID, which can be obtained by following the procedure in <a href="cci_02_1002.html">Obtaining an Account ID</a>.</li><li id="cci_02_0011__li14426143814467"><strong id="cci_02_0011__b19305843294">yangtse.io/project-id</strong>: project ID, which can be obtained by following the procedure in <a href="cci_02_1001.html">Obtaining a Project ID</a>.</li><li id="cci_02_0011__li570204120491"><strong id="cci_02_0011__b126331235175219">subnetID</strong>: ID of the subnet in the VPC, which can be obtained on the VPC console or by calling the API for querying subnets.</li></ul>
+</p></li><li id="cci_02_0011__li567211611164"><span>Call the API described in <a href="createCciV2NamespacedPod.html">Creating a Pod</a> to create an Nginx pod.</span><p><p id="cci_02_0011__p1785127151612">In this example, a pod whose name is <strong id="cci_02_0011__b1168112371361">nginx</strong> and specifications are set to 1 vCPU and 2 GiB of memory will be created from the open-source image nginx:stable-alpine-perl. After the API is called, CCI creates a container running nginx.</p>
+<p id="cci_02_0011__p17651304562"></p>
+<p id="cci_02_0011__p12542085615"></p>
+<pre class="screen" id="cci_02_0011__screen263102815410">{
+  "apiVersion": "cci/v2",
+  "kind": "Pod",
+  "metadata": {
+    "name": "nginx"
+  },
+  "spec": {
+    "containers": [
+      {
+        "image": "nginx:stable-alpine-perl",
+        "name": "container-0",
+        "resources": {
+          "limits": {
+            "cpu": "1",
+            "memory": "2Gi"
+          },
+          "requests": {
+            "cpu": "1",
+            "memory": "2Gi"
+          }
+        }
+      }
+    ],
+    "imagePullSecrets": [
+      {
+        "name": "imagepull-secret"
+      }
+    ]
+  }
+}</pre>
+<p id="cci_02_0011__p158031145154217">You must specify the following parameters:</p>
+<ul id="cci_02_0011__ul28031645154218"><li id="cci_02_0011__li780354515427"><strong id="cci_02_0011__b7817191091018">name</strong>: pod name</li><li id="cci_02_0011__li17803174512426"><strong id="cci_02_0011__b194759232101">containers</strong>: container information<ul id="cci_02_0011__ul1080344515422"><li id="cci_02_0011__li88038459427"><strong id="cci_02_0011__b1968193371015">image</strong>: image used to create containers</li><li id="cci_02_0011__li85149165467">name: container name</li><li id="cci_02_0011__li78031745174212"><strong id="cci_02_0011__b13171115931018">resources.limits</strong>: resource limits for a container. The resources used by a container cannot exceed the limits.</li><li id="cci_02_0011__li67391753465"><strong id="cci_02_0011__b15837143118119">resources.requests</strong>: resources requested by a container</li></ul>
+</li></ul>
+<p id="cci_02_0011__p1280312455426">After the pod is created, you can view it on the CCI console.</p>
+<p id="cci_02_0011__p5803945104215"><span><img id="cci_02_0011__image18777181420403" src="en-us_image_0000001874007888.png"></span></p>
+</p></li></ol>
+</div>
+</div>
+

docs/cci/api-ref/cci_02_0067.html

@@ -0,0 +1,23 @@
+<a name="cci_02_0067"></a><a name="cci_02_0067"></a>
+
+<h1 class="topictitle1">Appendix</h1>
+<div id="body1498621882376"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="pro_ys.html">Notes and Constraints</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="devg_na.html">Namespace and Network</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cci_02_0068.html">Status Codes</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="ErrorCode.html">Error Codes</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cci_02_1001.html">Obtaining a Project ID</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cci_02_1002.html">Obtaining an Account ID</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cci_02_1003.html">Obtaining a Container Image Address</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cci/api-ref/cci_02_0081.html

@@ -0,0 +1,23 @@
+<a name="cci_02_0081"></a><a name="cci_02_0081"></a>
+
+<h1 class="topictitle1">Introduction</h1>
+<div id="body1559725665165"><p id="cci_02_0081__p12450194413815">This topic describes fine-grained permissions management for your CCI. If your account does not need individual IAM users, you may skip this topic.</p>
+<p id="cci_02_0081__p3667300181">You need to add a user to one or more groups, and assign permissions policies to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user can perform specified operations on CCI based on the permissions. </p>
+<p id="cci_02_0081__p1899510162510">You can grant users their permissions by using roles and policies. Roles are a type of service-based, coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
+<div class="note" id="cci_02_0081__note6366144684"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cci_02_0081__p154172117296">If you want to allow or deny the access to an API, fine-grained authorization is a good choice.</p>
+</div></div>
+<p id="cci_02_0081__p245111441980">If you use IAM users in your account to call an API, the IAM users must be granted the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries pods using an API, the user must have been granted permissions that allow the <strong id="cci_02_0081__b15372134813448">CCI:namespaceSubResource:Get</strong> action.</p>
+<div class="section" id="cci_02_0081__section534924411819"><h4 class="sectiontitle">Supported Actions</h4><p id="cci_02_0081__p3420193535311">CCI provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
+<ul id="cci_02_0081__ul16451204417810"><li id="cci_02_0081__li16451744887">Permission: A statement in a policy that allows or denies certain operations.</li><li id="cci_02_0081__li204515443815">APIs: REST APIs that can be called in a custom policy.</li><li id="cci_02_0081__li14111949191912">Actions: Added to a custom policy to control permissions for specific operations.</li><li id="cci_02_0081__li49812232011">IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. </li></ul>
+<div class="note" id="cci_02_0081__note14458114184310"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cci_02_0081__p18874191524313">The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.</p>
+</div></div>
+<p id="cci_02_0081__p9451544080">CCI supports the following actions that can be defined in custom policies:</p>
+<ul id="cci_02_0081__ul241324734617"><li id="cci_02_0081__li1941314471465"><a href="cci_02_0083.html#cci_02_0083__table6129054123319">Namespace management actions</a>: actions supported by all namespace management APIs, such as the APIs for creating, querying, updating, and deleting a namespace</li><li id="cci_02_0081__li10278190474"><a href="cci_02_0083.html#cci_02_0083__table529334703410">Pod management actions</a>: actions supported by all pod management APIs, such as the APIs for creating, querying, modifying, and a deleting pod</li><li id="cci_02_0081__li15457648134814"><a href="cci_02_0083.html#cci_02_0083__table19741529184014">Network management actions</a>: actions supported by all network management APIs, such as the APIs creating, querying, modifying, and deleting a network</li><li id="cci_02_0081__li19892710154914"><a href="cci_02_0083.html#cci_02_0083__table833064864119">ConfigMap management actions</a>: actions supported by all ConfigMap management APIs, such as the APIs for creating, querying, modifying, and deleting a ConfigMap</li><li id="cci_02_0081__li429382174913"><a href="cci_02_0083.html#cci_02_0083__table16668191964212">Secret management actions</a>: actions supported by all secret management APIs, such as the APIs for creating, querying, modifying, and deleting a secret</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0082.html">Permissions Policies and Supported Actions</a></div>
+</div>
+</div>
+

docs/cci/api-ref/cci_02_0082.html

@@ -0,0 +1,13 @@
+<a name="cci_02_0082"></a><a name="cci_02_0082"></a>
+
+<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
+<div id="body1579415269113"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="cci_02_0081.html">Introduction</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="cci_02_0083.html">Category of CCI Actions</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cci/api-ref/cci_02_1001.html

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

docs/cci/api-ref/cci_02_1002.html

@@ -0,0 +1,15 @@
+<a name="cci_02_1002"></a><a name="cci_02_1002"></a>
+
+<h1 class="topictitle1">Obtaining an Account ID</h1>
+<div id="body1536284603344"><p id="cci_02_1002__p8112855194115">An account ID (domain ID) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:</p>
+<ol id="cci_02_1002__ol8715914194127"><li id="cci_02_1002__li50056756194127">Log in to the management console.</li><li id="cci_02_1002__li2804809915217">Click the username in the upper right corner and choose <strong id="cci_02_1002__b101421817194518">My Credentials</strong> from the drop-down list.<p id="cci_02_1002__p136772519449"></p>
+<div class="fignone" id="cci_02_1002__fig1110211275296"><span class="figcap"><b>Figure 1 </b>Obtaining your account ID</span><br><span><img id="cci_02_1002__image310214274295" src="en-us_image_0000001909236985.png"></span></div>
+<p id="cci_02_1002__p1515102822910"></p>
+</li></ol>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0067.html">Appendix</a></div>
+</div>
+</div>
+

docs/cci/api-ref/cci_02_1003.html

@@ -0,0 +1,12 @@
+<a name="cci_02_1003"></a><a name="cci_02_1003"></a>
+
+<h1 class="topictitle1">Obtaining a Container Image Address</h1>
+<div id="body1538227496964"><p id="cci_02_1003__p524683913514">Cloud Container Instance (CCI) supports both images in the container registry and those uploaded to SoftWare Repository for Container (SWR). Where,</p>
+<ul id="cci_02_1003__ul632115713153"><li id="cci_02_1003__li12953639191518">SWR has synchronized some common images from the container registry so that you can use the images named in the format of <span class="uicontrol" id="cci_02_1003__uicontrol012212287577"><b>Image name:Tag</b></span> (for example, <strong id="cci_02_1003__b1122122895714">nginx:alpine</strong>) on the internal network. You can query the synchronized images on the SWR console.</li><li id="cci_02_1003__li732113575159">SWR images can be obtained by using <span class="uicontrol" id="cci_02_1003__uicontrol543333515819"><b>Image Pull Command</b></span>. After an image is uploaded, you can obtain its address.</li></ul>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0067.html">Appendix</a></div>
+</div>
+</div>
+

docs/cci/api-ref/cci_02_2000.html

@@ -0,0 +1,65 @@
+<a name="cci_02_2000"></a><a name="cci_02_2000"></a>
+
+<h1 class="topictitle1">Proprietary APIs</h1>
+<div id="body1534218703861"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="listCciV2Namespace.html">Listing or Watching Objects of kind Namespace</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="createCciV2Namespace.html">Creating a Namespace</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="deleteCciV2Namespace.html">Deleting a Namespace</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readCciV2Namespace.html">Reading the Specified Namespace</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="listCciV2NamespacedConfigMap.html">Listing or Watching Objects of kind ConfigMap</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="createCciV2NamespacedConfigMap.html">Creating a ConfigMap</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="deleteCciV2NamespacedConfigMap.html">Deleting a ConfigMap</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readCciV2NamespacedConfigMap.html">Reading the Specified ConfigMap</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="replaceCciV2NamespacedConfigMap.html">Replacing the Specified ConfigMap</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="listCciV2NamespacedPod.html">Listing or Watching Objects of kind Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="createCciV2NamespacedPod.html">Creating a Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="deleteCciV2NamespacedPod.html">Deleting a Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readCciV2NamespacedPod.html">Reading the Specified Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="patchCciV2NamespacedPod.html">Partially Updating the Specified Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="replaceCciV2NamespacedPod.html">Replacing the Specified Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="connectCciV2GetNamespacedPodExec.html">Connecting GET Requests to exec of Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="connectCciV2PostNamespacedPodExec.html">Connecting POST Requests to exec of Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readCciV2NamespacedPodLog.html">Reading Logs of the Specified Pod</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="listCciV2NamespacedSecret.html">Listing or Watching Objects of kind Secret</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="createCciV2NamespacedSecret.html">Creating a Secret</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="deleteCciV2NamespacedSecret.html">Deleting a Secret</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readCciV2NamespacedSecret.html">Reading the Specified Secret</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="replaceCciV2NamespacedSecret.html">Replacing the Specified Secret</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="listYangtseV2NamespacedNetwork.html">Listing or Watching Objects of kind Network</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="createYangtseV2NamespacedNetwork.html">Creating a Network</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="deleteYangtseV2NamespacedNetwork.html">Deleting a Network</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="readYangtseV2NamespacedNetwork.html">Reading the Specified Network</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="replaceYangtseV2NamespacedNetwork.html">Replacing the Specified Network</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/cci/api-ref/devg_na.html

@@ -0,0 +1,18 @@
+<a name="devg_na"></a><a name="devg_na"></a>
+
+<h1 class="topictitle1">Namespace and Network</h1>
+<div id="body0000001392829485"><p id="devg_na__en-us_topic_0127684722_p366216366496">A namespace provides a method of allocating resources among multiple users. It applies to scenarios where multiple teams or projects exist.</p>
+<p id="devg_na__en-us_topic_0127684722_p0953533104614">A network is a Kubernetes resource object extended for CCI. You can associate a network with a Virtual Private Cloud (VPC) and subnet so that CCI can use network resources of the public cloud.</p>
+<div class="section" id="devg_na__en-us_topic_0127684722_section17189123157"><h4 class="sectiontitle">Relationship Between a Namespace and Network</h4><p id="devg_na__en-us_topic_0127684722_p113090420361">A namespace corresponds to a subnet in a VPC, as shown in <a href="#devg_na__en-us_topic_0127684722_fig714315366295">Figure 1</a>. When a namespace is created, it will be associated with a VPC, and a subnet will be created under the VPC. In this namespace, resources such as pods and Services are created in the corresponding VPC and subnet, and the IP addresses in the subnet are used.</p>
+<p id="devg_na__en-us_topic_0127684722_p588217147288">If you want to run resources of multiple services in the same VPC, you need to plan subnet CIDR blocks and IP addresses.</p>
+<div class="fignone" id="devg_na__en-us_topic_0127684722_fig714315366295"><a name="devg_na__en-us_topic_0127684722_fig714315366295"></a><a name="en-us_topic_0127684722_fig714315366295"></a><span class="figcap"><b>Figure 1 </b>Relationship between namespaces and VPC subnets</span><br><span><img id="devg_na__en-us_topic_0127684722_image4808536164720" src="en-us_image_0000001909077313.png"></span></div>
+</div>
+<div class="section" id="devg_na__en-us_topic_0127684722_section5571151617513"><h4 class="sectiontitle">Scenarios Where Multiple Namespaces Are Used</h4><p id="devg_na__en-us_topic_0127684722_p1924341711518">Because namespaces enable partial environment isolation, you can create different namespaces, such as production, test, and development namespaces based on project attributes when there are a large number of projects and persons.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0067.html">Appendix</a></div>
+</div>
+</div>
+

docs/cci/api-ref/en-us_topic_0000001991313061.html

@@ -0,0 +1,38 @@
+<a name="EN-US_TOPIC_0000001991313061"></a><a name="EN-US_TOPIC_0000001991313061"></a>
+
+<h1 class="topictitle1">Change History</h1>
+<div id="body0000001991313061">
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001991313061__table15700183215116" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001991313061__row1270012323513"><th align="left" class="cellrowborder" valign="top" width="21.19%" id="mcps1.3.1.1.3.1.1"><p id="EN-US_TOPIC_0000001991313061__p3701143220513"><strong id="EN-US_TOPIC_0000001991313061__b0263913192911">Released On</strong></p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="78.81%" id="mcps1.3.1.1.3.1.2"><p id="EN-US_TOPIC_0000001991313061__p070193212518"><strong id="EN-US_TOPIC_0000001991313061__b1532771410291">What's New</strong></p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="EN-US_TOPIC_0000001991313061__row114041940123116"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001991313061__p1441145113115">2024-10-12</p>
+</td>
+<td class="cellrowborder" valign="top" width="78.81%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001991313061__p8945104918311">Modified the following:</p>
+<ul id="EN-US_TOPIC_0000001991313061__ul89451749173113"><li id="EN-US_TOPIC_0000001991313061__li17945194963111"><a href="cci_02_2000.html">Proprietary APIs</a></li></ul>
+</td>
+</tr>
+<tr id="EN-US_TOPIC_0000001991313061__row323113296561"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001991313061__p1623213299562">2024-10-10</p>
+</td>
+<td class="cellrowborder" valign="top" width="78.81%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001991313061__p19232142915560">Modified the following:</p>
+<ul id="EN-US_TOPIC_0000001991313061__ul16744124375617"><li id="EN-US_TOPIC_0000001991313061__li674464355619"><a href="cci_02_2000.html">Proprietary APIs</a></li></ul>
+</td>
+</tr>
+<tr id="EN-US_TOPIC_0000001991313061__row17452853161119"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001991313061__p1221216154372">2024-07-18</p>
+</td>
+<td class="cellrowborder" valign="top" width="78.81%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001991313061__p31997119382">Modified the following:</p>
+<ul id="EN-US_TOPIC_0000001991313061__ul117824170619"><li id="EN-US_TOPIC_0000001991313061__li176572164311"><a href="cci_02_0011.html">Getting Started</a></li><li id="EN-US_TOPIC_0000001991313061__li224116162147"><a href="cci_02_0081.html">Introduction</a></li></ul>
+</td>
+</tr>
+<tr id="EN-US_TOPIC_0000001991313061__row1416781274311"><td class="cellrowborder" valign="top" width="21.19%" headers="mcps1.3.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001991313061__p7794151694314">2024-05-10</p>
+</td>
+<td class="cellrowborder" valign="top" width="78.81%" headers="mcps1.3.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001991313061__p147944160433">This issue is the first official release.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+

docs/cci/api-ref/pro_ys.html

@@ -0,0 +1,27 @@
+<a name="pro_ys"></a><a name="pro_ys"></a>
+
+<h1 class="topictitle1">Notes and Constraints</h1>
+<div id="body0000001342829574"><div class="section" id="pro_ys__section2353330201613"><h4 class="sectiontitle">Regions</h4><p id="pro_ys__p820914271101">CCI is available in regions listed in <a href="#pro_ys__table3107172125619">Table 1</a>.</p>
+
+<div class="tablenoborder"><a name="pro_ys__table3107172125619"></a><a name="table3107172125619"></a><table cellpadding="4" cellspacing="0" summary="" id="pro_ys__table3107172125619" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Supported regions</caption><thead align="left"><tr id="pro_ys__row51081322564"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.3.2.3.1.1"><p id="pro_ys__p1110802115612">Region Name</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.1.3.2.3.1.2"><p id="pro_ys__p31081525563">Region</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="pro_ys__row10615185219236"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.3.2.3.1.1 "><p id="pro_ys__p1364234144713">EU-Magdeburg/Biere</p>
+</td>
+<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.1.3.2.3.1.2 "><p id="pro_ys__p516842152416">eu-de</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="cci_02_0067.html">Appendix</a></div>
+</div>
+</div>
+