Deleting a Snapshot

Function

This API is used to delete a snapshot. Standard snapshots are only supported in some regions. You can check the supported regions on the console.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

DELETE /v5/{project_id}/snapshots/{snapshot_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition The project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
snapshot_id	Yes	String	Definition The snapshot ID. You can call the Querying Details About EVS Snapshots API to obtain the snapshot ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 202

**Table 3** Response body parameters
Parameter	Type	Description
job_id	String	Definition The task ID. For details about how to query the task status, see Querying Task Status. Range N/A

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Definition The error information returned if an error occurs. Range N/A

**Table 5** Error
Parameter	Type	Description
code	String	Definition The error code returned if an error occurs. Range For details about the error code, see Error Codes.
message	String	Definition The error message returned if an error occurs. Range N/A

Example Requests

DELETE https://{endpoint}/v5/{project_id}/snapshots/{snapshot_id}

Example Responses

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

Status Codes

Status Code	Description
202	Accepted
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Standard Snapshot Management

Previous topic: Querying the Number of Snapshots

Next topic: Listing Snapshot Chains

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot