功能介紹
查詢策略列表
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/policies
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
operation_type |
否 |
String |
策略類型：備份（backup）、復(fù)制(replication) 枚舉值：
|
|
vault_id |
否 |
String |
存儲庫ID |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取（響應(yīng)消息頭中X-Subject-Token的值）。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
policies |
策略列表 |
|
|
count |
Integer |
策略總數(shù) |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
enabled |
Boolean |
策略是否啟用 |
|
id |
String |
策略ID |
|
name |
String |
策略名稱 |
|
operation_definition |
策略屬性 |
|
|
operation_type |
String |
保護類型：備份（backup）、復(fù)制(replication)。 枚舉值：
|
|
trigger |
策略時間調(diào)度規(guī)則 |
|
|
associated_vaults |
關(guān)聯(lián)的存儲庫 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
day_backups |
Integer |
保留日備個數(shù)，該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù)，則timezone 也必選。 最小值：0 最大值：100 |
|
destination_project_id |
String |
復(fù)制的目標(biāo)項目ID，僅在跨區(qū)域復(fù)制時才會使用并且必須指定。 |
|
destination_region |
String |
復(fù)制的目標(biāo)區(qū)域，僅在跨區(qū)域復(fù)制時才會使用并且必須指定。長度限制：0- 255，只能由字母、數(shù)字、“_”、“-”組成 |
|
enable_acceleration |
Boolean |
跨區(qū)域復(fù)制時，是否啟用加速從而縮減復(fù)制的時間，如果不指定，默認不啟用加速。 |
|
max_backups |
Integer |
單個備份對象自動備份的最大備份數(shù)。取值為-1或0-99999。-1代表不按備份數(shù)清理。若該字段和retention_duration_days字段同時為空，備份會永久保留。 最小值：1 最大值：99999 缺省值：-1 |
|
month_backups |
Integer |
保留月備個數(shù)，該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù)，則timezone 也必選。 最小值：0 最大值：100 |
|
retention_duration_days |
Integer |
備份保留時長，單位天。最長支持99999天。-1代表不按時間清理。若該字段和max_backups 參數(shù)同時為空，備份會永久保留。 最小值：1 最大值：99999 缺省值：-1 |
|
timezone |
String |
用戶所在時區(qū),格式形如UTC+08:00, 若選擇年備，月備，周備，日備中任一參數(shù)，則該參數(shù)不能為空。 |
|
week_backups |
Integer |
保留周備個數(shù)，該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù)，則timezone 也必選。 |
|
year_backups |
Integer |
保留年備個數(shù)，該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù)，則timezone 也必選。 最小值：0 最大值：100 |
|
full_backup_interval |
Integer |
每間隔多少次執(zhí)行一次全量備份，當(dāng)取值為 -1 時，不執(zhí)行全量備份 最小值：-1 最大值：100 最小值：-1 最大值：100 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
調(diào)度器id |
|
name |
String |
調(diào)度器名稱 |
|
properties |
調(diào)度器屬性 |
|
|
type |
String |
調(diào)度器類型,目前只支持 time: 定時調(diào)度。 枚舉值：
|
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
pattern |
Array of strings |
調(diào)度規(guī)則。限制24條規(guī)則。調(diào)度器的調(diào)度規(guī)則，可參照iCalendar RFC 2445規(guī)范中的事件規(guī)則，但僅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等參數(shù)，其中FREQ僅支持WEEKLY和DAILY，BYDAY支持一周七天（MO、TU、WE、TH、FR、SA、SU），BYHOUR支持0-23小時，BYMINUTE支持0-59分鐘，并且間隔不能小于一小時，一天最大24個時間點。例如，周一到周天，每天UTC時間的14:00調(diào)度，其規(guī)則為：'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如：某個地區(qū)的時間為 UTC+8，若在該地區(qū)每天14:00調(diào)度，則在14點基礎(chǔ)上減8，其規(guī)則為'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。 |
|
start_time |
String |
調(diào)度器開始時間，例如："2020-01-08 09:59:49" |
請求示例
查詢指定備份策略列表
GET https://{endpoint}/v3/{project_id}/policies
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"policies" : [ {
"name" : "policy001",
"associated_vaults" : [ ],
"enabled" : true,
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
"start_time" : "2019-05-08 06:57:05"
},
"type" : "time",
"id" : "d67269a6-5369-42d7-8150-5254bd446328",
"name" : "default"
},
"operation_definition" : {
"retention_duration_days" : 1,
"year_backups" : 0,
"day_backups" : 0,
"month_backups" : 0,
"week_backups" : 0,
"timezone" : "UTC+08:00"
},
"operation_type" : "backup",
"id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
} ],
"count" : 10
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
