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>
123 lines
11 KiB
HTML
123 lines
11 KiB
HTML
<a name="en-us_topic_0079467625"></a><a name="en-us_topic_0079467625"></a>
|
|
|
|
<h1 class="topictitle1">Deleting an Agency</h1>
|
|
<div id="body1507708723006"><div class="section" id="en-us_topic_0079467625__sb6596dc8b5f44731a92c8b950ee95e38"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0079467625__p354876111320">This API is used to delete an agency.</p>
|
|
<div class="note" id="en-us_topic_0079467625__note5886143613720"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0079467625__p2886536077">After this operation, the delegated party can no longer access the relevant resources. Exercise caution when performing this operation.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467625__se12ea354d7df4a2f89999cc32c337dd7"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0079467625__u32757515daf8471d8ead977f606e04e2"><li id="en-us_topic_0079467625__la843d511f8a6464cb91b2c95ad9c317a">URI format<p id="en-us_topic_0079467625__a0f340de18cca424abdcf4bf9223057b2"><a name="en-us_topic_0079467625__la843d511f8a6464cb91b2c95ad9c317a"></a><a name="la843d511f8a6464cb91b2c95ad9c317a"></a>DELETE /v3.0/OS-AGENCY/agencies/{agency_id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467625__ue6634046750547169c6263b9cff37aa5"><li id="en-us_topic_0079467625__l4675e09aa1d747e3b0c22702f78e5d1c">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467625__t9160453da6c646bab98ddb409718d030" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467625__r0790258fcb724e31999bd0c4f0f7cd8e"><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_0079467625__a8b4497ec357e417eae3508dcc05bfdda"><strong id="en-us_topic_0079467625__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_0079467625__a27e14d6572df4c69a0f4d68b18602437"><strong id="en-us_topic_0079467625__b842352706161940">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_0079467625__aa372e51be903421da30b54b77c6ce29c"><strong id="en-us_topic_0079467625__b842352706143526">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_0079467625__aed93ee8738a643fdaae6aed295844ab2"><strong id="en-us_topic_0079467625__b20601766145329">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467625__r3438217c55c7410fa66f7d1dc61d35d7"><td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0079467625__a1a21bcca29fe4ef1b7b752484f32330e">agency_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_0079467625__af4b82dfe9d5b411bab7fc415e602ed72">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_0079467625__a2912d1342d76422e839f3d24b6dc912d">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_0079467625__afc3d3b18f93c4b2997ef7cefda5e5a8a">ID of an agency.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467625__s6b7ffda07dd44957b5fb7f306b13a924"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0079467625__u8059446faf564658af83619d86d9afca"><li id="en-us_topic_0079467625__lf638f8133d8c4011be1790309081c5cb">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467625__tf116769063204d7596eaaa9fd057926d" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467625__r8e25bcd7ed0d474cb19289b1da801b23"><th align="left" class="cellrowborder" valign="top" width="19.36%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0079467625__aa20bfca9bf01411ba9cf7ea09be73cba"><strong id="en-us_topic_0079467625__b1425050232">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0079467625__aa8f2b48d9a0a411098dd2e918ed50bc7"><strong id="en-us_topic_0079467625__b84235270616358">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.46%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0079467625__ad81c2db9fab54416942d17d4054153fa"><strong id="en-us_topic_0079467625__b1359115712">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.45%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0079467625__ade539319fe5544b884685f354ea18b1f"><strong id="en-us_topic_0079467625__b1219693272">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467625__r1bc4074380ce4caa98258b006d937e2f"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467625__a1a0a073e17de4254a5904d17faaf54b7">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467625__a81855a86cedb4c1bbdcb03de8c7ef87d">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467625__af506635a79744dcb85881210222edcc4">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.45%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467625__a6f7c37f5f0704523b61136a4d1e72a7b">Fill <strong id="en-us_topic_0079467625__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467625__r8022c5e431104b75841d73f8bf0d83b5"><td class="cellrowborder" valign="top" width="19.36%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0079467625__a96f588d7ea674791961c78d8b7469fe5">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0079467625__ae1c8f8b729084269b159f1d491513b17">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.46%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0079467625__ab6dd06b9fe6c43a8bda64189dc5aeb29">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.45%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0079467625__a6f8a4cec8b1e4540ba921ba50f5ba3a3">Authenticated token with the <strong id="en-us_topic_0079467625__b750798910387">Security Administrator</strong> permission.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0079467625__uc381ec5d043849a19a0172a4c909d524"><li id="en-us_topic_0079467625__la991a6826fb44873998346fdcb6730c8">Example request<pre class="screen" id="en-us_topic_0079467625__se411645d982a4154a282a92b926d64b1"><em id="en-us_topic_0079467625__i63513954112722">curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X DELETE https://</em><em id="en-us_topic_0079467625__i42471188112722">sample.domain.com</em><em id="en-us_topic_0079467625__i34754676112722">/v3<em id="en-us_topic_0079467625__a47c0634c87ee498abb686f7a63363d71">.0/OS-AGENCY</em>/agencies/2809756f748a46e2b92d58d309f67291</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467625__sbc04ebdb940349d9a2107d5041800789"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0079467625__u336f8bd23a9a4dd7b676c7c91672f6ba"><li id="en-us_topic_0079467625__l92d00bff83184c34a04545dbdb9e1349">Example response (request failed)<pre class="screen" id="en-us_topic_0079467625__s374b65c71ed545808cfdb3b6cc4ba263">{
|
|
"error": {
|
|
"message": "Could not find agency: 2809756f748a46e2b92d58d309f67291",
|
|
"code": 404,
|
|
"title": "Not Found"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0079467625__sdfa0d1f63be8432287f6ecc0fe4b91c5"><h4 class="sectiontitle"><strong id="en-us_topic_0079467625__b842352706183230">Status Codes</strong></h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0079467625__tc7141067802c43ef881aa22220820fb7" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0079467625__ra753c762e52944509247ce977b72ae90"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0079467625__afcb83520d064464dabb3441e86ae7486"><strong id="en-us_topic_0079467625__b493233238">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_0079467625__a38c9798d04d94fe0819e20aaaa6cc5ec"><strong id="en-us_topic_0079467625__b12869534">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0079467625__r35129cb7e9e24827b7a08134ae4a3fc3"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467625__ab1c9a58498d14deb910e2679dc8884b0">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467625__ac2a02d868a9a4f3489e5e18374329c3a">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467625__rea238a1492f74494aba7c5bbfc11e13d"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467625__a21d8c4bd30e042469ed07bee172d2858">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467625__a34e556791e6f40ff8ac68110192a21f1">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467625__rb960e9f524b9467ea13bfef36fe20a86"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467625__a5c605ca12e0b40be89ebe65ba66f49f4">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467625__a43d3636287fc476a9e1de01fd9101d24">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467625__r200e6dc59b404ee3b10f0ee3c30a93a3"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467625__ae3268a5f33df48649e441d3c426f2a65">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467625__acbfcfb3f66b34dab8ee8f165b0946232">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0079467625__r7bde0cda122243379e138695a0dc77c8"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0079467625__ab44cab09ac2c4f87b312aedb8fc7ca26">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0079467625__a1c3f6fd876f8434c8b5c993667fbf707">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>
|
|
|