文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 快照管理/ 查询快照策略
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询快照策略

功能介绍

查询快照策略。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/clusters/{cluster_id}/snapshot-policies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

必须是有效的dws集群ID。

取值范围：

36位UUID。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

keep_day

Integer

参数解释：

保留天数。

取值范围：

大于等于0。

backup_strategies

Array of BackupStrategyDetail objects

参数解释：

备份策略列表。

取值范围：

不涉及。

device_name

String

参数解释：

备份设备，一般为OBS。

取值范围：

不涉及。

server_ips

Array of strings

参数解释：

服务IP。

取值范围：

不涉及。

server_port

String

参数解释：

服务端口。

取值范围：

不涉及。

backup_param

String

参数解释：

备份参数。

取值范围：

不涉及。

auto_backup

Boolean

参数解释：

自动备份开关状态。

取值范围：

true：已开启自动备份选项；

false：已关闭自动备份选项；

backup_strategy_cluster_type_limit_num

Integer

参数解释：

此策略下集群级快照最大数量。

取值范围：

大于等于0。

backup_strategy_schema_type_limit_num

Integer

参数解释：

此策略下schema级快照最大数量。

取值范围：

大于等于0。
表3 BackupStrategyDetail

参数

参数类型

描述

policy_id

String

参数解释：

策略ID。

取值范围：

不涉及。

policy_name

String

参数解释：

策略名称。

取值范围：

不涉及。

backup_strategy

String

参数解释：

执行策略，一般为crontab表达式。

取值范围：

不涉及。

backup_type

String

参数解释：

备份类型。

取值范围：

不涉及。

backup_level

String

参数解释：

备份级别。

取值范围：

不涉及。

next_fire_time

String

参数解释：

下次触发时间（预估，与其它任务冲突时不执行）。

取值范围：

不涉及。

update_time

String

参数解释：

更新时间。

取值范围：

不涉及。

time_zone_offset

Integer

参数解释：

时区偏移量（相比UTC时间）。

取值范围：

0~23

请求示例

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/snapshot-policies

响应示例

状态码：200

查询快照策略成功。

{
  "keep_day" : 3,
  "backup_strategies" : [ {
    "policy_id" : "3b5464ad-74a5-42cc-9667-76122839109a",
    "policy_name" : "apie-default-full-strategy",
    "backup_strategy" : "0 0 2 ? * 1",
    "backup_type" : "full",
    "backup_level" : "cluster",
    "next_fire_time" : "1747533600000",
    "update_time" : "2025-05-11T10:06:16",
    "time_zone_offset" : 0
  }, {
    "policy_id" : "ceaeaf07-d600-494c-86d7-caa0fbf0858a",
    "policy_name" : "apie-default-increment-strategy",
    "backup_strategy" : "0 7 2/8 ? * 2,3,4,5,6,7",
    "backup_type" : "increment",
    "backup_level" : "cluster",
    "next_fire_time" : "1747015620000",
    "update_time" : "2025-05-11T10:06:16",
    "time_zone_offset" : 0
  } ],
  "device_name" : "OBS",
  "server_ips" : null,
  "server_port" : null,
  "backup_param" : null,
  "auto_backup" : true,
  "backup_strategy_cluster_type_limit_num" : 10,
  "backup_strategy_schema_type_limit_num" : 50
}

状态码

状态码

描述

200

查询快照策略成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。
父主题： 快照管理