vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ims/api-ref/en-us_topic_0036994324.html
Zaoxu, Li c236478734 IMS API DOC 
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-05 07:22:50 +00:00

150 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0036994324"></a><a name="EN-US_TOPIC_0036994324"></a>
<h1 class="topictitle1">Deleting Image Sharing Members</h1>
<div id="body1472781317570"><div class="section" id="EN-US_TOPIC_0036994324__section11046056154747"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0036994324__p48629638193118">This API is an extension one and used to stop sharing images by deleting tenants the image is shared with.</p>
<p id="EN-US_TOPIC_0036994324__p7229911386">This API is an asynchronous one. If <strong id="EN-US_TOPIC_0036994324__b18966192494112">job_id</strong> is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is <strong id="EN-US_TOPIC_0036994324__b13967122444119">success</strong>, the task is successfully executed. If the status is <strong id="EN-US_TOPIC_0036994324__b497092464111">failed</strong>, the task fails. For details about how to query the status of an asynchronous task, see <a href="en-us_topic_0022473688.html">Querying the Status of an Asynchronous Job</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0036994324__section66620681154747"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0036994324__p1631075693910">DELETE /v1/cloudimages/members</p>
</div>
<div class="section" id="EN-US_TOPIC_0036994324__section29704853154747"><h4 class="sectiontitle">Request</h4><div class="p" id="EN-US_TOPIC_0036994324__p0567194914817">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0036994324__table57282886154747" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0036994324__row33194661154747"><th align="left" class="cellrowborder" valign="top" width="20.01200120012001%" id="mcps1.3.3.2.1.1.5.1.1"><p id="EN-US_TOPIC_0036994324__p4413036154747">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.69216921692169%" id="mcps1.3.3.2.1.1.5.1.2"><p id="EN-US_TOPIC_0036994324__p15244109154747">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.761776177617765%" id="mcps1.3.3.2.1.1.5.1.3"><p id="EN-US_TOPIC_0036994324__p4364817210345">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.53405340534053%" id="mcps1.3.3.2.1.1.5.1.4"><p id="EN-US_TOPIC_0036994324__p26813302154747">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0036994324__row24393852154747"><td class="cellrowborder" valign="top" width="20.01200120012001%" headers="mcps1.3.3.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0036994324__p29744966154747">images</p>
</td>
<td class="cellrowborder" valign="top" width="21.69216921692169%" headers="mcps1.3.3.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0036994324__p384719154747">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.761776177617765%" headers="mcps1.3.3.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0036994324__p2213925010345">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40.53405340534053%" headers="mcps1.3.3.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0036994324__p129047121673">Specifies the image IDs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row2933734592853"><td class="cellrowborder" valign="top" width="20.01200120012001%" headers="mcps1.3.3.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0036994324__p6350774992915">projects</p>
</td>
<td class="cellrowborder" valign="top" width="21.69216921692169%" headers="mcps1.3.3.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0036994324__p4385401492915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.761776177617765%" headers="mcps1.3.3.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0036994324__p6251420792915">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40.53405340534053%" headers="mcps1.3.3.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0036994324__p3048600192915">Specifies the project IDs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0036994324__section28742813123"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0036994324__p1698004219127">Deleting image recipients who can use shared images (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)</p>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0036994324__screen25548375214125"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DELETE</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v1/cloudimages/members</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;images&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;d164b5df-1bc3-4c3f-893e-3e471fd16e64&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;0b680482-acaa-4045-b14c-9a8c7dfe9c70&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;projects&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;9c61004714024f9586705d090530f9fa&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;edc89b490d7d4392898e19b2deb34797&quot;</span>
<span class="w"> </span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0036994324__section42338041154747"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0036994324__ul5242527391115"><li id="EN-US_TOPIC_0036994324__li206541791115">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0036994324__table1858875391115" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0036994324__row5097995091115"><th align="left" class="cellrowborder" valign="top" width="30.486951304869514%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0036994324__p3573529991115">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.078292170782923%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0036994324__p4803685091115">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0036994324__p6577961291115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0036994324__row2654833891115"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0036994324__p293180691115">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0036994324__p4244468991115">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0036994324__p1546781891115">Specifies the asynchronous job ID.</p>
<p id="EN-US_TOPIC_0036994324__p19968122117312">For details, see <a href="en-us_topic_0022473688.html">Querying the Status of an Asynchronous Job</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0036994324__li3986255291235">Example response<pre class="codeblock" id="EN-US_TOPIC_0036994324__codeblock6641838292551">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0036994324__screen4148514791229"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;job_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;edc89b490d7d4392898e19b2deb34797&quot;</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0036994324__section40084941"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0036994324__ul4445458"><li id="EN-US_TOPIC_0036994324__li40009126">Normal<p id="EN-US_TOPIC_0036994324__p24537816"><a name="EN-US_TOPIC_0036994324__li40009126"></a><a name="li40009126"></a>200</p>
</li><li id="EN-US_TOPIC_0036994324__li19513753">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0036994324__table1069408417333" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0036994324__row4772021317333"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0036994324__p4013206717333">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0036994324__p2947196917333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0036994324__row3841925517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p2495195017333">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p784206117333">Request error. For details, see <a href="en-us_topic_0022473689.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row3122722917333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p4637763817333">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p6560116717333">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row5353959117333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p4173958717333">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p2546341217333">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row5197513192250"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p21898657192252">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p28960832192252">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row2784412417333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p4078159117333">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p1497458717333">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0036994324__row55355517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0036994324__p4483799017333">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0036994324__p799858217333">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0135482660.html">Image Sharing</a></div>
</div>
</div>
View Git Blame Copy Permalink