ListAutoSnapshotPolicy
功能介绍
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/snapshot-policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
自动快照策略ID。 |
name |
否 |
String |
自动快照策略名称。 |
tags |
否 |
String |
自动快照策略的标签的key/value对,例如{"key1":"value1"} |
tag_key |
否 |
String |
自动快照策略的标签的key |
enterprise_project_id |
否 |
String |
自动快照策略的企业项目id |
limit |
否 |
Integer |
返回结果个数限制。 |
offset |
否 |
Integer |
偏移量 |
sort_key |
否 |
String |
返回结果按该关键字排序,支持id,created_at等关键字,默认为“created_at”。 |
sort_dir |
否 |
String |
返回结果按照降序或升序排列,默认为“desc”。 降序:desc 升序:asc |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
snapshot_policies |
Array of GetSnapshotPolicy objects |
查询的自动快照策略列表信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
自动快照策略ID |
name |
String |
自动快照策略名称。最大支持255个字节。 最小长度:0 最大长度:255 |
repeat_weekdays |
Array of strings |
自动快照的重复日期,单位为天,周期为星期。取值范围为 1~7,如 1 表示周一。 当一星期内需要创建多次自动快照时,可以传入多个时间点: 最多传入 7 个时间点。 多个时间点用一个格式类似"1", "2", … "7"的 JSON 数组表示,时间点之间用半角逗号(,)隔开。 |
repeat_interval_days |
Integer |
自动快照的间隔日期,单位为天,取值范围为 1~30,如1表示每天 |
time_points |
Array of strings |
自动快照的创建时间点。使用 UTC +8 时间,单位为小时。取值范围为 0~23,代表 00:00 至 23:00 共 24 个时间点,如 1 表示 01:00。 当一天内需要创建多次自动快照时,可以传入多个时间点: 最多传入 24 个时间点。 多个时间点用一个格式类似"0", "1", … "23"的 JSON 数组表示,时间点之间用半角逗号(,)隔开。 |
retention_days |
Integer |
设置快照的保留时间,单位为天。保留时间到期后快照会被自动释放,取值范围:1~65536。 缺省值:-1,表示快照持续保留。 |
created_at |
String |
自动快照策略的创建时间。 |
updated_at |
String |
自动快照策略的更新时间。 |
tags |
Map<String,String> |
设置自动快照策略的标签 |
enterprise_project_id |
String |
企业项目id |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
出现错误时,返回的错误信息。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
|
400 |
错误码
请参见错误码。