UpdatePolicyV2 - 修改策略

更新时间:
复制 MD 格式

修改一个策略。

接口说明

策略的修改,将对所有绑定的数据源生效,请谨慎操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PolicyId

string

策略 ID。

po-000************viy

PolicyName

string

策略名称。

每天备份 + 异地备份

PolicyDescription

string

策略描述。

每天早上10点备份一次,异地备份到上海。

Rules

array<object>

策略规则列表。

array<object>

策略规则。

RuleId

string

规则 ID。

rule-000************rof

RuleType

string

规则类型,每一个策略需要至少有一个 BACKUP 类型规则,有且仅有一个 TRANSITION 类型规则:

  • BACKUP:备份规则。

  • TRANSITION:生命周期规则。

  • REPLICATION:复制规则。

BACKUP

Schedule

string

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份定时设置。可选格式:

  • I|{startTime}|{interval}:表示从{startTime}开始每隔{interval}的时间执行一次备份任务。例如I|1631685600|P1D表示从 2021-09-15 14:00:00 开始每隔一天备份一次。

    • startTime:备份起始时间,UNIX 时间,单位为秒。

    • interval: ISO8601 时间间隔。例如:PT1H表示间隔一小时。P1D表示间隔一天。

  • C|{startTime}|{crontab}:表示从{startTime}开始根据{crontab}表达式执行备份任务。例如C|1631685600|0 0 2 ? * 3,5,7表示从 2021-09-15 14:00:00 开始每周二, 周四和周六的 02:00:00 执行备份。

    • startTime:备份起始时间,UNIX 时间,单位为秒。

    • crontab: crontab 表达式。例如:0 0 2 ? * 3,5,7表示每周二, 周四和周六的 02:00:00。

不会补偿已过去时间的备份任务。如果上一次备份任务没有完成,不会触发下一次备份任务。

I|1648647166|P1D

BackupType

string

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份类型。取值为 COMPLETE,表示全量备份。

COMPLETE

Retention

integer

仅当 RuleType 取值为 TRANSITIONREPLICATION 时,需要配置该参数。

  • RuleType 取值为 TRANSITION:备份保留时间,最小值为 1,单位为天。

  • RuleType 取值为 REPLICATION:异地备份保留时间,最小值为 1,单位为天。

7

ReplicationRegionId

string

仅当 RuleType 取值为 REPLICATION 时,需要配置该参数。复制的目标地域 ID。

cn-shanghai

ArchiveDays

integer

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。备份转为归档的时间,单位为天。

90

ColdArchiveDays

integer

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。备份转为冷归档的时间,单位为天。

365

VaultId

string

仅当 RuleType 取值为 BACKUP 时,需要配置该参数。备份库 ID。

v-0001************aseg

RetentionRules

array<object>

仅当 RuleType 取值为 TRANSITION 时,需要配置该参数。特殊保留规则。

object

特殊保留规则。

AdvancedRetentionType

string

特殊保留规则类型:

  • WEEKLY:每周的备份

  • MONTHLY:每月的备份

  • YEARLY:每年的备份

YEARLY

WhichSnapshot

integer

针对第几个备份生效,当前仅支持第 1 个备份,值为 1。

1

Retention

integer

备份的特殊保留时间,最小值为 1,单位为天。

365

KeepLatestSnapshots

integer

是否开启保留至少一个备份版本。

  • 0 - 不保留

  • 1 - 保留

1

DataSourceFilters

array<object>

仅当 RuleType 取值为 TAG 时,需要配置该参数。数据源过滤规则。

object

SourceType

string

数据源类型。取值范围:

  • UDM_ECS:表示 ECS 整机备份。仅当 RuleType 取值为UDM_ECS_ONLY时,支持该数据源类型。

  • OSS:表示 OSS 备份。仅当 RuleType 取值为 STANDARD 时,支持该数据源类型。

  • NAS:表示阿里云 NAS 备份。仅当 RuleType 取值为 STANDARD 时,支持该数据源类型。

  • ECS_FILE:表示 ECS 文件备份标准版。仅当 RuleType 取值为 STANDARD 时,支持该数据源类型。

  • OTS:表示 Tablestore 备份。仅当 RuleType 取值为 STANDARD 时,支持该数据源类型。

UDM_ECS

DataSourceIds deprecated

array

已废弃。

deprecated

string

已废弃。

已废弃。

TagFilters

array<object>

仅当 RuleType 取值为 TAG 时,需要配置该参数。资源标签过滤规则。

object

Key

string

标签键。

env

Value

string

标签值,为空时表示任意值。

prod

Operator

string

标签匹配规则,支持

  • EQUAL:匹配标签键和标签值。

  • NOT:匹配标签键,不匹配标签值。

EQUAL

Immutable

boolean

仅当 PolicyType 取值为UDM_ECS_ONLY并且 RuleType 取值为 SECURITY 时,需要配置该参数。表示是否开启备份锁定。

true

返回参数

名称

类型

描述

示例值

object

UpdatePolicyResponse

Success

boolean

请求是否成功。

  • true:成功。

  • false:失败。

true

Code

string

返回码,200 表示成功。

200

Message

string

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful

RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情