Files
doc-exports/docs/eps/api-ref/en-us_topic_0121230881.html
weihongmin1 89457a7fa8 EPS API First Version
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2025-11-13 12:55:55 +00:00

200 lines
16 KiB
HTML

<a name="en-us_topic_0121230881"></a><a name="en-us_topic_0121230881"></a>
<h1 class="topictitle1">Creating an Enterprise Project</h1>
<div id="body16080284"><div class="section" id="en-us_topic_0121230881__section4094231"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="en-us_topic_0121230881__p27434664">This API is used to create an enterprise project.</p>
</div>
<div class="section" id="en-us_topic_0121230881__section36848086"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0121230881__p12857883">POST /v1.0/enterprise-projects</p>
</div>
<div class="section" id="en-us_topic_0121230881__section63197322"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0121230881__ul15253336"><li id="en-us_topic_0121230881__li3062304">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0121230881__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters in the request header</caption><thead align="left"><tr id="en-us_topic_0121230881__row176585332119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0121230881__p15659133320119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0121230881__p18660183315117">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0121230881__p966018339111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0121230881__p10660173317118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0121230881__row12658203320118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0121230881__p766013333113">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0121230881__p066163320113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0121230881__p1066116335114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0121230881__p1666103311113">Specifies the user token. EPS is a global service. When calling the IAM API to obtain a user token, set <strong id="en-us_topic_0121230881__b191567813314">scope</strong> to <strong id="en-us_topic_0121230881__b71568813319">domain</strong>. The value of <strong id="en-us_topic_0121230881__b168911111338">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row6658433151116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0121230881__p163831551165418">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0121230881__p938318511546">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0121230881__p8362219105513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0121230881__p203831251205414">Default value: <strong id="en-us_topic_0121230881__b1834318551036">application/json; charset=UTF-8</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0121230881__table27560736" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request body</caption><thead align="left"><tr id="en-us_topic_0121230881__row4452677"><th align="left" class="cellrowborder" valign="top" width="25.080000000000002%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0121230881__p25122570">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.24%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0121230881__p21662275">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.91%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0121230881__p9813849">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.77%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0121230881__p56724275">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0121230881__row31263545"><td class="cellrowborder" valign="top" width="25.080000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0121230881__p49319253">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.24%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0121230881__p35436524">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="21.91%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0121230881__p51786216">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.77%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0121230881__p33934001">A name can contain 1 to 255 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name must be unique in the domain and cannot include any form of the word "default".</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row36970558"><td class="cellrowborder" valign="top" width="25.080000000000002%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0121230881__p41825188">description</p>
</td>
<td class="cellrowborder" valign="top" width="17.24%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0121230881__p32397067">No</p>
</td>
<td class="cellrowborder" valign="top" width="21.91%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0121230881__p6916762">String</p>
</td>
<td class="cellrowborder" valign="top" width="35.77%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0121230881__p23386874">A description can contain a maximum of 512 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0121230881__ul15288659"><li id="en-us_topic_0121230881__li5361068">Example request<pre class="codeblock" id="en-us_topic_0121230881__codeblock159986459155">POST https://{EPS endpoint}/v1.0/enterprise-projects</pre>
<pre class="screen" id="en-us_topic_0121230881__screen923925781513">{
"name":"enterprise_project1",
"description": "description"
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0121230881__section31904988"><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0121230881__p165182016166"><strong id="en-us_topic_0121230881__b121221501548">Status code: 201</strong></p>
<ul id="en-us_topic_0121230881__ul51710807"><li id="en-us_topic_0121230881__li62744084">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0121230881__table27825849" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="en-us_topic_0121230881__row12044645"><th align="left" class="cellrowborder" valign="top" width="26.51%" id="mcps1.3.4.3.1.1.2.4.1.1"><p id="en-us_topic_0121230881__p36092170">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.12%" id="mcps1.3.4.3.1.1.2.4.1.2"><p id="en-us_topic_0121230881__p37784672">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.37%" id="mcps1.3.4.3.1.1.2.4.1.3"><p id="en-us_topic_0121230881__p5093181">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0121230881__row9894549"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.3.1.1.2.4.1.1 "><p id="en-us_topic_0121230881__p63260989">enterprise_project</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.3.1.1.2.4.1.2 "><p id="en-us_topic_0121230881__p5227182819111">Dict&lt;enterprise_project&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.3.1.1.2.4.1.3 "><p id="en-us_topic_0121230881__p22874919">Specifies the enterprise project.</p>
<p id="en-us_topic_0121230881__p165601146105614">For details, see <a href="#en-us_topic_0121230881__table26929716">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0121230881__ul40929185"><li id="en-us_topic_0121230881__li32818352"><strong id="en-us_topic_0121230881__b6699296094725">enterprise_project</strong> data structure
<div class="tablenoborder"><a name="en-us_topic_0121230881__table26929716"></a><a name="table26929716"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0121230881__table26929716" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="en-us_topic_0121230881__b11887144941212">enterprise_project</strong> data structure description</caption><thead align="left"><tr id="en-us_topic_0121230881__row9104898"><th align="left" class="cellrowborder" valign="top" width="26.51%" id="mcps1.3.4.4.1.2.2.4.1.1"><p id="en-us_topic_0121230881__p66408105">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.12%" id="mcps1.3.4.4.1.2.2.4.1.2"><p id="en-us_topic_0121230881__p10347445">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.37%" id="mcps1.3.4.4.1.2.2.4.1.3"><p id="en-us_topic_0121230881__p42531099">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0121230881__row22467013"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p7888755">id</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p35009422">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p50286377">Specifies the enterprise project ID.</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row49924209"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p17329090">name</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p61479044">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p39737209">Specifies the enterprise project name.</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row22090566"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p44505445">description</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p48171288">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p36183900">Provides supplementary information about the enterprise project.</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row57219647"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p4279845">status</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p39084151">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p31796234"><strong id="en-us_topic_0121230881__b84235270616119">1</strong> indicates <strong id="en-us_topic_0121230881__b84235270616912">Enabled</strong>. <strong id="en-us_topic_0121230881__b842352706161113">2</strong> indicates <strong id="en-us_topic_0121230881__b84235270616918">Disabled</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row17730652"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p26896723">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p31150983">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p35111876">Specifies the time (UTC) when the enterprise project was created.</p>
<p id="en-us_topic_0121230881__p62999120167">Example: 2018-05-18T06:49:06Z</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row47571430"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p28080649">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p59940076">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p8896531">Specifies the time (UTC) when the enterprise project was modified.</p>
<p id="en-us_topic_0121230881__p1939131951617">Example: 2018-05-18T06:49:06Z</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row1718749203716"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p3667961143">type</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p1966746146">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p186671615414">Project type. <strong id="en-us_topic_0121230881__b611112511418">prod</strong>: commercial project; <strong id="en-us_topic_0121230881__b81116518418">poc</strong>: test project</p>
</td>
</tr>
<tr id="en-us_topic_0121230881__row194165219373"><td class="cellrowborder" valign="top" width="26.51%" headers="mcps1.3.4.4.1.2.2.4.1.1 "><p id="en-us_topic_0121230881__p8509193331112">delete_flag</p>
</td>
<td class="cellrowborder" valign="top" width="30.12%" headers="mcps1.3.4.4.1.2.2.4.1.2 "><p id="en-us_topic_0121230881__p7509113319113">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="43.37%" headers="mcps1.3.4.4.1.2.2.4.1.3 "><p id="en-us_topic_0121230881__p155091833151117">Deletion flag. The value <strong id="en-us_topic_0121230881__b175320618410">false</strong> means that the information is not deleted and the value <strong id="en-us_topic_0121230881__b1753256343">true</strong> means that the information is deleted.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0121230881__ul49530407"><li id="en-us_topic_0121230881__li43120486">Example response<div class="p" id="en-us_topic_0121230881__p16389105661716"><a name="en-us_topic_0121230881__li43120486"></a><a name="li43120486"></a><strong id="en-us_topic_0121230881__b37111770413">Status code: 201</strong><pre class="screen" id="en-us_topic_0121230881__screen579519194110">{
"enterprise_project": {
"id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
"name": "enterprise_project1",
"description": "description",
"type":"prod",
"status": 1,
"delete_flag" : false,
"created_at": "2016-03-28T00:00:00Z",
"updated_at": "2016-03-28T00:00:00Z"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0121230881__section17789101582315"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0121230881__p145228330242">For details, see <a href="en-us_topic_0171146972.html">Status Code</a>.</p>
</div>
<div class="section" id="en-us_topic_0121230881__section18604165622519"><h4 class="sectiontitle">Error Codes</h4><p id="en-us_topic_0121230881__p177044331253">For details, see <a href="en-us_topic_0121230887.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0133321992.html">Enterprise Project Management</a></div>
</div>
</div>