功能介紹
創(chuàng)建策略,策略分為備份策略和復(fù)制策略。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v3/{project_id}/policies
| 
 參數(shù)  | 
 是否必選  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|---|
| 
 project_id  | 
 是  | 
 String  | 
 項(xiàng)目ID  | 
請(qǐng)求參數(shù)
| 
 參數(shù)  | 
 是否必選  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|---|
| 
 X-Auth-Token  | 
 是  | 
 String  | 
 用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。  | 
| 
 參數(shù)  | 
 是否必選  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|---|
| 
 enabled  | 
 否  | 
 Boolean  | 
 是否啟用策略 缺省值:true  | 
| 
 name  | 
 是  | 
 String  | 
 策略名稱,長(zhǎng)度限制:1- 64,只能由中文、字母、數(shù)字、“_”、“-”組成。 最小長(zhǎng)度:1 最大長(zhǎng)度:64  | 
| 
 operation_definition  | 
 是  | 
 調(diào)度參數(shù)  | 
|
| 
 operation_type  | 
 是  | 
 String  | 
 保護(hù)類型:備份(backup)、復(fù)制(replication)。  | 
| 
 trigger  | 
 是  | 
 策略執(zhí)行時(shí)間規(guī)則  | 
| 
 參數(shù)  | 
 是否必選  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|---|
| 
 day_backups  | 
 否  | 
 Integer  | 
 保留日備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 destination_project_id  | 
 否  | 
 String  | 
 復(fù)制的目標(biāo)項(xiàng)目ID,僅在跨區(qū)域復(fù)制時(shí)才會(huì)使用并且必須指定。  | 
| 
 destination_region  | 
 否  | 
 String  | 
 復(fù)制的目標(biāo)區(qū)域,僅在跨區(qū)域復(fù)制時(shí)才會(huì)使用并且必須指定。長(zhǎng)度限制:0- 255,只能由字母、數(shù)字、“_”、“-”組成  | 
| 
 enable_acceleration  | 
 否  | 
 Boolean  | 
 跨區(qū)域復(fù)制時(shí),是否啟用加速?gòu)亩s減復(fù)制的時(shí)間,如果不指定,默認(rèn)不啟用加速。  | 
| 
 max_backups  | 
 否  | 
 Integer  | 
 單個(gè)備份對(duì)象自動(dòng)備份的最大備份數(shù)。取值為-1或0-99999。-1代表不按備份數(shù)清理。若該字段和retention_duration_days字段同時(shí)為空,備份會(huì)永久保留。 最小值:1 最大值:99999 缺省值:-1  | 
| 
 month_backups  | 
 否  | 
 Integer  | 
 保留月備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 retention_duration_days  | 
 否  | 
 Integer  | 
 備份保留時(shí)長(zhǎng),單位天。最長(zhǎng)支持99999天。-1代表不按時(shí)間清理。若該字段和max_backups 參數(shù)同時(shí)為空,備份會(huì)永久保留。 最小值:1 最大值:99999 缺省值:-1  | 
| 
 timezone  | 
 否  | 
 String  | 
 用戶所在時(shí)區(qū),格式形如UTC+08:00, 若選擇年備,月備,周備,日備中任一參數(shù),則該參數(shù)不能為空。  | 
| 
 week_backups  | 
 否  | 
 Integer  | 
 保留周備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。  | 
| 
 year_backups  | 
 否  | 
 Integer  | 
 保留年備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 full_backup_interval  | 
 否  | 
 Integer  | 
 每間隔多少次執(zhí)行一次全量備份,當(dāng)取值為 -1 時(shí),不執(zhí)行全量備份 最小值:-1 最大值:100 最小值:-1 最大值:100  | 
| 
 參數(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小時(shí),BYMINUTE支持0-59分鐘,并且間隔不能小于一小時(shí),一天最大24個(gè)時(shí)間點(diǎn)。例如,周一到周天,每天UTC時(shí)間的14:00調(diào)度,其規(guī)則為:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如:某個(gè)地區(qū)的時(shí)間為 UTC+8,若在該地區(qū)每天14:00調(diào)度,則在14點(diǎn)基礎(chǔ)上減8,其規(guī)則為'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。  | 
響應(yīng)參數(shù)
狀態(tài)碼: 200
| 
 參數(shù)  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|
| 
 enabled  | 
 Boolean  | 
 策略是否啟用  | 
| 
 id  | 
 String  | 
 策略ID  | 
| 
 name  | 
 String  | 
 策略名稱  | 
| 
 operation_definition  | 
 策略屬性  | 
|
| 
 operation_type  | 
 String  | 
 保護(hù)類型:備份(backup)、復(fù)制(replication)。 枚舉值: 
  | 
| 
 trigger  | 
 策略時(shí)間調(diào)度規(guī)則  | 
|
| 
 associated_vaults  | 
 關(guān)聯(lián)的存儲(chǔ)庫(kù)  | 
| 
 參數(shù)  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|
| 
 day_backups  | 
 Integer  | 
 保留日備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 destination_project_id  | 
 String  | 
 復(fù)制的目標(biāo)項(xiàng)目ID,僅在跨區(qū)域復(fù)制時(shí)才會(huì)使用并且必須指定。  | 
| 
 destination_region  | 
 String  | 
 復(fù)制的目標(biāo)區(qū)域,僅在跨區(qū)域復(fù)制時(shí)才會(huì)使用并且必須指定。長(zhǎng)度限制:0- 255,只能由字母、數(shù)字、“_”、“-”組成  | 
| 
 enable_acceleration  | 
 Boolean  | 
 跨區(qū)域復(fù)制時(shí),是否啟用加速?gòu)亩s減復(fù)制的時(shí)間,如果不指定,默認(rèn)不啟用加速。  | 
| 
 max_backups  | 
 Integer  | 
 單個(gè)備份對(duì)象自動(dòng)備份的最大備份數(shù)。取值為-1或0-99999。-1代表不按備份數(shù)清理。若該字段和retention_duration_days字段同時(shí)為空,備份會(huì)永久保留。 最小值:1 最大值:99999 缺省值:-1  | 
| 
 month_backups  | 
 Integer  | 
 保留月備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 retention_duration_days  | 
 Integer  | 
 備份保留時(shí)長(zhǎng),單位天。最長(zhǎng)支持99999天。-1代表不按時(shí)間清理。若該字段和max_backups 參數(shù)同時(shí)為空,備份會(huì)永久保留。 最小值:1 最大值:99999 缺省值:-1  | 
| 
 timezone  | 
 String  | 
 用戶所在時(shí)區(qū),格式形如UTC+08:00, 若選擇年備,月備,周備,日備中任一參數(shù),則該參數(shù)不能為空。  | 
| 
 week_backups  | 
 Integer  | 
 保留周備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。  | 
| 
 year_backups  | 
 Integer  | 
 保留年備個(gè)數(shù),該備份不受保留最大備份數(shù)限制。取值為0到100。若選擇該參數(shù),則timezone 也必選。 最小值:0 最大值:100  | 
| 
 full_backup_interval  | 
 Integer  | 
 每間隔多少次執(zhí)行一次全量備份,當(dāng)取值為 -1 時(shí),不執(zhí)行全量備份 最小值:-1 最大值:100 最小值:-1 最大值:100  | 
| 
 參數(shù)  | 
 參數(shù)類型  | 
 描述  | 
|---|---|---|
| 
 id  | 
 String  | 
 調(diào)度器id  | 
| 
 name  | 
 String  | 
 調(diào)度器名稱  | 
| 
 properties  | 
 調(diào)度器屬性  | 
|
| 
 type  | 
 String  | 
 調(diào)度器類型,目前只支持 time: 定時(shí)調(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小時(shí),BYMINUTE支持0-59分鐘,并且間隔不能小于一小時(shí),一天最大24個(gè)時(shí)間點(diǎn)。例如,周一到周天,每天UTC時(shí)間的14:00調(diào)度,其規(guī)則為:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如:某個(gè)地區(qū)的時(shí)間為 UTC+8,若在該地區(qū)每天14:00調(diào)度,則在14點(diǎn)基礎(chǔ)上減8,其規(guī)則為'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。  | 
| 
 start_time  | 
 String  | 
 調(diào)度器開始時(shí)間,例如:"2020-01-08 09:59:49"  | 
請(qǐng)求示例
創(chuàng)建一個(gè)備份策略,周一到周天每天14:00執(zhí)行備份,保留策略按備份保留時(shí)長(zhǎng),保留一天。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies
{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "retention_duration_days" : 1,
      "timezone" : "UTC+08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "operation_type" : "backup",
    "trigger" : {
      "properties" : {
        "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
      }
    }
  }
}
響應(yīng)示例
狀態(tài)碼: 200
OK
{
  "policy" : {
    "name" : "policy001",
    "associated_vaults" : null,
    "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"
  }
}
狀態(tài)碼
| 
 狀態(tài)碼  | 
 描述  | 
|---|---|
| 
 200  | 
 OK  | 
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
  
    