更新时间:2025-09-18 GMT+08:00

添加快照策略

功能介绍

该接口用于设置快照策略。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

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

约束限制

必须是有效的dws集群ID。

取值范围

36位UUID。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

keep_day

Integer

参数解释

保留天数。

取值范围

输入值必须在1-31之间。

backup_strategies

Array of BackupStrategyRequest objects

参数解释

策略列表信息。当需要添加策略时该参数为必选。

取值范围

不涉及。

device_name

String

参数解释

备份设备。支持OBS、NBU和NFS。

取值范围

不涉及。

server_port

String

参数解释

NBU备份介质端口。备份介质为NBU时该字段必填。

取值范围

不涉及。

backup_param

String

参数解释

NBU备份参数。备份介质为NBU时该字段必选。

取值范围

不涉及。

server_ips

Array of strings

参数解释

备份介质服务IP。备份介质为NBU和NFS时该字段必填。备份介质为NBU时表示NBU服务器地址,备份介质为NFS时表示NFS服务器地址。

取值范围

不涉及。

表3 BackupStrategyRequest

参数

是否必选

参数类型

描述

policy_id

String

参数解释

策略ID。

取值范围

不涉及。

policy_name

String

参数解释

策略名称。添加备份策略时为必选字段。策略名称在4位到92位之间,必须以字母开头,不区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他特殊字符,并且名称唯一。

取值范围

不涉及。

backup_strategy

String

参数解释

执行策略。添加备份策略时为必选字段。符合Cron表达式格式。

取值范围

不涉及。

backup_type

String

参数解释

备份类型。

取值范围

full:全量。

increment:增量。

backup_level

String

参数解释

备份级别。

取值范围

cluster:集群级。

响应参数

状态码:200

请求成功。

请求示例

添加集群级别的全量快照策略,名为test,快照策略设置为每周一到每周天每天凌晨3点触发。

PUT https://{Endpoint} /v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/snapshot-policies

响应示例

状态码:200

请求成功。

{ }

状态码

状态码

描述

200

请求成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。