Querying Snapshot Details
Function
This API is used to query snapshot details using the snapshot ID.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/snapshots/{snapshot_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
snapshot_id |
Yes |
String |
Definition Snapshot ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
snapshot |
SnapshotDetail object |
Definition Snapshot details. Range N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition Snapshot ID. Range N/A |
name |
String |
Definition Snapshot name. Range N/A |
description |
String |
Definition Snapshot description. Range N/A |
started |
String |
Definition Snapshot creation time. The format is ISO8601: YYYY-MM-DDThh:mm:ssZ. Range N/A |
finished |
String |
Definition Time when a snapshot is complete. Format: ISO8601: YYYY-MM-DDThh:mm:ssZ. Range N/A |
size |
Double |
Definition Snapshot size, in GB. Range N/A |
status |
String |
Definition Snapshot status. Range CREATING AVAILABLE UNAVAILABLE FROZEN POLICE_FROZEN |
type |
String |
Definition Snapshot type. Range N/A |
cluster_id |
String |
Definition ID of the cluster for which the snapshot is created. Range N/A |
datastore |
Datastore object |
Definition Snapshot version. Range N/A |
cluster_name |
String |
Definition Name of the cluster for which the snapshot is created. Range N/A |
bak_expected_start_time |
String |
Definition Estimated start time of a snapshot. Range N/A |
bak_keep_day |
Integer |
Definition Retention days for a snapshot. Range N/A |
bak_period |
String |
Definition Snapshot policy. Range N/A |
db_user |
String |
Definition Database user. Range N/A |
progress |
String |
Definition Snapshot progress. Range N/A |
backup_key |
String |
Definition Snapshot backup key. Range N/A |
prior_backup_key |
String |
Definition Incremental snapshot. The backup key of the previous snapshot is used. Range N/A |
base_backup_key |
String |
Definition Backup key of the full snapshot. Range N/A |
backup_device |
String |
Definition Backup media. Range NBU or OBS |
total_backup_size |
Integer |
Definition Total size of snapshots. Range N/A |
base_backup_name |
String |
Definition Name of the full snapshot. Range N/A |
support_inplace_restore |
Boolean |
Definition Whether in-place restoration is supported. Range N/A |
fine_grained_backup |
Boolean |
Definition Whether fine-grained backup is used. Range N/A |
backup_level |
String |
Definition Backup level. Range N/A |
fine_grained_backup_detail |
FineGrainedSnapshotDetail object |
Definition Fine-grained backup information. Range N/A |
guest_agent_version |
String |
Definition GuestAgent version. Range N/A |
cluster_status |
String |
Definition Cluster status. Range N/A |
Example Requests
GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7
Example Responses
Status code: 200
Snapshot details queried.
{ "snapshot" : { "id" : "2a4d0f86-67cd-408a-8b66-017454fb7793", "name" : "snapshot-1", "description" : "snapshot description", "started" : "2016-08-23T03:59:23Z", "finished" : "2016-08-23T04:01:40Z", "size" : 500, "status" : "AVAILABLE", "type" : "MANUAL", "cluster_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Snapshot details queried. |
400 |
Request error. |
401 |
Authentication failed. |
403 |
You do not have required permissions. |
404 |
No resources found. |
500 |
Internal server error. |
503 |
Service unavailable. |
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