Querying a Snapshot List
Function
This API is used to query all snapshots of a cluster, including the snapshot creation time, data engine, snapshot ID, and snapshot status, helping you manage the lifecycle of cluster snapshots. This API enables you to quickly obtain the details of a specified snapshot, verify snapshot availability, and help you restore data, roll back versions, or analyze storage costs. This API also provides structured data support required for automatic monitoring and warning for the O&M team, significantly improving cluster O&M efficiency and stability.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A |
cluster_id |
Yes |
String |
Definition: ID of the cluster whose snapshots you want to query. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
backups |
Array of ListSnapshotBackupsResp objects |
Definition: Snapshot list. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
created |
String |
Definition: Snapshot creation time. Value range: The format is CCYY-MM-DDThh:mm:ss (ISO 8601). |
datastore |
Definition: Search engine. Value range: N/A |
|
description |
String |
Definition: Snapshot description. Value range: N/A |
id |
String |
Definition: Snapshot ID. Value range: N/A |
clusterId |
String |
Definition: Cluster ID. Value range: N/A |
clusterName |
String |
Definition: Cluster name. Value range: N/A |
name |
String |
Definition: Snapshot name. Value range: N/A |
status |
String |
Definition: Snapshot status. Value range:
|
backupType |
String |
Parameter description: Snapshot type. Options:
|
backupMethod |
String |
Parameter description: Snapshot creation mode. Options:
|
backupFrequency |
String |
Definition: Cluster snapshot creation frequency. Value range:
|
indices |
String |
Definition: Index you want to back up. Value range: N/A |
totalShards |
Integer |
Definition: Total number of shards of the index you want to back up. Value range: N/A |
failedShards |
Integer |
Definition: Number of shards that fail to be backed up. Value range: N/A |
restoreStatus |
String |
Definition: Snapshot restoration status. Value range:
|
startTime |
Long |
Definition: Snapshot start timestamp. Value range: N/A |
endTime |
Long |
Definition: Snapshot end timestamp. Value range: N/A |
bucketName |
String |
Definition: Name of the bucket that stores snapshot data. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Definition: Cluster engine type. Value range:
|
version |
String |
Definition: Elasticsearch engine version. For details, see the supported versions in Before You Start. Value range: N/A |
Example Requests
Query the cluster snapshot list.
GET https://{Endpoint}/v1.0/{project_id}/clusters/37cb1075-c38e-4cd8-81df-442d52df3786/index_snapshots
Example Responses
Status code: 200
Request succeeded.
{ "backups" : [ { "created" : "2018-03-07T07:34:47", "datastore" : { "type" : "elasticsearch", "version" : "x.x.x" }, "description" : "", "id" : "e29d99c1-3d19-4ea4-ae8d-f252df76cbe9", "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786", "clusterName" : "Es-xfx", "name" : "snapshot-002", "status" : "COMPLETED", "updated" : "2018-03-07T07:40:12", "backupType" : "1", "backupMethod" : "manual", "backupFrequency" : "HOUR", "indices" : ".kibanawebsite2", "totalShards" : 6, "failedShards" : 0, "version" : "x.x.x", "restoreStatus" : "success", "startTime" : 1520408087099, "endTime" : 1520408412219, "bucketName" : "obs-b8ed" }, { "created" : "2018-03-06T15:42:37", "datastore" : { "type" : "elasticsearch", "version" : "x.x.x" }, "description" : "", "id" : "29a2254e-947f-4463-b65a-5f0b17515fae", "clusterId" : "37cb1075-c38e-4cd8-81df-442d52df3786", "clusterName" : "Es-xfx", "name" : "snapshot-001", "status" : "COMPLETED", "updated" : "2018-03-06T15:48:04", "backupType" : "1", "backupMethod" : "manual", "indices" : ".kibana", "totalShards" : 1, "failedShards" : 0, "version" : "x.x.x", "restoreStatus" : "none", "startTime" : 1520350957275, "endTime" : 1520351284357, "bucketName" : "obs-b8ed" } ] }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class ListSnapshotsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); ListSnapshotsRequest request = new ListSnapshotsRequest(); request.withClusterId("{cluster_id}"); try { ListSnapshotsResponse response = client.listSnapshots(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSnapshotsRequest() request.cluster_id = "{cluster_id}" response = client.list_snapshots(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := css.NewCssClient( css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSnapshotsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListSnapshots(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
406 |
The server could not fulfill the request according to the content characteristics of the request. |
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