Querying Snapshot Details
Function
This API is used to query snapshot details using the snapshot ID.
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, the following identity policy-based permissions are required.
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: |
| type | String | Definition: Snapshot type. Range: |
| 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 |
| updated | String | Definition: The time when the snapshot was updated Range: None |
| 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 key, which will be used in other snapshots. Range N/A |
| prior_backup_key | String | Definition Backup key of the previous snapshot used by the incremental backup. 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: cluster: cluster-level snapshot; schema: schema-level snapshot; table: table-level snapshot; |
| 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: - RESTORING: restoring |
| cluster_task_status | String | Definition: Cluster task status Range: None |
| support_fine_grained_cross_version_restore | Boolean | Definition: Whether fine-grained cross-version restoration is supported Range: None |
| support_fine_grained_asymmetric_restore | Boolean | Definition: Whether fine-grained heterogeneous restoration is supported Range: None |
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",
"datastore" : {
"type" : "dws",
"version" : "8.2.1"
},
"cluster_name" : "dwstest-813-320",
"updated" : "2016-08-23T04:01:23Z",
"bak_expected_start_time" : "1471895963000",
"bak_keep_day" : 7,
"bak_period" : "0 0 2/8 ? * 2,3,4,5,6",
"db_user" : "dbadmin",
"progress" : "0",
"backup_key" : "backup20160823_035923",
"prior_backup_key" : "FULL",
"base_backup_key" : "backup20160823_035923",
"backup_device" : "obs",
"total_backup_size" : 21759308,
"base_backup_name" : "manual-snapshot",
"support_inplace_restore" : true,
"fine_grained_backup" : true,
"backup_level" : "cluster",
"fine_grained_backup_detail" : {
"database" : "postgres",
"schema_list" : [ "public", "test" ],
"table_list" : [ "t1", "t2", "t3" ]
},
"guest_agent_version" : "8.2.1.300",
"cluster_status" : "AVAILABLE",
"cluster_task_status" : null,
"support_fine_grained_cross_version_restore" : true,
"support_fine_grained_asymmetric_restore" : true
}
} SDK Sample Code
The SDK sample code is as follows.
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.dws.v2.region.DwsRegion; import com.huaweicloud.sdk.dws.v2.*; import com.huaweicloud.sdk.dws.v2.model.*; public class ListSnapshotDetailsSolution { 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); DwsClient client = DwsClient.newBuilder() .withCredential(auth) .withRegion(DwsRegion.valueOf("<YOUR REGION>")) .build(); ListSnapshotDetailsRequest request = new ListSnapshotDetailsRequest(); request.withSnapshotId("{snapshot_id}"); try { ListSnapshotDetailsResponse response = client.listSnapshotDetails(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()); } } } |
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 huaweicloudsdkdws.v2.region.dws_region import DwsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdws.v2 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 = DwsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DwsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSnapshotDetailsRequest() request.snapshot_id = "{snapshot_id}" response = client.list_snapshot_details(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ListSnapshotDetailsRequest{} request.SnapshotId = "{snapshot_id}" response, err := client.ListSnapshotDetails(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 | 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. |
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot