更新时间:2024-02-05 GMT+08:00

查询快照详情

功能介绍

该接口用于使用快照ID查询快照详情。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/snapshots/{snapshot_id}
表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法,请参见获取项目ID

snapshot_id

String

快照ID。

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

snapshot

SnapshotDetail object

快照详情对象。

表3 SnapshotDetail

参数

参数类型

描述

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:不可用。

type

String

快照创建类型。

  • MANUAL:手动快照。
  • AUTOMATED:自动快照。

cluster_id

String

快照对应的集群ID。

cluster_name

String

快照对应的集群名称。

backup_key

String

备份产生的Key。

prior_backup_key

String

增量快照使用前一个快照的BakupKey。当取值为FULL时表示这是一个全量快照。

base_backup_key

String

对应全量快照的BackupKey。

backup_device

String

备份介质。

total_backup_size

Long

快照累计大小,表示从全量开始到当前增量的累计大小。单位KB

base_backup_name

String

对应全量快照名称。

support_inplace_restore

Boolean

是否支持恢复至原集群。

fine_grained_backup

Boolean

是否是细粒度备份。

fine_grained_backup_detail

FineGrainedSnapshotDetail object

细粒度备份信息。

guest_agent_version

String

集群guestAgent版本号。

cluster_status

String

集群状态

  • AVAILABLE:可用

  • UNAVAILABLE:不可用

  • FROZEN:已冻结

bak_expected_start_time

String

预计快照开始时间。

bak_keep_day

Integer

备份保留天数。

bak_period

String

集群策略。

db_user

String

备份用户。

datastore

DataStore object

数据库版本

progress

String

备份进度。

backup_level

String

备份级别

  • cluster
  • schema
表4 FineGrainedSnapshotDetail

参数

参数类型

描述

database

String

备份数据库。

schema_list

Array of String

备份模式集合。

table_list

Array of String

备份表集合。

表5 DataStore

参数

参数类型

描述

type

String

数据库类型。

version

String

数据库版本。

请求示例

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"
  }
}

SDK代码示例

SDK代码示例如下。

 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
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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("cn-north-4"))
                .build();
        ListSnapshotDetailsRequest request = new ListSnapshotDetailsRequest();
        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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListSnapshotDetailsRequest()
        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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListSnapshotDetailsRequest{}
	response, err := client.ListSnapshotDetails(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询快照详情成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。