華為云計(jì)算 云知識(shí) 修改策略UpdatePolicy
修改策略UpdatePolicy

 

功能介紹

修改策略

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

PUT /v3/{project_id}/policies/{policy_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

policy_id

String

策略ID

project_id

String

項(xiàng)目ID

請(qǐng)求參數(shù)

表2 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。

表3 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

policy

PolicyUpdate object

修改策略body

表4 PolicyUpdate

參數(shù)

是否必選

參數(shù)類型

描述

enabled

Boolean

是否啟用策略

缺省值:true

name

String

策略名稱

最小長(zhǎng)度:1

最大長(zhǎng)度:64

operation_definition

PolicyoODCreate object

調(diào)度參數(shù)

trigger

PolicyTriggerReq object

策略執(zhí)行時(shí)間規(guī)則

表5 PolicyoODCreate

參數(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

表6 PolicyTriggerReq

參數(shù)

是否必選

參數(shù)類型

描述

properties

PolicyTriggerPropertiesReq object

調(diào)度器屬性

表7 PolicyTriggerPropertiesReq

參數(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

表8 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

policy

Policy object

創(chuàng)建響應(yīng)

表9 Policy

參數(shù)

參數(shù)類型

描述

enabled

Boolean

策略是否啟用

id

String

策略ID

name

String

策略名稱

operation_definition

PolicyoODCreate object

策略屬性

operation_type

String

保護(hù)類型:備份(backup)、復(fù)制(replication)。

枚舉值:

  • backup

trigger

PolicyTriggerResp object

策略時(shí)間調(diào)度規(guī)則

associated_vaults

Array of PolicyAssociateVault objects

關(guān)聯(lián)的存儲(chǔ)庫(kù)

表10 PolicyoODCreate

參數(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

表11 PolicyTriggerResp

參數(shù)

參數(shù)類型

描述

id

String

調(diào)度器id

name

String

調(diào)度器名稱

properties

PolicyTriggerPropertiesResp object

調(diào)度器屬性

type

String

調(diào)度器類型,目前只支持 time: 定時(shí)調(diào)度。

枚舉值:

  • time

表12 PolicyTriggerPropertiesResp

參數(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)度器開(kāi)始時(shí)間,例如:"2020-01-08 09:59:49"

表13 PolicyAssociateVault

參數(shù)

參數(shù)類型

描述

destination_vault_id

String

關(guān)聯(lián)的遠(yuǎn)端存儲(chǔ)庫(kù)ID

vault_id

String

存儲(chǔ)庫(kù)ID

請(qǐng)求示例

修改一個(gè)備份策略,周一到周天每天14:00執(zhí)行備份,保留策略按備份保留時(shí)長(zhǎng),保留一天。

PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff

{
  "policy" : {
    "enabled" : true,
    "name" : "policy001",
    "operation_definition" : {
      "day_backups" : 0,
      "month_backups" : 0,
      "max_backups" : 1,
      "timezone" : "UTC+08:00",
      "week_backups" : 0,
      "year_backups" : 0
    },
    "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" : [ ],
    "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" : {
      "max_backups" : 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)參見(jiàn)錯(cuò)誤碼