# 查询快照详情 - ListSnapshotDetails #### 功能介绍 该接口用于使用快照ID查询快照详情。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dws:cluster:getSnapshotDetail | List | cluster | - g:ResourceTag/\ - g:EnterpriseProjectId | dws:openAPISnapshot:detail | - | #### URI GET /v1.0/{project_id}/snapshots/{snapshot_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | snapshot_id | 是 | String | **参数解释**： 快照ID。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snapshot | [SnapshotDetail] object | **参数解释**： 快照详情对象。 **取值范围**： 不涉及。 | 表3SnapshotDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 快照ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 快照名称。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 快照描述。 **取值范围**： 不涉及。 | | started | String | **参数解释**： 快照创建的日期时间，格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。 **取值范围**： 不涉及。 | | finished | String | **参数解释**： 快照完成的日期时间，格式为 ISO8601: YYYY-MM-DDThh:mm:ssZ。 **取值范围**： 不涉及。 | | size | Double | **参数解释**： 快照大小，单位GB。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 快照状态： **取值范围**： - CREATING：创建中。 - AVAILABLE：可用。 - UNAVAILABLE：不可用。 - FROZEN：普通冻结。 - POLICE_FROZEN：公安冻结。 | | type | String | **参数解释**： 快照创建类型。 **取值范围**： - AUTO: 自动。 - MANUAL: 手动。 | | cluster_id | String | **参数解释**： 快照对应的集群ID。 **取值范围**： 不涉及。 | | datastore | [Datastore] object | **参数解释**： 快照版本。 **取值范围**： 不涉及。 | | cluster_name | String | **参数解释**： 快照对应的集群名称。 **取值范围**： 不涉及。 | | updated | String | **参数解释**： 快照更新时间。 **取值范围**： 不涉及。 | | bak_expected_start_time | String | **参数解释**： 快照预计开始时间。 **取值范围**： 不涉及。 | | bak_keep_day | Integer | **参数解释**： 快照保留天数。 **取值范围**： 不涉及。 | | bak_period | String | **参数解释**： 快照策略。 **取值范围**： 不涉及。 | | db_user | String | **参数解释**： 数据库用户。 **取值范围**： 不涉及。 | | progress | String | **参数解释**： 快照进度。 **取值范围**： 不涉及。 | | backup_key | String | **参数解释**： 快照的key，在其它快照中会用到。 **取值范围**： 不涉及。 | | prior_backup_key | String | **参数解释**： 增量快照，使用的前一个快照backup_key。 **取值范围**： 不涉及。 | | base_backup_key | String | **参数解释**： 对应全量快照backup_key。 **取值范围**： 不涉及。 | | backup_device | String | **参数解释**： 备份介质。 **取值范围**： - NBU：NetBackup备份介质。 - OBS：对象存储服务备份介质。 | | total_backup_size | Integer | **参数解释**： 累计快照大小。 **取值范围**： 不涉及。 | | base_backup_name | String | **参数解释**： 对应全量快照名称。 **取值范围**： 不涉及。 | | support_inplace_restore | Boolean | **参数解释**： 是否支持就地恢复。 **取值范围**： 不涉及。 | | fine_grained_backup | Boolean | **参数解释**： 是否是细粒度备份。 **取值范围**： 不涉及。 | | backup_level | String | **参数解释**： 备份级别。 **取值范围**： cluster：集群级快照； schema：schema级快照； table：表级快照； | | fine_grained_backup_detail | [FineGrainedSnapshotDetail] object | **参数解释**： 细粒度备份信息。 **取值范围**： 不涉及。 | | guest_agent_version | String | **参数解释**： guestAgent版本。 **取值范围**： 不涉及。 | | cluster_status | String | **参数解释**： 集群状态。 **取值范围**： - CREATING：创建中。 - AVAILABLE：可用。 - UNAVAILABLE：不可用。 - RESTORING：恢复中。 - FROZEN： 普通冻结。 - POLICE_FROZEN： 公安冻结。 | | cluster_task_status | String | **参数解释**： 集群任务状态。 **取值范围**： 不涉及。 | | support_fine_grained_cross_version_restore | Boolean | **参数解释**： 是否支持细粒度跨版本恢复。 **取值范围**： 不涉及。 | | support_fine_grained_asymmetric_restore | Boolean | **参数解释**： 是否支持细粒度异构恢复。 **取值范围**： 不涉及。 | 表4Datastore | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释**： 集群类型。 **取值范围**： - dws: dws存算一体。 - dws3.0: dws存算分离。 - hybrid: dws实时数仓。 | | version | String | **参数解释**： 集群版本。 **取值范围**： 不涉及。 | 表5FineGrainedSnapshotDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | database | String | **参数解释**： 数据库。 **取值范围**： 不涉及。 | | schema_list | Array of strings | **参数解释**： 模式列表。 **取值范围**： 不涉及。 | | table_list | Array of strings | **参数解释**： 表集合。 **取值范围**： 不涉及。 | #### 请求示例 查询快照详情 ``` GET https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/snapshots/b5c45780-1006-49e3-b2d5-b3229975bbc7 ``` #### 响应示例 **状态码：200** ``` { "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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("")). 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ListSnapshotDetails)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询快照详情成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务内部错误。 | | 503 | 服务不可用。 |