Deleting an Image
Function
This API is used to delete an image object. For a private image, you can also delete its SWR image content using parameters.
This API applies to the following scenarios: When an image is no longer required, the configuration is incorrect, or resources need to be cleared, you can use this API to delete the specified image object. Before using this API, ensure that the image exists and you have the permission to delete it. After the deletion is complete, the image object is permanently removed, and related resources and configurations are cleared. If the image does not exist, you do not have the operation permission, or the image is being used, the API will return an error message.
Constraints
No constraints
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
DELETE /v1/{project_id}/images/{id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Definition: Image ID. The ID is in the format of a Universally Unique Identifier (UUID). Constraints: N/A Range: N/A Default Value: N/A |
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: N/A Range: N/A Default Value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
force |
No |
Boolean |
Definition: Image content to be deleted from SWR. This parameter is valid only for private images. Constraints: N/A Range: The value is of the Boolean type.
Default Value: false |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
arch |
String |
Definition: Processor architecture supported by the image. Range:
|
create_at |
Long |
Definition: UTC time when the image is created, accurate to millisecond. Range: N/A |
description |
String |
Definition: Image description. Range: Up to 512 characters |
dev_services |
Array of strings |
Definition: Services supported by the image. Range:
|
id |
String |
Definition: ID of the image used for creating notebook instances. The ID is in Universally Unique Identifier (UUID) format. For details, see Querying Supported Images. Range: N/A |
name |
String |
Definition: Image name. Range: The name can contain a maximum of 512 characters. Lowercase letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. |
namespace |
String |
Definition: Organization to which the image belongs. You can create and view an organization on the Organization Management page of the SWR console. Range: N/A |
origin |
String |
Definition: Image source. Range:
|
resource_categories |
Array of strings |
Definition: Flavors supported by the image. Range:
|
service_type |
String |
Definition: Supported image types. Range:
|
size |
Long |
Definition: Image size, in KB. Range: N/A |
status |
String |
Definition: Image status. Range:
|
status_message |
String |
Definition: Build information during image saving. Range: N/A |
support_res_categories |
Array of strings |
Definition: Flavors supported by the image. Range:
|
swr_path |
String |
Definition: SWR image path. Range: N/A |
tag |
String |
Definition: Image tag. Range: N/A |
type |
String |
Definition: Image type. Range:
|
update_at |
Long |
Definition: Time (UTC) when the image was last updated, accurate to millisecond. Range: N/A |
visibility |
String |
Definition: Image visibility. Range:
|
workspace_id |
String |
Definition: Workspace ID. If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A |
flavor_type |
String |
Definition: Resource type of the image. Range:
|
Status code: 204
No content
Example Requests
DELETE https://{endpoint}/v1/{project_id}/images/{id}
Example Responses
Status code: 200
OK
{ "arch" : "x86_64", "create_at" : 1671093486722, "description" : "", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "c9ab2b2f-edda-4556-bdbb-494e868d043c", "name" : "mock-service-python", "namespace" : "mock-service1", "origin" : "CUSTOMIZE", "resource_categories" : [ "CPU" ], "service_type" : "UNKNOWN", "size" : 387840321, "status" : "DELETED", "swr_path" : "swr.xxx.com/mock-service1/mock-service-python:0.0.17", "tag" : "0.0.17", "type" : "DEDICATED", "update_at" : 1671093486722, "visibility" : "PRIVATE", "workspace_id" : "0" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
204 |
No content |
401 |
Unauthorized |
403 |
Forbidden |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot