Listing Snapshot Chains

Function

This API is used to list snapshot chains. Standard snapshots are available only in some regions. To check the supported regions, see the region information shown under "EVS Snapshots" in Function Overview

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/snapshot-chains

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition The project ID. Constraints N/A Range For details, see Obtaining a Project ID. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Definition The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page. Constraints N/A Range N/A Default Value N/A
limit	No	Integer	Definition The maximum number of query results that can be returned. Constraints N/A Range The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit. Default Value N/A
id	No	String	Definition The snapshot chain ID. Constraints N/A Range N/A Default Value N/A
volume_id	No	String	Definition The ID of the disk that the snapshot chain belongs to. You can obtain it on the disk list page of the EVS console. Constraints N/A Range N/A Default Value N/A
category	No	String	Definition The snapshot chain type. Constraints N/A Range The value can be standard, backup, or server_backup. Default Value N/A

Request Parameters

**Table 3** 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: 200

**Table 4** Response body parameters
Parameter	Type	Description
snapshot_chains	Array of snapshot_chains objects	Definition The snapshot chain list. Range N/A

**Table 5** snapshot_chains
Parameter	Type	Description
id	String	Definition The snapshot chain ID. Range N/A
availability_zone	String	Definition The AZ of the disk that the snapshot chain belongs to. Range N/A
snapshot_count	Integer	The number of snapshots on the snapshot chain.
capacity	Integer	Definition The snapshot chain storage usage. Range The value is greater than or equal to 0.
project_id	String	Definition The project ID. Range N/A
volume_id	String	Definition The ID of the disk that the snapshot chain belongs to. Range N/A
category	String	Definition The snapshot chain type. Range N/A
created_at	String	Definition The creation time. Range N/A
updated_at	String	Definition The update time. Range N/A

Status code: 400

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

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

Example Requests

GET https://{endpoint}/v5/{project_id}/snapshot-chains

Example Responses

Status code: 200

{
  "snapshot_chains" : [ {
    "id" : "e97f57fe-767b-46c6-ac1b-10b77e491406",
    "capacity" : 0,
    "project_id" : "fb640396c4344e4f96057fab643fe5b5",
    "volume_id" : "7c40f5ae-2b26-4922-b586-3d41af4822f1",
    "category" : "standard",
    "availability_zone" : "cn-southwest-242a",
    "snapshot_count" : 1,
    "created_at" : "2023-10-25T08:56:26.087002",
    "updated_at" : "2023-10-25T08:56:26.758003"
  }, {
    "id" : "5b798ddd-872b-4823-ab45-a02733ed62cb",
    "capacity" : 1,
    "project_id" : "fb640396c4344e4f96057fab643fe5b5",
    "volume_id" : "92fea069-6073-4784-a7e8-7a1a4caf9c70",
    "category" : "standard",
    "availability_zone" : null,
    "snapshot_count" : 1,
    "created_at" : "2023-08-15T13:17:59.061000",
    "updated_at" : "2023-08-15T13:17:59.065000"
  } ]
}

Status code: 400

Bad Request

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

Status Codes

Status Code	Description
200	OK
400	Bad Request

Error Codes

See Error Codes.

Parent topic: Standard Snapshot Management

Previous topic: Deleting a Snapshot

Next topic: Querying the Number of 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