forked from docs/doc-exports
zhangyue
3b5a58b1fe
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
148 lines
13 KiB
HTML
148 lines
13 KiB
HTML
<a name="en-us_topic_0074171149"></a><a name="en-us_topic_0074171149"></a>
|
|
|
|
<h1 class="topictitle1">Setting the Status of a Specified Project</h1>
|
|
<div id="body1503732280076"><div class="section" id="en-us_topic_0074171149__section18319181453614"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0074171149__p191433572015">This API is used to set the status of a specified project. The project statuses include <strong id="en-us_topic_0074171149__b842352706202019">Normal</strong> and <strong id="en-us_topic_0074171149__b842352706202023">Suspended</strong>.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0074171149__section1032051453615"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0074171149__ul132061403610"><li id="en-us_topic_0074171149__li1320181423617">URI format<p id="en-us_topic_0074171149__p6320101418363"><a name="en-us_topic_0074171149__li1320181423617"></a><a name="li1320181423617"></a>PUT /v3-ext/projects/{project_id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0074171149__ul143203143366"><li id="en-us_topic_0074171149__li133201214193614">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0074171149__table1532018142366" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0074171149__row103201149368"><th align="left" class="cellrowborder" valign="top" width="19.830000000000002%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0074171149__p1932041417367"><strong id="en-us_topic_0074171149__en-us_topic_0026586105_b842352706143612">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.78%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0074171149__p1232071411368"><strong id="en-us_topic_0074171149__en-us_topic_0026586105_b842352706143621">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.12%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0074171149__p832051411369"><strong id="en-us_topic_0074171149__b842352706143526_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.269999999999996%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0074171149__p2320191423611"><strong id="en-us_topic_0074171149__b20601766145329_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0074171149__row183201814193615"><td class="cellrowborder" valign="top" width="19.830000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0074171149__p432071415365">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.78%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0074171149__p83202014163620">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0074171149__p3320161415362">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.269999999999996%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0074171149__p332091410362">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0074171149__section132251415368"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0074171149__ul332281443619"><li id="en-us_topic_0074171149__li103221014173613">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0074171149__table3322161493613" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0074171149__row11322131413615"><th align="left" class="cellrowborder" valign="top" width="19.688031196880313%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0074171149__p1432218149369"><strong id="en-us_topic_0074171149__b1641262138">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.98820117988201%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0074171149__p8322161443614"><strong id="en-us_topic_0074171149__b1519956395">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.958204179582044%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0074171149__p19322111433620"><strong id="en-us_topic_0074171149__b842352706143526_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.36556344365563%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0074171149__p73221614143617"><strong id="en-us_topic_0074171149__b20601766145329_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0074171149__row113221514113620"><td class="cellrowborder" valign="top" width="19.688031196880313%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0074171149__p123221314183616">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.98820117988201%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0074171149__p15322181419363">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.958204179582044%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0074171149__p432215149367">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.36556344365563%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0074171149__p1332281419368">Fill <strong id="en-us_topic_0074171149__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row1332261493613"><td class="cellrowborder" valign="top" width="19.688031196880313%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0074171149__p113221814143614">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.98820117988201%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0074171149__p8322714173618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.958204179582044%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0074171149__p1322014123615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.36556344365563%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0074171149__p2354060691653">Authenticated token with the <strong id="en-us_topic_0074171149__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0074171149__li764413211246">Parameters in the request body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0074171149__table2644112114413" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0074171149__row964432117412"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="en-us_topic_0074171149__p764416211842"><strong id="en-us_topic_0074171149__b842352706102426">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.060000000000002%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="en-us_topic_0074171149__p156441821741"><strong id="en-us_topic_0074171149__b842352706102429">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.97%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="en-us_topic_0074171149__p106441212047"><strong id="en-us_topic_0074171149__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.269999999999996%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="en-us_topic_0074171149__p176442215416"><strong id="en-us_topic_0074171149__b20601766145329_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0074171149__row1365942119417"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="en-us_topic_0074171149__p865922118416">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.060000000000002%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="en-us_topic_0074171149__p1265914211416">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.97%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="en-us_topic_0074171149__p1065902117414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.269999999999996%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="en-us_topic_0074171149__p1065992116416">Project status. The value can be <strong id="en-us_topic_0074171149__b842352706102534">suspended</strong> or <strong id="en-us_topic_0074171149__b842352706102531">normal</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en-us_topic_0074171149__note1665913213410"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="en-us_topic_0074171149__ul13659142110418"><li id="en-us_topic_0074171149__li1165919218416"><strong id="en-us_topic_0074171149__b842352706102552">suspended</strong>: The project is frozen.</li><li id="en-us_topic_0074171149__li19659221444"><strong id="en-us_topic_0074171149__b319118802102558">normal</strong>: The project is normal or unfrozen.</li></ul>
|
|
</div></div>
|
|
</li><li id="en-us_topic_0074171149__li1332311145369">Example request<pre class="screen" id="en-us_topic_0074171149__screen1732310149362"><em id="en-us_topic_0074171149__i1432317146369">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -X "X-Auth-Token:$token" -X PUT -<em id="en-us_topic_0074171149__i63231114203612">d '{"project": {"status":"suspended"}}'</em>https://sample.domain.com/v3-ext/projects/5c9f5525d9d24c5bbf91e74d86772029</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0074171149__section1732319140365"><h4 class="sectiontitle">Response Parameters</h4><p id="en-us_topic_0074171149__p113234144369">None</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0074171149__section20323151411368"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0074171149__table8323141453613" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0074171149__row932381403612"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0074171149__p14323514173615"><strong id="en-us_topic_0074171149__b842352706183230_3">Status Code</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0074171149__p10323141463613"><strong id="en-us_topic_0074171149__b20601766145329_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0074171149__row132319142366"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p16323714103613">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p5323614133611">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row43234147366"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p1632321443618">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p432310148363">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row3323114113619"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p832311411365">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p14323121419361">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row15323514113619"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p13323131419361">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p12323914143611">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row1832313143362"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p20324171414362">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p33243147365">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row143245147365"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p1732412140368">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p232416145368">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0074171149__row83241314123618"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0074171149__p5324181453616">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0074171149__p232411417363">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845642.html">Project Management</a></div>
|
|
</div>
|
|
</div>
|
|
|