更新时间:2025-09-23 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:不可用。

FROZEN:普通冻结。

POLICE_FROZEN:公安冻结。

type

String

参数解释:

快照创建类型。

取值范围:

不涉及。

cluster_id

String

参数解释:

快照对应的集群ID。

取值范围:

不涉及。

datastore

Datastore object

参数解释:

快照版本。

取值范围:

不涉及。

cluster_name

String

参数解释:

快照对应的集群名称。

取值范围:

不涉及。

bak_expected_start_time

String

参数解释:

快照预计开始时间。

取值范围:

不涉及。

bak_keep_day

Integer

参数解释:

快照保留天数。

取值范围:

不涉及。

bak_period

String

参数解释:

快照策略。

取值范围:

不涉及。

db_user

String

参数解释:

数据库用户。

取值范围:

不涉及。

progress

String

参数解释:

快照进度。

取值范围:

不涉及。

backup_key

String

参数解释:

快照BakcupKey。

取值范围:

不涉及。

prior_backup_key

String

参数解释:

增量快照,使用的前一个快照BakcupKey。

取值范围:

不涉及。

base_backup_key

String

参数解释:

对应全量快照BakcupKey。

取值范围:

不涉及。

backup_device

String

参数解释:

备份介质。

取值范围:

NBU、OBS。

total_backup_size

Integer

参数解释:

累计快照大小。

取值范围:

不涉及。

base_backup_name

String

参数解释:

对应全量快照名称。

取值范围:

不涉及。

support_inplace_restore

Boolean

参数解释:

是否支持就地恢复。

取值范围:

不涉及。

fine_grained_backup

Boolean

参数解释:

是否是细粒度备份。

取值范围:

不涉及。

backup_level

String

参数解释:

备份级别。

取值范围:

不涉及。

fine_grained_backup_detail

FineGrainedSnapshotDetail object

参数解释:

细粒度备份信息。

取值范围:

不涉及。

guest_agent_version

String

参数解释:

guestAgent版本。

取值范围:

不涉及。

cluster_status

String

参数解释:

集群状态。

取值范围:

不涉及。

表4 Datastore

参数

参数类型

描述

type

String

参数解释:

集群类型。

取值范围:

不涉及。

version

String

参数解释:

集群版本。

取值范围:

不涉及。

表5 FineGrainedSnapshotDetail

参数

参数类型

描述

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

状态码

状态码

描述

200

查询快照详情成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。