Deleting Image Recipients
Function
This API is an extension one and used to stop sharing images by deleting image recipients.
This is an asynchronous API. If job_id is returned, the task is successfully delivered. You need to query the status of the asynchronous task. If the status is success, the task is successfully executed. If the status is failed, the task fails. For details about how to query an asynchronous job, see Querying the Progress of an Asynchronous Job.
URI
DELETE /v1/cloudimages/members
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| images | Yes | Array of strings | Specifies the image IDs. |
| projects | Yes | Array of strings | Specifies the project IDs. |
Example Request
Deleting image recipients (image IDs: d164b5df-1bc3-4c3f-893e-3e471fd16e64, 0b680482-acaa-4045-b14c-9a8c7dfe9c70; project IDs: 9c61004714024f9586705d090530f9fa, edc89b490d7d4392898e19b2deb34797)
1 2 3 4 5 6 7 8 9 10 11 | DELETE https://{Endpoint}/v1/cloudimages/members { "images": [ "d164b5df-1bc3-4c3f-893e-3e471fd16e64", "0b680482-acaa-4045-b14c-9a8c7dfe9c70" ], "projects": [ "9c61004714024f9586705d090530f9fa", "edc89b490d7d4392898e19b2deb34797" ] } |
Response
- Response parameters
Parameter
Type
Description
job_id
String
Specifies the asynchronous job ID.
For details, see Querying the Progress of an Asynchronous Job.
- Example response
STATUS CODE 200
1 2 3
{ "job_id": "edc89b490d7d4392898e19b2deb34797" }
Returned Values
- Normal
- Abnormal
Returned Value
Description
400 Bad Request
Request error. For details, see Error Codes.
401 Unauthorized
Authentication failed.
403 Forbidden
Insufficient permissions.
404 Not Found
Requested resource not found.
500 Internal Server Error
Internal service error.
503 Service Unavailable
Service unavailable.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.