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>
320 lines
27 KiB
HTML
320 lines
27 KiB
HTML
<a name="en-us_topic_0057845625"></a><a name="en-us_topic_0057845625"></a>
|
|
|
|
<h1 class="topictitle1">Querying Project Information Based on the Specified Criteria</h1>
|
|
<div id="body1492670576126"><div class="section" id="en-us_topic_0057845625__s380dc90cda6c4acba39c06b7dd2ce1e9"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845625__p1578617193584">This API is used to query project information based on the specified criteria.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845625__sf615d5ea5cc44edf8d9960f0bc981e97"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845625__ul172033512115"><li id="en-us_topic_0057845625__li4201535121115">URI format<p id="en-us_topic_0057845625__ae1fd3745bd9b465b8114a5110035b34d"><a name="en-us_topic_0057845625__li4201535121115"></a><a name="li4201535121115"></a>GET /v3/projects{?domain_id,name,enabled,parent_id,is_domain,page,per_page}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845625__en-us_topic_0026585113_ul50294666"><li id="en-us_topic_0057845625__en-us_topic_0026585113_li49998812">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845625__en-us_topic_0026585113_table47336128" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845625__en-us_topic_0026585113_row49554687"><th align="left" class="cellrowborder" valign="top" width="18.421842184218423%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p54506685"><strong id="en-us_topic_0057845625__b62544519112125">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.79187918791879%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p52965331"><strong id="en-us_topic_0057845625__a105e6ed8c3de4c5a9dde97ae5a71071e_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.021902190219024%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p62333418"><strong id="en-us_topic_0057845625__ac567ba5e1a47441987e0c88f4078942e_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.76437643764376%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p15842089"><strong id="en-us_topic_0057845625__a474b3e785d7d4684a0c90106e51e3ba6">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845625__en-us_topic_0026585113_row8140857"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p55429698">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p60620523">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p11315292">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p44123454">ID of an enterprise account to which a user belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__en-us_topic_0026585113_row61566768"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p20852350">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p11318800">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p44407631">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p40248354">Project name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row7299172943813"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p14121195319395">parent_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p71215530394">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p4121185320399">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p171211453143913">Parent project ID of a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row111461543103820"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p913943183913">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p813983143913">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p613918315398">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p181391532398">Whether a project is available.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row793683814389"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p1213920333917">is_domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p1013914313919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p181391537399">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p12139183153915">Indicates whether the user calling the API is a tenant.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row3301961143855"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p5159279014395">page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p1826646714395">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p318887714395">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p5697247514395">The page to be queried. The minimum value is <strong id="en-us_topic_0057845625__b1810282377163149">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row791068914390"><td class="cellrowborder" valign="top" width="18.421842184218423%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p5965671114395">per_page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.79187918791879%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p35544014395">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.021902190219024%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p2879064914395">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.76437643764376%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p62859960163424">Number of data records on each page.</p>
|
|
<p id="en-us_topic_0057845625__p5034119414395">Value range: [1,5000]</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="en-us_topic_0057845625__n83a2790017734740b3358e64aeba400f"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0057845625__p35690847175545">When querying required information by page, ensure that the query parameters <strong id="en-us_topic_0057845625__b62570273173344">page</strong> and <strong id="en-us_topic_0057845625__b26261545173344">per_page</strong> both exist.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845625__sf15b8a66213e4cbebbe19daa3db9f159"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845625__en-us_topic_0026585113_ul26758660"><li id="en-us_topic_0057845625__en-us_topic_0026585113_li39501348">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845625__en-us_topic_0026585113_table19967814" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845625__en-us_topic_0026585113_row62835574"><th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p56516768"><strong id="en-us_topic_0057845625__a3d36e4824b214268bc27dd6cf0b3fdee">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p14455523"><strong id="en-us_topic_0057845625__a105e6ed8c3de4c5a9dde97ae5a71071e_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.15%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p30046694"><strong id="en-us_topic_0057845625__ac567ba5e1a47441987e0c88f4078942e_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.57%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p17863121"><strong id="en-us_topic_0057845625__a78685c0019b64bedbbf38bdc95fd875d">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845625__rd830396628d84ea2a78249340dc8e6e5"><td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__ae69f4e1f183d4e6a82a447c6c51dd3bb">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__a46e7614fe7524390be4c0cfe6e146512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__a9172a1617e4c423ca144149fbf806f52">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.57%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__a8a69e5f2739b4fcc996e01ae20ecbaf3">Fill <strong id="en-us_topic_0057845625__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__en-us_topic_0026585113_row37626701"><td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p27863937">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p42386454">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.15%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p10750772">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.57%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p52774644194451">Authenticated token of the target tenant.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845625__l299236a225724653b43ee66cc1354cc5">Example request<pre class="screen" id="en-us_topic_0057845625__s9696d49d05474906a33403d3b1e6ec1e"><em id="en-us_topic_0057845625__i57921961141534">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -X "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/projects?domain_id=5c9f5525d9d24c5bbf91e74d86772029&name=</em>region_name</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845625__s50fc4d2354714f279e24d075fbc04a26"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845625__u038cb568d63e46ac95f0986f79d7bc03"><li id="en-us_topic_0057845625__l2e0c2ec3fbf640ca9f98448f23594a13">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845625__t1266dd240c3649048c9f42af34a0686b" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845625__rd8ac2cd80e4b47d684b61df4f3c570cf"><th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845625__ad167d1bf89ca443eac693ea562da12a3"><strong id="en-us_topic_0057845625__a91cc16ec42d849d3ada0fe573ea173e1">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845625__aad08ea1f8c8e4a42a1a81112a74cb237"><strong id="en-us_topic_0057845625__a105e6ed8c3de4c5a9dde97ae5a71071e_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.36%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845625__a9b5fafff0348408893dcc06fbe0b1186"><strong id="en-us_topic_0057845625__ac567ba5e1a47441987e0c88f4078942e_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.669999999999995%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845625__ad002a0bf107a468884a5777e55f837f6"><strong id="en-us_topic_0057845625__ab7086946bd9240b5a77037d99ded7220">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845625__ref3b81e8e64e418c961ca1bce6f25280"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__abb2b4d81b907497da50ad4f12760f7dc">projects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__a7e49a4eaca054e36ba774b0cdc492081">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__af41e29e0e266400c900609efde3aaf39">List</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.669999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__a8ded0409c6d948dc82f7f779a4cfa5b8">List of projects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row17979111841518"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845625__p34207706172552">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845625__p19360826172552">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.36%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845625__p24723091172552">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.669999999999995%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845625__p56413324172552">Project resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845625__l86920d09d4224a93a4379c10a51077f0">Description for the project format
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845625__t3ef10d134105438f922a72ac36adbe13" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845625__ra836795da3204436ad115c6d63f33cb3"><th align="left" class="cellrowborder" valign="top" width="20.61%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845625__a915f4fa2492a4fa3b5fc5b52cb975ed3"><strong id="en-us_topic_0057845625__a47d7f5d64c8b432b9b0986aae135c770">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845625__aeb29128c8bc6489593aaf12297635c52"><strong id="en-us_topic_0057845625__a105e6ed8c3de4c5a9dde97ae5a71071e_7">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.86%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845625__a367df15999ce47aa8fa2550bb2d3df9a"><strong id="en-us_topic_0057845625__ac567ba5e1a47441987e0c88f4078942e_7">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.3%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845625__a16a6b7e4145e4fbabf25e75163ec3f95"><strong id="en-us_topic_0057845625__ae8f3de030d304e9ca0154a467f37982a">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845625__row1630172942012"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__p6161946154521">is_domain</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__p21721285154521">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__p41042049154521">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__p305652154521">Indicates whether the user calling the API is a tenant.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r6aa1186cf8554a019ac2b2130cf5b8d2"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__a1441367937eb4233b8cda7012259c030">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__a69f17d6e57f544fb90861e9a8297a485">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__a1a749c575c9b40049712221af5070e71">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__ace0495cc79a34a2690c98b2dc69b4768">Project description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row13801134313207"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__p1080120431207">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__p2705079812952">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__p4363103412952">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__p4445286212952">Project resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__rb2ba995189ec478eb5d1181d3bb7be1c"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__aa1005da54f2c4746ae99676d14ab012d">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__a6d0540b177e34775b18c670cf5cd46bc">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__a65f6a6fc5a364d868072c58eeab90325">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__ababe5d21d4764e209d225a4cea9b9fa2">Whether a project is available.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r41522dc2bd8d475b8d2a16af17d5213b"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__a2501c5b12ff94e338c0930e6c321af90">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__af10224f581d946cb91a49683adf34271">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__a0316e95fb756489a82f70ae562c523b4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__af5ce8c5c520f468895f28d74f6eb4540">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__row2537965212"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__p49220723154521">parent_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__p64815690154521">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__p65672473154521">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__p30787847154521">Parent ID of the project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r1208cbb1496440d89eb758b2cd80d578"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__a4504807eb899465fb0ce3ac82d7013dc">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__en-us_topic_0026585113_p386591205643">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__a293aacc9b5354786a8b30a063a186b02">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__aa1138dcdd40340039e621e7abf0332e1">ID of an enterprise account to which a project belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__rbe8775b4e77a4b08be093de05e7bcbf3"><td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845625__acc4c499e1b2f4bdd98e5c7acd4e8861b">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845625__a4bf5dfe715d342e0a883343cbcf8181a">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845625__a8c424bac7d93444dbc647a1d5c5c21e4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.3%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845625__afc48731c8a2e4c66a56ac245f7a1e34e">Project name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845625__en-us_topic_0026585113_ul39601516"><li id="en-us_topic_0057845625__en-us_topic_0026585113_li20869327">Example response<pre class="screen" id="en-us_topic_0057845625__screen10521561191128">{
|
|
"links": {
|
|
"self": "<em id="en-us_topic_0057845625__i82691271320">https://sample.domain.com</em>/v3/projects?domain_id=c9f5525d9d24c5bbf91e74d86772029&name=region_name",
|
|
"previous": null,
|
|
"next": null
|
|
},
|
|
"projects": [
|
|
{
|
|
"is_domain": false,
|
|
"description": "",
|
|
"links": {
|
|
"self": "<em id="en-us_topic_0057845625__i49651171631">https://sample.domain.com</em>/v3/projects/e86737682ab64b2490c48f08bcc41914"
|
|
},
|
|
"enabled": true,
|
|
"id": "e86737682ab64b2490c48f08bcc41914",
|
|
"parent_id": "c9f5525d9d24c5bbf91e74d86772029",
|
|
"domain_id": "c9f5525d9d24c5bbf91e74d86772029",
|
|
"name": "region_name"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845625__s791625f7e91045a99dacb83eeaeab0ca"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845625__en-us_topic_0026585113_table8268111" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845625__en-us_topic_0026585113_row6757235"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845625__en-us_topic_0026585113_p10465156"><strong id="en-us_topic_0057845625__abf4071d983774024a2b3c35bebf32cfb">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_0057845625__en-us_topic_0026585113_p42371273"><strong id="en-us_topic_0057845625__a131041de71c64cb4b154f48c1db4e31d">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845625__reb721646e2bd423dba003e9081c1d4da"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__a2e8a8ee7a72c45d38d3b5b39c17806b6">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a5554a6af41f04ac0bfe75e541afdb6f7">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r94c2894d0685406eb347de138998e50d"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__a7039248d16864cfdb145042196dd0a4d">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a228f52291c964a8cb61e9f4cfa8835b2">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r82fdd253c453410ea60c395495e4fa6d"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__a087911f0192d4b1683fb93e6ed500ef6">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a5d0da0ddd2de45ca9631c290a74f45cd">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__re70fedbf4a8648a181e8a88d0b6f7b34"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__ad629b774064a4284ad2377c059ed5631">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__aa87e9b92d9d743ad80f53fb31fca0748">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r68339f474aee485fb565034249fd9965"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__acf8367d1dbd7416c97e8111d6d73da12">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a02f598d0b2ac43cf823fd56654688995">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__rb43cf0f7e13e4339bdc3c2b940fa979e"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__a887894ab473844529e048190c04a42c1">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a6524f6b7ad6b432a9b23621e0e3b0149">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845625__r322cf83b8af244cd8799c052cd4eee43"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845625__a46a4bb51a0d7448097fc34697403f919">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845625__a9e597e4f5b40449aa94be1f6935a031d">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>
|
|
|