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>
274 lines
24 KiB
HTML
274 lines
24 KiB
HTML
<a name="en-us_topic_0079467614"></a><a name="en-us_topic_0079467614"></a>
|
|
|
|
<h1 class="topictitle1">Querying an Agency List Based on the Specified Conditions</h1>
|
|
<div id="body1507708722830"><div class="section" id="en-us_topic_0079467614__s351a53087b624bf68c88f723526bd5d4"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0079467614__p42179297122">This API is used to query an agency list based on the specified conditions.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467614__s08fde0a01f0a4ead8e8fc38549803afc"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0079467614__u3639d79b66b340fbba411cd951e7bc5c"><li id="en-us_topic_0079467614__lcab3df695b534665a54403b98f950cf8">URI format<p id="en-us_topic_0079467614__p135456591446"><a name="en-us_topic_0079467614__lcab3df695b534665a54403b98f950cf8"></a><a name="lcab3df695b534665a54403b98f950cf8"></a>GET /v3.0/OS-AGENCY/agencies{?domain_id,name,trust_domain_id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467614__u7df8abaf3947441492a44e6e29e6ef83"><li id="en-us_topic_0079467614__la94871066e2f48b8b2a120a4ef5f8b1c">Query parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467614__tc955f64c43f647049fb9c0165b18cdc2" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467614__r79b5dc33889447b7a605f44df82b31e8"><th align="left" class="cellrowborder" valign="top" width="18.360000000000003%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0079467614__a5cf140b235a143eab767f5bff8c9f08f"><strong id="en-us_topic_0079467614__en-us_topic_0026586105_b842352706143612">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0079467614__a4b51552dc6024331908f59e52aededb1"><strong id="en-us_topic_0079467614__b84235270616358_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.86%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0079467614__a09624a05c0a041a48f058a0658b9cff2"><strong id="en-us_topic_0079467614__b842352706143526_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.3%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0079467614__a9403c6c94f0449c18818099a34847fff"><strong id="en-us_topic_0079467614__b20601766145329_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467614__rb603c04755804200b8a9db46f374bfbe"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__a70ffef7b605940ceab2554ffa2e9c9e0">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__a193d0d26deaf43b6b0783d496d91b15d">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__a4863d79620a24f2d8b953e5e6fe79902">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.3%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__acaf56792cac247aeb78c01f3d94681fd">ID of the current domain.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__ra0d821ace5f643878bec108d34734201"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__a1ca6e155158f459593999840eb90a1da">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__aa704c8457ad2413aaa8f8f704a57d9cb">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__a802ff17d536848c3a3626be288e81f2c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.3%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__a98a47a8d92ec42209fed0c3a5dad302c">Name of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__row0981727204512"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__p2982142724519">trust_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__p39824274453">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.86%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__p1798212715451">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.3%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__p698232764511">ID of the delegated domain.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467614__s7730776dd0be4258b07cfc8001cc82e3"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0079467614__u8c4e33e81f334bcd8c06f7060b84a7d7"><li id="en-us_topic_0079467614__l523d02ad3fe54889957410e2b6b4ed5b">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467614__t10f54517dbcc4a03831bbfa37e3e0f76" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467614__r7b5c0cd2a702444a8b36935202710c14"><th align="left" class="cellrowborder" valign="top" width="18.698130186981302%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0079467614__a4f33c3460da84fffbe137fefbd621939"><strong id="en-us_topic_0079467614__b1753241136">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.188181181881813%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0079467614__ac771b1051939406a977f3d01269784e6"><strong id="en-us_topic_0079467614__b84235270616358_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.66813318668133%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0079467614__a7f14cc65c30d4d29a42772f0f05d699a"><strong id="en-us_topic_0079467614__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.44555544445555%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0079467614__aa6efa916a232459fa15ee2c3829955aa"><strong id="en-us_topic_0079467614__b20601766145329_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467614__r6847fe683769403d9f201b63f1a41a37"><td class="cellrowborder" valign="top" width="18.698130186981302%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__a20bd172006a745e48fc7d63cc8a6bb07">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.188181181881813%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__a3e14fea6edfc4e5189724017a30c5b20">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.66813318668133%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__a52e5b54be9144f0eb25f763df7a4ab53">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.44555544445555%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__a1b153a1e9dab46439d82ac79b23ea22e">Fill <strong id="en-us_topic_0079467614__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r6216c12734e742aa931ef342eb45a7e7"><td class="cellrowborder" valign="top" width="18.698130186981302%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__afd66d1ddd49a4892a90a05ad1b71d542">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.188181181881813%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__af6f2e0365f964329b0beff328366d677">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.66813318668133%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__a086767e16f914d81a4c0ee48994cee87">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.44555544445555%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__p57174477113315">Authenticated token with the <strong id="en-us_topic_0079467614__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467614__ub32bd15d12884f2b83ead6cc3c0e7a85"><li id="en-us_topic_0079467614__lf5dc4680d2d54f16b28a80e7d4103516">Example request<pre class="screen" id="en-us_topic_0079467614__s6ddb27559cff4eefbc504cc998aaf7e5"><em id="en-us_topic_0079467614__i2574323911284">curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X GET https://</em><em id="en-us_topic_0079467614__i3524491711284">sample.domain.com</em><em id="en-us_topic_0079467614__i3036256211284">/v3.0/OS-AGENCY/agencies?domain_id=0ae9c6993a2e47bb8c4c7a9bb8278d61</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467614__s198ef18fb06f4e758c416b93700e996d"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0079467614__ul745314209356"><li id="en-us_topic_0079467614__l546bb7aa1f014af5b82d6534933a7be7">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467614__t25fa11869fcc4bbe930214e8b3a352a8" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467614__r607717c6cad24f3085d946d96e8706f6"><th align="left" class="cellrowborder" valign="top" width="18.891889188918892%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0079467614__a60b8a28cb4a14f4d957e11fbb5ed3491"><strong id="en-us_topic_0079467614__b435835000">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.13181318131813%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0079467614__a18979c4eb8f144c889953807a71fe2c0"><strong id="en-us_topic_0079467614__b842352706161749_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.93189318931893%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0079467614__aac65acd7fc7b4c96933b30be7d73b987"><strong id="en-us_topic_0079467614__b842352706143526_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.04440444044405%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0079467614__ae0490d31122747f29843f4295fab3147"><strong id="en-us_topic_0079467614__b6981351183141_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467614__rae278792d71a4337b1b3ebb9d3cee2d8"><td class="cellrowborder" valign="top" width="18.891889188918892%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467614__ac8b2e0e1384f4dfc8cdea40e1b2992d5">agencies</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13181318131813%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467614__a3f02f98df8b4493c810f2017e8d18dd0">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93189318931893%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467614__a20eedf6a66c144868d14c84c17b47526">JSONArray</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.04440444044405%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467614__adba154707b0049a19d9f6c70c5ff6936">List of agencies.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0079467614__li195373151589">Description for the agency format
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467614__ta8ec7733f3e249568598f092b2720528" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467614__redb2511c03314e6688cf6683d2c25de8"><th align="left" class="cellrowborder" valign="top" width="19.16%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0079467614__a9a1c101100ac49d8b01b6fff33850669"><strong id="en-us_topic_0079467614__b1335608768">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.13%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0079467614__a1346a92b22174e5686a156f2fb7d36f1"><strong id="en-us_topic_0079467614__b842352706161749_3">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.93%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0079467614__a70c10262fdca44c8b6330a1ea18cd1b4"><strong id="en-us_topic_0079467614__b842352706143526_7">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.78%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0079467614__a6897c47449a749889693a4715dc29b50"><strong id="en-us_topic_0079467614__b6981351183141_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467614__r110078ccf9074b61964145e1ab6b4641"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a63c3299b0ce34c21b2a46a56bdb3a264">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__aacfeadabeffa4782b3659e6653070707">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__ae17a21f3468e4ff9a3ef45623af3c959">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__a25157631aeb2483381bbdc786cf25894">ID of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r9313bd23c4384e42a2f8807a693ec666"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a66df6c7fe64e46c9b330d702d2bb4eae">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__abb3b9446d1964dcba392ac04363918f2">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a7d8a46dfe96143ee965795296322d053">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__adf0ce3fd3ecd4eb2a1847aebaa0eccc1">Name of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r691ce2d2be9b4f0d9b446bae0c47d44a"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__en-us_topic_0059029098_p27845782253">domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__aaccfb0ccad5f45838c408cf9bfdd15f4">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a807774074d544fd0859de28bcf268291">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__ae2406e3e6f744fac9745bedcff50f650">ID of the current domain.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r325a9bff4b994a34b57507d4be78beb8"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__ad3629c12f37d4d9592921c14bc84cf6a">trust_domain_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__a2b4c52c03e994fdebfb89d893d4783c1">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a0f101baff64e42f2b2f4e7992cf53e11">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__afd114fc907224d158f657dbde21b7cc7">ID of the delegated domain.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r80e0a5d33f4042f380f5dc2508e86d33"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a11f4b492e6e54a35b90f5fa822632c68">trust_domain_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__a2e4ea74a231e40a79a3d85832c48c2f7">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__ae068b7139057460cb86f4b8558642212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__a885ded2f854540519e8453ab8c140d13">Name of the delegated domain.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__rfff3a67faefa4a4d90ccc4d55117e826"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a3d83a6e80abe424bb89c81a56a345db9">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__a551138aae7ee4ffc8e5b18e8817ad4a3">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a193994eeb3d54231a63b3f00f9c54356">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__a9898e931b68c425e925bbc45b62cabaa">Description of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r2bcc39d4ccd44d5f960103b0078650dd"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a331f9511108649f099fca4b621d2e652">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__a849d9919d2e24ccbb99e7c2540d9e6b8">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a6e474dedf75c47aaa89707390041df4d">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__en-us_topic_0059029098_p332264614915">Validity period of an agency. The default value is <strong id="en-us_topic_0079467614__b84235270615357">null</strong>, indicating that the agency is permanently valid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r47accea11d2a4656b5f59f9a91d4d0e4"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a7952ac6cef1748f9b602370442dac4e6">expire_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__acde65e73e5884215896fb0dfbacfd4d8">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a233710e9c7a74a359805e3a792fe50eb">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__adc40a6e0b8434d50ac019a190bccf712">Expiration time of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r4da6881b747348288637c6c1d8ec00e2"><td class="cellrowborder" valign="top" width="19.16%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0079467614__a7ec8cdeeb85a480c8cab8dd98d89e0e8">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.13%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0079467614__a01610d2c42324f74afab101741bd4377">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.93%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0079467614__a04aed5dc54a746b4846d2044e0854bb8">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.78%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0079467614__a411673306f3d4621999f7fbd460d5612">Time when an agency is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467614__u67af89444fc7433bacb83caa81cb362e"><li id="en-us_topic_0079467614__l620f8864efbd473f8ba19c6911fef9c1">Example response (request successful)<pre class="screen" id="en-us_topic_0079467614__s99f73bacf35a4090990c968eb138ddca">{
|
|
"agencies": [
|
|
{
|
|
"trust_domain_name": "exampledomain",
|
|
"description": " testsfdas ",
|
|
"trust_domain_id": "b3f266d0c08544a0859740de8b84e850",
|
|
"id": "afca8ddf2e92469a8fd26a635da5206f",
|
|
"duration": null,
|
|
"create_time": "2017-01-04T09:09:15.000000",
|
|
"expire_time": null,
|
|
"domain_id": "0ae9c6993a2e47bb8c4c7a9bb8278d61",
|
|
"name": "exampleagency"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467614__u53fea135a63d4291a2e68900374354f3"><li id="en-us_topic_0079467614__l2c442d2a0fab4720b7c87590b883d628">Example response (request failed)<pre class="screen" id="en-us_topic_0079467614__s46bb080a6f1e4d6baba93d4b16f6c34b">{
|
|
"error": {
|
|
"message": "You are not authorized to perform the requested action: identity:list_agencies",
|
|
"code": 403,
|
|
"title": "Forbidden"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467614__s5265144bfc06480cb5006e53b414094b"><h4 class="sectiontitle"><strong id="en-us_topic_0079467614__b842352706183230_1">Status Codes</strong></h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467614__t10316128f6d1479d8eb3c20842d6cb05" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467614__r41c0a862739b4129a1e7477f0148c7e2"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0079467614__a2d85218ca7f644028b00cf625ce46cec"><strong id="en-us_topic_0079467614__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_0079467614__ae7d197d8cff948488553163ca813095d"><strong id="en-us_topic_0079467614__b20601766145329_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467614__r41ba72042c6a484cbf3b90b8aa4c7f60"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467614__ac3b0732dbcb44954bd7c67a20b9752ed">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467614__ac4b9041eb5c746518c888bc5653d3e5b">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r4a7c11abcd714755aa9c7b10ead1e3bc"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467614__a4cab802f9df940daaba760aa19116435">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467614__aa922b46662de42e28dbe8b28f954c12c">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r5637e9b3de70452f8811b285d3ee63f6"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467614__a6153873f5cb54b94bc6f6ca0ef4c98ae">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467614__a5b992477df8a4cbba92d8c4bd8e5b355">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__row166461220388"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467614__p206471620982">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467614__p564720201881">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467614__r10c22aac01bf4282914d5c6811a28c0f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467614__a5e6bd16dc1fb412ebf7aaa4b1dfc20eb">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467614__a9efd6c5584d642b49f94fd416155ecca">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0079467612.html">Agency Management</a></div>
|
|
</div>
|
|
</div>
|
|
|